{ "openapi": "3.0.0", "info": { "version": "3.0.0", "title": "Didit Verification API", "description": "API de verificação de identidade. Autentique-se com o cabeçalho x-api-key." }, "servers": [ { "url": "https://verification.didit.me" } ], "tags": [], "paths": { "/system/healthcheck": { "get": { "summary": "Verificação de integridade do serviço (pública, sem autenticação)", "description": "Sonda de disponibilidade (liveness probe) pública e sem autenticação. Retorna `HTTP 200` com `{status: \"ok\", timestamp}` quando o serviço, o banco de dados, o cache e o broker estão íntegros.", "operationId": "get_system_healthcheck", "x-didit-sdk": { "resource": "system", "method": "healthcheck", "auth": "public", "server": false }, "tags": [ "System" ], "security": [ {} ], "parameters": [], "responses": { "200": { "description": "O serviço está íntegro e aceitando requisições. O corpo é sempre `{\"status\": \"ok\", \"timestamp\": \"\"}`.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "timestamp" ], "properties": { "status": { "type": "string", "enum": [ "ok" ], "description": "Marcador de prova de vida. Sempre a string literal `\"ok\"` em uma resposta 200.", "example": "ok" }, "timestamp": { "type": "string", "format": "date-time", "description": "Horário do servidor em que o healthcheck foi avaliado, em ISO 8601 com precisão de milissegundos e sufixo `Z` (UTC).", "example": "2026-04-21T16:42:50.445Z" } } }, "examples": { "Healthy": { "summary": "O serviço está no ar", "value": { "status": "ok", "timestamp": "2026-04-21T16:42:50.445Z" } } } } } }, "503": { "description": "O serviço não está íntegro: um dos plugins de verificação de integridade configurados (banco de dados, cache, broker) está falhando. O corpo da resposta é intencionalmente mínimo; o status HTTP é o sinal que importa. Tente novamente com backoff exponencial." }, "5XX": { "description": "O serviço de verificação está degradado ou inacessível. Trate qualquer resposta diferente de 2xx como \"não saudável\" e tente novamente com backoff exponencial." } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -i https://verification.didit.me/system/healthcheck" }, { "lang": "Python", "label": "Python (requests)", "source": "import requests\n\nresp = requests.get(\"https://verification.didit.me/system/healthcheck\", timeout=5)\nresp.raise_for_status()\nprint(resp.json()) # {'status': 'ok', 'timestamp': '2026-04-21T16:42:50.445Z'}" }, { "lang": "JavaScript", "label": "Node.js (fetch)", "source": "const res = await fetch(\"https://verification.didit.me/system/healthcheck\");\nif (!res.ok) throw new Error(`Didit unhealthy: ${res.status}`);\nconst body = await res.json();\nconsole.log(body); // { status: 'ok', timestamp: '2026-04-21T16:42:50.445Z' }" } ] } }, "/v3/email/risk/": { "post": { "summary": "Calcular a pontuação de risco de um endereço de e-mail", "description": "Retorna sinais de entregabilidade, endereço descartável, vazamentos, correspondência entre sessões e inteligência de risco normalizada, sem enviar um OTP. O endpoint cria uma sessão de API e retorna o id dela como `request_id`.\n\n**Decisão.** O `status` de nível superior reflete `email.status`. Normalmente é `Approved`; a avaliação de risco pode resultar em `In Review` ou `Declined`.\n\n**Aliases de compatibilidade.** As respostas do ambiente de produção expõem o objeto de inteligência normalizado tanto como `email.email_intelligence` quanto como `email.enrichment`. Os valores são idênticos. Novas integrações podem ler `email.enrichment`. As duas chaves ficam ausentes quando nenhum dado de inteligência utilizável é retornado.\n\n**Faturamento.** As chamadas no ambiente de produção usam os preços da Email Risk API. A requisição é cobrada assim que a consulta começa, mesmo quando alguns campos de melhor esforço não estão disponíveis.\n\n**Sandbox.** As chaves de sandbox validam a requisição e retornam dados aprovados determinísticos, sem enviar e-mail, consumir créditos, criar uma sessão ou contribuir para o Networks.\n\n**Autenticação.** Envie a chave de API da sua aplicação em `x-api-key`. Credenciais ausentes ou inválidas retornam `403`: esta API nunca retorna `401`.\n\n**Limite de requisições.** Cota de escrita compartilhada de 300 requisições por minuto por chave de API, somando todos os endpoints POST/PATCH/DELETE.\n\n**Presença em redes sociais.** Defina `enable_social` como `true` para adicionar um bloco `email_social`: as plataformas online em que este endereço está cadastrado, com contagens por categoria e os detalhes de perfil disponíveis. `profiles_registered: 0` significa que as plataformas foram verificadas e o endereço não foi encontrado em nenhuma delas, uma resposta válida e cobrada. O bloco fica ausente quando o complemento não foi solicitado ou a verificação não pôde ser concluída, e nesse caso não é cobrado. O faturamento adiciona uma unidade `email_social` por requisição, além do preço do próprio 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": "Pontuar um endereço com os valores padrão", "value": { "email": "alice@example.com" } }, "Full context": { "summary": "Pontuar com sinais, indicação de país e IDs de correlação", "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": "A avaliação de risco foi concluída. Verifique `status` para ver a decisão; o HTTP é sempre `200` para consultas concluídas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRiskResponse" }, "examples": { "Clean address": { "summary": "Endereço entregável sem exposição a vazamentos", "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": "Endereço encontrado em vazamentos conhecidos", "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 a pontuação de risco de um endereço IP", "description": "Retorna geolocalização, propriedade da rede, indicadores de VPN/Tor e de data center, dados de ameaças e `country_mismatch` para um endereço IP informado. O endpoint cria uma sessão de API e retorna o id dela como `request_id`.\n\n**Decisão.** O `status` é `In Review` quando o país identificado diverge de `claimed_country` ou quando o endereço está associado a infraestrutura de VPN, Tor ou data center. Caso contrário, é `Approved`.\n\n**Melhor esforço.** O enriquecimento de IP é feito por melhor esforço. Se nenhuma fonte de enriquecimento retornar dados utilizáveis, o endpoint retorna uma resposta aprovada com `ip.ip_address: null`, `ip.country_mismatch: null` e um objeto `ip.threat` vazio.\n\n**Faturamento.** As chamadas no ambiente de produção usam os preços da IP Risk API. A requisição é cobrada assim que a consulta começa.\n\n**Sandbox.** As chaves de sandbox validam a requisição e retornam dados aprovados determinísticos, sem consumir créditos, criar uma sessão ou contribuir para o Networks.\n\n**Autenticação.** Envie a chave de API da sua aplicação em `x-api-key`. Credenciais ausentes ou inválidas retornam `403`: esta API nunca retorna `401`.\n\n**Limite de requisições.** Cota de escrita compartilhada de 300 requisições por minuto por chave de API, somando todos os endpoints POST/PATCH/DELETE.", "operationId": "post_v3ip_risk", "x-didit-sdk": { "resource": "ip", "method": "assess_risk", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/ip/risk/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"ip_address\": \"8.8.8.8\",\n \"claimed_country\": \"ESP\",\n \"user_agent\": \"Mozilla/5.0\",\n \"vendor_data\": \"lead-123\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.ip.assess_risk(\n ip_address=\"8.8.8.8\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.ip.assessRisk({\n ip_address: \"8.8.8.8\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IP.AssessRisk(ctx, didit.IPRiskRequest{\n\tIPAddress: \"8.8.8.8\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.IPRiskRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.ip().assessRisk(IPRiskRequest.builder()\n .ipAddress(\"8.8.8.8\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "ip->assessRisk([\n 'ip_address' => '8.8.8.8',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.ip.assess_risk(ip_address: \"8.8.8.8\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Ip.AssessRiskAsync(new IPRiskRequest\n{\n IpAddress = \"8.8.8.8\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPRiskRequest" }, "examples": { "Minimal": { "summary": "Pontuar um endereço com os valores padrão", "value": { "ip_address": "8.8.8.8" } }, "With claimed country": { "summary": "Pontuar com um país declarado para detectar divergências", "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": "A avaliação de risco foi concluída. Verifique `status` para ver a decisão; o HTTP é sempre `200` para consultas concluídas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPRiskResponse" }, "examples": { "Clean residential IP": { "summary": "Endereço residencial, país declarado corresponde", "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": "Endereço de data center em conflito com o país declarado", "value": { "request_id": "5b1d4e9a-3c7b-4f8e-9a2d-1b0c9d8e7f6a", "status": "In Review", "ip": { "status": "In Review", "ip_address": "8.8.8.8", "ip_country": "United States", "ip_country_code": "US", "ip_state": "California", "ip_city": "Mountain View", "latitude": 37.386, "longitude": -122.0838, "isp": "Google", "organization": "Google LLC", "is_vpn_or_tor": true, "is_data_center": true, "time_zone": "America/Los_Angeles", "time_zone_offset": "-0700", "asn_number": 15169, "asn_organization": "GOOGLE, US", "connection_type": "hosting", "carrier": null, "proxy_type": "VPN", "claimed_country": "ESP", "country_mismatch": true, "threat": { "is_proxy": true, "is_data_center": true, "is_tor": false } }, "vendor_data": "lead-126", "metadata": null, "created_at": "2026-09-01T10:30:00.123456+00:00" } } } } } }, "400": { "$ref": "#/components/responses/IPRiskValidationError" }, "403": { "$ref": "#/components/responses/RiskPermissionDenied" }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/phone/risk/": { "post": { "summary": "Calcular a pontuação de risco de um número de telefone", "description": "Consulta um número de telefone e retorna sinais de operadora, tipo de linha, portabilidade, número descartável, correspondência entre sessões e inteligência de risco normalizada, sem enviar um OTP. O endpoint cria uma sessão de API e retorna o id dela como `request_id`.\n\n**Decisão.** O `status` de nível superior espelha `phone.status`. Normalmente ele é `Approved`; a avaliação de risco pode produzir `In Review` ou `Declined`.\n\n**Aliases de compatibilidade.** As respostas no ambiente de produção expõem o objeto de inteligência normalizado tanto como `phone.phone_intelligence` quanto como `phone.enrichment`. Os valores são idênticos. Novas integrações podem ler `phone.enrichment`. As duas chaves ficam ausentes quando nenhum dado de inteligência utilizável foi retornado.\n\n**Faturamento.** As chamadas no ambiente de produção usam os preços da Phone Risk API. A requisição é faturável assim que a consulta começa, mesmo quando alguns campos de melhor esforço não estão disponíveis.\n\n**Sandbox.** As chaves de sandbox validam a requisição e retornam dados aprovados determinísticos sem enviar um OTP, consumir créditos, criar uma sessão ou contribuir para Networks.\n\n**Autenticação.** Envie a chave de API da sua aplicação em `x-api-key`. Credenciais ausentes ou inválidas retornam `403`: esta API nunca retorna `401`.\n\n**Limite de requisições.** Cota de escrita compartilhada de 300 requisições por minuto por chave de API em todos os endpoints POST/PATCH/DELETE.\n\n**Presença em redes sociais.** Defina `enable_social` como `true` para adicionar um bloco `phone_social`: as plataformas online em que este número está registrado, com contagens por categoria e os detalhes de perfil disponíveis. `profiles_registered: 0` significa que as plataformas foram verificadas e o número não foi encontrado em nenhuma delas, o que é uma resposta válida e faturável. O bloco fica ausente quando o complemento não foi solicitado ou a verificação não pôde ser concluída, e nesse caso ele não é faturado. O faturamento adiciona uma unidade `phone_social` por requisição, além do preço próprio deste 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": "Pontuar um número com os valores padrão", "value": { "phone_number": "+14155552671" } }, "Full context": { "summary": "Pontuar com sinais, indicação de país e IDs de correlação", "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": "A avaliação de risco foi concluída. Verifique `status` para ver a decisão; o HTTP é sempre `200` para consultas concluídas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneRiskResponse" }, "examples": { "Clean mobile number": { "summary": "Número de celular limpo com cobertura de inteligê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 descartável ou virtual sinalizado para revisão", "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": "Criar uma sessão de verificação", "description": "Cria uma sessão de Verificação de usuários (KYC) ou de Verificação de empresas (KYB) e recebe uma `url` de verificação hospedada, além de um `session_token`, para redirecionar ou incorporar para o seu usuário final. O `workflow_id` define quais etapas de verificação são executadas e se a sessão é de KYC ou de KYB.\n\nChame este endpoint a partir do seu backend (nunca do navegador — a chave de API é secreta) sempre que um usuário ou uma empresa precisar ser verificado: no cadastro, antes de uma ação sensível ou quando for necessária uma reverificação. Pré-requisitos: um fluxo de verificação (workflow) publicado (criado na página [Workflows](https://docs.didit.me/pt-br/console/workflows) do Console) e uma chave de API da aplicação com créditos disponíveis. Aplicações de sandbox ignoram a verificação de créditos.\n\n**Idempotência:** quando `vendor_data` é informado e já existe uma sessão não finalizada (`Not Started`, `In Progress`, `Resubmitted` ou `Awaiting User`) com o mesmo `vendor_data` na **versão publicada mais recente atual** do fluxo (e essa sessão já tem uma URL de verificação hospedada), a sessão existente é retornada (ainda com `201`) em vez de ser criada uma duplicata — com seus `callback` e `metadata` atualizados para os novos valores informados. Uma sessão não finalizada criada em uma versão mais antiga do fluxo (que foi republicado desde então) **não** é reutilizada; em vez disso, é criada uma nova sessão vinculada à versão publicada mais recente. Sessões em `Approved`, `Declined`, `In Review`, `Expired`, `Abandoned` ou `Kyc Expired` nunca são reutilizadas.\n\n**Efeitos colaterais:** a URL de verificação hospedada é gerada e armazenada; se `contact_details.send_notification_emails` for `true` e um e-mail for informado, um e-mail de convite para verificação é enviado. A sessão expira após o tempo de expiração de sessão configurado no fluxo. Em fluxos de KYB, `contact_details.phone` e `expected_details` são ignorados.", "operationId": "post_v3_session_create", "x-didit-sdk": { "resource": "sessions", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "responses": { "201": { "description": "Sessão criada (ou retornada, se já existir uma sessão não concluída com o mesmo `vendor_data` na versão publicada mais recente do fluxo). A resposta é a sessão serializada, incluindo a `url` da verificação hospedada para a qual o usuário deve ser redirecionado.", "content": { "application/json": { "schema": { "type": "object", "required": [ "session_id", "session_number", "session_token", "url", "vendor_data", "metadata", "status", "workflow_id", "workflow_version", "callback" ], "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Identificador único da sessão de verificação. Use este id ao chamar `GET /v3/session/{sessionId}/decision/`.", "example": "11111111-2222-3333-4444-555555555555" }, "session_number": { "type": "integer", "description": "Número sequencial e fácil de ler atribuído à sessão dentro da sua aplicação. Útil para suporte e painéis.", "example": 43762 }, "session_token": { "type": "string", "description": "Token seguro para URL de 12 caracteres que autoriza o usuário final a acessar o fluxo de verificação hospedado em `url`. Válido até a sessão expirar. Trate-o como um segredo: qualquer pessoa que o tenha pode abrir o fluxo de verificação desta sessão.", "example": "3FaJ9wLqX2Mz" }, "url": { "type": "string", "format": "uri", "description": "URL de verificação hospedada para a qual o usuário final deve ser redirecionado. A URL incorpora o `session_token` e, se configurado, usa seu domínio de marca própria. Quando a requisição inclui `language`, a URL contém um segmento de caminho com o idioma: `https://verify.didit.me/{language}/session/{session_token}` (por exemplo, `/es/session/...`); sem `language`, o segmento é omitido.", "example": "https://verify.didit.me/session/3FaJ9wLqX2Mz" }, "vendor_data": { "type": "string", "nullable": true, "description": "Identificador que você passou na requisição para vincular a sessão a um usuário ou empresa no seu próprio sistema. Retornado exatamente como enviado. Null quando não informado.", "example": "user-123" }, "metadata": { "description": "Payload JSON arbitrário que você armazenou com a sessão no momento da criação. Devolvido literalmente — qualquer valor JSON que você enviou (objeto, string, número, array) é retornado como está, embora um objeto JSON seja recomendado. Não é exibido ao usuário final. Sempre presente nas respostas; `null` quando não fornecido no momento da criação.", "example": { "user_type": "premium", "account_id": "ABC123" } }, "tags": { "type": "array", "items": { "type": "string" }, "description": "As tags da sessão, por nome.", "example": [ "VIP", "ONBOARDING Q4" ] }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Status atual da sessão. Sessões recém-criadas retornam `Not Started`. Se já existia uma sessão não finalizada para o mesmo `vendor_data` na versão publicada mais recente do fluxo, o status retornado reflete essa sessão existente.", "example": "Not Started" }, "callback": { "type": "string", "format": "uri", "nullable": true, "description": "URL de redirecionamento final para a qual o usuário é enviado após concluir o fluxo. A Didit acrescenta `?verificationSessionId={session_id}&status={status}` a essa URL. Quando não é informada na requisição, usa a URL de retorno configurada no fluxo de verificação (workflow); `null` quando nenhuma das duas está definida. Quando a aplicação tem domínios permitidos e essa URL é uma URL web fora deles (por exemplo, um padrão do fluxo definido antes de a lista mudar), o fluxo hospedado não redireciona o usuário para ela.", "example": "https://example.com/verification/callback" }, "workflow_id": { "type": "string", "format": "uuid", "description": "Identificador estável do fluxo em que esta sessão é executada. É sempre o identificador estável de grupo do fluxo: mesmo que você tenha referenciado o UUID de uma versão específica do fluxo na requisição (busca retrocompatível), a resposta traz o `workflow_id` estável. Use-o para correlacionar a sessão com o fluxo que você configurou no Console.", "example": "11111111-2222-3333-4444-555555555555" }, "workflow_version": { "type": "integer", "description": "Número da versão publicada do fluxo à qual a sessão foi fixada na criação. A Didit resolve o `workflow_id` para a versão publicada mais recente do fluxo quando a sessão é criada, e a sessão continua executando essa versão mesmo que o fluxo seja republicado depois.", "example": 3 } } }, "examples": { "KYC session": { "summary": "Sessão KYC criada", "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": "Sessão KYB criada", "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": "Requisição inválida: o payload não passou na validação (`workflow_id` ausente ou desconhecido, `language` inválido, `vendor_data` na lista de bloqueio, `portrait_image` malformado, `address` sem `country`/`poa_country`, `sandbox_scenario` inválido, documentos `sign`, campos ou valores que a etapa de Assinatura eletrônica do fluxo recusa, como `signature_document_not_supported`, `signature_document_conversion_failed`, `field_anchor_not_found` ou `field_value_missing` etc.) ou sua organização não tem créditos suficientes para iniciar a sessão.\n\nO corpo é um objeto cujas chaves são os nomes dos campos com problema (ou `detail` para erros que não são de campo). Os valores são um **array de strings** para falhas de validação de entrada (por exemplo, campo obrigatório ausente, idioma inválido, imagem de retrato grande demais) e uma **string simples** para falhas detectadas durante a criação da sessão (`workflow_id` desconhecido, `vendor_data` na lista de bloqueio, nenhuma face de referência disponível para um fluxo de Correspondência facial). Trate os dois formatos.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível para erros que não são de campo (por exemplo, créditos insuficientes). Falhas no nível do campo usam o nome do campo como chave, com um valor de string ou array de strings.", "example": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } }, "examples": { "Missing workflow_id": { "summary": "Campo obrigatório omitido (formato de array de strings)", "value": { "workflow_id": [ "This field is required." ] } }, "Invalid workflow_id": { "summary": "workflow_id desconhecido (formato de string simples)", "value": { "workflow_id": "Invalid workflow_id." } }, "Insufficient credits": { "summary": "A organização está sem créditos", "value": { "detail": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } }, "Blocklisted vendor_data": { "summary": "vendor_data está na lista de bloqueio", "value": { "vendor_data": "This user or business has been blocked and cannot create new verification sessions." } }, "Portrait image too large": { "summary": "portrait_image falha na validação de tamanho", "value": { "portrait_image": [ "Image size exceeds 2MB." ] } }, "No stored face for vendor_data": { "summary": "Fluxo de Correspondência facial sem portrait_image e sem rosto armazenado para o usuário 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": "Fluxo de Correspondência facial sem portrait_image e sem 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": "Falha de autenticação ou autorização. Uma chave incorreta, revogada ou expirada retorna `401`. O endpoint retorna `403` quando o cabeçalho `x-api-key` está ausente ou quando a chave de API é válida, mas o cliente não tem permissão para criar sessões nesta aplicação (por exemplo, a chave de API pertence a uma organização diferente). Essas falhas compartilham o corpo `{\"detail\": \"You do not have permission to perform this action.\"}`. Verifique se o cabeçalho `x-api-key` está presente e pertence à aplicação pretendida, obtenha novamente a chave de API da aplicação pela [Auth API](/pt-br/auth-api/get-credentials), se necessário, e tente novamente.\n\n**Aplicação excluída:** durante alguns minutos após a exclusão de uma aplicação, uma requisição feita com uma de suas chaves de API pode responder `{\"detail\": \"This application was deleted.\", \"code\": \"application_deleted\"}`. Não tente novamente: a aplicação e suas chaves de API não existem mais. Passados esses minutos, a chave é recusada como qualquer outra chave inválida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "You do not have permission to perform this action." }, "code": { "type": "string", "description": "Motivo legível por máquina, presente apenas em algumas falhas. `application_deleted`: a chave de API pertence a uma aplicação que foi excluída.", "example": "application_deleted" } }, "required": [ "detail" ] }, "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key` ou chave de API inválida", "value": { "detail": "You do not have permission to perform this action." } }, "No permission": { "summary": "O cliente não pode criar sessões", "value": { "detail": "You do not have permission to perform this action." } }, "Application deleted": { "summary": "Chave de API de uma aplicação excluída", "value": { "detail": "This application was deleted.", "code": "application_deleted" } } } } } }, "429": { "description": "Limite de requisições excedido: mais de 600 requisições de criação de sessão em uma janela de 60 segundos vindas da mesma chave de API / IP. Verifique `Retry-After` e aguarde antes de tentar novamente.\n\n**Observação:** o código-fonte também define um `FREE_SESSION_RATE_LIMIT` de 10 chamadas/minuto junto com `PAID_SESSION_RATE_LIMIT=600` (`sessions/serializers/session.py`), mas esse teto do plano gratuito **não é aplicado a este endpoint V3**: o middleware de limite de requisições aplica o `SESSION_CREATE_RATE_LIMIT` de 600/min independentemente do plano. 600/min é o único limite que você pode atingir aqui.", "headers": { "Retry-After": { "description": "Segundos que o chamador deve aguardar antes de tentar novamente a requisição.", "schema": { "type": "integer", "minimum": 1, "example": 42 } }, "X-RateLimit-Limit": { "description": "Número máximo de requisições permitidas na janela atual de 60 segundos para o limite que foi excedido (600 para criação de sessão). Ausente na variante de cota do sandbox.", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Número de requisições ainda permitidas na janela atual para o limite excedido. Ausente na variante de cota do sandbox.", "schema": { "type": "integer", "minimum": 0, "example": 0 } }, "X-RateLimit-Reset": { "description": "Segundos desde a época Unix (UTC) em que a janela atual do limite de requisições é reiniciada. Ausente na variante de cota do sandbox.", "schema": { "type": "integer", "minimum": 0, "example": 1747497600 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Explicação legível da violação do limite de requisições. Use esta mensagem para identificar qual dos três limites foi atingido.", "example": "Session creation rate limit exceeded. You can make up to 600 requests per minute." } } }, "examples": { "Session-create limit": { "summary": "Mais de 600 requisições de criação de sessão por minuto", "value": { "detail": "Session creation rate limit exceeded. You can make up to 600 requests per minute." } }, "Sandbox session quota": { "summary": "A aplicação de sandbox excedeu 500 sessões em 24 horas", "value": { "detail": "Sandbox session quota exceeded (500 sessions per 24h). Wait for the window to reset. Expected available in 3600 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/session/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"workflow_id\": \"11111111-2222-3333-4444-555555555555\",\n \"vendor_data\": \"user-123\",\n \"callback\": \"https://example.com/verification/callback\",\n \"callback_method\": \"both\",\n \"metadata\": {\"user_type\": \"premium\", \"account_id\": \"ABC123\"},\n \"language\": \"en\",\n \"contact_details\": {\n \"email\": \"john.doe@example.com\",\n \"send_notification_emails\": true,\n \"email_lang\": \"en\",\n \"phone\": \"+14155552671\"\n },\n \"expected_details\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1990-05-15\",\n \"id_country\": \"USA\",\n \"expected_document_types\": [\"P\", \"ID\"]\n }\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.create(\n workflow_id=\"11111111-2222-3333-4444-555555555555\",\n vendor_data=\"user-123\",\n callback=\"https://example.com/verification/callback\",\n callback_method=\"both\",\n metadata={\"user_type\": \"premium\", \"account_id\": \"ABC123\"},\n language=\"en\",\n contact_details={\n \"email\": \"john.doe@example.com\",\n \"send_notification_emails\": True,\n \"email_lang\": \"en\",\n \"phone\": \"+14155552671\",\n },\n expected_details={\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": \"1990-05-15\",\n \"nationality\": \"USA\",\n \"id_country\": \"USA\",\n \"expected_document_types\": [\"P\", \"ID\"],\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.create({\n workflow_id: \"11111111-2222-3333-4444-555555555555\",\n vendor_data: \"user-123\",\n callback: \"https://example.com/verification/callback\",\n callback_method: \"both\",\n metadata: { user_type: \"premium\", account_id: \"ABC123\" },\n language: \"en\",\n contact_details: {\n email: \"john.doe@example.com\",\n send_notification_emails: true,\n email_lang: \"en\",\n phone: \"+14155552671\",\n },\n expected_details: {\n first_name: \"John\",\n last_name: \"Doe\",\n date_of_birth: \"1990-05-15\",\n nationality: \"USA\",\n id_country: \"USA\",\n expected_document_types: [\"P\", \"ID\"],\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Create(ctx, didit.SessionsCreateParams{\n\tWorkflowID: \"11111111-2222-3333-4444-555555555555\",\n\tVendorData: didit.String(\"user-123\"),\n\tCallback: didit.String(\"https://example.com/verification/callback\"),\n\tCallbackMethod: didit.Some(didit.SessionsCreateParamsCallbackMethod(\"both\")),\n\tMetadata: didit.Some[any](map[string]any{\"user_type\": \"premium\", \"account_id\": \"ABC123\"}),\n\tLanguage: didit.Some(didit.SessionsCreateParamsLanguage(\"en\")),\n\tContactDetails: didit.Some(didit.SessionsCreateParamsContactDetails{\n\t\tEmail: didit.String(\"john.doe@example.com\"),\n\t\tSendNotificationEmails: didit.Bool(true),\n\t\tEmailLang: didit.Some(didit.SessionsCreateParamsContactDetailsEmailLang(\"en\")),\n\t\tPhone: didit.String(\"+14155552671\"),\n\t}),\n\tExpectedDetails: didit.Some(didit.SessionsCreateParamsExpectedDetails{\n\t\tFirstName: didit.String(\"John\"),\n\t\tLastName: didit.String(\"Doe\"),\n\t\tDateOfBirth: didit.String(\"1990-05-15\"),\n\t\tNationality: didit.String(\"USA\"),\n\t\tIDCountry: didit.String(\"USA\"),\n\t\tExpectedDocumentTypes: didit.Some([]didit.SessionsCreateParamsExpectedDetailsExpectedDocumentTypes{\"P\", \"ID\"}),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport java.util.List;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SessionsCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().create(SessionsCreateParams.builder()\n .workflowId(\"11111111-2222-3333-4444-555555555555\")\n .vendorData(\"user-123\")\n .callback(\"https://example.com/verification/callback\")\n .callbackMethod(SessionsCreateParams.CallbackMethod.of(\"both\"))\n .metadata(Map.of(\"user_type\", \"premium\", \"account_id\", \"ABC123\"))\n .language(SessionsCreateParams.Language.of(\"en\"))\n .contactDetails(SessionsCreateParams.ContactDetails.builder()\n .email(\"john.doe@example.com\")\n .sendNotificationEmails(true)\n .emailLang(SessionsCreateParams.ContactDetails.EmailLang.of(\"en\"))\n .phone(\"+14155552671\")\n .build())\n .expectedDetails(SessionsCreateParams.ExpectedDetails.builder()\n .firstName(\"John\")\n .lastName(\"Doe\")\n .dateOfBirth(LocalDate.parse(\"1990-05-15\"))\n .nationality(\"USA\")\n .idCountry(\"USA\")\n .expectedDocumentTypes(List.of(SessionsCreateParams.ExpectedDetails.ExpectedDocumentTypes.of(\"P\"), SessionsCreateParams.ExpectedDetails.ExpectedDocumentTypes.of(\"ID\")))\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->create([\n 'workflow_id' => '11111111-2222-3333-4444-555555555555',\n 'vendor_data' => 'user-123',\n 'callback' => 'https://example.com/verification/callback',\n 'callback_method' => 'both',\n 'metadata' => ['user_type' => 'premium', 'account_id' => 'ABC123'],\n 'language' => 'en',\n 'contact_details' => [\n 'email' => 'john.doe@example.com',\n 'send_notification_emails' => true,\n 'email_lang' => 'en',\n 'phone' => '+14155552671',\n ],\n 'expected_details' => [\n 'first_name' => 'John',\n 'last_name' => 'Doe',\n 'date_of_birth' => '1990-05-15',\n 'nationality' => 'USA',\n 'id_country' => 'USA',\n 'expected_document_types' => ['P', 'ID'],\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.create(\n workflow_id: \"11111111-2222-3333-4444-555555555555\",\n vendor_data: \"user-123\",\n callback: \"https://example.com/verification/callback\",\n callback_method: \"both\",\n metadata: { user_type: \"premium\", account_id: \"ABC123\" },\n language: \"en\",\n contact_details: {\n email: \"john.doe@example.com\",\n send_notification_emails: true,\n email_lang: \"en\",\n phone: \"+14155552671\",\n },\n expected_details: {\n first_name: \"John\",\n last_name: \"Doe\",\n date_of_birth: \"1990-05-15\",\n nationality: \"USA\",\n id_country: \"USA\",\n expected_document_types: [\"P\", \"ID\"],\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.CreateAsync(new SessionsCreateParams\n{\n WorkflowId = \"11111111-2222-3333-4444-555555555555\",\n VendorData = \"user-123\",\n Callback = \"https://example.com/verification/callback\",\n CallbackMethod = new SessionsCreateParamsCallbackMethod(\"both\"),\n Metadata = new Dictionary { [\"user_type\"] = \"premium\", [\"account_id\"] = \"ABC123\" },\n Language = new SessionsCreateParamsLanguage(\"en\"),\n ContactDetails = new SessionsCreateParamsContactDetails\n {\n Email = \"john.doe@example.com\",\n SendNotificationEmails = true,\n EmailLang = new SessionsCreateParamsContactDetailsEmailLang(\"en\"),\n Phone = \"+14155552671\",\n },\n ExpectedDetails = new SessionsCreateParamsExpectedDetails\n {\n FirstName = \"John\",\n LastName = \"Doe\",\n DateOfBirth = \"1990-05-15\",\n Nationality = \"USA\",\n IdCountry = \"USA\",\n ExpectedDocumentTypes = new SessionsCreateParamsExpectedDetailsExpectedDocumentTypes[] { \"P\", \"ID\" },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "workflow_id" ], "properties": { "workflow_id": { "type": "string", "format": "uuid", "description": "Identificador estável do fluxo de verificação (workflow) que define quais etapas de verificação a sessão executará. Os fluxos são criados e gerenciados na página [Workflows](/pt-br/console/workflows) do Console. O `workflow_id` também determina implicitamente se a sessão é KYC ou KYB.", "example": "11111111-2222-3333-4444-555555555555", "x-readme-id": "0.0" }, "vendor_data": { "type": "string", "description": "Um identificador exclusivo do usuário que está sendo verificado, como um UUID, e-mail ou ID interno de usuário. Este campo é usado para: (1) **Agrupamento de usuários** — sessões com o mesmo vendor_data são vinculadas ao mesmo perfil de usuário na aba Usuários. (2) **Detecção de duplicatas entre sessões** — ao verificar rostos, documentos, números de telefone, e-mails, endereços IP ou impressões digitais de dispositivo duplicados, sessões com o mesmo vendor_data são tratadas como o mesmo usuário e excluídas das correspondências. Sem vendor_data, cada sessão é tratada como um usuário único e todas as possíveis duplicatas são exibidas. Recomendamos fortemente sempre fornecer um vendor_data para reduzir o ruído na detecção de duplicatas.", "example": "user-123", "x-readme-id": "0.1" }, "multi_account_segment": { "type": "string", "maxLength": 64, "description": "Domínio opcional de detecção de duplicados dentro da sua organização. As verificações de rosto duplicado comparam esta sessão apenas com outras sessões que tenham o mesmo segmento, de modo que bases de contas separadas (contas pessoais e empresariais, ou uma por subcliente B2B) não sinalizem uma pessoa que legitimamente tenha uma conta em cada uma. Omita-o para usar o domínio padrão único, que é o que todas as sessões usam hoje. As correspondências com a lista de bloqueio e a lista de permissões ignoram este campo.", "example": "business-accounts" }, "callback": { "type": "string", "description": "URL para a qual o usuário é redirecionado após a conclusão da verificação. A Didit acrescenta automaticamente `verificationSessionId` e `status` (Approved, Declined, In Review) como parâmetros de consulta. Esquemas de URL personalizados (por exemplo, `myapp://`) são compatíveis com callbacks em dispositivos móveis. Se omitida, é usado o `callback_url` padrão do fluxo de verificação. Quando a aplicação tem domínios permitidos (`allowed_domains` em `PATCH /v3/webhook/`), um callback `http` ou `https` deve estar em uma dessas origens (mesmo esquema, host e porta); caso contrário, a requisição falha com 400 em `callback`: `callback must be on one of the application's allowed domains: https://app.example.com`. Esquemas de URL personalizados são sempre aceitos.", "example": "https://example.com/verification/callback", "x-readme-id": "0.2" }, "callback_method": { "type": "string", "description": "Determina qual dispositivo deve tratar o redirecionamento para a URL de retorno informada. Use `initiator` para redirecionar apenas o dispositivo que iniciou o fluxo, `completer` para o dispositivo que o conclui ou `both` para permitir que qualquer um dos dispositivos acione o retorno. Se você notar que o retorno não é acionado de forma confiável, recomendamos definir este valor como `both`.", "enum": [ "initiator", "completer", "both" ], "default": "initiator", "example": "both", "x-readme-id": "0.3" }, "metadata": { "description": "JSON arbitrário armazenado com a sessão e devolvido na resposta e nos webhooks. Qualquer valor JSON é aceito (objeto, string, número, array), mas recomenda-se um objeto JSON de pares chave/valor. Não é exibido ao usuário final. Use-o para passar seus próprios IDs de correlação, variantes de teste A/B ou contexto de negócio.", "example": { "user_type": "premium", "account_id": "ABC123" }, "x-readme-id": "0.4" }, "tags": { "type": "array", "items": { "type": "string", "maxLength": 50 }, "maxItems": 10, "description": "Tags adicionadas à sessão quando ela é criada, pelo nome. Até 10, cada uma com até 50 caracteres. Os nomes não diferenciam maiúsculas de minúsculas e são armazenados em maiúsculas. Um nome que ainda não existe na aplicação é criado como uma nova tag. As tags aparecem na sessão no console, onde você pode filtrar por elas.", "example": [ "VIP", "ONBOARDING Q4" ] }, "language": { "type": "string", "description": "Código de idioma (ISO 639-1) para a interface do processo de verificação. Controla o idioma exibido ao usuário final durante a verificação. Se não for informado, o idioma do navegador será detectado e usado automaticamente. Confira todos os idiomas suportados [aqui](/pt-br/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": "Informações de contato do usuário que podem ser usadas para notificações, preenchimento prévio de formulários de verificação e verificação de telefone. Isso inclui endereço de e-mail, idioma preferido para comunicações e número de telefone.", "example": { "email": "john.doe@example.com", "send_notification_emails": true, "email_lang": "en", "phone": "+14155552671" }, "properties": { "email": { "type": "string", "format": "email", "description": "Endereço de e-mail do usuário (por exemplo, \"john.doe@example.com\") que será usado na etapa de [Verificação de e-mail](/pt-br/core-technology/email-verification/overview). Se não for informado, o usuário deverá fornecê-lo durante o fluxo de verificação.", "example": "john.doe@example.com", "x-readme-id": "1.0" }, "send_notification_emails": { "type": "boolean", "default": false, "description": "Se true e um e-mail for informado, a Didit envia de forma assíncrona o e-mail inicial \"Verifique sua identidade\" quando a sessão de Verificação de usuários (KYC) ou Verificação de empresas (KYB) é criada. A Didit também envia ao endereço de e-mail informado notificações de status da verificação para sessões que exigem revisão manual (por exemplo, de 'Em revisão' para 'Aprovado' ou 'Recusado'). Isso ajuda os usuários a voltar à sua aplicação quando a verificação for concluída. Se a marca própria estiver ativada para a sessão, o e-mail enviado será com marca própria.", "example": true, "x-readme-id": "1.1" }, "email_lang": { "type": "string", "description": "Código de idioma (ISO 639-1) para as notificações por e-mail. Controla o idioma de todas as comunicações por e-mail (por exemplo, \"en\", \"es\", \"fr\"). Não há um padrão armazenado: quando omitido, o e-mail de convite de verificação simplesmente usa inglês (`en`) no momento do envio. O enum abaixo é um retrato do momento; a fonte oficial e atualizada dos valores aceitos é a documentação de [idiomas suportados](/pt-br/integration/supported-languages). Consulte-a sempre antes de depender de um código específico.", "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 telefone no formato E.164 (por exemplo, \"+14155552671\") que será usado na etapa de [Verificação de telefone](/pt-br/core-technology/phone-verification/overview). Se não for informado, o usuário deverá fornecê-lo durante o fluxo de verificação. Ignorado em fluxos de Verificação de empresas (KYB). **Importante:** este número de telefone só é aplicado se for um número E.164 válido. Se o número informado for inválido ou não puder ser interpretado, ele será ignorado e o usuário poderá inserir qualquer número de telefone válido durante a etapa de Verificação de telefone.", "example": "+14155552671", "x-readme-id": "1.3" } }, "x-readme-id": "0.4" }, "expected_details": { "type": "object", "description": "Dados esperados do usuário, usados para validação cruzada com os dados extraídos do documento de identidade do usuário, do Comprovante de endereço e de outras etapas de verificação. Divergências aparecem como avisos na decisão; alguns campos (por exemplo, `id_country`, `expected_document_types`) também alteram o fluxo exibido ao usuário. Em fluxos de Verificação de empresas (KYB), somente os campos da empresa (`company_name`, `registry_country`, `registration_number`) são usados, pois pré-preenchem para o usuário a busca no registro de empresas, e todos os campos referentes à pessoa são ignorados.", "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": "Nome do usuário. Por exemplo, `John`. A correspondência usa comparação aproximada, e você pode ajustar o rigor configurando o limiar da pontuação de correspondência de nome no Console, tanto para fluxos de documento de identidade quanto de Comprovante de endereço.", "example": "John", "x-readme-id": "1.0" }, "last_name": { "type": "string", "description": "Sobrenome do usuário. Por exemplo, `Doe`. A correspondência usa comparação aproximada, e você pode ajustar o rigor configurando o limiar da pontuação de correspondência de nome no Console, tanto para fluxos de documento de identidade quanto de Comprovante de endereço.", "example": "Doe", "x-readme-id": "1.1" }, "date_of_birth": { "type": "string", "format": "date", "description": "Data de nascimento do usuário no formato YYYY-MM-DD. Por exemplo, `1990-05-15`.", "example": "1990-05-15", "x-readme-id": "1.2" }, "gender": { "type": "string", "nullable": true, "enum": [ "M", "F" ], "default": null, "description": "Gênero do usuário. Deve ser 'M', 'F' ou null.", "example": "M", "x-readme-id": "1.3" }, "nationality": { "type": "string", "description": "Código ISO 3166-1 alpha-3 que representa o país de origem do solicitante. Por exemplo, `USA`. Consulte a [lista completa de códigos de país compatíveis](https://docs.didit.me/pt-br/core-technology/id-verification/supported-documents-id-verification#documentos-aceitos-por-país).", "example": "USA", "x-readme-id": "1.4" }, "country": { "type": "string", "description": "Código ISO 3166-1 alpha-3 usado como alternativa nas verificações de divergência de país tanto da Verificação de identidade quanto do Comprovante de endereço. Obrigatório quando `address` é informado e nem `id_country` nem `poa_country` estão definidos.", "example": "USA", "x-readme-id": "1.4.1" }, "id_country": { "type": "string", "description": "Código ISO 3166-1 alpha-3 que representa o país esperado do documento de identidade do solicitante, que pode ser diferente da nacionalidade. Por exemplo, `GBR`. Tem prioridade sobre `country` nas verificações de divergência de país da verificação de identidade. Consulte a [lista completa de códigos de país compatíveis](https://docs.didit.me/pt-br/core-technology/id-verification/supported-documents-id-verification#documentos-aceitos-por-país).", "example": "GBR", "x-readme-id": "1.5" }, "poa_country": { "type": "string", "description": "Código ISO 3166-1 alpha-3 que representa o país esperado do documento de Comprovante de endereço. Por exemplo, `USA`. Tem prioridade sobre `country` nas verificações de divergência de país do comprovante de endereço. Consulte a [lista completa de códigos de país compatíveis](https://docs.didit.me/pt-br/core-technology/id-verification/supported-documents-id-verification#documentos-aceitos-por-país).", "example": "USA", "x-readme-id": "1.5.1" }, "address": { "type": "string", "description": "O endereço em formato legível, com o máximo de informações possível. Por exemplo, `123 Main St, San Francisco, CA 94105, USA`. Quando informado, você também deve enviar `country` ou `poa_country`; caso contrário, a requisição falha com `400`.", "example": "123 Main St, San Francisco, CA 94105, USA", "x-readme-id": "1.6" }, "identification_number": { "type": "string", "description": "O número do documento, número pessoal ou número fiscal do usuário. Por exemplo, `123456789`.", "example": "123456789", "x-readme-id": "1.7" }, "ip_address": { "type": "string", "description": "Endereço IP esperado para a sessão, em formato IPv4 ou IPv6. Se o endereço IP real for diferente desse valor, um aviso será registrado. Por exemplo, `192.168.1.100` ou `2001:db8::1`.", "example": "192.168.1.100", "x-readme-id": "1.8" }, "expected_document_types": { "type": "array", "description": "Restringe os tipos de documento que o usuário pode apresentar durante a etapa de verificação de identidade (OCR). Quando definido, a tela de seleção de documento mostra apenas os tipos solicitados, e o `documents_allowed` retornado é filtrado de acordo. Os valores não diferenciam maiúsculas de minúsculas e são deduplicados; valores desconhecidos são rejeitados com `400`. Códigos permitidos: `P` (passaporte), `ID` (documento nacional de identidade), `DL` (carteira de motorista), `RP` (autorização de residência), `HIC` (cartão de plano de saúde), `TC` (cartão fiscal), `SSC` (cartão de seguridade social).", "items": { "type": "string", "enum": [ "P", "ID", "DL", "RP", "HIC", "TC", "SSC" ] }, "example": [ "P", "ID" ], "x-readme-id": "1.9" }, "company_name": { "type": "string", "maxLength": 255, "description": "Razão social esperada da empresa que está sendo verificada. Por exemplo, `Tesco PLC`. Pré-preenche o campo de nome da empresa na busca no registro em fluxos de Verificação de empresas (KYB); quando `registration_number` também é informado, a consulta ao registro combina os dois identificadores. Ignorado em fluxos de KYC.", "example": "Tesco PLC", "x-readme-id": "1.10" }, "registry_country": { "type": "string", "maxLength": 10, "description": "Código ISO 3166-1 alpha-2 do país em cujo registro de empresas a empresa está registrada. Por exemplo, `GB`. Onde os registros de empresas operam em nível estadual ou provincial, acrescente o código de subdivisão ISO 3166-2 no formato `XX-YY`: `US-CA` aponta para o registro da Califórnia. Mesmo formato de `country_code` na [KYB Registry Search API](https://docs.didit.me/pt-br/standalone-apis/kyb-registry-search). Pré-seleciona o país do registro em fluxos de Verificação de empresas (KYB); é ignorado em fluxos de KYC.", "example": "US-CA", "x-readme-id": "1.11" }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registro esperado da empresa no registro de empresas. Por exemplo, `00445790`. Pré-preenche o campo de número de registro na busca no registro em fluxos de Verificação de empresas (KYB); quando `company_name` também é informado, a consulta ao registro combina os dois identificadores. Ignorado em fluxos de KYC.", "example": "00445790", "x-readme-id": "1.12" } }, "x-readme-id": "0.5" }, "portrait_image": { "type": "string", "format": "byte", "description": "Imagem de retrato do rosto do usuário final codificada em Base64 (máx. 2MB; JPEG, PNG, WebP ou TIFF). Usada como imagem de referência para comparação com a captura de prova de vida quando o fluxo é um fluxo `Biometric Authentication` com a Correspondência facial habilitada, ou qualquer fluxo baseado em grafo em que a Correspondência facial é executada antes da Verificação de identidade (OCR). Opcional quando o usuário de `vendor_data` já tem uma imagem facial armazenada: a Didit a reutiliza automaticamente, escolhida nesta ordem de prioridade: rosto da prova de vida aprovada, foto do chip do passaporte eletrônico, retrato do documento de identidade, rosto de perfil cadastrado manualmente (somente rostos de sessões aprovadas ou rostos que você mesmo cadastrou são reutilizados). Quando fornecida, `portrait_image` sempre tem precedência sobre o rosto armazenado. Se for omitida e não houver rosto armazenado (ou se `vendor_data` não for enviado), a criação da sessão falha com `400`. Ignorada para outros tipos de fluxo.", "example": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=", "x-readme-id": "0.6" }, "sandbox_scenario": { "type": "string", "description": "Slug de cenário exclusivo do sandbox. É aceito somente quando a chave de API pertence a uma aplicação em modo sandbox e é rejeitado em aplicações em produção. Quando definido, o fluxo de criação aplica os valores mágicos incluídos no cenário aos campos de entrada da sessão (contact_details, expected_details), para que os provedores simulados reproduzam o resultado do cenário por meio do pipeline real do fluxo. Consulte o catálogo de cenários em GET /v1/sandbox/scenarios/ ou em [Sandbox e dados de teste](/pt-br/integration/sandbox-testing). Você também pode armar (ou rearmar) um cenário após a criação via POST /v3/session/{sessionId}/sandbox/arm/, desde que a sessão ainda esteja `Not Started`. Para consultas sem documento, use `lookup_partial_match`, `lookup_no_match` ou `lookup_provider_error` para testar o limite de tentativas configurado e o fallback. Para carteiras de identidade, use `wallet_cancelled`, `wallet_timeout` ou `wallet_provider_error`; `approve` simula uma carteira verificada. Todas as carteiras do catálogo podem ser testadas no sandbox, inclusive esquemas indisponíveis em aplicações em produção. Tentativas simuladas não são cobradas.", "example": "decline_document_expired" }, "sign": { "type": "object", "description": "Entrada de assinatura eletrônica para esta sessão. `documents` são os documentos a assinar, para um fluxo de verificação (workflow) cuja etapa de Assinatura eletrônica recebe documentos da sessão (`signature_documents_source` `session` ou `both`): até 20 documentos e 50 MB no total. `field_values` preenche os campos cujo `prefill` é `api.`, tanto nos documentos do fluxo quanto nos da sessão. Criar novamente uma sessão para o mesmo `workflow_id` e `vendor_data` retorna a sessão pendente; se essa chamada enviar `sign`, seus documentos, campos e valores devem ser idênticos aos da primeira, e qualquer diferença retorna `400` com `{\"sign\": \"signature_document_changed\"}`. Consulte [Documentos de assinatura eletrônica](/pt-br/sessions-api/create-session#documentos-de-assinatura-eletrônica).", "properties": { "documents": { "type": "array", "minItems": 1, "maxItems": 20, "items": { "$ref": "#/components/schemas/SessionSignDocument" } }, "field_values": { "type": "object", "description": "Valores indexados pela `` de cada fonte de preenchimento prévio `api.`: strings de 1 a 500 caracteres para campos `text` e `data`, booleanos para um `checkbox`. Retorna `400` com `field_value_unknown` para uma chave que nenhum campo usa, `field_value_missing` para um campo obrigatório sem valor e `field_value_invalid` para um valor que não passa na validação do seu campo.", "additionalProperties": { "oneOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "boolean" } ] }, "example": { "credit_limit": "3,000 EUR" } } } }, "user_state": { "type": "string", "maxLength": 16, "description": "Onde a pessoa mora, quando você souber: um código de subdivisão ISO 3166-2 (`US-IL`, `ES-M`) ou um código ou nome de estado dos EUA (`IL`, `Illinois`). Um estado cuja lei exige consentimento biométrico explícito (Illinois, Texas, Colorado) faz o fluxo de verificação solicitá-lo antes de capturar um rosto, com o gatilho `declared_state`. Um valor não reconhecido retorna `400`. Consulte [Consentimento biométrico](/pt-br/getting-started/biometric-consent).", "example": "US-IL" }, "biometric_consent": { "type": "object", "description": "Consentimento biométrico explícito que você já coletou da pessoa. Ele atende ao requisito, de modo que o fluxo de verificação não o solicita novamente, e a decisão o registra como `status: \"given\"` com o gatilho `customer_collected`. Uma resposta que a pessoa já deu no fluxo nunca é substituída. Consulte [Consentimento biométrico](/pt-br/getting-started/biometric-consent).", "required": [ "given_at", "text_version" ], "properties": { "given_at": { "type": "string", "format": "date-time", "description": "Quando a pessoa deu consentimento biométrico explícito (ISO 8601). Não pode estar no futuro." }, "text_version": { "type": "string", "maxLength": 64, "description": "Id da versão do texto de consentimento que a pessoa aceitou, nos seus próprios registros." } } } }, "example": { "workflow_id": "11111111-2222-3333-4444-555555555555", "vendor_data": "user-123", "callback": "https://example.com/verification/callback", "callback_method": "both", "metadata": { "user_type": "premium", "account_id": "ABC123" }, "language": "en", "contact_details": { "email": "john.doe@example.com", "send_notification_emails": true, "email_lang": "en", "phone": "+14155552671" }, "expected_details": { "first_name": "John", "last_name": "Doe", "date_of_birth": "1990-05-15", "id_country": "USA", "expected_document_types": [ "P", "ID" ] } } }, "examples": { "Create KYC session": { "summary": "Payload completo do fluxo bem-sucedido de uma sessão de Verificação de usuários (KYC)", "description": "Chamada de criação realista que usa todos os campos definidos com frequência: seleção do fluxo de verificação (workflow), vínculo com o fornecedor, roteamento de callback, metadados, localidade, preenchimento prévio de contato e dados esperados do usuário. Copie e cole diretamente no exemplo de cURL acima.", "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 do cenário de sucesso para uma sessão de Verificação de empresas (KYB)", "description": "Mesmo formato da chamada de KYC: é o `workflow_id` que torna a sessão KYB. `vendor_data` normalmente referencia a empresa no seu sistema e `contact_details.email` se destina ao representante legal que concluirá o fluxo. `expected_details` aceita os campos da empresa (`company_name`, `registry_country`, `registration_number`), que preenchem previamente a busca no registro de empresas; campos de pessoa e `contact_details.phone` são ignorados em fluxos 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": "Criar um job de importação de verificações", "description": "Cria um job de importação assíncrono para sessões históricas de Verificação de usuários, sessões de Verificação de empresas, registros de monitoramento de transações ou regras de status personalizado de fluxos de verificação (workflow). Defina `source=provider` para migrar de outro provedor: a Didit lê Sumsub, Onfido, Persona e ComplyCube com sua chave somente leitura, lê os registros de Veriff, iDenfy e MetaMap pelos IDs que você envia em `file` e importa um arquivo de exportação no formato da Didit para os demais provedores. Os IDs de registro recebem um namespace por provedor (`sumsub:`), de modo que uma nova execução ignora tudo o que já está na Didit. As importações ficam desativadas por padrão e precisam ser ativadas pela Didit para cada organização.", "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": "O que importar: sessões históricas de Verificação de usuários, sessões históricas de Verificação de empresas, regras de status personalizados do fluxo de verificação (workflow) ou registros históricos de monitoramento de transações." }, "workflow_id": { "type": "string", "format": "uuid", "description": "UUID do fluxo de verificação (workflow) ao qual as sessões ou regras de status importadas devem ser vinculadas. Obrigatório para user_verification, business_verification e status_rules. Omita para transactions." }, "source_format": { "type": "string", "enum": [ "csv", "ndjson" ], "description": "Opcional. Inferido a partir da extensão do arquivo enviado quando omitido." }, "file": { "type": "string", "format": "binary", "description": "Arquivo CSV ou NDJSON canônico. Use NDJSON para importações grandes. Tamanho máximo de upload de 25 MB (use `source_file_url` para arquivos maiores). Mutuamente exclusivo com `source_file_url`." }, "source_file_url": { "type": "string", "format": "uri", "description": "Alternativa ao upload de arquivo. Deve ser uma URL HTTPS que resolva para um endereço público (redes privadas/loopback são rejeitadas). Mutuamente exclusivo com `file`." }, "source": { "type": "string", "enum": [ "file", "provider" ], "description": "`provider` torna esta importação uma migração de outro provedor de verificação de identidade. Omita para uma importação de arquivo." }, "provider": { "type": "string", "enum": [ "sumsub", "jumio", "veriff", "onfido", "persona", "metamap", "socure", "idnow", "shufti", "idenfy", "ondato", "trulioo", "au10tix", "complycube", "other" ], "description": "Origem da migração, obtida de `GET /v3/session/imports/providers/`. Obrigatório quando `source` é `provider`." }, "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A chave somente leitura do provedor, com os nomes de campo listados em `credential_fields`. Criptografada em repouso, nunca retornada e apagada quando a importação termina. Envie-a como uma string JSON no multipart." }, "options": { "type": "object", "properties": { "region": { "type": "string", "description": "A região do provedor, uma das suas `regions` (Onfido: `eu`, `us`, `ca`)." } } }, "status_mapping": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Not Finished", "Abandoned" ] }, "description": "Alterações no mapeamento de status padrão do provedor: status de origem para status da Didit. `Not Finished` e `Abandoned` são ignorados e contabilizados, nunca importados." }, "dry_run": { "type": "boolean", "default": false, "description": "Conta o que a migração importaria (por status, já existente na Didit, mesma pessoa, não concluído) e não grava nada. O job termina em `READY`. Inicie-o com `POST /v3/session/imports/{importId}/start/`." }, "face_templates": { "type": "boolean", "default": false, "description": "Gera templates faciais a partir das selfies importadas e os busca entre os rostos e a lista de bloqueio da aplicação. As correspondências são apenas sinalizadas para revisão. Requer `lawful_basis_confirmed`." }, "lawful_basis_confirmed": { "type": "boolean", "default": false, "description": "Confirma que você tem uma base legal para compartilhar essas selfies com a Didit, na qualidade de operadora." } } } }, "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": "O que importar: sessões históricas de Verificação de usuários, sessões históricas de Verificação de empresas, regras de status personalizados do fluxo de verificação (workflow) ou registros históricos de monitoramento de transações." }, "workflow_id": { "type": "string", "format": "uuid", "description": "UUID do fluxo de verificação (workflow) ao qual as sessões ou regras de status importadas devem ser vinculadas. Obrigatório para user_verification, business_verification e status_rules. Omita para transactions." }, "source_format": { "type": "string", "enum": [ "csv", "ndjson" ], "description": "Opcional. Inferido a partir da extensão de arquivo da URL quando omitido." }, "source_file_url": { "type": "string", "format": "uri", "description": "Alternativa ao upload de arquivo. Deve ser uma URL HTTPS que resolva para um endereço público (redes privadas/loopback são rejeitadas). Mutuamente exclusivo com `file`." }, "source": { "type": "string", "enum": [ "file", "provider" ], "description": "`provider` torna esta importação uma migração de outro provedor de verificação de identidade. Omita para uma importação de arquivo." }, "provider": { "type": "string", "enum": [ "sumsub", "jumio", "veriff", "onfido", "persona", "metamap", "socure", "idnow", "shufti", "idenfy", "ondato", "trulioo", "au10tix", "complycube", "other" ], "description": "Origem da migração, obtida de `GET /v3/session/imports/providers/`. Obrigatório quando `source` é `provider`." }, "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A chave somente leitura do provedor, com os nomes de campo listados em `credential_fields`. Criptografada em repouso, nunca retornada e apagada quando a importação termina. Envie-a como uma string JSON no multipart." }, "options": { "type": "object", "properties": { "region": { "type": "string", "description": "A região do provedor, uma das suas `regions` (Onfido: `eu`, `us`, `ca`)." } } }, "status_mapping": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Not Finished", "Abandoned" ] }, "description": "Alterações no mapeamento de status padrão do provedor: status de origem para status da Didit. `Not Finished` e `Abandoned` são ignorados e contabilizados, nunca importados." }, "dry_run": { "type": "boolean", "default": false, "description": "Conta o que a migração importaria (por status, já existente na Didit, mesma pessoa, não concluído) e não grava nada. O job termina em `READY`. Inicie-o com `POST /v3/session/imports/{importId}/start/`." }, "face_templates": { "type": "boolean", "default": false, "description": "Gera templates faciais a partir das selfies importadas e os busca entre os rostos e a lista de bloqueio da aplicação. As correspondências são apenas sinalizadas para revisão. Requer `lawful_basis_confirmed`." }, "lawful_basis_confirmed": { "type": "boolean", "default": false, "description": "Confirma que você tem uma base legal para compartilhar essas selfies com a Didit, na qualidade de operadora." } } }, "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": "Tarefa de importação aceita. Consulte o `uuid` retornado até que `status` seja `COMPLETED` ou `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": "Fluxo, tipo de arquivo, tamanho de arquivo, URL de origem ou combinação de seletores inválidos. Uma migração cuja chave o provedor recusa responde com `code` (`invalid_credentials`, `missing_permission`, `wrong_region`, `provider_unavailable`, `rate_limited`, `ids_required`, `record_not_found`), `missing_permissions` e `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": "Importações não habilitadas, aplicação de sandbox ou chave de API ausente (uma chave incorreta, revogada ou expirada retorna `401`). As importações de verificações vêm desabilitadas por padrão e precisam ser habilitadas pela Didit para cada organização.", "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": "A aplicação já tem um job de importação ativo (PENDING/PROCESSING/PAUSED). Aguarde a conclusão antes de iniciar outro.", "content": { "application/json": { "examples": { "Active job": { "value": { "detail": "This application already has an active import job. Wait for it to finish before starting another." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.create(\n import_type=\"user_verification\",\n workflow_id=\"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n source_file_url=\"https://files.example.com/exports/sessions.ndjson\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.create({\n import_type: \"user_verification\",\n workflow_id: \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n source_file_url: \"https://files.example.com/exports/sessions.ndjson\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Create(ctx, didit.SessionsImportsCreateParams{\n\tImportType: didit.Some(didit.SessionsImportsCreateParamsImportType(\"user_verification\")),\n\tWorkflowID: didit.String(\"9f9b1234-aaaa-bbbb-cccc-1234567890ab\"),\n\tSourceFileURL: didit.String(\"https://files.example.com/exports/sessions.ndjson\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsImportsCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().create(SessionsImportsCreateParams.builder()\n .importType(SessionsImportsCreateParams.ImportType.of(\"user_verification\"))\n .workflowId(\"9f9b1234-aaaa-bbbb-cccc-1234567890ab\")\n .sourceFileUrl(\"https://files.example.com/exports/sessions.ndjson\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->create([\n 'import_type' => 'user_verification',\n 'workflow_id' => '9f9b1234-aaaa-bbbb-cccc-1234567890ab',\n 'source_file_url' => 'https://files.example.com/exports/sessions.ndjson',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.create(\n import_type: \"user_verification\",\n workflow_id: \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n source_file_url: \"https://files.example.com/exports/sessions.ndjson\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.CreateAsync(new SessionsImportsCreateParams\n{\n ImportType = new SessionsImportsCreateParamsImportType(\"user_verification\"),\n WorkflowId = \"9f9b1234-aaaa-bbbb-cccc-1234567890ab\",\n SourceFileUrl = \"https://files.example.com/exports/sessions.ndjson\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/template/": { "get": { "summary": "Baixar modelo de importação de verificações", "description": "Baixe o cabeçalho CSV canônico para importações de verificações. O conjunto de colunas é determinado por `import_type`. A primeira coluna dos modelos de sessão é a chave de 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": "Arquivo de modelo CSV.", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Chave de API ausente, inválida ou revogada, ou a chave não pode baixar modelos de importação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "summary": "Chave de API ausente, inválida ou revogada", "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": "Obter um job de importação de verificações", "description": "Obtenha os contadores de progresso da importação e o status final de um job. Consulte periodicamente até que `status` seja `COMPLETED` ou `FAILED`; `failed_count` > 0 significa que algumas linhas foram rejeitadas: liste-as pelo endpoint de erros.", "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": "Status do job de importação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "404": { "description": "Job de importação não encontrado para esta aplicação.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "403": { "description": "Chave de API ausente, inválida ou revogada, ou a chave não pode ler jobs de importação desta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "summary": "Chave de API ausente, inválida ou revogada", "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/{importId}/errors/": { "get": { "summary": "Listar erros de linhas da importação de verificações", "description": "Lista os erros por linha de um job de importação de verificações, ordenados por `row_number`. Use este endpoint para gerar um arquivo corrigido para tentar novamente, contendo apenas as linhas com falha.", "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": "Tamanho da página. O padrão é 50 quando omitido." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "Deslocamento, a partir de zero, do primeiro registro a retornar." } ], "responses": { "200": { "description": "Erros de linha paginados.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número de linhas com erro: exato até 100 e limitado a 100 acima disso. Considere `next` igual a `null` para detectar a última página." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta da próxima página, ou `null` na última página." }, "previous": { "type": "string", "nullable": true, "description": "URL absoluta da página anterior, ou `null` na primeira 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": "Job de importação não encontrado para esta aplicação.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "403": { "description": "Chave de API ausente, inválida ou revogada, ou a chave não pode ler jobs de importação desta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "summary": "Chave de API ausente, inválida ou revogada", "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": "Recuperar a decisão completa de uma sessão de verificação", "description": "Recupera o relatório de decisão completo de uma sessão de verificação: o `status` consolidado da sessão e um relatório para cada recurso de verificação que o fluxo de verificação (workflow) executou. Este é o endpoint de leitura de referência para sessões de Verificação de usuários (KYC) e de Verificação de empresas (KYB): o mesmo caminho atende os dois tipos, e o discriminador `session_kind` no nível superior indica qual formato você recebeu (`\"user\"` ou `\"business\"`).\n\n**Todo relatório de recurso é um array no plural.** Fluxos V3 são grafos que podem executar o mesmo recurso mais de uma vez. Por isso, cada bloco (`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`) é um array JSON em que cada item traz um `node_id` que identifica o nó do grafo do fluxo que o gerou. Leia NFC como `response.nfc_verifications[0]`, nunca como um campo `nfc` no singular. Um bloco é `null` até que o fluxo tenha executado esse recurso pelo menos uma vez. Recursos que o fluxo não inclui nunca aparecem com dados. Os resultados de Assinatura eletrônica ficam em `signatures`, que só está presente quando o fluxo tem uma etapa de Assinatura eletrônica.\n\n**Quando chamar.** O padrão recomendado é orientado a eventos: aguarde o webhook `status.updated`, disparado quando a sessão chega a uma decisão (`Approved`, `Declined`, `In Review`), e então chame este endpoint uma vez para buscar o relatório completo. Fazer polling também funciona, pois o endpoint pode ser chamado em qualquer momento do ciclo de vida da sessão e retorna os dados produzidos até então, mas aguardar o webhook e depois buscar é mais barato e mais rápido. As URLs de mídia na resposta (imagens de documentos, vídeos, PDFs) são links pré-assinados de curta duração: baixe-os logo ou solicite a decisão novamente para obter links novos, e não os armazene como referências de longo prazo.\n\n**Status.** O `status` no nível superior é o status do ciclo de vida da sessão (`Not Started`, `In Progress`, `Awaiting User`, `In Review`, `Approved`, `Declined`, `Resubmitted`, `Expired`, `Kyc Expired`, `Abandoned`). Além disso, cada item de recurso traz seu próprio `status` no nível do recurso (`Not Finished`, `Approved`, `Declined`, `In Review`, ...). Uma sessão pode estar `Approved` no geral enquanto um recurso individual está `In Review`, dependendo das regras de decisão do fluxo.\n\n**Autenticação e visibilidade.** Autentique-se com a chave de API da aplicação no cabeçalho `x-api-key` (um token Bearer de usuário do console com a permissão `read:sessions` também funciona). Somente as sessões pertencentes à aplicação autenticada ficam visíveis. Se o seu fluxo restringe os atributos da resposta, os campos não permitidos dentro dos itens de recurso são retornados como `null`, enquanto `status`, `warnings` e `node_id` são sempre preservados.\n\n**Limites de requisições.** Requisições GET são limitadas a 600 por minuto por chave de API. Exceder o limite retorna `429` com os cabeçalhos `Retry-After` e `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": "Relatório de decisão completo. `session_kind` distingue as duas estruturas: sessões `user` contêm os arrays de recursos de KYC mostrados abaixo; sessões `business` contêm, em vez disso, `registry_checks`, `document_verifications` e `key_people_checks` junto com os arrays compartilhados. Os arrays de recursos são `null` até que o fluxo tenha executado o recurso correspondente; as URLs de mídia são links pré-assinados de curta duração.", "content": { "application/json": { "examples": { "Example": { "summary": "Exemplo completo", "value": { "session_id": "11111111-2222-3333-4444-555555555555", "session_kind": "user", "session_number": 43762, "session_url": "https://verify.didit.me/session/11111111-2222-3333-4444-555555555555", "status": "In Review", "environment": "live", "workflow_id": "11111111-2222-3333-4444-555555555555", "features": [ "ID_VERIFICATION", "NFC", "LIVENESS", "FACE_MATCH", "POA", "PHONE", "DATABASE_VALIDATION", "AML", "IP_ANALYSIS" ], "vendor_data": "11111111-1111-1111-1111-111111111111", "metadata": { "user_type": "premium", "account_id": "ABC123" }, "expected_details": { "first_name": "Carmen", "last_name": "Española Española" }, "contact_details": { "email": "carmen@example.com", "email_lang": "es", "send_notification_emails": false, "phone": null }, "callback": "https://verify.didit.me/", "id_verifications": [ { "node_id": "feature_ocr_1", "status": "Approved", "document_type": "Identity Card", "document_subtype": "ID_CARD_GENERIC", "document_number": "CAA000000", "personal_number": "99999999R", "portrait_image": "https:///portrait.jpg", "front_image": "https:///front.jpg", "front_video": "https:///front.mp4", "back_image": "https:///back.jpg", "back_video": "https:///back.mp4", "full_front_image": "https:///full_front.jpg", "full_back_image": "https:///full_back.jpg", "front_image_camera_front": "https:///front_camera_front.jpg", "back_image_camera_front": "https:///back_camera_front.jpg", "date_of_birth": "1980-01-01", "age": 45, "expiration_date": "2031-06-02", "date_of_issue": "2021-06-02", "issuing_state": "ESP", "issuing_state_name": "Spain", "first_name": "Carmen", "last_name": "Española Española", "full_name": "Carmen Española Española", "gender": "F", "address": "Avda de Madrid 34, Madrid, Madrid", "formatted_address": "Avda de Madrid 34, Madrid, Madrid 28822, Spain", "place_of_birth": "Madrid", "marital_status": "Single", "nationality": "ESP", "extra_fields": { "dl_categories": [], "blood_group": null }, "mrz": { "surname": "ESPANOLA ESPANOLA", "name": "CARMEN", "country": "ESP", "nationality": "ESP", "birth_date": "800101", "expiry_date": "310602", "sex": "F", "document_type": "ID", "document_number": "CAA000000", "optional_data": "99999999R", "optional_data_2": "", "birth_date_hash": "4", "expiry_date_hash": "8", "document_number_hash": "4", "final_hash": "1", "personal_number": "99999999R", "warnings": [], "errors": [], "mrz_type": "TD1", "mrz_string": "IDESPCAA000000499999999R<<<<<<\n8001014F3106028ESP<<<<<<<<<<<1\nESPANOLA/match_face.jpg", "status": "Approved", "is_blocklisted": false, "is_allowlisted": false, "api_service": null, "source": "session" } ], "front_image_quality_score": { "focus_score": 85.3, "brightness_score": 92.1, "brightness_issue": "ok", "is_document_fully_visible": true, "resolution_score": 72.4, "overall_score": 88.7 }, "back_image_quality_score": { "focus_score": 79.1, "brightness_score": 90.5, "brightness_issue": "ok", "is_document_fully_visible": true, "resolution_score": 72.4, "overall_score": 85.2 }, "extra_files": [ "https:///extra_id_verification.jpg" ], "matches": [ { "session_id": "7d4f1f60-9c2e-4b8a-8f3d-2a1b5c6d7e8f", "session_number": 1234, "vendor_data": "user_ref_001", "verification_date": "2024-06-15T10:30:00Z", "user_details": { "name": "John Smith", "document_type": "ID", "document_number": "CLM148418" }, "status": "Approved", "is_blocklisted": false, "api_service": null, "front_image_url": "https:///document_front.jpg" }, { "session_id": "b2c8e4d1-6a3f-4e7b-95c0-1d8f2a6b4c9e", "session_number": 1235, "vendor_data": null, "verification_date": "2024-05-20T14:45:00Z", "user_details": { "name": "John Smith", "document_type": "ID", "document_number": "CLM148418" }, "status": "Declined", "is_blocklisted": true, "api_service": "ID_VERIFICATION", "front_image_url": "https:///document_front_2.jpg" } ], "warnings": [ { "feature": "ID_VERIFICATION", "risk": "QR_NOT_DETECTED", "additional_data": null, "log_type": "information", "short_description": "QR not detected", "long_description": "The system couldn't find or read the QR code on the document, which is necessary for document verification. This could be due to poor image quality or an unsupported document type.", "node_id": "feature_ocr_1" } ], "verification_method": "document", "assurance": "documentary", "wallet_provider": null, "fallback_from": null, "id_lookup": null, "wallet_verification": null, "document_liveness": { "portrait_replace": { "score": 96.46, "front": 96.46, "back": 98.2, "decline_threshold": 35, "review_threshold": 70, "bucket": "approve" }, "printed_copy": { "score": 91.2, "front": 91.2, "back": 93.7, "decline_threshold": 35, "review_threshold": 77, "bucket": "approve" }, "screen_replay": { "score": 99.9, "front": 99.9, "back": 99.5, "decline_threshold": 30, "review_threshold": 70, "bucket": "approve" } } }, { "node_id": "feature_ocr_2", "status": "Approved", "issuing_state": "ZAF", "issuing_state_name": "South Africa", "first_name": "Thabo", "last_name": "Mokoena", "full_name": "Thabo Mokoena", "date_of_birth": "1991-06-15", "personal_number": "9106155043088", "verification_method": "id_lookup", "assurance": "data_match", "wallet_provider": null, "fallback_from": null, "id_lookup": { "source": "Department of Home Affairs", "checked_at": "2026-09-04T09:12:44Z", "attempts": 1, "max_attempts": 2, "outcome": "match", "comparison": [ { "field": "identification_number", "label": "ID number", "provided": "9106155043088", "record": "9106155043088", "result": "match" }, { "field": "full_name", "label": "Full name", "provided": "Thabo Mokoena", "record": "Thabo Mokoena", "result": "match" }, { "field": "date_of_birth", "label": "Date of birth", "provided": "1991-06-15", "record": "1991-06-15", "result": "match" } ], "registry_portrait": "https:///registry_portrait.jpg", "face_match_score": 96.4, "source_errors": [] }, "wallet_verification": null, "warnings": [] }, { "node_id": "feature_ocr_3", "status": "Approved", "issuing_state": "DNK", "issuing_state_name": "Denmark", "first_name": "Freja", "last_name": "Nielsen", "full_name": "Freja Nielsen", "date_of_birth": "1988-03-02", "verification_method": "wallet", "assurance": "cryptographic", "wallet_provider": "mitid", "fallback_from": null, "id_lookup": null, "wallet_verification": { "provider": "mitid", "provider_name": "MitID", "issuing_authority": "Danish Agency for Digital Government", "issuing_country": "DNK", "credential_type": "person_identification", "level_of_assurance": "substantial", "verified_at": "2026-09-04T09:12:44Z", "signature_valid": true, "attributes": { "full_name": "Freja Nielsen", "date_of_birth": "1988-03-02", "cpr_alias": "b0f1c2d3-e4f5-4678-9abc-def012345678" }, "portrait": null, "face_match_score": null }, "warnings": [] } ], "nfc_verifications": [ { "node_id": "feature_nfc_1", "status": "In Review", "is_nfc_skipped": false, "skip_reason": null, "chip_protocol": "icao", "jpki": null, "portrait_image": "https:///portrait.jpg", "signature_image": "https:///signature.jpg", "chip_data": { "document_type": "ID", "issuing_country": "ESP", "document_number": "123456789", "expiration_date": "2030-01-01", "first_name": "John", "last_name": "Smith", "birth_date": "1990-05-15", "gender": "M", "nationality": "ESP", "address": "CALLE MAYOR 123 4B, MADRID, MADRID", "place_of_birth": "MADRID, MADRID" }, "authenticity": { "sod_integrity": true, "dg_integrity": true }, "certificate_summary": { "issuer": "Common Name: CSCA SPAIN, Serial Number: 3, Organization: DIRECCION GENERAL DE LA POLICIA, Country: ES", "subject": "Common Name: DS n-eID SPAIN 2, Organizational Unit: PASSPORT, Organization: DIRECCION GENERAL DE LA POLICIA, Country: ES", "serial_number": "118120836164494130086420187336801405660", "not_valid_after": "2031-02-18 10:21:11", "not_valid_before": "2020-11-18 10:21:11" }, "warnings": [ { "feature": "NFC", "risk": "DATA_INCONSISTENT", "additional_data": null, "log_type": "warning", "short_description": "OCR and NFC mrz code extracted are not the same", "long_description": "The Optical Character Recognition (OCR) data and the NFC chip data don't match, indicating potential document tampering or data inconsistency.", "node_id": "feature_nfc_1" } ] } ], "liveness_checks": [ { "node_id": "feature_liveness_1", "status": "Approved", "method": "ACTIVE_3D", "score": 89.92, "reference_image": "https:///reference.jpg", "video_url": "https:///video.mp4", "age_estimation": 24.3, "matches": [ { "session_id": "7d4f1f60-9c2e-4b8a-8f3d-2a1b5c6d7e8f", "session_number": 1234, "vendor_data": "user_ref_001", "verification_date": "2024-06-15T10:30:00Z", "user_details": { "full_name": "John Smith", "document_type": "ID", "document_number": "CLM148418" }, "status": "Approved", "is_blocklisted": false, "is_allowlisted": false, "api_service": null, "source": "session", "match_image_url": "https:///face_match.jpg", "similarity_percentage": 98.5 }, { "session_id": "3e9a7c21-5b48-4f0e-9c6a-8d2f4b1e0a35", "session_number": 1100, "vendor_data": "customer_xyz", "verification_date": "2024-04-10T09:15:00Z", "user_details": { "full_name": "John Smith", "document_type": "P", "document_number": "DZ8375806" }, "status": "Approved", "is_blocklisted": false, "is_allowlisted": false, "api_service": "PASSIVE_LIVENESS", "source": "session", "match_image_url": "https:///face_match_2.jpg", "similarity_percentage": 95.2 } ], "warnings": [ { "feature": "LIVENESS", "risk": "LOW_LIVENESS_SCORE", "additional_data": null, "log_type": "information", "short_description": "Low liveness score", "long_description": "The liveness check resulted in a low score, indicating potential use of non-live facial representations or poor-quality biometric data.", "node_id": "feature_liveness_1" } ], "face_quality": null, "face_luminance": null } ], "face_matches": [ { "node_id": "feature_face_match_1", "status": "In Review", "score": 65.43, "source_image_session_id": null, "source_image": "https:///source-image.jpg", "target_image": "https:///target-image.jpg", "warnings": [ { "feature": "FACEMATCH", "risk": "LOW_FACE_MATCH_SIMILARITY", "additional_data": null, "log_type": "warning", "short_description": "Low face match similarity", "long_description": "The facial features of the provided image don't closely match the reference image, suggesting a potential identity mismatch.", "node_id": "feature_face_match_1" } ] } ], "phone_verifications": [ { "node_id": "feature_phone_1", "status": "Approved", "phone_number_prefix": "+34", "phone_number": "600600600", "full_number": "+34600600600", "country_code": "ES", "country_name": "Spain", "carrier": { "name": "Orange", "type": "mobile" }, "is_disposable": false, "is_virtual": false, "verification_method": "sms", "verification_attempts": 1, "verified_at": "2024-07-28T06:47:35.654321Z", "lifecycle": [ { "type": "PHONE_VERIFICATION_MESSAGE_SENT", "timestamp": "2025-08-24T09:12:39.580554+00:00", "details": { "status": "Success", "reason": null, "channel": "sms", "actual_channel": "sms" }, "fee": 0.1 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2025-08-24T09:12:39.662157+00:00", "details": { "code_tried": "123456", "status": "Approved" }, "fee": 0 }, { "type": "PHONE_VERIFICATION_APPROVED", "timestamp": "2025-08-24T09:12:39.684292+00:00", "details": null, "fee": 0 } ], "warnings": [], "matches": [ { "session_id": null, "session_number": null, "vendor_data": null, "verification_date": null, "phone_number": "+34600000000", "status": null, "is_blocklisted": true, "api_service": null, "source": "list_entry" } ] } ], "email_verifications": [ { "node_id": "feature_email_1", "status": "Approved", "email": "test@example.com", "is_breached": true, "breaches": [ { "name": "TAPAirPortugal", "domain": "flytap.com", "logo_path": "https://logos.example.com/TAPAirPortugal.png", "breach_date": "2022-08-25", "description": "In August 2022, the Portuguese airline TAP Air Portugal was the target of a ransomware attack perpetrated by the Ragnar Locker gang who later leaked the compromised data via a public dark web site. Over 5M unique email addresses were exposed alongside other personal data including names, genders, DoBs, phone numbers and physical addresses.", "is_verified": true, "data_classes": [ "dates_of_birth", "email_addresses", "genders", "names", "nationalities", "phone_numbers", "physical_addresses", "salutations", "spoken_languages" ], "breach_emails_count": 6083479 } ], "is_disposable": false, "is_undeliverable": false, "verification_attempts": 1, "verified_at": "2025-09-15T17:36:19.963451Z", "warnings": [ { "feature": "EMAIL", "risk": "BREACHED_EMAIL_DETECTED", "additional_data": null, "log_type": "information", "short_description": "Breached email detected", "long_description": "This email address was found in one or more known data breaches.", "node_id": "feature_email_1" } ], "lifecycle": [ { "type": "EMAIL_VERIFICATION_MESSAGE_SENT", "timestamp": "2025-09-15T17:36:19.792684+00:00", "details": { "status": "Success", "reason": null }, "fee": 0.02 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2025-09-15T17:36:19.963427+00:00", "details": { "code_tried": "123456", "status": "Approved" }, "fee": 0 }, { "type": "EMAIL_VERIFICATION_DECLINED", "timestamp": "2025-09-15T17:36:20.081471+00:00", "details": { "reason": "BREACHED_EMAIL_DETECTED" }, "fee": 0 } ], "matches": [ { "session_id": null, "session_number": null, "vendor_data": null, "verification_date": null, "email": "test@example.com", "status": null, "is_blocklisted": true, "api_service": null, "source": "list_entry" } ] } ], "poa_verifications": [ { "node_id": "feature_poa_1", "status": "Declined", "document_file": "https:///poa_document.pdf", "issuing_state": "AR", "document_type": "UTILITY_BILL", "document_subtype": null, "document_language": "es", "document_metadata": { "file_size": 1000, "content_type": "application/pdf", "creation_date": "2021-01-01", "modified_date": "2021-01-01", "overlay_manipulation": null, "creator": null, "producer": "PDF Generator", "software": null, "encryption": null, "is_signed": false, "is_tampered": false, "signature_info": null, "exif_original_date": null, "exif_digitized_date": null, "processed_by_known_editor": false, "has_different_creation_mod_date": true }, "issuer": "Aguas del Norte", "issue_date": "2021-02-01", "expiration_date": null, "poa_address": "AVDA. MONSEÑOR TAVELLA N° 3396, SALTA", "poa_formatted_address": "Av. Monseñor Tavella 3396, A4400 Salta, Argentina", "poa_parsed_address": { "address_type": "Avenida", "street_1": "Avenida Monseñor Tavella 3396", "street_2": null, "city": "Salta", "region": "Salta", "country": "AR", "postal_code": "A4400", "document_location": { "latitude": -24.8208664, "longitude": -65.4131 } }, "name_on_document": "Fernando De Lima", "name_match_score_expected_details": null, "name_match_score_id_verification": 38.5, "expected_details_address": null, "expected_details_formatted_address": null, "expected_details_parsed_address": {}, "extra_fields": { "bank_account_number": "1234567890", "bank_iban": null, "bank_sort_code": null, "bank_routing_number": null, "bank_swift_bic": null, "bank_branch_name": null, "bank_branch_address": null, "document_phone_number": "+5491112345678", "additional_names": [] }, "extra_files": [ "https:///extra_poa.pdf" ], "detected_codes": [ { "type": "QR_CODE", "page_number": 1, "position": [ [ 820, 1120 ], [ 1002, 1120 ], [ 1002, 1302 ], [ 820, 1302 ] ], "x": 820, "y": 1120, "width": 182, "height": 182, "page_width": 1190, "page_height": 1684, "raw_payload": "aHR0cHM6Ly9hZ3Vhc2RlbG5vcnRlLmNvbS9mYWN0dXJhLzk5ODgxMQ==", "parsed_payload": "https://aguasdelnorte.com/factura/998811" }, { "type": "CODE_128", "page_number": 1, "position": [ [ 112, 1480 ], [ 560, 1480 ], [ 560, 1540 ], [ 112, 1540 ] ], "x": 112, "y": 1480, "width": 448, "height": 60, "page_width": 1190, "page_height": 1684, "raw_payload": "MDA5OTg4MTEwMDA0Mg==", "parsed_payload": "0099881100042" } ], "warnings": [] } ], "document_ai_documents": [ { "status": "Approved", "node_id": "feature_document_ai_1", "items": [ { "uuid": "c1a2b3c4-d5e6-7f80-9a1b-2c3d4e5f6071", "node_id": "feature_document_ai_1", "document_key": "proof_of_funds", "original_filename": "bank_statement.pdf", "file_size": 184320, "file_url": "https:///document_ai/proof_of_funds.pdf", "status": "Approved", "extracted_data": { "account_holder": "John Doe", "balance": 15230.55, "currency": "EUR", "statement_date": "2026-05-31" }, "detected_codes": [ { "type": "QR_CODE", "page_number": 2, "position": [ [ 124, 86 ], [ 306, 86 ], [ 306, 268 ], [ 124, 268 ] ], "x": 124, "y": 86, "width": 182, "height": 182, "page_width": 1190, "page_height": 1684, "raw_payload": "SU5WLTIwMjYtMDA0Mg==", "parsed_payload": "INV-2026-0042" } ], "fields": [ { "key": "account_holder", "name": "Account holder", "instruction": "Extract the full name of the account holder.", "type": "text", "required": true }, { "key": "balance", "name": "Closing balance", "instruction": "Extract the closing balance amount.", "type": "number", "required": true } ], "document_metadata": { "is_tampered": false }, "cross_check_result": null, "created_at": "2026-06-01T12:34:56Z" } ], "warnings": [] } ], "questionnaire_responses": [ { "node_id": "feature_questionnaire_1", "questionnaire_id": "9f7485e0-b00b-4d56-9d3e-7859b68d1213", "title": "Source of Funds", "description": "Reply to this questionnaire to help us understand the source of funds.", "languages": [ "en" ], "default_language": "en", "is_active": true, "is_simple_questionnaire": true, "questionnaire_group_id": "2b6a9d40-13a8-4b1e-9a6c-3f1d2e4b5a60", "version": 1, "published_at": "2025-11-02T09:14:55.000000Z", "sections": [ { "title": null, "description": null, "items": [ { "uuid": "618636d9-7d5c-41ce-b8d0-1ab2a4be20db", "value": "question_1", "element_type": "DROPDOWN", "is_required": true, "title": "What is your primary source of funds?", "description": null, "placeholder": null, "choices": [ { "label": "Salary", "value": "salary" }, { "label": "Business Income", "value": "business_income" }, { "label": "Savings", "value": "savings" }, { "label": "Investments", "value": "investments" }, { "label": "Sale of Asset", "value": "sale_of_asset" }, { "label": "Inheritance/Gift", "value": "inheritance_gift" }, { "label": "Pension", "value": "pension" }, { "label": "Crypto Proceeds", "value": "crypto_proceeds" }, { "label": "Other", "value": "other", "requires_text_input": true } ], "max_files": 1, "answer": { "value": "salary" }, "required_if": null, "repeatable_config": null }, { "uuid": "2d16b527-72be-42e0-8e96-b164b818386c", "value": "question_2", "element_type": "LONG_TEXT", "is_required": true, "title": "Provide details of the primary source.", "description": null, "placeholder": null, "choices": null, "max_files": 1, "answer": { "value": "Test answer" }, "required_if": null, "repeatable_config": null }, { "uuid": "a9239b7c-fbfb-4ea7-b7e4-c835cd4016e0", "value": "question_3", "element_type": "DROPDOWN", "is_required": true, "title": "What is your annual income range (pre-tax)?", "description": null, "placeholder": null, "choices": [ { "label": "Less than $25,000", "value": "<25k" }, { "label": "$25,000 - $50,000", "value": "25k-50k" }, { "label": "$50,001 - $100,000", "value": "50k-100k" }, { "label": "$100,001 - $250,000", "value": "100k-250k" }, { "label": "More than $250,000", "value": ">250k" } ], "max_files": 1, "answer": { "value": "<25k" }, "required_if": null, "repeatable_config": null }, { "uuid": "93dede62-6d0c-4a7f-934d-42175eb94011", "value": "question_4", "element_type": "DROPDOWN", "is_required": true, "title": "What is your approximate net worth (range)?", "description": null, "placeholder": null, "choices": [ { "label": "Less than $50,000", "value": "<50k" }, { "label": "$50,000 - $250,000", "value": "50k-250k" }, { "label": "$250,001 - $1,000,000", "value": "250k-1m" }, { "label": "$1,000,001 - $5,000,000", "value": "1m-5m" }, { "label": "More than $5,000,000", "value": ">5m" } ], "max_files": 1, "answer": { "value": "<50k" }, "required_if": null, "repeatable_config": null }, { "uuid": "2af60d6f-6961-4692-9ee7-24b3033610a6", "value": "question_5", "element_type": "LONG_TEXT", "is_required": true, "title": "For your initial deposit/funding, indicate the exact source and amount.", "description": null, "placeholder": null, "choices": null, "max_files": 1, "answer": { "value": "Test answer" }, "required_if": null, "repeatable_config": null }, { "uuid": "0ad9d1aa-736f-46cf-947b-9e1241b53e40", "value": "question_6", "element_type": "LONG_TEXT", "is_required": true, "title": "Breakdown of sources by percentage.", "description": null, "placeholder": null, "choices": null, "max_files": 1, "answer": { "value": "Test answer" }, "required_if": null, "repeatable_config": null }, { "uuid": "1bf8a2a3-14ee-48a8-bb3d-175481aae4aa", "value": "question_7", "element_type": "SINGLE_CHOICE", "is_required": true, "title": "Will any funds originate from third parties? If yes, please provide details.", "description": null, "placeholder": null, "choices": [ { "label": "Yes", "value": "yes", "requires_text_input": true }, { "label": "No", "value": "no" } ], "max_files": 1, "answer": { "text": "Additional details", "value": "yes" }, "required_if": null, "repeatable_config": null }, { "uuid": "e18d4dd3-b7bf-4883-ba18-d6046adbe313", "value": "question_8", "element_type": "SINGLE_CHOICE", "is_required": true, "title": "Do you hold or plan to use virtual assets (e.g., crypto) to fund this account? If yes, please provide details.", "description": null, "placeholder": null, "choices": [ { "label": "Yes", "value": "yes", "requires_text_input": true }, { "label": "No", "value": "no" } ], "max_files": 1, "answer": { "text": "Additional details", "value": "yes" }, "required_if": null, "repeatable_config": null }, { "uuid": "a90a073d-e098-404c-bbce-5130d8b12a13", "value": "question_9", "element_type": "FILE_UPLOAD", "is_required": true, "title": "Upload a proof of funds document", "description": "You can upload your three (3) most recent bank statements, three (3) most recent payslips, your most recent tax return, proof of company ownership, trading exchange statement, sale of property, or proof of inheritance.", "placeholder": null, "choices": null, "max_files": 3, "answer": { "files": [ "/media/ocr/", "/media/ocr/" ] }, "required_if": null, "repeatable_config": null }, { "uuid": "9503b486-7cb8-4c3b-a97d-4b64926a5a47", "value": "question_10", "element_type": "LONG_TEXT", "is_required": false, "title": "Would you like to add any details to help us expedite our review of the documents you submitted?", "description": null, "placeholder": null, "choices": null, "max_files": 1, "answer": { "value": "Test answer" }, "required_if": null, "repeatable_config": null } ] } ], "status": "Approved" } ], "aml_screenings": [ { "node_id": "feature_aml_1", "status": "In Review", "total_hits": 1, "entity_type": "person", "hits": [ { "id": "hit_7c1e9a40b2d35f86e0a4c912", "url": "https://news.example.org/articles/sample", "match": false, "score": 0.73, "target": null, "caption": "Javier Ejemplo Modelo", "datasets": [ "PEP" ], "features": null, "rca_name": "", "last_seen": "2025-06-13T00:00:00", "risk_view": { "crimes": { "score": 0, "weightage": 20, "risk_level": "Low", "risk_scores": {} }, "countries": { "score": 0, "weightage": 30, "risk_level": "Low", "risk_scores": {} }, "categories": { "score": 100, "weightage": 50, "risk_level": "High", "risk_scores": { "PEP": 100 } }, "custom_list": {} }, "first_seen": "2025-01-18T00:00:00", "properties": { "name": [ "Javier Ejemplo Modelo" ], "alias": [ "Javier Ejemplo Modelo", "David Azagra" ], "notes": [ "Spanish orchestra conductor" ], "title": null, "gender": [ "male" ], "height": null, "topics": null, "weight": null, "address": null, "country": null, "website": null, "eyeColor": null, "keywords": null, "lastName": [ "Ejemplo", "Modelo" ], "position": null, "religion": null, "birthDate": [ "1974" ], "education": [ "Tokyo Arts and Space (2012-2012)", "Saint Petersburg Conservatory (-2010)", "Comillas Pontifical University" ], "ethnicity": null, "firstName": [ "David" ], "hairColor": null, "weakAlias": null, "birthPlace": [ "Madrid" ], "modifiedAt": null, "wikidataId": null, "citizenship": null, "nationality": null }, "match_score": 98, "risk_score": 73, "review_status": "Unreviewed", "score_breakdown": { "name_score": 95, "name_weight": 60, "name_weight_normalized": 70.59, "name_contribution": 67.06, "dob_score": 100, "dob_weight": 25, "dob_weight_normalized": 29.41, "dob_contribution": 29.41, "country_score": 0, "country_weight": 15, "country_weight_normalized": 0, "country_contribution": 0, "document_number_match_type": "NEUTRAL", "document_number_effect": "No document number provided for screening", "total_score": 98 }, "pep_matches": [ { "aliases": [ "Javier Ejemplo Modelo", "David Azagra" ], "education": [ "Tokyo Arts and Space (2012-2012)", "Saint Petersburg Conservatory (-2010)", "Comillas Pontifical University" ], "list_name": "Wikidata", "publisher": "Wikidata", "source_url": "https://news.example.org/articles/sample", "description": "Wikidata is the structured data project of the Wikipedia community, providing fact-based information edited by humans and machines", "matched_name": "Javier Ejemplo Modelo", "pep_position": "", "date_of_birth": "1974", "other_sources": [], "place_of_birth": "Madrid" } ], "linked_entities": [ { "name": [ "Antonio Ejemplo" ], "active": [], "status": [], "details": [], "relation": [] } ], "warning_matches": [], "sanction_matches": [], "adverse_media_details": { "sentiment": "Moderately Negative", "entity_type": "person", "sentiment_score": -2, "adverse_keywords": { "fraud": 3, "juicio": 1, "delitos": 2, "imputado": 1, "impunidad": 1, "corruption": 2, "favoritism": 2, "privilegio": 1, "corrupción": 1, "persecution": 2, "desconfianza": 1, "desprestigio": 1, "fraude de ley": 2, "manipulación": 1, "investigación": 3, "prevaricación": 8, "trato de favor": 1, "irregularidades": 2, "crisis de confianza": 1, "tráfico de influencias": 8 } }, "adverse_media_matches": [ { "country": "spain", "summary": "Javier Ejemplo is implicated in legal violations related to favoritism and influence trafficking, leading to a negative portrayal in the article.", "headline": "La Diputación de Villaejemplo consolida la plaza a medida para el ex asesor de Moncloa amigo del \"hermanito\" de Ejemplo", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "fraud", "prevaricación", "tráfico de influencias", "irregularidades", "imputado" ], "sentiment_score": -2, "publication_date": "2025-06-10T20:46:38" }, { "country": "spain", "summary": "Javier Ejemplo is implicated in legal issues regarding favoritism and corruption, leading to a negative portrayal in the article.", "headline": "La Diputación de Villaejemplo consolida la plaza a medida para el ex asesor de Moncloa amigo del \"hermanito\" de Ejemplo", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "fraud", "prevaricación", "tráfico de influencias", "irregularidades", "trato de favor" ], "sentiment_score": -2, "publication_date": "2025-06-10T20:46:38" }, { "country": "spain", "summary": "Javier Ejemplo Modelo is mentioned in connection with Carlos Ficticio's corruption case, indicating his involvement in alleged influence peddling.", "headline": "España, paraíso del aforado", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "prevaricación", "tráfico de influencias", "corrupción", "impunidad", "privilegio", "desconfianza", "manipulación", "fraude de ley" ], "sentiment_score": -2, "publication_date": "2025-06-10T05:05:34" }, { "country": "spain", "summary": "Javier Ejemplo Modelo is implicated in the same investigation as Ficticio, which raises questions about his conduct and political ethics.", "headline": "Aforamientos: esa figura incómoda", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "prevaricación", "tráfico de influencias", "investigación", "juicio", "fraude de ley", "desprestigio", "crisis de confianza", "delitos" ], "sentiment_score": -2, "publication_date": "2025-06-08T06:01:00" }, { "country": "spain", "summary": "Javier Ejemplo is implicated in a legal investigation regarding irregularities in his hiring, which raises serious concerns about his conduct.", "headline": "La jueza del 'caso Javier Ejemplo' denuncia un «fraude de ley» en el aforamiento de Ficticio (Partido Ejemplo)", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "fraud", "irregularities", "prevaricación", "tráfico de influencias" ], "sentiment_score": -2, "publication_date": "2025-06-09T10:19:10" }, { "country": "spain", "summary": "Javier Ejemplo Modelo is mentioned in connection with legal allegations of corruption, contributing to a negative perception.", "headline": "'Caso aforamiento': la letrada mayor de la Asamblea certifica a la juez que Ficticio es diputado desde antes de prometer su cargo en el Pleno", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "prevaricación", "tráfico de influencias" ], "sentiment_score": -2, "publication_date": "2025-06-09T08:08:30" }, { "country": "spain", "summary": "Javier Ejemplo Modelo is implicated in the same investigation as Ficticio, raising concerns about political corruption and influence.", "headline": "Aforamientos: esa figura incómoda", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "prevaricación", "tráfico de influencias", "investigación" ], "sentiment_score": -2, "publication_date": "2025-06-08T06:01:00" }, { "country": "spain", "summary": "Javier Ejemplo Modelo is implicated in the same investigation as Ficticio, which raises concerns about political misconduct.", "headline": "Aforamientos: esa figura incómoda", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "prevaricación", "tráfico de influencias", "investigación", "delitos" ], "sentiment_score": -2, "publication_date": "2025-06-08T06:00:59" }, { "country": "spain", "summary": "Javier Ejemplo is implicated in a case of favoritism and corruption, which casts a negative light on his character and actions.", "headline": "'Caso Javier Ejemplo': las asociaciones judiciales salen en defensa de la juez Luisa Inventada ante las \"presiones externas\" que sufre", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "favoritism", "corruption", "persecution" ], "sentiment_score": -2, "publication_date": "2025-06-06T10:08:15" }, { "country": "spain", "summary": "Javier Ejemplo is implicated in a case of alleged favoritism and corruption, which casts a negative light on his character and actions.", "headline": "'Caso Javier Ejemplo': las asociaciones judiciales salen en defensa de la juez Luisa Inventada ante las \"presiones externas\" que sufre", "sentiment": "moderately negative", "thumbnail": "https://news.example.org/articles/sample", "source_url": "https://news.example.org/articles/sample", "author_name": null, "other_sources": [], "adverse_keywords": [ "favoritism", "corruption", "persecution" ], "sentiment_score": -2, "publication_date": "2025-06-06T08:08:15" } ], "additional_information": {} } ], "score": 80, "screened_data": { "full_name": "Javier Ejemplo Modelo", "nationality": "ES", "date_of_birth": "1974-01-01", "document_number": null }, "is_ongoing_monitoring_enabled": true, "next_ongoing_monitoring_bill_date": "2026-07-24", "last_ongoing_screening_at": "2026-09-12T04:03:11Z", "last_ongoing_screening_datasets_updated_at": "2026-09-11T06:00:00Z", "warnings": [ { "feature": "AML", "risk": "POSSIBLE_MATCH_FOUND", "additional_data": null, "log_type": "warning", "short_description": "Possible match found in AML screening", "long_description": "The Anti-Money Laundering (AML) screening process identified potential matches with watchlists or high-risk databases, requiring further review.", "node_id": "feature_aml_1" } ] } ], "ip_analyses": [ { "node_id": "feature_ip_1", "status": "Approved", "device_brand": "Apple", "device_model": "iPhone", "browser_family": "Mobile Safari", "os_family": "iOS", "platform": "mobile", "device_fingerprint": "didit-fp-a1b2c3d4e5f6g7h8", "ip_country": "Spain", "ip_country_code": "ES", "ip_state": "Barcelona", "ip_city": "Barcelona", "latitude": 41.4022, "longitude": 2.1407, "ip_address": "83.50.226.71", "isp": null, "organization": null, "is_vpn_or_tor": false, "is_data_center": false, "time_zone": "Europe/Madrid", "time_zone_offset": "+0100", "ip": { "location": { "latitude": 40.2206327, "longitude": 1.5770097 }, "distance_from_id_document": 23.4, "distance_from_poa_document": 12.3 }, "id_document": { "location": { "latitude": 41.2706327, "longitude": 1.9770097 }, "distance_from_ip": 23.4, "distance_from_poa_document": 18.7 }, "poa_document": { "location": { "latitude": 41.2706327, "longitude": 1.9770097 }, "distance_from_ip": 12.3, "distance_from_id_document": 18.7 }, "warnings": [], "matches": [ { "session_id": "99999999-8888-7777-6666-555555555555", "session_number": 41205, "vendor_data": "22222222-2222-2222-2222-222222222222", "verification_date": "2024-07-20T10:15:30Z", "match_type": "ip_address", "match_source": "ip_address", "matched_value": "83.50.226.71", "status": "Approved", "is_blocklisted": false, "api_service": null, "source": "session", "device_info": { "device_brand": "Apple", "device_model": "iPhone", "browser_family": "Mobile Safari", "os_family": "iOS", "platform": "mobile", "device_fingerprint": "didit-fp-f9e8d7c6b5a40312" }, "location_info": { "ip_address": "83.50.226.71", "ip_country": "Spain", "ip_country_code": "ES", "ip_state": "Barcelona", "ip_city": "Barcelona", "is_vpn_or_tor": false, "is_data_center": false }, "confidence": 0.0, "match_mode": "co_occurrence" }, { "session_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "session_number": 42830, "vendor_data": "33333333-3333-3333-3333-333333333333", "verification_date": "2024-06-30T18:22:05Z", "match_type": "device_fingerprint", "match_source": "recovered_high", "matched_value": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "status": "Declined", "is_blocklisted": false, "api_service": null, "source": "session", "device_info": { "device_brand": "Samsung", "device_model": "SM-G991B", "browser_family": "Chrome Mobile", "os_family": "Android", "platform": "mobile", "device_fingerprint": null }, "location_info": { "ip_address": "83.50.231.18", "ip_country": "Spain", "ip_country_code": "ES", "ip_state": "Madrid", "ip_city": "Madrid", "is_vpn_or_tor": false, "is_data_center": false }, "confidence": 1.0, "match_mode": "deterministic", "recovery_similarity": 0.9874, "tls_ja4_corroborated": true, "recovery_gate_reason": "hardware_root_match" } ] } ], "database_validations": [ { "node_id": "feature_db_validation_1", "issuing_state": "BRA", "validation_type": "one_by_one", "screened_data": { "last_name": "De Lima", "first_name": "Fernando", "tax_number": "01234567890", "date_of_birth": "1980-01-01", "document_type": "ID", "expiration_date": "2030-01-01" }, "validations": [ { "service_id": "bra_cpf", "service_name": "Brazil - CPF status check", "outcome_code": "MATCH", "validation": { "full_name": "full_match", "date_of_birth": "full_match", "identification_number": "full_match" }, "source_data": { "identification_number": "01234567890", "first_name": "FERNANDO", "last_name": "DE LIMA", "date_of_birth": "1980-01-01", "gender": "M", "nationality": "BRA" } } ], "match_type": "full_match", "status": "Approved", "warnings": [] } ], "reviews": [ { "user": "compliance@example.com", "new_status": "Declined", "comment": "Possible match found in AML screening", "created_at": "2024-07-18T13:29:00.366811Z" } ], "created_at": "2024-07-24T08:54:25.443172Z", "expires_at": "2025-07-24T08:54:25.443172Z", "biometric_consent": { "required": false, "trigger": null, "status": "not_required", "given_at": null, "declined_at": null, "text_version": null, "text_hash": null, "locale": null, "policy_url": null, "step": null, "node_id": null, "ip_address": null, "ip_country_code": null, "ip_state": null, "ip_city": null, "user_agent": null, "detected_ip_address": "83.50.226.71", "detected_country_code": "ES", "detected_state": "ES-B", "detected_city": "Barcelona", "declared_state": null, "document_state": null, "jurisdictions": [], "retention_months": null, "reason": null, "decline_reason": null, "face_data_deleted_at": null } } }, "BusinessExample": { "summary": "Exemplo de sessão de empresa (KYB)", "description": "Uma decisão `session_kind = \"business\"`: as sessões KYB substituem os arrays de recursos de KYC por `registry_checks`, `document_verifications` e `key_people_checks`, enquanto compartilham `aml_screenings`, `phone_verifications`, `email_verifications`, `questionnaire_responses`, `ip_analyses`, `reviews` e o envelope da sessão.", "value": { "session_id": "66666666-7777-8888-9999-000000000000", "session_kind": "business", "session_number": 31415, "session_url": "https://verify.didit.me/session/business123", "status": "In Review", "environment": "live", "workflow_id": "abababab-cdcd-efef-0101-232323232323", "features": [ "KYB_REGISTRY", "KYB_DOCUMENTS", "KYB_KEY_PEOPLE" ], "vendor_data": "merchant-001234", "metadata": null, "callback": "https://example.com/verification/callback", "registry_checks": [ { "status": "Approved", "node_id": "feature_kyb_registry_1", "data_resolved": true, "company": { "uuid": "dddd4444-eeee-5555-ffff-666677778888", "node_id": "feature_kyb_registry_1", "status": "Approved", "registry_status": "active", "data_resolved": true, "company_name": "ACME HOLDINGS LTD", "registration_number": "12345678", "country_code": "GB", "region": null, "company_type": "Private Limited Company", "incorporation_date": "2015-03-12", "registered_address": "1 Example Street, London, EC1A 1AA", "tax_number": null, "risk_level": null, "verification_status": null, "is_from_registry": true, "fetch_status": "resolved", "alternative_names": null, "nature_of_business": "62012 - Business and domestic software development", "registered_capital": "100 GBP", "registered_capital_amount": "100.00", "registered_capital_currency": "GBP", "website": null, "email": null, "phone": null, "legal_entity_identifier": null, "location_of_registration": "England and Wales", "financial_summary": null, "officers": [ { "uuid": "aaaa1111-bbbb-2222-cccc-333344445555", "name": "Jane Smith", "designation": "Director", "role": "director", "nationality": "British", "is_active": true, "kyc_status": "Approved", "kyc_session_url": "https://verify.didit.me/session/abc123def456" } ], "beneficial_owners": [ { "uuid": "bbbb2222-cccc-3333-dddd-444455556666", "name": "John Doe", "first_name": "John", "last_name": "Doe", "entity_type": "person", "roles": [ "ubo", "shareholder" ], "ownership_min_shares": "50", "ownership_max_shares": "75", "is_active": true, "kyc_status": "Pending", "kyc_session_url": "https://verify.didit.me/session/def456ghi789", "effective_ownership_percent": 75.0 } ], "addresses": [ { "type": "registered", "address": "1 Example Street, London, EC1A 1AA", "country": "GB" } ], "industries": [ { "code": "62012", "description": "Business and domestic software development" } ], "accounts": null, "registry_data": {}, "user_provided_data": { "company_name": "ACME HOLDINGS", "registration_number": "12345678" }, "confirmed_by_user_at": "2026-06-10T12:01:30.000000Z", "last_console_edit_at": null, "is_editable": false }, "ownership_structure": { "shareholders": [ { "name": "John Doe", "first_name": "John", "last_name": "Doe", "date_of_birth": null, "country_of_birth": null, "company_name": null, "registration_number": null, "entity_type": "person", "nationality": null, "designation": null, "roles": [ "shareholder" ], "ownership_min_shares": "75", "ownership_max_shares": "75", "voting_min_shares": null, "voting_max_shares": null, "appointment_date": null, "is_active": true, "shareholding": { "share_class": "ORDINARY", "number_of_shares": 750.0, "currency": "GBP", "nominal_value": 1.0, "total_value": null, "percentage": 75.0 } } ], "beneficial_owners": [] }, "warnings": [] } ], "aml_screenings": null, "document_verifications": [ { "status": "In Review", "node_id": "feature_kyb_documents_1", "items": [ { "uuid": "eeee5555-ffff-6666-0000-777788889999", "document_type": "LEGAL_PRESENCE", "document_subtype": "CERTIFICATE_OF_INCORPORATION", "document_group": "LEGAL_PRESENCE", "file_url": "https:///kyb/certificate-of-incorporation.pdf", "original_filename": "certificate_of_incorporation.pdf", "file_size": 482133, "status": "Approved", "created_at": "2026-06-10T12:03:11.000000Z", "cross_check_result": { "critical": { "company_name": { "document": "ACME HOLDINGS LTD", "registry": "ACME HOLDINGS LTD", "score": 1.0, "match": true }, "registration_number": { "document": "12345678", "registry": "12345678", "match": true } }, "non_critical": {}, "people": {} }, "document_metadata": { "file_size": 482133, "content_type": "application/pdf", "creation_date": "2015-03-12T09:00:00", "modified_date": "2015-03-12T09:00:00", "creator": null, "producer": null, "software": null, "encryption": null, "is_signed": true, "is_tampered": false, "signature_info": null, "exif_original_date": null, "exif_digitized_date": null, "processed_by_known_editor": false, "has_different_creation_mod_date": false, "overlay_manipulation": null }, "description": null, "is_requested": false, "ocr_data": { "company_name": "ACME HOLDINGS LTD", "registration_number": "12345678", "incorporation_date": "2015-03-12" }, "is_console_upload": false, "is_confirmed": true }, { "uuid": "ffff6666-0000-7777-1111-888899990000", "document_type": "OWNERSHIP_STRUCTURE", "document_subtype": null, "document_group": "OWNERSHIP_STRUCTURE", "file_url": null, "original_filename": null, "file_size": null, "status": "Not Finished", "created_at": "2026-06-10T15:40:02.000000Z", "cross_check_result": null, "document_metadata": null, "description": "Please upload an up-to-date shareholder registry", "is_requested": true, "ocr_data": null, "is_console_upload": false, "is_confirmed": true } ], "groups": { "LEGAL_PRESENCE": { "total": 1, "approved": 1, "pending": 0, "declined": 0, "in_review": 0, "other": 0, "missing": 0 }, "OWNERSHIP_STRUCTURE": { "total": 1, "approved": 0, "pending": 0, "declined": 0, "in_review": 0, "other": 0, "missing": 1 } }, "required_groups": [ "LEGAL_PRESENCE", "OWNERSHIP_STRUCTURE" ], "warnings": [] } ], "key_people_checks": [ { "status": "In Review", "node_id": "feature_kyb_key_people_1", "registry": { "officers": [ { "uuid": "aaaa1111-bbbb-2222-cccc-333344445555", "name": "Jane Smith", "designation": "Director", "role": "director", "nationality": "British", "appointment_date": "2015-03-12", "termination_date": null, "is_active": true, "address": "1 Example Street, London, EC1A 1AA", "aml_status": "Approved", "kyc_status": "Approved", "kyc_session_url": "https://verify.didit.me/session/abc123def456", "kyc_session_id": "77777777-8888-9999-aaaa-bbbbbbbbbbbb", "verification_workflow_type": "kyc", "verification_workflow_id": "12121212-3434-5656-7878-909090909090", "verification_workflow_label": "Key People KYC", "verification_workflow_features": [ { "feature": "ID_VERIFICATION", "status": "Approved" }, { "feature": "LIVENESS", "status": "Approved" }, { "feature": "AML", "status": "Approved" } ], "didit_internal_id": "99999999-0000-1111-2222-333333333333", "kyc_document_type": "P", "kyc_nationality": "GBR", "kyc_liveness_passed": true, "kyc_verified_at": "2026-06-10T14:22:31.123456Z", "kyc_aml_categories": { "sanctions": "clear", "pep": "clear", "adverse_media": "clear", "warnings": "clear" }, "kyc_notification_sent_at": "2026-06-09T09:00:00.000000Z" } ], "beneficial_owners": [ { "uuid": "bbbb2222-cccc-3333-dddd-444455556666", "name": "John Doe", "first_name": "John", "last_name": "Doe", "date_of_birth": "1980-05-04", "country_of_birth": null, "email": null, "company_name": null, "registration_number": null, "entity_type": "person", "nationality": "British", "designation": null, "roles": [ "ubo", "shareholder" ], "ownership_min_shares": "50", "ownership_max_shares": "75", "is_active": true, "aml_status": null, "kyc_status": "In Progress", "kyc_session_url": "https://verify.didit.me/session/def456ghi789", "kyc_session_id": "88888888-9999-aaaa-bbbb-cccccccccccc", "verification_workflow_type": "kyc", "verification_workflow_id": "12121212-3434-5656-7878-909090909090", "verification_workflow_label": "Key People KYC", "verification_workflow_features": [ { "feature": "ID_VERIFICATION", "status": "Not Finished" }, { "feature": "LIVENESS", "status": "Not Finished" }, { "feature": "AML", "status": "Not Finished" } ], "didit_internal_id": null, "kyc_document_type": null, "kyc_nationality": null, "kyc_liveness_passed": null, "kyc_verified_at": null, "kyc_aml_categories": null, "kyc_notification_sent_at": null, "child_beneficial_owners": [], "effective_ownership_percent": 75.0 } ] }, "submitted": { "parties": [ { "uuid": "cccc3333-dddd-4444-eeee-555566667777", "entity_type": "person", "source": "USER", "name": "John Doe", "first_name": "John", "last_name": "Doe", "company_name": null, "registration_number": null, "email": "john.doe@example.com", "nationality": "GBR", "phone_number": "+447700900123", "date_of_birth": "1980-05-04", "position": "Chief Executive Officer", "custom_fields": {}, "is_active": true, "is_skipped": false, "requires_verification": true, "roles": [ { "role": "ubo", "ownership_percent": 75.0, "voting_percent": 75.0 }, { "role": "director", "ownership_percent": null, "voting_percent": null } ], "kyc_session_id": "88888888-9999-aaaa-bbbb-cccccccccccc", "kyc_session_status": "In Progress", "kyc_session_url": "https://verify.didit.me/session/def456ghi789", "kyb_sub_session_id": null, "kyb_sub_session_status": null, "kyb_sub_session_url": null, "verification_workflow_type": "kyc", "verification_workflow_id": "12121212-3434-5656-7878-909090909090", "verification_workflow_label": "Key People KYC", "verification_workflow_features": [ { "feature": "ID_VERIFICATION", "status": "Not Finished" }, { "feature": "LIVENESS", "status": "Not Finished" }, { "feature": "AML", "status": "Not Finished" } ], "didit_internal_id": null } ] }, "ubo_kyc_summary": { "total": 1, "approved": 0, "flagged": 0, "pending": 1 }, "warnings": [] } ], "phone_verifications": null, "email_verifications": null, "questionnaire_responses": null, "ip_analyses": null, "reviews": [], "contact_details": null, "expected_details": { "company_name": "Tesco PLC", "registry_country": "GB", "registration_number": "00445790" }, "created_at": "2026-06-10T11:58:04.000000Z", "expires_at": "2026-06-24T11:58:04.000000Z" } } }, "schema": { "$ref": "#/components/schemas/SessionDecision" } } } }, "403": { "description": "Falha de autenticação ou autorização. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`. Duas strings de `detail` distinguem os modos de falha:\n\n- `\"Authentication credentials were not provided or are invalid.\"` — não há cabeçalho `x-api-key` (nem token `Authorization: Bearer`), ou a credencial fornecida falhou na introspecção (revogada, expirada ou malformada).\n- `\"You do not have permission to perform this action.\"` — a credencial é válida, mas não tem permissão para ler esta sessão: um token Bearer de usuário do console não tem a permissão `read:sessions` ou não pode acessar a aplicação proprietária, ou uma chave de API pertence a uma organização diferente da sessão.\n\nObserve que, para um `sessionId` totalmente desconhecido, o endpoint resolve a aplicação proprietária antes de validar as credenciais; portanto, uma sessão inexistente retorna `404` mesmo quando a credencial está ausente ou é invá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": "Cabeçalho x-api-key ausente, ou a chave falhou na introspecção", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Insufficient permissions": { "summary": "Credencial válida sem read:sessions ou sem acesso à aplicação proprietária", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Sessão não encontrada. Retornado quando nenhuma sessão existente corresponde ao `sessionId` informado, seja como sessão de Verificação de usuários (KYC), seja como sessão de Verificação de empresas (KYB). Uma sessão que foi excluída também cai neste caso. O corpo é o envelope padrão `{\"detail\": ...}`.\n\n**Duas strings `detail` distintas.** Se o `sessionId` for desconhecido tanto como sessão KYC quanto como sessão KYB, a consulta do proprietário antes da autenticação falha e você recebe `{\"detail\": \"Not found.\"}`. Isso acontece antes da validação de credenciais, portanto é retornado até mesmo em chamadas não autenticadas. Se a sessão existir, mas não puder ser recuperada na aplicação autenticada (por exemplo, um registro desatualizado ou recém-excluído), a view retorna `{\"detail\": \"Session not found.\"}`. Ambos indicam o mesmo resultado (a sessão não está acessível), então use o código de status `404` para identificar o caso, e não a string.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Not found." } } }, "examples": { "Unknown session id": { "summary": "sessionId é desconhecido para esta aplicação", "value": { "detail": "Not found." } }, "Session not retrievable": { "summary": "A sessão existe, mas não pode ser recuperada por esta aplicação", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Limite de requisições excedido. As requisições GET são limitadas a **600 por minuto por credencial** (chave de API, token Bearer ou IP de origem quando não autenticado). Verifique `Retry-After` / `X-RateLimit-Reset` e aguarde antes de tentar novamente. Se você atingir esse limite ao consultar decisões periodicamente (polling), passe a usar o webhook `status.updated` e busque a decisão uma vez a cada mudança de status.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente a requisição.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Número máximo de requisições permitidas na janela atual (600 para requisições GET).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Timestamp Unix (segundos) em que a janela atual é reiniciada.", "schema": { "type": "integer", "example": 1750000000 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Explicação legível da violação do limite de requisições.", "example": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } }, "examples": { "Throttled": { "summary": "Mais de 600 requisições GET em um minuto com a mesma 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 da sessão de verificação cuja decisão você deseja obter. É o `session_id` retornado por `POST /v3/session/`. O mesmo caminho funciona para sessões de Verificação de usuários (KYC) e de Verificação de empresas (KYB): o servidor resolve o id entre os dois tipos de sessão.\n\n**Deve ser um UUID válido.** A rota só corresponde a UUIDs bem formados, então um valor malformado é rejeitado pelo roteador de URLs antes que qualquer código da aplicação seja executado, e a resposta é uma página **HTML** `404` em vez do envelope JSON `{\"detail\": ...}` mostrado abaixo. Valide o formato do UUID no lado do cliente para distinguir um erro de entrada de um `404` real de sessão inexistente.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "include", "in": "query", "required": false, "description": "Lista separada por vírgula de seções extras do payload. Valores aceitos: `events` e `resubmissions`, isoladamente ou juntos (`events,resubmissions`). Quando `include=events` é enviado, a resposta também contém a linha do tempo de eventos da sessão (`events`, incluindo os eventos de roteamento `WORKFLOW_BRANCH_EVALUATED` / `WORKFLOW_STATUS_NODE_REACHED` descritos na página Retrieve Session), o registro completo de atividades (`activity_reviews`), as sinalizações da lista de bloqueio (`blocklisted`), um `cost_breakdown` por sessão, metadados do fluxo (`workflow_type`, `workflow_version`, `workflow_version_id` e `workflow_terminal_node_id` - o último nó de status do fluxo registrado que definiu um status da sessão, ou `null` se nenhum tiver sido registrado; é uma proveniência histórica que não é apagada por aprovações, recusas ou reenvios manuais e é substituída por um nó de status do fluxo posterior) e metadados da sessão (`api_service` — string ou `null`, definido apenas para sessões de API independente; `session_type` — `API`, `HOSTED` ou `MIGRATED`; `has_device_nfc_support` — booleano). Dois campos mudam em relação ao formato simples: o discriminador `session_kind` de nível superior é **omitido** (o formato com eventos só existe para sessões de usuário), e o array `features` passa de strings simples para objetos `{feature, node_id}` — nos quais o recurso de e-mail aparece como `EMAIL` em vez de `EMAIL_VERIFICATION`. Esse formato expandido é usado principalmente pelo Didit Console; a maioria das integrações de API deve omitir o parâmetro. **Limitação de KYB:** `include=events` só se aplica a sessões de usuário (KYC). Sessões de empresa (`session_kind = \"business\"`) sempre retornam o formato padrão de decisão de empresa — `events`, `activity_reviews`, `blocklisted`, `cost_breakdown` e os metadados extras de `workflow_*`/sessão nunca são retornados para sessões de empresa, e o array `features` delas continua sendo um array de strings simples. Com `include=resubmissions` (tanto em sessões de usuário quanto de empresa), a resposta também contém `resubmissions`: uma entrada por solicitação de reenvio, da mais antiga para a mais recente, cada uma com `number`, `created_at`, `previous_status`, `nodes`, `reasons`, `requested_by` e `results` (o que as etapas reenviadas retornaram antes da solicitação, com as mesmas chaves e no mesmo formato dos resultados atuais). Cada item de `cost_breakdown` contém `usage_type`, `price`, `details` e `created_at`: uma etapa reenviada que é executada novamente é cobrada como um novo item.", "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": "Excluir uma sessão de verificação (KYC ou KYB)", "description": "Exclua uma única sessão de verificação, de Verificação de usuários (KYC) ou de Verificação de empresas (KYB), pelo seu `session_id`. O id é procurado primeiro entre as sessões KYC e depois entre as sessões KYB, então os dois tipos são excluídos por esta mesma URL.\n\n**O que é excluído:**\n- A sessão e todas as tentativas de verificação que ela contém, incluindo resultados substituídos por um reenvio: a decisão, os dados extraídos, todos os registros de recursos relacionados (verificação de identidade, rosto, prova de vida, correspondência facial, AML, consultas a registros, análise de IP etc.), suas revisões e seu registro de atividades.\n- Todos os arquivos armazenados que pertencem à sessão: fotos da frente e do verso do documento (versões completa, recortada e desfocada para privacidade), vídeos de captura do documento, recortes de retrato, imagens do retrato e da assinatura do chip NFC, imagens faciais de referência, vídeos de prova de vida, imagens de origem e de destino da correspondência facial, documentos de Comprovante de endereço e quaisquer arquivos extras enviados (KYC); documentos da empresa enviados e arquivos extras (KYB). Documentos de assinatura eletrônica, PDFs assinados, PDFs de evidências e imagens de assinatura (KYC e KYB): seus caminhos de download deixam de funcionar. URLs de mídia emitidas anteriormente (`https:///...`) deixam de ser resolvidas.\n- Os dados faciais da sessão. O embedding facial também é excluído, a menos que você opte por manter um template biométrico sem imagem (consulte **Dados biométricos faciais**).\n- Entregas de webhook ainda na fila para a sessão e suas novas tentativas. Webhooks já entregues não são afetados.\n- Para uma sessão de Verificação de empresas (KYB): as verificações que ela criou para suas pessoas-chave (KYC) e seus proprietários corporativos (KYB), de forma recursiva, informadas como `deleted_child_verifications`. Uma verificação à qual ela apenas se vincula, como um KYC aprovado existente que foi reutilizado, não é excluída.\n\nA sessão desaparece imediatamente de todos os endpoints de leitura: `GET /v3/session/{sessionId}/decision/` retorna `404` e `GET /v3/sessions/` deixa de listá-la. O monitoramento AML contínuo e o monitoramento de registro KYB iniciados pelas verificações excluídas são interrompidos.\n\n**O que não é afetado:** as entradas da lista de bloqueio criadas a partir desta sessão (rosto ou documento) **não** são removidas; gerencie-as com os endpoints da lista de bloqueio. Os tokens de compartilhamento emitidos para a sessão não são revogados, mas não resta nada para eles importarem: uma importação com um deles retorna `400` com `{\"share_token\": [\"Original session does not exist.\"]}`. Os créditos já consumidos **não** são reembolsados. A entidade pai, de usuário ou de empresa, **não** é excluída; para isso, use `POST /v3/users/delete/` ou `POST /v3/businesses/delete/`. Se o retrato do perfil do usuário veio desta sessão, o retrato é removido junto com ela.\n\n**Dados biométricos faciais:** por padrão, o embedding facial da sessão é excluído com a sessão (`face_retention_outcome: deleted`). Uma aplicação que aderiu à retenção de templates biométricos (`face_retention_policy: retain_until_user_deleted` em `PATCH /v3/webhook/`), ou uma requisição com `retain_face_embeddings: true`, mantém um template biométrico facial sem imagem, gerenciado separadamente e vinculado ao usuário da sessão (`retained_with_user`), para que a detecção de duplicatas, a Busca facial e a autenticação biométrica continuem funcionando. O template nunca contém a imagem do rosto, mídias, campos de identidade, a decisão nem o id da sessão excluída; ele é um dado biométrico excluído em `biometric_template_expires_at`, ou antes disso, na exclusão do usuário, em um apagamento por privacidade ou em uma remoção explícita por meio de `/v3/biometric-templates/`. Uma sessão sem usuário vinculado não pode reter um template (`ineligible_no_vendor_user`). Envie `deletion_instruction: privacy_erasure` para solicitações de titulares de dados: isso remove todos os templates retidos desse usuário e nunca retém um novo.\n\n**Irreversível:** a exclusão é permanente e não existe endpoint de restauração. Exporte tudo o que precisar (por exemplo, um PDF da decisão) antes de chamá-lo.\n\n**Efeitos colaterais:** nenhum webhook é emitido para exclusões.\n\n**Resposta:** `200 OK` assim que a exclusão é concluída, com um corpo JSON que informa o `face_retention_outcome`, a validade do template retido e, para uma sessão KYB, `deleted_child_verifications`. Versões anteriores deste endpoint retornavam `204 No Content`; atualize os clientes que verificam `204`. Guarde o seu `instruction_id` no seu próprio registro de apagamentos.\n\n**Idempotência:** não é idempotente no nível HTTP: a primeira chamada retorna `200`; repeti-la retorna `404`, porque a sessão não é mais encontrada. Após um `503`, a sessão continua existindo; repita a mesma requisição para concluir a exclusão.\n\n**Autenticação:** envie a chave de API da sua aplicação no cabeçalho `x-api-key`; a sessão deve pertencer a essa aplicação. Tokens de acesso de usuários do console (`Authorization: Bearer ...`) também podem chamar este endpoint quando tiverem a permissão `delete:sessions`. Falhas de autenticação e de permissão retornam `403`; esta API nunca retorna `401`.\n\n**Limite de requisições:** cota de escrita compartilhada de 300 requisições/min por chave de API em todos os endpoints POST/PATCH/DELETE; ultrapassá-la retorna `429`.\n\nPara excluir sessões KYC em massa pelo seu `session_number` numérico, use `POST /v3/sessions/delete/`.\n\n**Relatórios regulatórios registrados:** se os dados selecionados estiverem em um relatório regulatório finalizado, toda a requisição é recusada com `409` e nada é excluído. O corpo usa `code: in_filed_report` e identifica cada relatório com `uuid`, `report_number`, `report_type` e `case_uuid`. Exclua os relatórios e depois repita a requisição.", "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`) da sessão de Verificação de usuários (KYC) ou de Verificação de empresas (KYB) a ser excluída, conforme retornado na criação da sessão. Deve ser um UUID canônico com hifens: um valor que não seja UUID não corresponde à rota e retorna `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "responses": { "200": { "description": "Sessão excluída. O corpo informa o que aconteceu com os dados biométricos faciais da sessão e, para uma sessão KYB, quantas verificações criadas por ela foram excluídas junto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "A sessão excluída." }, "session_number": { "type": "integer", "nullable": true, "description": "O número da sessão excluída." }, "face_retention_outcome": { "type": "string", "enum": [ "retained_with_user", "deleted", "none", "ineligible_no_vendor_user" ], "description": "O que aconteceu com os dados biométricos faciais da sessão. `deleted`: o embedding facial foi excluído junto com a sessão (padrão). `retained_with_user`: a sessão é excluída e um template biométrico sem imagem permanece vinculado ao User; veja `biometric_template_uuid`. `none`: a sessão não tinha embedding facial (por exemplo, uma sessão de KYB ou uma sessão de KYC sem selfie de prova de vida). `ineligible_no_vendor_user`: a retenção foi solicitada, mas a sessão não tem um User vinculado, então o embedding foi excluído junto com a sessão. Uma falha no armazenamento biométrico nunca é informada por este campo neste endpoint: ele retorna `503` e a sessão não é excluída." }, "biometric_template_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Id do template biométrico retido quando `face_retention_outcome` é `retained_with_user`; caso contrário, `null`. Gerencie-o por meio de `/v3/biometric-templates/{template_uuid}/`." }, "biometric_template_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o template biométrico retido é excluído, quando `face_retention_outcome` é `retained_with_user`; `null` quando nenhum template é retido." }, "deleted_child_verifications": { "type": "integer", "description": "Para uma sessão de Verificação de empresas (KYB): quantas verificações criadas por ela (as sessões de KYC das suas pessoas-chave e as sessões de KYB dos seus proprietários corporativos, recursivamente) foram excluídas junto com ela. Sempre `0` para uma sessão 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": "Retenção solicitada em uma sessão criada sem 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": "Uma verificação de empresa excluída junto com as três verificações que ela criou para suas pessoas-chave" } } } } }, "400": { "description": "Erro de validação: nada é excluído.", "content": { "application/json": { "examples": { "Privacy erasure cannot retain": { "value": { "retain_face_embeddings": [ "Privacy erasure cannot retain biometric templates." ] } }, "No finite retention duration": { "summary": "Retenção solicitada sem face_retention_days na requisição ou na aplicação", "value": { "detail": "A finite biometric-template retention duration is required." } } } } } }, "403": { "description": "Falha de autenticação ou de permissão. Uma chave ausente também retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`. Exceção: quando o `sessionId` não corresponde a uma sessão ativa, a busca do proprietário feita antes da autenticação retorna `404` primeiro, mesmo com credenciais ausentes ou inválidas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid API key": { "summary": "Cabeçalho x-api-key ausente, ou a chave é inválida", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Insufficient permission": { "summary": "Token de usuário sem delete:sessions, ou credenciais de uma aplicação que não é proprietária da sessão", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhuma sessão de KYC ou KYB ativa com este `session_id`: o id é desconhecido ou a sessão já foi excluída (repetir uma exclusão bem-sucedida cai aqui).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not Found": { "summary": "Sessão desconhecida ou já excluída", "value": { "detail": "Not found." } } } } } }, "429": { "description": "Limite de requisições de escrita compartilhado excedido (300 requisições POST/PATCH/DELETE por minuto por chave de API). Verifique o `Retry-After` e os cabeçalhos de resposta `X-RateLimit-*` antes de tentar novamente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Orçamento de escrita esgotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } }, "503": { "description": "A exclusão não pôde ser concluída porque um serviço de armazenamento, um repositório biométrico ou um provedor de monitoramento estava indisponível. A sessão continua existindo; repita a mesma requisição até que ela retorne `200`. Alguns dos arquivos armazenados ou o embedding facial dela podem já ter sido excluídos, então não dependa deles após um `503`. As novas tentativas convergem para um único template.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Session deletion unavailable": { "summary": "Um serviço de armazenamento ou um provedor de monitoramento estava indisponível", "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": "Um armazenamento biométrico ficou indisponível durante a retenção ou a exclusão de um template", "value": { "detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable." } } } } } }, "409": { "description": "A sessão faz parte de um relatório regulatório finalizado. Nada é excluído.", "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. Omita o corpo inteiro para seguir a política de retenção da aplicação com uma exclusão operacional.", "content": { "application/json": { "schema": { "type": "object", "properties": { "retain_face_embeddings": { "type": "boolean", "nullable": true, "description": "Substitui a `face_retention_policy` da aplicação para esta exclusão. `true` mantém um template biométrico facial sem imagem vinculado ao User da sessão após a exclusão da sessão; `false` exclui o embedding facial junto com a sessão; omita ou use `null` para seguir a política da aplicação. Ignorado para sessões KYB e para sessões sem embedding facial.", "example": true }, "face_retention_days": { "type": "integer", "minimum": 1, "maximum": 3650, "description": "Duração finita de retenção, em dias, de um template biométrico retido. Obrigatório quando um template é retido, a menos que a aplicação já defina `face_retention_days`. O `expires_at` do template é o mais próximo entre essa duração, o período geral de retenção de dados da aplicação e `face_retention_deadline`.", "example": 365 }, "face_retention_deadline": { "type": "string", "format": "date-time", "description": "Expiração definitiva opcional para um template retido. Deve estar no futuro.", "example": "2027-08-28T00:00:00Z" }, "deletion_instruction": { "type": "string", "enum": [ "operational_session_delete", "privacy_erasure" ], "default": "operational_session_delete", "description": "A classe de instrução que você está dando. `operational_session_delete` exclui a sessão e retém um template apenas quando a política ou `retain_face_embeddings` assim determina. `privacy_erasure` elimina todos os templates biométricos retidos vinculados ao User da sessão antes de excluir a sessão, não pode ser substituído pela política da aplicação e não pode ser combinado com `retain_face_embeddings: true` (`400`).", "example": "operational_session_delete" }, "instruction_id": { "type": "string", "maxLength": 255, "description": "Sua referência permanente para esta instrução de exclusão (por exemplo, o ID de um ticket de apagamento). Registrada na trilha de auditoria e em qualquer template retido. Gerada pela Didit quando omitida.", "example": "dsar-2026-0142" } } }, "examples": { "Retain a biometric template": { "summary": "Excluir a sessão e manter um template sem imagens por 365 dias", "value": { "retain_face_embeddings": true, "face_retention_days": 365, "instruction_id": "post-approval-cleanup-2026-08" } }, "Force deletion on an opted-in application": { "summary": "Excluir o embedding facial independentemente da política da aplicação", "value": { "retain_face_embeddings": false } }, "Privacy erasure": { "summary": "Solicitação do titular dos dados: excluir a sessão e eliminar todos os modelos retidos dessa pessoa", "value": { "deletion_instruction": "privacy_erasure", "instruction_id": "dsar-2026-0142" } } } } } } } }, "/v3/session/{sessionId}/generate-pdf/": { "get": { "summary": "Baixar um relatório em PDF de uma sessão de verificação", "description": "Gera e baixa um relatório em PDF pronto para conformidade de uma sessão de verificação finalizada. O mesmo caminho atende tanto sessões de Verificação de usuários (KYC) quanto de Verificação de empresas (KYB): o servidor resolve o `sessionId` nos dois tipos de sessão e escolhe o modelo de relatório correspondente.\n\n**Status elegíveis.** A sessão já deve ter um status final ou passível de revisão:\n\n- Sessões KYC: `Approved`, `Declined`, `In Review` ou `Kyc Expired`.\n- Sessões KYB: `Approved`, `Declined` ou `In Review`.\n\nQualquer outro status (`Not Started`, `In Progress`, `Expired`, `Abandoned`, …) retorna `403` com uma string `detail` explicativa; veja a resposta `403` abaixo.\n\n**O que o relatório contém.** O PDF reproduz a visualização da sessão no console no momento da requisição:\n\n- **KYC**: status consolidado da sessão, a lista de avisos e uma seção por recurso executado: Verificação de identidade (imagens do documento e campos extraídos), NFC, Prova de vida, Correspondência facial, Verificação de e-mail, Verificação de telefone, Comprovante de endereço, respostas de Questionários, Validação de banco de dados, Análise AML e Análise de IP, seguidas das tags da sessão, da atividade de revisão no console (comentários e mudanças de status) e da linha do tempo de eventos da sessão.\n- **KYB**: verificações em registros (dados da empresa), análises AML, verificações de documentos da empresa, verificações de pessoas-chave, respostas de questionários, verificações de telefone/e-mail, análises de IP e a linha do tempo de eventos da sessão, seguidas das tags e da atividade de revisão.\n\n**Marca.** Se a sua aplicação tiver personalização de marca própria, o relatório é gerado com o seu logotipo e links para a URL da sua política de privacidade; caso contrário, ele traz a marca Didit. Os relatórios são gerados em inglês; não há parâmetro de idioma.\n\n**Sem cache.** Cada chamada gera novamente o PDF a partir dos dados atuais da sessão, portanto um relatório gerado após uma revisão manual reflete a decisão do revisor. Duas chamadas para a mesma sessão podem produzir arquivos com bytes diferentes; arquive o arquivo baixado se precisar de uma cópia imutável.\n\n**Latência.** A geração baixa todas as imagens armazenadas (lados do documento, selfies, arquivos extras) antes de compor o PDF, portanto sessões com muita mídia podem levar vários segundos. Use um tempo limite de leitura generoso no cliente (60 s recomendados) e grave o corpo da resposta em disco por streaming.\n\n**Barra final.** A rota canônica termina com uma barra final (`…/generate-pdf/`). Uma requisição sem ela é atendida diretamente com a mesma resposta: não há redirecionamento `301`, então nenhum cliente precisa seguir redirecionamentos e o `curl` não precisa de `-L`. Use a URL com barra, como nos exemplos.\n\nSe você precisar dos dados subjacentes em JSON em vez de um relatório gerado, use `GET /v3/session/{sessionId}/decision/`. Para reunir todas as sessões reportáveis de um usuário em um único documento, use `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 da sessão de Verificação de usuários (KYC) ou de Verificação de empresas (KYB) a ser renderizada: o `session_id` retornado por `POST /v3/session/`. O mesmo caminho funciona para os dois tipos de sessão; use o nome de arquivo do `Content-Disposition` na resposta para saber qual tipo de relatório você recebeu.\n\n**Deve ser um UUID bem formado e em letras minúsculas.** A rota só corresponde a UUIDs válidos, então um valor malformado é rejeitado pelo roteador de URLs antes de qualquer código da aplicação ser executado, e a resposta é uma página **HTML** de `404` em vez do envelope JSON `{\"detail\": ...}` mostrado abaixo. O conversor de UUID da rota só corresponde à forma canônica em minúsculas: UUIDs com hexadecimais em maiúsculas são rejeitados com o 404 em HTML.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } } ], "responses": { "200": { "description": "O documento PDF renderizado, retornado diretamente como binário `application/pdf`: não há wrapper JSON nem indireção por URL de download. O corpo começa com os bytes mágicos `%PDF` (PDF 1.7). Salve-o em um arquivo `.pdf` ou transmita-o diretamente para quem fez a chamada.", "headers": { "Content-Disposition": { "description": "`attachment; filename=session_{sessionId}.pdf` para sessões de KYC, `attachment; filename=business_{sessionId}.pdf` para sessões de KYB. O prefixo indica qual modelo de relatório foi gerado.", "schema": { "type": "string", "example": "attachment; filename=session_11111111-2222-3333-4444-555555555555.pdf" } }, "Content-Length": { "description": "Tamanho total do PDF em bytes; o corpo não é dividido em partes (chunked).", "schema": { "type": "integer", "example": 25191 } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Falha de autenticação, autorização ou de status da sessão. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`. Diferencie os modos de falha pela string de `detail`:\n\n- `\"Authentication credentials were not provided or are invalid.\"` — não há cabeçalho `x-api-key` (nem token `Authorization: Bearer`), ou a credencial fornecida falhou na introspecção (revogada, expirada ou malformada).\n- `\"You do not have permission to perform this action.\"` — a credencial é válida, mas não pode ler esta sessão: um token Bearer de usuário do console não tem a permissão `read:sessions` ou não pode acessar a aplicação proprietária, ou uma chave de API pertence a uma organização diferente da sessão.\n- `\"You can only generate a PDF for sessions in review, declined, approved or kyc expired\"` — a sessão de KYC existe, mas ainda não está em um status elegível (por exemplo, `Not Started` ou `In Progress`). Aguarde o webhook `status.updated` antes de solicitar o relatório.\n- `\"You can only generate a PDF for sessions in review, declined or approved\"` — a mesma condição para sessões de KYB.\n\nObserve que, para um `sessionId` totalmente desconhecido, o endpoint resolve a aplicação proprietária antes de validar as credenciais; portanto, uma sessão inexistente retorna `404` mesmo quando a credencial está ausente ou é invá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": "Cabeçalho x-api-key ausente, ou a chave falhou na introspecção", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Insufficient permissions": { "summary": "Credencial válida sem read:sessions ou sem acesso à aplicação proprietária", "value": { "detail": "You do not have permission to perform this action." } }, "KYC session not finished": { "summary": "Sessão KYC ainda em Not Started / In Progress", "value": { "detail": "You can only generate a PDF for sessions in review, declined, approved or kyc expired" } }, "KYB session not finished": { "summary": "Sessão KYB ainda em Not Started / In Progress", "value": { "detail": "You can only generate a PDF for sessions in review, declined or approved" } } } } } }, "404": { "description": "Não existe nenhuma sessão ativa com este `sessionId`: ela nunca foi criada ou foi excluída. A identificação do proprietário acontece antes da validação das credenciais, então este `404` é retornado mesmo para requisições não autenticadas. Dependendo de qual consulta falha, a string `detail` é `\"Not found.\"` (o caso mais comum) ou `\"Session not found.\"`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Not found." } } }, "examples": { "Unknown session": { "summary": "sessionId não corresponde a nenhuma sessão de KYC ou KYB", "value": { "detail": "Not found." } }, "Recently deleted session": { "summary": "A sessão foi excluída entre as consultas", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Limite de requisições excedido. A geração de PDF tem um limite próprio de **50 requisições por minuto por credencial** (chave de API, token Bearer ou IP de origem quando não autenticado), além do limite global de 600/min para GET. Aguarde `Retry-After` segundos (também refletidos nos cabeçalhos `X-RateLimit-*`) e tente novamente. Os relatórios não ficam em cache no servidor, então baixe cada relatório uma vez e armazene o arquivo em vez de buscá-lo de novo.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente a requisição.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Número máximo de gerações de PDF permitidas na janela atual (50).", "schema": { "type": "integer", "example": 50 } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Timestamp Unix (segundos) em que a janela atual é reiniciada.", "schema": { "type": "integer", "example": 1750000000 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Explicação legível da violação do limite de requisições.", "example": "Session PDF generation rate limit exceeded. You can make up to 50 requests per minute." } } }, "examples": { "Throttled": { "summary": "Mais de 50 gerações de PDF em um minuto com a mesma 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": "Ativar um cenário de sandbox em uma sessão", "description": "Salva um cenário de sandbox em uma sessão `Not Started` e aplica à sessão os valores mágicos incluídos nele (e-mail, telefone ou campos de `expected_details`), para que os provedores simulados reproduzam o resultado do cenário quando o fluxo for executado. Este é o endpoint que o seletor de cenários pré-fluxo da interface de verificação hospedada da Didit chama quando um testador escolhe um resultado antes de iniciar a captura. Crie seu próprio seletor com base nele ou chame-o diretamente a partir de um ambiente de testes em sandbox.\n\nAutentique-se com o próprio `Session-Token` da sessão (retornado em `session_token` por [Criar sessão](/pt-br/sessions-api/create-session)), e não com o `x-api-key` da sua aplicação: este endpoint foi feito para ser chamado pelo cliente, não pelo seu backend. Um cenário só é aceito enquanto o `status` for `Not Started`. Chamá-lo novamente enquanto a sessão ainda estiver `Not Started` reconfigura a sessão: os valores mágicos do novo cenário são aplicados e apenas os valores gravados pelo cenário *anterior* são apagados, de modo que qualquer valor que o usuário já tenha digitado manualmente (e-mail, primeiro nome etc.) é mantido na reconfiguração. Configurar uma sessão que já passou de `Not Started`, ou que pertence a uma aplicação de produção (não sandbox), é rejeitado.\n\nConsulte [Sandbox e dados de teste](/pt-br/integration/sandbox-testing) para ver o catálogo completo de cenários e as outras duas formas de definir um resultado: `sandbox_scenario` na criação da sessão e a digitação direta de valores mágicos.", "operationId": "post_v3_session_sandbox_arm", "x-didit-sdk": { "resource": "sessions", "method": "arm_sandbox", "auth": "device_token", "server": false }, "tags": [ "Sessions" ], "security": [ { "SessionTokenAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID da sessão de verificação de sandbox a ser preparada. Deve corresponder à sessão codificada no Session-Token usado para autenticação.", "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 do cenário a ser ativado. Consulte o catálogo em GET /v1/sandbox/scenarios/ ou a tabela de cenários em [Sandbox e dados de teste](/pt-br/integration/sandbox-testing).", "example": "decline_document_expired" } } }, "examples": { "Arm": { "summary": "Ativar o cenário de ocorrência de PEP na AML", "value": { "scenario": "decline_aml_hit" } } } } } }, "responses": { "200": { "description": "Cenário armado. Seus valores mágicos agora estão na sessão. `status` reflete o status atual da sessão, que esta chamada nunca altera: em caso de sucesso, ele é sempre `Not Started`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid" }, "scenario": { "type": "string", "description": "O slug do cenário ativado (repete o valor da requisição)." }, "status": { "type": "string", "example": "Not Started" } } }, "examples": { "Armed": { "summary": "Cenário armado em uma sessão Not Started", "value": { "session_id": "11111111-2222-3333-4444-555555555555", "scenario": "decline_aml_hit", "status": "Not Started" } } } } } }, "400": { "description": "Erro de validação: slug de cenário desconhecido, ou a sessão já avançou além de `Not Started`.", "content": { "application/json": { "examples": { "Unknown Scenario": { "summary": "o cenário não está no catálogo", "value": { "scenario": [ "Unknown sandbox scenario: 'not-a-real-scenario'." ] } }, "Already Started": { "summary": "A sessão saiu do status Not Started", "value": [ "Scenario can only be armed before the verification starts." ] } } } } }, "404": { "description": "O Session-Token não corresponde a este `session_id`, ou a sessão pertence a uma aplicação de produção (não sandbox).", "content": { "application/json": { "examples": { "Not Found": { "summary": "Sessão de produção, ou session_id / token incompatíveis", "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": "Aprovar, recusar ou solicitar reenvio de uma sessão de verificação", "description": "Substitui manualmente a decisão final de uma sessão de verificação KYC ou KYB. Defina `new_status` como `Approved` ou `Declined` para registrar uma decisão manual, ou como `Resubmitted` para limpar etapas de verificação específicas e permitir que o usuário as refaça pela mesma URL de verificação. O endpoint aceita IDs de sessão tanto de usuário (KYC) quanto de empresa (KYB).\n\nChame-o depois que a sessão chegar a um estado revisável: o status atual deve ser `Approved`, `Declined`, `In Review`, `Kyc Expired`, `Abandoned` ou `Resubmitted`. Sessões que ainda estão em `Not Started`, `In Progress` ou `Awaiting User`, ou que terminaram como `Expired`, retornam `400`. Sua chave de API precisa da permissão `write:sessions` (uma chave de API com escopo precisa de acesso de escrita a decisões). A verificação de estado elegível é executada antes da validação do corpo, então uma sessão não elegível retorna o erro `Wrong Current Status` mesmo quando o payload também é inválido.\n\nPara `Resubmitted`, envie `nodes_to_resubmit` para escolher quais etapas do fluxo de verificação (workflow) o usuário deve refazer, ou omita-o para selecionar automaticamente as tentativas de recursos existentes em um estado que permite reenvio (`Declined`, `In Review`, `Not Finished`, `Expired`). Recursos nunca tentados não são selecionados automaticamente: liste-os explicitamente em `nodes_to_resubmit`, caso contrário a requisição retorna `400` quando nenhuma tentativa registrada precisa de reenvio. Os resultados anteriores das etapas selecionadas passam para o histórico do reenvio (retornado por Get Decision com `include=resubmissions`), as etapas são reordenadas de acordo com o grafo do fluxo, a janela de expiração da sessão é reiniciada e a URL de verificação original volta a poder ser usada. Etapas exclusivas do backend (`AML`, `DATABASE_VALIDATION`, `IP_ANALYSIS`) no início da lista são executadas imediatamente, sem interação do usuário; se todas as etapas reenviadas forem exclusivas do backend, a sessão é finalizada novamente na mesma requisição. `KYB_REGISTRY` e `KYB_KEY_PEOPLE` não podem ser reenviadas diretamente: reenvie as sessões KYC filhas correspondentes e a sessão de empresa principal é recalculada automaticamente.\n\nToda chamada que altera o status dispara o [webhook](/pt-br/integration/webhooks) `status.updated` assim que a alteração é confirmada e adiciona uma entrada de atividade (com a atribuição do autor e o seu `comment`) aos `reviews` da sessão, visível em [Get Decision](#get-/v3/session/-sessionId-/decision/) e na linha do tempo de atividades do console. Os agregados do perfil do usuário vinculados ao `vendor_data` da sessão também são atualizados. Recusar desativa o monitoramento AML contínuo da sessão; aprovar novamente o reativa (a partir de `Resubmitted`, `Declined` ou `Kyc Expired`) quando o fluxo tem o monitoramento ativado. Aprovar ou recusar uma sessão KYC filha que pertence a uma verificação de pessoas-chave de KYB recalcula o status da sessão de empresa principal. Defina `send_email: true` (com `email_address`) para notificar o usuário: um aviso de status para `Approved`/`Declined`, ou um e-mail de reenvio com o link de verificação e os motivos por etapa para `Resubmitted`. Para conferir o e-mail antes, visualize-o com [Preview Decision Email](/pt-br/sessions-api/preview-decision-email) (`Approved`, `Declined`) ou [Preview Resubmission Email](/pt-br/sessions-api/preview-resubmission) (`Resubmitted`) e envie o `preview_token` retornado como `email_preview_token`: a atualização então envia exatamente o e-mail visualizado, ou retorna `409` antes de alterar qualquer coisa quando o e-mail ou a sessão mudou desde a visualização ou quando o comprovante tem mais de 15 minutos.\n\nRepetir `Approved` ou `Declined` em uma sessão que já tem esse status não altera nada e retorna `200`: nenhum webhook, nenhuma entrada de atividade e nenhum e-mail. Repetir `Resubmitted` retorna `400` (`The new status is the same as the current status.`). Credenciais ausentes ou inválidas e permissões ausentes retornam `403`; uma chave de API com escopo expirada 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 da sessão de verificação a ser atualizada. Aceita IDs de sessão tanto de usuário (KYC) quanto de empresa (KYB): o serviço resolve o ID entre os dois tipos de sessão.", "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": "Status de destino. `Approved` e `Declined` registram uma decisão manual final (cada um também pode reverter o outro). `Resubmitted` limpa as etapas selecionadas e devolve a sessão ao usuário. Qualquer outro valor retorna `400`.", "enum": [ "Approved", "Declined", "Resubmitted" ], "example": "Approved" }, "comment": { "type": "string", "description": "Motivo da alteração em texto livre, armazenado no histórico de revisão da sessão e retornado no array `reviews` de [Get Decision](#get-/v3/session/-sessionId-/decision/). Por exemplo, `Duplicated user`.", "example": "All checks passed manual review" }, "nodes_to_resubmit": { "type": "array", "description": "Etapas do fluxo que o usuário precisa refazer. Só é considerado quando `new_status` é `Resubmitted`. Para `Approved`/`Declined`, as entradas continuam sendo validadas pelo schema (um valor de `feature` inválido retorna `400`), mas as entradas válidas no schema são ignoradas semanticamente. Se omitido, o servidor seleciona automaticamente as tentativas existentes de OCR, prova de vida, correspondência facial, comprovante de endereço, telefone, e-mail, AML, validação de banco de dados e questionário cujo status seja `Declined`, `In Review`, `Not Finished` ou `Expired` (tentativas de NFC, análise de IP, estimativa de idade, busca facial e documentos KYB nunca são selecionadas automaticamente; tentativas faciais que não sejam de correspondência facial são selecionadas como `LIVENESS`). Recursos que o usuário nunca tentou (sem tentativa registrada) NÃO são selecionados, portanto uma sessão sem nenhuma tentativa retorna `400` (\"No features found that need resubmission\") mesmo que nada tenha sido aprovado; nesse caso, envie `nodes_to_resubmit` explicitamente. As etapas são executadas na ordem do grafo do fluxo, independentemente da ordem em que você as enviar. `KYB_REGISTRY`, `KYB_KEY_PEOPLE` e o alias `KYB` são rejeitados com `400`: essas verificações-pai são recalculadas a partir das sessões KYC filhas.", "items": { "type": "object", "required": [ "node_id", "feature" ], "properties": { "node_id": { "type": "string", "description": "Identificador do nó conforme aparece na definição do fluxo de verificação (workflow) da sessão (por exemplo, `feature_ocr`, `feature_liveness`).", "example": "feature_ocr" }, "feature": { "type": "string", "description": "Tipo de recurso do nó. Os aliases `ID_VERIFICATION`, `POA`, `PHONE` e `EMAIL` são normalizados no servidor para `OCR`, `PROOF_OF_ADDRESS`, `PHONE_VERIFICATION` e `EMAIL_VERIFICATION`. `KYB_REGISTRY`, `KYB_KEY_PEOPLE` e `KYB` passam na validação do schema, mas são sempre rejeitados com o `400` de regra de negócio mostrado nos exemplos.", "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": "Se o usuário deve receber um e-mail sobre a alteração. Requer `email_address`. Para `Approved`/`Declined`, o usuário recebe uma notificação de status; para `Resubmitted`, o e-mail inclui o link de verificação e os motivos de reenvio de cada etapa.", "default": false, "example": false }, "email_address": { "type": "string", "format": "email", "description": "Destinatário do e-mail de notificação. **Obrigatório quando `send_email` é `true`** — omiti-lo retorna `400`.", "example": "user@example.com" }, "email_language": { "type": "string", "description": "Idioma do e-mail de notificação. Aceita qualquer string no nível do schema; códigos não suportados passam a usar inglês (`en`) sem aviso.", "default": "en", "example": "en" }, "email_preview_token": { "type": "string", "writeOnly": true, "minLength": 1, "maxLength": 512, "description": "Recibo opcional de [Preview Decision Email](/pt-br/sessions-api/preview-decision-email) (para `Approved` e `Declined`) ou de [Preview Resubmission Email](/pt-br/sessions-api/preview-resubmission) (para `Resubmitted`): seu `preview_token`. Válido apenas com `send_email: true`; sem isso, a requisição retorna `400`. O destinatário, o idioma, o status da sessão, o remetente e o e-mail (e, no caso de um reenvio, as etapas selecionadas) ainda devem corresponder à pré-visualização, e o recibo expira após 15 minutos. Caso contrário, a requisição retorna `409` antes que a sessão seja alterada ou que um e-mail seja enviado. Integrações existentes podem omitir este campo." } } }, "examples": { "Approve Session": { "summary": "Aprovar uma sessão após revisão manual", "value": { "new_status": "Approved", "comment": "All checks passed manual review" } }, "Decline Session": { "summary": "Recusar uma sessão", "value": { "new_status": "Declined", "comment": "Suspected fraud" } }, "Resubmit Specific Steps": { "summary": "Solicitar reenvio das etapas escolhidas, com e-mail", "value": { "new_status": "Resubmitted", "nodes_to_resubmit": [ { "node_id": "feature_ocr", "feature": "OCR" }, { "node_id": "feature_liveness", "feature": "LIVENESS" } ], "send_email": true, "email_address": "user@example.com", "email_language": "en" } }, "Resubmit Auto-select": { "summary": "Solicitar reenvio (seleciona automaticamente as etapas não aprovadas)", "value": { "new_status": "Resubmitted" } }, "Approve With Previewed Email": { "summary": "Aprovar e enviar o e-mail retornado por Preview Decision Email", "value": { "new_status": "Approved", "send_email": true, "email_address": "person@example.com", "email_language": "en", "email_preview_token": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } } } } } }, "responses": { "200": { "description": "Status atualizado. A resposta contém apenas o `session_id`; obtenha a sessão atualizada via [Get Decision](#get-/v3/session/-sessionId-/decision/). O webhook `status.updated` é disparado assim que a alteração é confirmada. Repetir `Approved` ou `Declined` retorna o mesmo corpo e não altera nada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "UUID da sessão atualizada." } } }, "examples": { "Updated": { "summary": "Retornado igualmente para Aprovado, Recusado e Reenviado", "value": { "session_id": "3472fb7c-8f7c-4d1a-9cf4-cf3d74ce1a60" } } } } } }, "400": { "description": "Erro de validação. Os erros de campo chegam como `{\"\": [\"\"]}` (algumas rejeições por regra de negócio usam uma string como valor: `{\"nodes_to_resubmit\": \"\"}`), os erros entre estados como `{\"detail\": \"\"}` e o erro de mesmo status como um array JSON simples.", "content": { "application/json": { "examples": { "Wrong Current Status": { "summary": "A sessão não está em um estado atualizável", "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 é um status de sessão real, mas não é Approved/Declined/Resubmitted", "value": { "new_status": [ "You can only update the status to 'Approved', 'Declined', or 'Resubmitted'." ] } }, "Missing new_status": { "summary": "Campo obrigatório omitido", "value": { "new_status": [ "This field is required." ] } }, "Same Status": { "summary": "Reenvio solicitado em uma sessão que já está em Resubmitted", "value": [ "The new status is the same as the current status." ] }, "Email Address Required": { "summary": "send_email true sem email_address", "value": { "email_address": [ "Email address is required when send_email is true." ] } }, "Non-resubmittable Feature": { "summary": "O reenvio tem como alvo uma verificação pai 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": "A seleção automática não encontrou recursos não aprovados", "value": { "nodes_to_resubmit": "No features found that need resubmission. All features are already approved." } }, "Invalid Feature Choice": { "summary": "Recurso desconhecido em 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 não é um valor válido de StatusChoices", "value": { "new_status": [ "\"Bogus\" is not a valid choice." ] } }, "Preview Receipt Without Email": { "summary": "email_preview_token enviado sem send_email: true", "value": { "email_preview_token": [ "A preview receipt is only valid when the email is sent." ] } } } } } }, "401": { "description": "A chave de API com escopo expirou.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Chave de API com escopo após a data de validade", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Credenciais ausentes ou permissões insuficientes, ou um `session_id` que pertence a outra aplicação.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente ou inválido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "A chave de API não tem write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhuma sessão de KYC ou KYB com este `session_id` (sessões excluídas também retornam `404`).", "content": { "application/json": { "examples": { "Not Found": { "summary": "session_id desconhecido", "value": { "detail": "Not found." } } } } } }, "429": { "description": "Um reenvio direcionado apenas a recursos exclusivos do backend (AML, DATABASE_VALIDATION, IP_ANALYSIS) foi repetido dentro da janela de espera de 30 segundos; uma repetição imediata não pode alterar o resultado. Aguarde e tente novamente após o intervalo indicado em `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": "A pré-visualização do e-mail mudou ou expirou. Gere uma nova pré-visualização antes de confirmar; nenhuma alteração na sessão nem entrega de e-mail acontece.", "content": { "application/json": { "examples": { "Preview Changed": { "summary": "O comprovante não corresponde mais ou tem mais de 15 minutos", "value": { "detail": "This email preview changed or expired. Preview the message again before confirming." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-status/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"new_status\": \"Approved\",\n \"comment\": \"All checks passed manual review\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_status(\n \"11111111-2222-3333-4444-555555555555\",\n new_status=\"Approved\",\n comment=\"All checks passed manual review\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateStatus(\"11111111-2222-3333-4444-555555555555\", {\n new_status: \"Approved\",\n comment: \"All checks passed manual review\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateStatus(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsUpdateStatusParams{\n\tNewStatus: \"Approved\",\n\tComment: didit.String(\"All checks passed manual review\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsUpdateStatusParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateStatus(\"11111111-2222-3333-4444-555555555555\", SessionsUpdateStatusParams.builder()\n .newStatus(SessionsUpdateStatusParams.NewStatus.of(\"Approved\"))\n .comment(\"All checks passed manual review\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateStatus('11111111-2222-3333-4444-555555555555', [\n 'new_status' => 'Approved',\n 'comment' => 'All checks passed manual review',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_status(\n \"11111111-2222-3333-4444-555555555555\",\n new_status: \"Approved\",\n comment: \"All checks passed manual review\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateStatusAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsUpdateStatusParams\n{\n NewStatus = \"Approved\",\n Comment = \"All checks passed manual review\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/id-verification/": { "post": { "summary": "Verificação de identidade (OCR do documento + verificações de fraude)", "description": "Faça o OCR de um documento de identidade e execute verificações de fraude documental em uma única chamada: a resposta traz os campos extraídos do titular, a MRZ interpretada, um `status` `Approved`/`Declined`/`In Review` e uma lista `warnings` que explica cada problema encontrado. Compatível com 14,000+ tipos de documento de 220+ países e territórios.\n\n**Como funciona.** Envie a `front_image` do documento (obrigatória) e, para documentos com frente e verso, a `back_image`. Envie fotos sem recorte, com os quatro cantos do documento visíveis. O próprio serviço detecta, alinha e recorta o documento, portanto não faça o recorte antes. O documento é classificado automaticamente (você nunca informa o país nem o tipo de documento), a zona visual é lida com OCR, e a MRZ e eventuais códigos de barras são decodificados. Em seguida, verificações cruzadas validam datas, formatos de número e dígitos verificadores da MRZ, e comparam a zona visual com a MRZ. Com `perform_document_liveness=true`, as imagens também são analisadas para detectar reprodução em tela, cópias impressas e manipulação do retrato.\n\n**Lógica de decisão.** O `status` é `Approved`, a menos que pelo menos um aviso resulte em recusa. Riscos de fraude e falhas graves sempre resultam em recusa: `DOCUMENT_EXPIRED`, `SCREEN_CAPTURE_DETECTED`, `PRINTED_COPY_DETECTED`, `PORTRAIT_MANIPULATION_DETECTED`, `PUBLIC_DOCUMENT_IMAGE_DETECTED`, além de falhas de extração (`NAME_NOT_DETECTED`, `DATE_OF_BIRTH_NOT_DETECTED`, `DOCUMENT_NUMBER_NOT_DETECTED`). (`PORTRAIT_IMAGE_NOT_DETECTED`, `INVALID_DATE` e `MRZ_NOT_DETECTED` existem em sessões de fluxo, mas nunca são gerados por este endpoint independente. `COULD_NOT_DETECT_DOCUMENT_TYPE` é retornado aqui quando a imagem da frente não corresponde, com alta confiança, a um modelo conhecido de documento oficial, e a requisição é recusada.) Três grupos de risco podem ser configurados por requisição com `invalid_mrz_action`, `inconsistent_data_action` e `expiration_date_not_detected_action` (`DECLINE` ou `NO_ACTION`). Todos os demais avisos (por exemplo, `POSSIBLE_DUPLICATED_USER`) são informativos e nunca causam recusa por si só. Quando `perform_document_liveness=true` (o padrão) e a verificação de falsificação não retorna uma pontuação utilizável (o provedor falhou, respondeu com código diferente de 200 ou respondeu HTTP 200 com `status=\"ERR\"`), a chamada retorna `200` com `status: \"In Review\"` e um aviso `DOCUMENT_LIVENESS_NOT_COMPUTED` (`log_type: \"warning\"`) em vez de `Approved`: uma verificação que não foi executada não é evidência de que o documento é autêntico. Esse escalonamento não é configurável e nunca substitui um `Declined`. Com `perform_document_liveness=false`, a verificação é ignorada e o status segue os demais avisos, como antes. Um documento que não pode ser processado de forma alguma retorna `400` com `{\"error\": \"COULD_NOT_RECOGNIZE_DOCUMENT\"}`. Um documento legível, mas com problemas, retorna `200` com `status: \"Declined\"`. Sempre verifique `id_verification.status` e `id_verification.warnings`, e não apenas o código HTTP.\n\n**Faturamento.** Cada resposta `200` consome um crédito da API de Verificação de identidade (pago com o crédito do seu plano ou com o saldo recarregado). Quando o saldo da organização não cobre a chamada, o endpoint retorna `403` com o erro de créditos insuficientes antes de qualquer processamento de imagem.\n\n**Persistência da sessão (`save_api_request`, padrão `true`).** Quando `true`, a chamada é persistida como uma sessão do tipo API: ela aparece no Business Console, o `request_id` retornado é um ID de sessão real que você pode passar para `GET /v3/session/{sessionId}/decision/`, as imagens recortadas do documento e do retrato são armazenadas e retornadas como URLs de mídia de curta duração (`https:///ocr/...`), e um webhook `status.updated` é enviado aos endpoints de webhook configurados. Quando `false`, nada é armazenado, `request_id` é um UUID de correlação de uso único, e `portrait_image`/`front_image`/`back_image` são retornados inline como strings JPEG codificadas em base64.\n\n**Sandbox.** Chaves de API de sandbox ignoram todo o processamento e o faturamento: após a validação da requisição (entradas malformadas continuam retornando `400`), o endpoint retorna um payload simulado estático `Approved` (uma carteira de identidade fictícia dos EUA de \"Sandbox User\"), nenhuma sessão é persistida e nenhum crédito é consumido.\n\n**Autenticação.** Envie a chave de API da sua aplicação no cabeçalho `x-api-key`. Credenciais ausentes ou inválidas retornam `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`). Esta API nunca retorna `401`.\n\n**Limite de requisições.** Cota de escrita compartilhada de 300 requisições/min por chave de API entre todos os endpoints POST/PATCH/DELETE. Ao excedê-la, a API 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": "Frente do documento de identidade. Extensões permitidas: `tiff`, `jpg`, `jpeg`, `png`, `webp`, `pdf`. Tamanho máximo de upload: **10 MB** (arquivos maiores são rejeitados com `400`). PDFs são renderizados como imagem antes do OCR; PDFs criptografados exigem `front_image_password`. As imagens são comprimidas automaticamente para ~0,5 MB e a orientação EXIF é aplicada. Envie a captura completa, sem recorte, com os quatro cantos do documento visíveis." }, "front_image_password": { "type": "string", "description": "Senha para descriptografar `front_image` quando for um PDF criptografado. Enviar um PDF criptografado sem senha (ou com uma senha errada) retorna `400`.", "writeOnly": true }, "back_image": { "type": "string", "format": "binary", "description": "Verso do documento: envie-o sempre que o documento tiver um (muitas carteiras de identidade trazem a MRZ ou um código de barras no verso; omiti-lo apenas deixa a MRZ e os campos do verso vazios na resposta, e este endpoint não gera um aviso de MRZ ausente). Mesmo formato e limites de tamanho de `front_image`. Quando omitido, `back_image` e os campos do verso são `null` na resposta." }, "back_image_password": { "type": "string", "description": "Senha para descriptografar `back_image` quando for um PDF criptografado.", "writeOnly": true }, "perform_document_liveness": { "type": "boolean", "default": true, "description": "Analisa as duas imagens em busca de fraude de apresentação: reprodução em tela (`SCREEN_CAPTURE_DETECTED`), cópias impressas (`PRINTED_COPY_DETECTED`) e manipulação do retrato (`PORTRAIT_MANIPULATION_DETECTED`). Qualquer uma delas resulta em recusa automática. Ativado por padrão; defina como `false` para pular a análise de fraude e reduzir a latência. Quando ativado e o provedor não retorna uma pontuação utilizável, a resposta é `In Review` com um aviso `DOCUMENT_LIVENESS_NOT_COMPUTED`, em vez de `Approved`.", "example": true }, "minimum_age": { "type": "integer", "nullable": true, "default": null, "minimum": 1, "maximum": 120, "description": "Aceito e validado (1–120), mas **atualmente não aplicado** por este endpoint — ele nunca gera um aviso `MINIMUM_AGE_NOT_MET` a partir deste campo. Aplique as regras de idade com base em `date_of_birth`/`age` retornados, ou use um fluxo de sessão de verificação com restrições de idade." }, "expiration_date_not_detected_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "O que fazer quando nenhuma data de validade pode ser lida (`EXPIRATION_DATE_NOT_DETECTED`). Padrão `NO_ACTION`, pois muitos documentos de identidade não trazem data de validade impressa. Observação: uma data de validade *detectada e já vencida* sempre recusa (`DOCUMENT_EXPIRED`), independentemente desta opção." }, "invalid_mrz_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "DECLINE", "description": "O que fazer quando a MRZ extraída falha na validação dos dígitos verificadores (`MRZ_VALIDATION_FAILED`). A ausência de MRZ não gera aviso neste endpoint. Relevante apenas para documentos que possuem MRZ. `REVIEW` não é compatível com este endpoint e retorna `400`." }, "inconsistent_data_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "DECLINE", "description": "O que fazer quando os dados extraídos são internamente inconsistentes: `DATA_INCONSISTENT`, `MRZ_AND_DATA_EXTRACTED_FROM_OCR_NOT_SAME` (a zona visual diverge da MRZ) ou `DOCUMENT_NAME_DIFFERENT_FROM_OTHER_APPROVED_DOCUMENTS`." }, "critical_field_occlusion_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "DECLINE", "description": "O que fazer quando um campo impresso crítico foi fisicamente coberto na captura (`CRITICAL_FIELD_OCCLUSION_DETECTED`): um número de identidade, um nome, a data de nascimento ou a data de validade. Recusa por padrão, como os demais riscos de integridade de documento deste endpoint: cobrir os números com os quais um relatório é conciliado é justamente a aparência de um documento censurado. O valor lido de um campo coberto é descartado da extração de qualquer forma, então o aviso `*_NOT_DETECTED` correspondente geralmente o acompanha. `REVIEW` não é compatível com este endpoint e retorna `400`." }, "document_or_personal_number_format_mismatch_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "O que fazer quando um número não corresponde ao formato que a autoridade emissora usa para aquele tipo de documento (`DOCUMENT_NUMBER_FORMAT_MISMATCH`, `PERSONAL_NUMBER_FORMAT_MISMATCH`). Padrão `NO_ACTION`, que informa o aviso sem alterar o status. `REVIEW` não é compatível com este endpoint e retorna `400`." }, "preferred_characters": { "type": "string", "enum": [ "latin", "non_latin" ], "default": "latin", "description": "Escrita preferencial para os campos de nome/endereço em documentos que imprimem texto latino e não latino (árabe, cirílico, CJK, …). `latin` retorna valores transliterados/latinos; `non_latin` dá preferência à escrita nativa." }, "save_api_request": { "type": "boolean", "default": true, "description": "Quando `true` (padrão), persiste a chamada como uma sessão do tipo API: visível no Business Console, recuperável via `GET /v3/session/{sessionId}/decision/` usando o `request_id` retornado, anunciada por meio de um webhook `status.updated` e com as imagens do documento retornadas como URLs de mídia. Quando `false`, nada é armazenado, `request_id` é um UUID transitório e as imagens são retornadas inline como strings JPEG em base64.", "example": true }, "vendor_data": { "type": "string", "description": "String opaca opcional (seu ID interno de usuário, e-mail, UUID…) armazenada na sessão persistida e devolvida na resposta. Use-a para correlacionar chamadas de API com seus próprios registros e para filtrar sessões posteriormente.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objeto JSON opcional armazenado com a sessão (quando `save_api_request=true`) e devolvido na resposta. Em requisições multipart, envie-o como um campo de string codificada em JSON (por exemplo, `metadata={\"flow\":\"onboarding\"}`), que é convertido em um objeto.", "example": { "flow": "onboarding" } } } }, "example": { "front_image": "(binary JPEG/PNG/PDF of the document front)", "back_image": "(binary JPEG/PNG/PDF of the document back)", "perform_document_liveness": true, "save_api_request": true, "vendor_data": "user-123", "metadata": { "flow": "onboarding" } } } } }, "responses": { "200": { "description": "Documento processado. `id_verification.status` é `Approved`, `Declined` ou `In Review`; cada problema detectado é detalhado em `id_verification.warnings`. `In Review` é retornado quando uma verificação de prova de vida do documento solicitada não produziu resultado utilizável (`DOCUMENT_LIVENESS_NOT_COMPUTED`). Um documento com problemas ainda retorna `200` com `status: \"Declined\"`: inspecione o corpo, não apenas o código HTTP. Quando `save_api_request=true`, `request_id` é o id da sessão persistida e os campos de imagem são URLs de mídia de curta duração; com `save_api_request=false`, eles são strings JPEG em base64 inline.", "content": { "application/json": { "examples": { "Approved": { "summary": "Documento de identidade de dois lados lido sem problemas (salvo, com as imagens como URLs de mí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 da sessão persistida quando `save_api_request=true` (utilizável com `GET /v3/session/{sessionId}/decision/`); caso contrário, um UUID de correlação transitório." }, "id_verification": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review" ], "description": "`Approved` quando nenhum aviso resulta em recusa e a verificação de prova de vida do documento solicitada produziu um resultado utilizável; `In Review` quando essa verificação solicitada não produziu um resultado utilizável (`DOCUMENT_LIVENESS_NOT_COMPUTED`); `Declined` quando um aviso resulta em recusa. A lista `warnings` explica o motivo." }, "document_type": { "type": "string", "nullable": true, "description": "Nome de exibição do tipo de documento detectado: `Identity Card`, `Passport`, `Driver's License`, `Residence Permit`, `Health Insurance Card` ou `Tax Card`. É `null` quando o documento não pôde ser classificado.", "example": "Identity Card" }, "document_subtype": { "type": "string", "nullable": true, "description": "Subtipo mais detalhado, quando disponível (por exemplo, `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 pessoal/nacional secundário impresso em alguns documentos.", "example": "20446581H" }, "portrait_image": { "type": "string", "nullable": true, "description": "Foto de retrato recortada do documento. Uma URL de mídia de curta duração (`https:///ocr/...`) quando `save_api_request=true` (padrão); uma string JPEG codificada em base64 inline quando `save_api_request=false`. `null` quando nenhum retrato foi detectado." }, "front_image": { "type": "string", "nullable": true, "description": "Recorte alinhado da frente do documento. URL de mídia quando salvo; caso contrário, JPEG em base64 inline." }, "back_image": { "type": "string", "nullable": true, "description": "Recorte alinhado do verso do documento. `null` quando nenhuma `back_image` foi enviada." }, "front_image_camera_front": { "type": "string", "nullable": true, "description": "Sempre `null` neste endpoint (preenchido apenas em sessões de verificação com captura pela câmera)." }, "back_image_camera_front": { "type": "string", "nullable": true, "description": "Sempre `null` neste endpoint." }, "front_image_camera_front_face_match_score": { "type": "number", "nullable": true, "description": "Sempre `null` neste endpoint." }, "back_image_camera_front_face_match_score": { "type": "number", "nullable": true, "description": "Sempre `null` neste endpoint." }, "front_image_quality_score": { "type": "object", "nullable": true, "description": "Diagnóstico da qualidade de captura da imagem enviada (`null` quando o lado não foi fornecido ou a pontuação falhou). Todas as pontuações vão de 0 a 100.", "properties": { "focus_score": { "type": "number", "format": "float", "description": "Nitidez do recorte do documento (quanto maior, mais nítido)." }, "brightness_score": { "type": "number", "format": "float", "description": "Qualidade da exposição (quanto maior, melhor)." }, "brightness_issue": { "type": "string", "nullable": true, "description": "`ok` quando a exposição está adequada; caso contrário, o problema detectado (por exemplo, escuro demais / claro demais)." }, "is_document_fully_visible": { "type": "boolean", "nullable": true, "description": "Indica se os quatro cantos do documento estão dentro do enquadramento." }, "resolution_score": { "type": "number", "format": "float", "description": "Resolução efetiva da área do documento." }, "overall_score": { "type": "number", "format": "float", "description": "Pontuação de qualidade agregada." } } }, "back_image_quality_score": { "type": "object", "nullable": true, "description": "Diagnóstico da qualidade de captura da imagem enviada (`null` quando o lado não foi fornecido ou a pontuação falhou). Todas as pontuações vão de 0 a 100.", "properties": { "focus_score": { "type": "number", "format": "float", "description": "Nitidez do recorte do documento (quanto maior, mais nítido)." }, "brightness_score": { "type": "number", "format": "float", "description": "Qualidade da exposição (quanto maior, melhor)." }, "brightness_issue": { "type": "string", "nullable": true, "description": "`ok` quando a exposição está adequada; caso contrário, o problema detectado (por exemplo, escuro demais / claro demais)." }, "is_document_fully_visible": { "type": "boolean", "nullable": true, "description": "Indica se os quatro cantos do documento estão dentro do enquadramento." }, "resolution_score": { "type": "number", "format": "float", "description": "Resolução efetiva da área do documento." }, "overall_score": { "type": "number", "format": "float", "description": "Pontuação de qualidade agregada." } } }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "example": "1980-01-13" }, "age": { "type": "integer", "nullable": true, "description": "Idade do titular em anos, 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 alpha-3).", "example": "ESP" }, "issuing_state_name": { "type": "string", "nullable": true, "example": "Spain" }, "first_name": { "type": "string", "nullable": true, "example": "Julio Francisco" }, "last_name": { "type": "string", "nullable": true, "example": "Fores Sena" }, "full_name": { "type": "string", "nullable": true, "example": "Julio Francisco Fores Sena" }, "gender": { "type": "string", "nullable": true, "description": "`M`, `F` ou `null` quando não impresso/detectado.", "example": "M" }, "address": { "type": "string", "nullable": true, "description": "Endereço exatamente como impresso no documento." }, "formatted_address": { "type": "string", "nullable": true, "description": "Versão geocodificada e normalizada de `address`." }, "place_of_birth": { "type": "string", "nullable": true, "example": "Valencia, Valencia" }, "marital_status": { "type": "string", "nullable": true, "description": "`UNKNOWN`, a menos que o documento traga o estado civil impresso.", "example": "UNKNOWN" }, "nationality": { "type": "string", "nullable": true, "description": "Nacionalidade do titular (ISO 3166-1 alfa-3).", "example": "ESP" }, "extra_fields": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Dados extras específicos do documento que não têm coluna dedicada (por exemplo, `first_surname`/`second_surname` em documentos de identidade espanhóis, categorias de habilitação em carteiras de motorista)." }, "mrz": { "type": "object", "description": "Zona de leitura mecânica interpretada. Um **objeto vazio** (`{}`) quando o documento não tem MRZ ou ela não pôde ser lida; nesse caso, verifique também a lista `warnings`. As datas dentro da MRZ usam o formato bruto `YYMMDD`.", "properties": { "surname": { "type": "string", "example": "FORES SENA" }, "name": { "type": "string", "example": "JULIO FRANCISCO" }, "country": { "type": "string", "description": "País emissor (ISO 3166-1 alpha-3).", "example": "ESP" }, "nationality": { "type": "string", "description": "Nacionalidade do titular (ISO 3166-1 alfa-3).", "example": "ESP" }, "birth_date": { "type": "string", "description": "Data de nascimento bruta da MRZ (`YYMMDD`).", "example": "800113" }, "expiry_date": { "type": "string", "description": "Data de validade bruta da MRZ (`YYMMDD`).", "example": "320331" }, "sex": { "type": "string", "example": "M" }, "document_type": { "type": "string", "description": "Código do tipo de documento da MRZ (por exemplo, `ID`, `P`).", "example": "ID" }, "document_number": { "type": "string", "example": "CBX164224" }, "optional_data": { "type": "string", "nullable": true, "example": "20446581H" }, "optional_data_2": { "type": "string", "nullable": true, "example": "" }, "birth_date_hash": { "type": "string", "description": "Dígito verificador da MRZ para a data de nascimento.", "example": "9" }, "expiry_date_hash": { "type": "string", "description": "Dígito verificador da MRZ para a data de validade.", "example": "8" }, "document_number_hash": { "type": "string", "description": "Dígito verificador da MRZ para o número do documento.", "example": "3" }, "final_hash": { "type": "string", "description": "Dígito verificador composto da MRZ.", "example": "3" }, "personal_number": { "type": "string", "nullable": true, "example": "20446581H" }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Avisos não fatais da análise da MRZ." }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Erros de dígito verificador/análise da MRZ. Erros não vazios aparecem como um aviso `MRZ_VALIDATION_FAILED`." }, "mrz_type": { "type": "string", "description": "Layout da MRZ: `TD1` (carteiras de identidade, 3 linhas), `TD2` ou `TD3` (passaportes, 2 linhas).", "example": "TD1" }, "mrz_string": { "type": "string", "description": "Texto bruto da MRZ conforme lido, com as linhas separadas por `\\n`." }, "mrz_key": { "type": "string", "description": "Chave composta (número do documento + dígitos verificadores) usada em verificações cruzadas." } } }, "parsed_address": { "type": "object", "nullable": true, "description": "Detalhamento estruturado e geocodificado de `address`. `null` quando o documento não contém endereço ou ele não pôde ser interpretado.", "properties": { "street_1": { "type": "string", "nullable": true, "example": "Avenida el Cardonal 52" }, "street_2": { "type": "string", "nullable": true, "example": "b" }, "city": { "type": "string", "nullable": true, "example": "La Laguna" }, "region": { "type": "string", "nullable": true, "example": "Canarias" }, "country": { "type": "string", "nullable": true, "description": "Código de país ISO 3166-1 alpha-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": "String canônica do endereço geocodificado.", "example": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain" }, "raw_results": { "type": "object", "additionalProperties": true, "description": "Payload bruto de geocodificação (`address_components`, `geometry.location`, `place_id`, …) para consumidores avançados." }, "document_location": { "type": "object", "nullable": true, "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "description": "Coordenadas geocodificadas do endereço do documento." }, "label": { "type": "string", "nullable": true, "description": "De qual campo do documento o endereço foi lido.", "example": "Spain Identity Card Address" }, "is_verified": { "type": "boolean", "description": "Indica se a geocodificação confirmou que o endereço existe." }, "category": { "type": "string", "nullable": true, "description": "Categoria do endereço (por exemplo, `Residential`, `Commercial`).", "example": "Residential" } } }, "warnings": { "type": "array", "description": "Vazio em uma aprovação sem ressalvas. Cada entrada explica um risco detectado; entradas com `log_type: \"error\"` definem `status` como `Declined`, e `DOCUMENT_LIVENESS_NOT_COMPUTED` (`log_type: \"warning\"`) o define como `In Review`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "description": "Código de risco legível por máquina. Riscos que sempre resultam em recusa: `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` (apenas 400, nunca um aviso), `DOCUMENT_NUMBER_NOT_DETECTED`, `COULD_NOT_DETECT_DOCUMENT_TYPE`, `NAME_NOT_DETECTED`, `DATE_OF_BIRTH_NOT_DETECTED`. Controlados por opções da requisição: `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`). Outros riscos (por exemplo, `POSSIBLE_DUPLICATED_USER`) são informativos. `DOCUMENT_LIVENESS_NOT_COMPUTED` é gerado quando `perform_document_liveness=true`, mas a verificação de falsificação não retornou uma pontuação utilizável; ele define `status` como `In Review`. `COULD_NOT_DETECT_DOCUMENT_TYPE` também é retornado quando a frente do documento não corresponde, com alta confiança, a um modelo de documento oficial conhecido, por exemplo, um documento editado ou gerado por computador, ou um modelo que ainda não é suportado.", "example": "DOCUMENT_EXPIRED" }, "feature": { "type": "string", "enum": [ "ID_VERIFICATION" ], "description": "Recurso que emitiu o aviso. Sempre `ID_VERIFICATION` neste endpoint." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Contexto adicional para alguns riscos (por exemplo, `POSSIBLE_DUPLICATED_USER` inclui `duplicated_session_id`); `null` para a maioria." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Severidade. Avisos `error` levam o `status` para `Declined`; `warning` (somente `DOCUMENT_LIVENESS_NOT_COMPUTED`, quando a verificação de falsificação solicitada não produziu uma pontuação utilizável) leva o `status` para `In Review`; entradas `information` são apenas informativas e nunca alteram o status." }, "short_description": { "type": "string", "description": "Resumo legível do risco em uma linha." }, "long_description": { "type": "string", "description": "Explicação legível do risco." } } } }, "barcodes": { "type": "array", "description": "Códigos de barras decodificados do documento (PDF417, QR, …). Vazio quando o documento não tem nenhum ou quando nenhum pôde ser lido.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Tipo de código de barras (por exemplo, `PDF417`, `QR_CODE`, `UNKNOWN`)." }, "position": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Localização do código de barras na imagem, quando disponível." }, "data": { "type": "string", "description": "Payload decodificado." }, "data_raw": { "type": "string", "description": "Payload bruto (não decodificado), quando diferente." }, "side": { "type": "string", "nullable": true, "description": "`front` ou `back`." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco do `vendor_data` que você enviou, ou `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Eco do objeto `metadata` que você enviou, ou `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp ISO 8601 (UTC) do momento em que a resposta foi gerada." } } } } } }, "400": { "description": "Erro de validação ou de processamento. Problemas em nível de campo retornam o envelope padrão do DRF (um array de mensagens para cada campo com problema). Problemas com PDFs criptografados retornam `{\"detail\": ...}`. Uma imagem de documento em que nenhum documento pode ser reconhecido retorna `{\"error\": \"COULD_NOT_RECOGNIZE_DOCUMENT\"}`. Envios de PDF também podem falhar com \"The submitted PDF file is corrupted or invalid.\" ou com um erro de ausência de páginas.", "content": { "application/json": { "examples": { "Missing front image": { "summary": "`front_image` não incluído nos dados do formulário", "value": { "front_image": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Extensão de arquivo fora de tiff/jpg/jpeg/png/webp/pdf", "value": { "front_image": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, webp, pdf." ] } }, "File too large": { "summary": "O upload excede o limite de 10 MB", "value": { "front_image": [ "File size should not exceed 10 MB" ] } }, "Invalid option value": { "summary": "As opções aceitam apenas DECLINE ou NO_ACTION", "value": { "invalid_mrz_action": [ "\"REVIEW\" is not a valid choice." ] } }, "Encrypted PDF": { "summary": "PDF enviado sem a senha exigida", "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` não descriptografa o PDF", "value": { "detail": "The PDF password is incorrect. Please provide the correct password." } }, "Document not recognized": { "summary": "Nenhum documento de identidade pôde ser detectado na imagem", "value": { "error": "COULD_NOT_RECOGNIZE_DOCUMENT" } }, "PDF conversion failure": { "summary": "Não foi possível converter o PDF enviado em imagem", "value": { "error": "Failed to convert front image PDF." } } } } } }, "403": { "description": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente e também quando o saldo da organização que faz a chamada não cobre a chamada; uma chave incorreta, revogada ou expirada retorna `401`. Uma chave ausente retorna `403` com `{\"detail\": ...}`; uma chave incorreta, revogada ou expirada retorna `401`. Créditos insuficientes retornam `403` com `{\"error\": ...}` antes de qualquer processamento da imagem.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "O saldo da organização não cobre a chamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Limite de requisições excedido. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API. A resposta inclui os cabeçalhos `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Mais de 300 requisições de escrita no minuto atual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/id-verification/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'front_image=@./id_front.jpg' \\\n -F 'back_image=@./id_back.jpg' \\\n -F 'perform_document_liveness=true' \\\n -F 'save_api_request=true' \\\n -F 'vendor_data=user-123'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_verification.verify(\n front_image=open(\"front_image.jpg\", \"rb\"),\n back_image=open(\"back_image.jpg\", \"rb\"),\n perform_document_liveness=True,\n save_api_request=True,\n vendor_data=\"user-123\",\n metadata={\"flow\": \"onboarding\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idVerification.verify({\n front_image: await fileFromPath(\"front_image.jpg\"),\n back_image: await fileFromPath(\"back_image.jpg\"),\n perform_document_liveness: true,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"onboarding\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDVerification.Verify(ctx, didit.IDVerificationVerifyParams{\n\tFrontImage: didit.FileFromPath(\"front_image.jpg\"),\n\tBackImage: didit.Some(didit.FileFromPath(\"back_image.jpg\")),\n\tPerformDocumentLiveness: didit.Bool(true),\n\tSaveAPIRequest: didit.Bool(true),\n\tVendorData: didit.String(\"user-123\"),\n\tMetadata: didit.Some(map[string]any{\"flow\": \"onboarding\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.IdVerificationVerifyParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idVerification().verify(IdVerificationVerifyParams.builder()\n .frontImage(Path.of(\"front_image.jpg\"))\n .backImage(Path.of(\"back_image.jpg\"))\n .performDocumentLiveness(true)\n .saveApiRequest(true)\n .vendorData(\"user-123\")\n .metadata(Map.of(\"flow\", \"onboarding\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idVerification->verify([\n 'front_image' => File::fromPath('front_image.jpg'),\n 'back_image' => File::fromPath('back_image.jpg'),\n 'perform_document_liveness' => true,\n 'save_api_request' => true,\n 'vendor_data' => 'user-123',\n 'metadata' => ['flow' => 'onboarding'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_verification.verify(\n front_image: Pathname(\"front_image.jpg\"),\n back_image: Pathname(\"back_image.jpg\"),\n perform_document_liveness: true,\n save_api_request: true,\n vendor_data: \"user-123\",\n metadata: { flow: \"onboarding\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdVerification.VerifyAsync(new IdVerificationVerifyParams\n{\n FrontImage = FileUpload.FromPath(\"front_image.jpg\"),\n BackImage = FileUpload.FromPath(\"back_image.jpg\"),\n PerformDocumentLiveness = true,\n SaveApiRequest = true,\n VendorData = \"user-123\",\n Metadata = new Dictionary { [\"flow\"] = \"onboarding\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/face-match/": { "post": { "summary": "Correspondência facial", "description": "Compare duas imagens de rosto (1:1) e receba uma `score` de similaridade (0–100) e um `status` `Approved`/`Declined`.\n\n**Como funciona.** As duas imagens são decodificadas e analisadas por um modelo biométrico (defina `rotate_image=true` se as capturas puderem estar de lado ou de cabeça para baixo) e, em seguida, é calculada uma pontuação de similaridade entre os dois rostos. Uma pontuação **estritamente acima** de `face_match_score_decline_threshold` (padrão `30`) retorna `status: \"Approved\"`; uma pontuação igual ou inferior a esse valor retorna `Declined` com um aviso `LOW_FACE_MATCH_SIMILARITY`. Se nenhum par de rostos puder ser pontuado, a chamada ainda retorna `200` com `status: \"Declined\"` e um aviso `NO_REFERENCE_IMAGE`: `score` é `null` no fluxo padrão de salvamento, ou `0` com `save_api_request=false`. Envie um único rosto nítido e frontal por imagem para obter os melhores resultados.\n\n**Faturamento.** Cada resposta `200` consome um crédito da API de Correspondência facial (pago com o crédito do seu plano ou com o saldo recarregado). Quando o saldo da organização não cobre a chamada, o endpoint retorna `403` com o erro de créditos insuficientes antes de qualquer processamento de imagem.\n\n**Persistência da sessão (`save_api_request`, padrão `true`).** Quando `true`, a chamada é persistida como uma sessão do tipo API: ela aparece no Business Console, o `request_id` retornado é um ID de sessão real que você pode passar para `GET /v3/session/{sessionId}/decision/`, as duas imagens são armazenadas como imagens de origem/destino da correspondência facial da sessão e um webhook `status.updated` é emitido para os endpoints de webhook configurados. Quando `false`, nada é armazenado e `request_id` é um UUID de correlação avulso que não pode ser consultado depois.\n\n**Índice de busca facial.** Este endpoint nunca cadastra rostos no seu índice de busca facial e nunca executa triagem de lista de bloqueio ou de duplicados; para isso, use `POST /v3/passive-liveness/` ou `POST /v3/face-search/`.\n\n**Sandbox.** Chaves de API de sandbox ignoram todo o processamento e o faturamento: após a validação da requisição (entradas malformadas ainda retornam `400`), o endpoint retorna um payload simulado estático `Approved`, nenhuma sessão é persistida e nenhum crédito é consumido.\n\n**Autenticação.** Envie a chave de API da sua aplicação no cabeçalho `x-api-key`. Credenciais ausentes ou inválidas retornam `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); esta API nunca retorna `401`.\n\n**Limite de requisições.** Cota de escrita compartilhada de 300 requisições/min por chave de API entre todos os endpoints POST/PATCH/DELETE; ao excedê-la, a resposta é `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": "Imagem de rosto ao vivo ou candidata a verificar (por exemplo, uma selfie). Envie uma única foto frontal com o rosto da pessoa claramente visível e bem iluminado. Extensões permitidas: `tiff`, `jpg`, `jpeg`, `png`, `webp`. Tamanho máximo de upload: **5 MB** (arquivos maiores são rejeitados com `400`). As imagens são compactadas automaticamente para cerca de 0,5 MB antes do processamento, portanto resoluções muito altas não melhoram a precisão." }, "ref_image": { "type": "string", "format": "binary", "description": "Imagem facial de referência para comparação (por exemplo, o retrato de um documento de identidade ou uma foto cadastrada anteriormente). Mesmos limites de formato e tamanho de `user_image`." }, "face_match_score_decline_threshold": { "type": "number", "format": "float", "default": 30, "minimum": 0, "maximum": 100, "description": "Limiar de similaridade (0–100) que determina o `status` da resposta. Uma pontuação calculada **igual ou inferior** a esse valor define `status` como `Declined` e adiciona um aviso `LOW_FACE_MATCH_SIMILARITY`; uma pontuação estritamente superior retorna `Approved`. O padrão `30` é permissivo: aumente-o (por exemplo, `50`–`60`) para uma verificação mais rigorosa. Valores fora de 0–100 retornam `400`.", "example": 50 }, "rotate_image": { "type": "boolean", "default": false, "description": "Quando `true`, o serviço testa as imagens de entrada em incrementos de 90 graus (0, 90, 180, 270) e usa a orientação que produz a melhor detecção de rosto, o que é útil para capturas móveis sem orientação EXIF. Aumenta a latência, então ative apenas se você não puder garantir imagens na posição vertical.", "example": false }, "save_api_request": { "type": "boolean", "default": true, "description": "Quando `true` (padrão), persiste a chamada como uma sessão do tipo API: visível no Business Console, recuperável via `GET /v3/session/{sessionId}/decision/` usando o `request_id` retornado e anunciada por meio de um webhook `status.updated`. Quando `false`, nada é armazenado e `request_id` é um UUID transitório usado apenas para correlacionar a resposta.", "example": true }, "vendor_data": { "type": "string", "description": "String opaca opcional (seu ID interno de usuário, e-mail, UUID…) armazenada na sessão persistida e devolvida na resposta. Use-a para correlacionar chamadas de API com seus próprios registros e para filtrar sessões posteriormente.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objeto JSON opcional armazenado com a sessão (quando `save_api_request=true`) e devolvido na resposta. Em requisições multipart, envie-o como um campo de string codificada em JSON (por exemplo, `metadata={\"flow\":\"login\"}`), que é convertido em um objeto.", "example": { "flow": "login", "device_id": "abc123" } } } }, "example": { "user_image": "(binary JPEG/PNG of the live selfie)", "ref_image": "(binary JPEG/PNG of the reference photo)", "face_match_score_decline_threshold": 50, "rotate_image": false, "save_api_request": true, "vendor_data": "user-123", "metadata": { "flow": "login" } } } } }, "responses": { "200": { "description": "Correspondência facial calculada. `face_match.score` é um float de 0 a 100 (duas casas decimais); `status` é `Approved` quando a pontuação está estritamente acima de `face_match_score_decline_threshold` e, caso contrário, `Declined` com um aviso explicativo. Uma similaridade baixa ou um par que não pode ser pontuado ainda retorna `200`: verifique `face_match.status` e `face_match.warnings`, não apenas o código HTTP. Quando `save_api_request=true`, `request_id` é o ID da sessão persistida.", "content": { "application/json": { "examples": { "Approved": { "summary": "Mesma pessoa: pontuação acima do limiar", "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": "Pontuação igual ou inferior ao limiar de recusa", "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 da sessão persistida quando `save_api_request=true` (utilizável com `GET /v3/session/{sessionId}/decision/`); caso contrário, um UUID de correlação transitório." }, "face_match": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Approved` quando a pontuação de similaridade está estritamente acima de `face_match_score_decline_threshold` e foi possível calcular uma pontuação; `Declined` caso contrário (um aviso explica o motivo)." }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Pontuação de similaridade de 0 a 100: a confiança do modelo de que as duas imagens retratam a mesma pessoa. É arredondada para duas casas decimais somente quando `save_api_request` é true; com `save_api_request=false`, o float bruto é retornado. É `null` quando nenhum par de rostos pôde ser pontuado (com o padrão `save_api_request=true`); com `save_api_request=false`, a mesma condição pode aparecer como `score: 0`. Em ambos os casos, um aviso `NO_REFERENCE_IMAGE` está presente e `status` é `Declined`.", "example": 99.41 }, "user_image": { "type": "object", "description": "Resultados da detecção facial para as imagens analisadas.", "properties": { "entities": { "type": "array", "items": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Caixa delimitadora do rosto detectado, como coordenadas em pixels `[x_min, y_min, x_max, y_max]` na imagem processada.", "example": [ 661, 728, 1688, 2188 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Confiança da detecção facial (0–1).", "example": 0.732973 }, "age": { "type": "number", "format": "float", "description": "Idade do rosto detectado estimada pelo modelo, em anos. Apenas informativa: não afeta a decisão de correspondência facial.", "example": 26.91 }, "gender": { "type": "string", "description": "Gênero do rosto detectado previsto pelo modelo (`male` ou `female`). Apenas informativo.", "example": "male" }, "race": { "type": "string", "nullable": true, "description": "Campo reservado: sempre `null` nas respostas deste endpoint.", "example": null } } }, "description": "Uma entrada por rosto detectado." }, "best_angle": { "type": "integer", "description": "Rotação (em graus: 0, 90, 180 ou 270) que produziu a melhor detecção de rosto. Só é diferente de zero quando `rotate_image=true` corrigiu a orientação.", "example": 0 } } }, "ref_image": { "type": "object", "description": "Resultados da detecção facial para a imagem de referência, com o mesmo formato de `user_image`.", "properties": { "entities": { "type": "array", "items": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Caixa delimitadora do rosto detectado, como coordenadas em pixels `[x_min, y_min, x_max, y_max]` na imagem processada.", "example": [ 661, 728, 1688, 2188 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Confiança da detecção facial (0–1).", "example": 0.732973 }, "age": { "type": "number", "format": "float", "description": "Idade do rosto detectado estimada pelo modelo, em anos. Apenas informativa: não afeta a decisão de correspondência facial.", "example": 26.91 }, "gender": { "type": "string", "description": "Gênero do rosto detectado previsto pelo modelo (`male` ou `female`). Apenas informativo.", "example": "male" }, "race": { "type": "string", "nullable": true, "description": "Campo reservado: sempre `null` nas respostas deste endpoint.", "example": null } } }, "description": "Uma entrada por rosto detectado." }, "best_angle": { "type": "integer", "example": 0 } } }, "warnings": { "type": "array", "description": "Vazio em uma aprovação sem ressalvas. `NO_REFERENCE_IMAGE` (`error`): nenhum par de rostos pôde ser pontuado; `LOW_FACE_MATCH_SIMILARITY` (`error`): pontuação igual ou inferior ao limiar de recusa. Qualquer um deles define `status` como `Declined`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "enum": [ "NO_REFERENCE_IMAGE", "LOW_FACE_MATCH_SIMILARITY" ], "description": "Código de risco legível por máquina." }, "feature": { "type": "string", "enum": [ "FACEMATCH" ], "description": "Recurso que emitiu o aviso. Sempre `FACEMATCH` neste endpoint." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Sempre `null` para avisos de correspondência facial." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Severidade. Avisos `error` levam o `status` para `Declined`; entradas `warning` e `information` são apenas informativas e nunca recusam a sessão por conta própria." }, "short_description": { "type": "string", "description": "Resumo legível do risco em uma linha." }, "long_description": { "type": "string", "description": "Explicação legível do risco." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco do `vendor_data` que você enviou, ou `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Eco do objeto `metadata` que você enviou, ou `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp ISO 8601 (UTC) do momento em que a resposta foi gerada, por exemplo `2026-06-12T01:04:42.763237+00:00`." } } } } } }, "400": { "description": "Erro de validação. Retornado quando uma imagem obrigatória está ausente, excede 5 MB ou tem uma extensão não suportada, ou quando uma opção está fora do intervalo permitido. O corpo é o envelope padrão de erros de campo do DRF: um array de mensagens para cada campo com problema.", "content": { "application/json": { "examples": { "Missing required image": { "summary": "`ref_image` (ou `user_image`) não foi incluído nos dados do formulário", "value": { "ref_image": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Extensão de arquivo fora de tiff/jpg/jpeg/png/webp", "value": { "user_image": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, webp." ] } }, "File too large": { "summary": "O upload excede o limite de 5 MB", "value": { "user_image": [ "File size should not exceed 5 MB" ] } }, "Threshold out of range": { "summary": "`face_match_score_decline_threshold` fora do intervalo 0–100", "value": { "face_match_score_decline_threshold": [ "Ensure this value is less than or equal to 100." ] } } } } } }, "403": { "description": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente e também quando o saldo da organização que faz a chamada não cobre a chamada; uma chave incorreta, revogada ou expirada retorna `401`. Uma chave ausente retorna `403` com `{\"detail\": ...}`; uma chave incorreta, revogada ou expirada retorna `401`. Créditos insuficientes retornam `403` com `{\"error\": ...}` antes de qualquer processamento da imagem.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "O saldo da organização não cobre a chamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Limite de requisições excedido. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API. A resposta inclui os cabeçalhos `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Mais de 300 requisições de escrita no minuto atual", "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": "Estimativa de idade (idade pelo rosto + prova de vida passiva)", "description": "Estime a idade de uma pessoa a partir de uma única foto do rosto e execute uma verificação passiva de prova de vida na mesma chamada. A resposta traz a `age_estimation` prevista pelo modelo (em anos), uma `score` de prova de vida (0–100) e um `status` `Approved`/`Declined`. A idade é **prevista pelo modelo a partir do rosto, e não verificada em um documento**: use-a para restrições por idade e verificações de baixo atrito, não como prova legal de idade.\n\n**Como funciona.** A imagem é analisada em busca de rostos (defina `rotate_image=true` se as capturas puderem estar de lado ou de cabeça para baixo); cada rosto detectado recebe uma idade estimada, e o maior rosto do quadro determina a `age_estimation`. Em paralelo, um modelo passivo de prova de vida avalia se a foto mostra uma pessoa real (sem exigir nenhum desafio do usuário) e detecta ataques de apresentação (fotos de fotos, telas, máscaras). Para obter os melhores resultados, envie um rosto nítido, de frente e bem iluminado por imagem.\n\n**Lógica de decisão.** Qualquer aviso resulta em recusa: o `status` só é `Approved` quando o array `warnings` está vazio. Uma `score` de prova de vida igual ou inferior a `face_liveness_score_decline_threshold` (padrão `30`) adiciona `LOW_LIVENESS_SCORE`; um ataque detectado adiciona `LIVENESS_FACE_ATTACK`; nenhum rosto encontrado pelo modelo de prova de vida adiciona `NO_FACE_DETECTED`; nenhuma idade estimável do rosto adiciona `AGE_NOT_DETECTED` (`age_estimation` é `null`); uma idade estimada abaixo de `age_estimation_decline_threshold` (padrão `18`) adiciona `AGE_BELOW_MINIMUM`. Idades limítrofes próximas ao seu limiar merecem um fallback para verificação baseada em documento, pois o erro do modelo aumenta para rostos próximos ao limite.\n\n**Faturamento.** Cada resposta `200` consome um crédito da API de Estimativa de idade (pago com o crédito do seu plano ou com o saldo de recarga). Quando o saldo da organização não cobre a chamada, o endpoint retorna `403` com o erro de créditos insuficientes antes de qualquer processamento da imagem.\n\n**Persistência da sessão (`save_api_request`, padrão `true`).** Quando `true`, a chamada é persistida como uma sessão do tipo API: ela aparece no Business Console, o `request_id` retornado é um ID de sessão real que você pode passar para `GET /v3/session/{sessionId}/decision/` (o resultado é exposto ali em `liveness_checks[]`, com `features: [\"AGE_ESTIMATION\"]`), o recorte do rosto e a imagem de referência são armazenados, o embedding facial é adicionado ao índice facial da sua aplicação (usado pela busca facial e pela detecção de duplicatas) e um webhook `status.updated` é emitido. Quando `false`, nada é armazenado e o `request_id` é um UUID de correlação avulso que não pode ser consultado depois.\n\n**Sandbox.** Chaves de API de sandbox ignoram todo o processamento e o faturamento: após a validação da requisição (entradas malformadas ainda retornam `400`), o endpoint retorna um payload simulado estático `Approved` (`age_estimation: 30`, sem avisos), nenhuma sessão é persistida e nenhum crédito é consumido.\n\n**Autenticação.** Envie a chave de API da sua aplicação no cabeçalho `x-api-key`. Credenciais ausentes ou inválidas retornam `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); esta API nunca retorna `401`.\n\n**Limite de requisições.** Cota de escrita compartilhada de 300 requisições/min por chave de API em todos os endpoints POST/PATCH/DELETE; ao excedê-la, a resposta é `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 do rosto a ser analisada (por exemplo, uma selfie). Envie uma única foto frontal com o rosto da pessoa claramente visível e bem iluminado. Extensões permitidas: `tiff`, `jpg`, `jpeg`, `png`, `webp` (sem PDF). Tamanho máximo de upload: **5 MB** (arquivos maiores são rejeitados com `400`). As imagens são comprimidas automaticamente para cerca de 0,3 MB antes do processamento, portanto resoluções muito altas não melhoram a precisão." }, "face_liveness_score_decline_threshold": { "type": "number", "format": "float", "default": 30, "minimum": 0, "maximum": 100, "description": "Limiar de prova de vida (0–100). Um `score` de prova de vida **igual ou inferior** a este valor adiciona um aviso `LOW_LIVENESS_SCORE` e recusa a verificação. Aumente esse valor para uma proteção antispoofing mais rigorosa. Valores fora do intervalo 0–100 retornam `400`.", "example": 30 }, "age_estimation_decline_threshold": { "type": "integer", "default": 18, "minimum": 0, "maximum": 100, "description": "Idade estimada mínima aceitável, em anos. Uma idade estimada **abaixo** desse valor adiciona um aviso `AGE_BELOW_MINIMUM` e recusa. Defina `0` para desativar a verificação de idade (a chamada então executa apenas prova de vida + estimativa de idade, sem decisão baseada em idade).", "example": 18 }, "rotate_image": { "type": "boolean", "default": false, "description": "Quando `true`, o serviço testa a imagem de entrada em incrementos de 90 graus (0, 90, 180, 270) e usa a orientação que produz a melhor detecção de rosto, o que é útil para capturas móveis sem orientação EXIF. Aumenta a latência, então ative apenas se você não puder garantir imagens na posição vertical.", "example": false }, "save_api_request": { "type": "boolean", "default": true, "description": "Quando `true` (padrão), persiste a chamada como uma sessão do tipo API: visível no Business Console, recuperável via `GET /v3/session/{sessionId}/decision/` usando o `request_id` retornado, anunciada por meio de um webhook `status.updated` e com o rosto detectado adicionado ao índice facial da sua aplicação. Quando `false`, nada é armazenado e `request_id` é um UUID transitório usado apenas para correlacionar a resposta.", "example": true }, "vendor_data": { "type": "string", "description": "String opaca opcional (seu ID interno de usuário, e-mail, UUID…) armazenada na sessão persistida e devolvida na resposta. Use-a para correlacionar chamadas de API com seus próprios registros e para filtrar sessões posteriormente.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objeto JSON opcional armazenado com a sessão (quando `save_api_request=true`) e devolvido na resposta. Em requisições multipart, envie-o como um campo de string codificada em JSON (por exemplo, `metadata={\"flow\":\"age-gate\"}`), que é convertido em um objeto.", "example": { "flow": "age-gate" } } } }, "example": { "user_image": "(binary JPEG/PNG of the selfie)", "face_liveness_score_decline_threshold": 30, "age_estimation_decline_threshold": 18, "rotate_image": false, "save_api_request": true, "vendor_data": "user-123", "metadata": { "flow": "age-gate" } } } } }, "responses": { "200": { "description": "Estimativa de idade e prova de vida passiva concluídas. `age_estimation.age_estimation` é a idade prevista pelo modelo, em anos, do maior rosto detectado (`null` se não houver nenhum); `age_estimation.score` é a pontuação da prova de vida passiva (0–100); `status` é `Approved` somente quando `warnings` está vazio. Uma captura de menor de idade ou com spoofing ainda retorna `200` com `status: \"Declined\"`. Inspecione o corpo, não apenas o código HTTP. Quando `save_api_request=true`, `request_id` é o ID da sessão persistida.", "content": { "application/json": { "examples": { "Approved": { "summary": "Rosto adulto real — ambas as verificações aprovadas", "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": "Idade estimada abaixo 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": "Pontuação de prova de vida igual ou inferior ao limiar de recusa (possível spoofing)", "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 da sessão persistida quando `save_api_request=true` (utilizável com `GET /v3/session/{sessionId}/decision/`); caso contrário, um UUID de correlação transitório." }, "age_estimation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Approved` quando nenhum aviso foi gerado; `Declined` caso contrário (todo aviso que este endpoint produz resulta em recusa)." }, "method": { "type": "string", "enum": [ "PASSIVE" ], "description": "Método de prova de vida. Sempre `PASSIVE` neste endpoint (imagem única, sem desafio para o usuário)." }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Pontuação de prova de vida passiva de 0 a 100: a confiança do modelo de que a foto mostra uma pessoa real. É comparada com `face_liveness_score_decline_threshold`; se for igual ou inferior a esse limiar, a chamada é recusada com `LOW_LIVENESS_SCORE`. `null` quando o modelo de prova de vida não retorna confiança; a chamada ainda é recusada com `LOW_LIVENESS_SCORE`, porque null é tratado como 0 na comparação com o limiar.", "example": 97.5 }, "user_image": { "type": "object", "description": "Resultados da detecção facial para a imagem analisada.", "properties": { "entities": { "type": "array", "description": "Uma entrada por rosto detectado. Vazio quando nenhum rosto foi encontrado (nesse caso, `age_estimation` é `null` e um aviso `AGE_NOT_DETECTED` é adicionado).", "items": { "type": "object", "properties": { "age": { "type": "number", "format": "float", "description": "Idade deste rosto estimada pelo modelo, em anos.", "example": 27.33 }, "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Caixa delimitadora do rosto detectado, como coordenadas em pixels `[x_min, y_min, x_max, y_max]` na imagem processada.", "example": [ 40, 40, 100, 100 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Confiança da detecção facial (0–1).", "example": 0.7177750468254089 }, "gender": { "type": "string", "description": "Gênero do rosto detectado previsto pelo modelo (`male` ou `female`). Apenas informativo.", "example": "male" } } } }, "best_angle": { "type": "integer", "nullable": true, "description": "Rotação (em graus: 0, 90, 180 ou 270) que produziu a melhor detecção de rosto. Só é diferente de zero quando `rotate_image=true` corrigiu a orientação.", "example": 0 } } }, "age_estimation": { "type": "number", "format": "float", "nullable": true, "description": "Idade em anos prevista pelo modelo para o **maior** rosto detectado. `null` quando não foi possível estimar a idade de nenhum rosto (um aviso `AGE_NOT_DETECTED` é adicionado e a chamada é recusada).", "example": 27.33 }, "warnings": { "type": "array", "description": "Vazio em uma aprovação sem ressalvas. Qualquer entrada define `status` como `Declined`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "enum": [ "NO_FACE_DETECTED", "LOW_LIVENESS_SCORE", "LIVENESS_FACE_ATTACK", "AGE_NOT_DETECTED", "AGE_BELOW_MINIMUM" ], "description": "Código de risco legível por máquina. `NO_FACE_DETECTED`: o modelo de prova de vida não encontrou nenhum rosto; `LOW_LIVENESS_SCORE`: `score` de prova de vida igual ou inferior a `face_liveness_score_decline_threshold`; `LIVENESS_FACE_ATTACK`: foi detectado um ataque de apresentação (foto/tela/máscara); `AGE_NOT_DETECTED`: não foi possível estimar a idade do rosto; `AGE_BELOW_MINIMUM`: idade estimada abaixo de `age_estimation_decline_threshold`. `NO_FACE_DETECTED` e `LOW_LIVENESS_SCORE` são mutuamente exclusivos: quando nenhum rosto é encontrado, apenas `NO_FACE_DETECTED` é emitido." }, "feature": { "type": "string", "enum": [ "LIVENESS" ], "description": "Recurso que emitiu o aviso. Sempre `LIVENESS` neste endpoint." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Sempre `null` para avisos de estimativa de idade." }, "log_type": { "type": "string", "enum": [ "error" ], "description": "Severidade. Todo aviso que este endpoint produz é `error` e define `status` como `Declined`." }, "short_description": { "type": "string", "description": "Resumo legível do risco em uma linha." }, "long_description": { "type": "string", "description": "Explicação legível do risco." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco do `vendor_data` que você enviou, ou `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Eco do objeto `metadata` que você enviou, ou `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp ISO 8601 (UTC) do momento em que a resposta foi gerada." } } } } } }, "400": { "description": "Erro de validação. Retornado quando `user_image` está ausente, excede 5 MB ou tem uma extensão não suportada, ou quando um limiar está fora do intervalo permitido. O corpo é o envelope padrão de erros de campo do DRF: um array de mensagens para cada campo com problema.", "content": { "application/json": { "examples": { "Missing user image": { "summary": "`user_image` não incluído nos dados do formulário", "value": { "user_image": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Extensão de arquivo fora de tiff/jpg/jpeg/png/webp", "value": { "user_image": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, webp." ] } }, "File too large": { "summary": "O upload excede o limite de 5 MB", "value": { "user_image": [ "File size should not exceed 5 MB" ] } }, "Threshold out of range": { "summary": "`face_liveness_score_decline_threshold` fora do intervalo 0–100", "value": { "face_liveness_score_decline_threshold": [ "Ensure this value is less than or equal to 100." ] } } } } } }, "403": { "description": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente e também quando o saldo da organização que faz a chamada não cobre a chamada; uma chave incorreta, revogada ou expirada retorna `401`. Uma chave ausente retorna `403` com `{\"detail\": ...}`; uma chave incorreta, revogada ou expirada retorna `401`. Créditos insuficientes retornam `403` com `{\"error\": ...}` antes de qualquer processamento da imagem.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "O saldo da organização não cobre a chamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Limite de requisições excedido. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API. A resposta inclui os cabeçalhos `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Mais de 300 requisições de escrita no minuto atual", "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": "Comprovante de endereço (OCR do documento + verificações de endereço)", "description": "Extraia e valide um documento de Comprovante de endereço (contas de consumo, extratos bancários e documentos emitidos pelo governo) em uma única chamada. Retorna o emissor, as datas de emissão e validade, o nome do titular, o endereço bruto e o endereço estruturado/geocodificado, um `status` `Approved`/`Declined` e uma lista `warnings` que explica cada problema encontrado.\n\n**Latência.** A extração é baseada em LLM: chamadas típicas levam **5–15 segundos**, e PDFs com várias páginas até **~30 segundos**. Configure um tempo limite no cliente de **pelo menos 45 segundos** e não tente novamente antes de a chamada terminar.\n\n**Como funciona.** O documento (imagem ou PDF, até 15 MB; PDFs criptografados exigem `document_password`) é classificado em um tipo e um subtipo de documento (por exemplo, `UTILITY_BILL` / `WATER_BILL`), e o emissor, as datas, o nome do titular e o endereço são extraídos por meio de extração baseada em LLM. O endereço é estruturado e geocodificado em `poa_parsed_address`. A análise forense de PDF/EXIF procura sinais de adulteração (modificação após a assinatura digital, editores de PDF conhecidos, manipulação com sobreposição de texto, reexportações suspeitas) e sinaliza `SUSPECTED_DOCUMENT_MANIPULATION` ou `DOCUMENT_METADATA_MISMATCH`. A idade do documento é validada em relação a `poa_document_age_months`, e o idioma em relação a `poa_languages_allowed`. Se você enviar `expected_address`, `expected_country` ou `expected_first_name`/`expected_last_name`, os valores extraídos são comparados e as divergências são sinalizadas.\n\n**Lógica de decisão.** O `status` é `Approved`, a menos que pelo menos um aviso resulte em recusa. Falhas graves sempre resultam em recusa: `MISSING_ADDRESS_INFORMATION`, `POA_DOCUMENT_EXPIRED`, `INVALID_DOCUMENT_TYPE`, `UNABLE_TO_VALIDATE_DOCUMENT_AGE`, além de `UNABLE_TO_EXTRACT_ISSUE_DATE` e `POA_NAME_NOT_DETECTED` (não configuráveis neste endpoint). Cinco grupos de risco são configuráveis por requisição por meio das opções `poa_*_action` (`DECLINE` ou `NO_ACTION`, todas com padrão `DECLINE`). `POA_DOCUMENT_NOT_SUPPORTED_FOR_APPLICATION` e `UNPARSABLE_OR_INVALID_ADDRESS` são informativos neste endpoint e nunca resultam em recusa. Um documento que não pode ser processado retorna `400`; um documento legível, mas com problemas, retorna `200` com `status: \"Declined\"`. Sempre verifique `poa.status` e `poa.warnings`, e não apenas o código HTTP.\n\n**Faturamento.** Cada resposta `200` consome um crédito da API de Comprovante de endereço (pago com o crédito do seu plano ou com o saldo recarregado). Quando o saldo da organização não cobre a chamada, o endpoint retorna `403` com o erro de créditos insuficientes antes de qualquer processamento do documento.\n\n**Persistência da sessão (`save_api_request`, padrão `true`).** Quando `true`, a chamada é persistida como uma sessão do tipo API: ela aparece no Business Console, o documento enviado é armazenado, o `request_id` retornado é um ID de sessão real que você pode passar para `GET /v3/session/{sessionId}/decision/` (a decisão também expõe `document_file` e a análise forense `document_metadata`, que esta resposta omite) e um webhook `status.updated` é emitido. Quando `false`, nada é armazenado e `request_id` é um UUID de correlação avulso que não pode ser consultado depois.\n\n**Sandbox.** As chaves de API de sandbox ignoram todo o processamento e o faturamento: após a validação da requisição (entradas malformadas ainda retornam `400`), o endpoint retorna um payload simulado estático `Approved` (uma conta de energia fictícia da \"Sandbox Power Co.\"), nenhuma sessão é persistida e nenhum crédito é consumido.\n\n**Autenticação.** Envie a chave de API da sua aplicação no cabeçalho `x-api-key`. Credenciais ausentes ou inválidas retornam `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); esta API nunca retorna `401`.\n\n**Limite de requisições.** Cota de escrita compartilhada de 300 requisições/min por chave de API entre todos os endpoints POST/PATCH/DELETE; ao excedê-la, a API retorna `429`.\n\nObservação: `FUTURE_ISSUE_DATE` e `POOR_DOCUMENT_QUALITY` existem em sessões de fluxo de verificação (workflow), mas nunca são gerados por este endpoint independente; um documento com data futura não é recusado automaticamente aqui.", "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": "O documento de Comprovante de endereço. Extensões permitidas: `tiff`, `jpg`, `jpeg`, `png`, `pdf`, `webp`. Tamanho máximo de upload: **15 MB** (arquivos maiores são rejeitados com `400`). PDFs com várias páginas são aceitos (espere uma latência maior); PDFs criptografados exigem `document_password`. As imagens são compactadas automaticamente antes do processamento." }, "document_password": { "type": "string", "description": "Senha para descriptografar `document` quando for um PDF criptografado. Enviar um PDF criptografado sem senha (ou com uma senha errada) retorna `400`.", "writeOnly": true }, "expected_address": { "type": "string", "description": "Endereço a ser verificado em relação ao documento. Ele é geocodificado e comparado com o endereço extraído; uma divergência (ou um endereço esperado que não pode ser geocodificado/verificado) adiciona `ADDRESS_MISMATCH_WITH_PROVIDED`, regido por `poa_address_mismatch_action`. A forma geocodificada é retornada em `expected_details_formatted_address` / `expected_details_parsed_address`.", "example": "Av. Monseñor Tavella 1291, Salta, Argentina" }, "expected_country": { "type": "string", "description": "País a ser verificado em relação ao documento (código ISO 3166-1, por exemplo, `ARG` ou `AR`). Uma divergência com o país do documento adiciona `POA_COUNTRY_MISMATCH_WITH_PROVIDED`, controlado por `poa_address_mismatch_action`.", "example": "ARG" }, "expected_first_name": { "type": "string", "description": "Primeiro nome a ser verificado em relação a `name_on_document` (correspondência aproximada, considerando transliteração). Uma pontuação abaixo do limiar de correspondência adiciona `NAME_MISMATCH_WITH_PROVIDED`, controlado por `poa_address_mismatch_action`.", "example": "Sophia" }, "expected_last_name": { "type": "string", "description": "Sobrenome a ser verificado em relação a `name_on_document`, combinado com `expected_first_name` para a pontuação de correspondência.", "example": "Martinez" }, "poa_languages_allowed": { "type": "string", "description": "Lista separada por vírgula dos idiomas de documento aceitos, como códigos ISO 639-1 (por exemplo, `en,es,fr`). Quando omitida ou vazia, **todos os 51 idiomas compatíveis** são aceitos. Um documento em um idioma fora da lista adiciona `UNSUPPORTED_DOCUMENT_LANGUAGE` (controlado por `poa_unsupported_language_action`); um código desconhecido na lista retorna `400` com o conjunto completo de códigos compatíveis.", "example": "en,es" }, "poa_document_age_months": { "type": "string", "description": "Pares `key:value` separados por vírgula que definem a idade máxima do documento, em meses, por tipo de documento. Chaves: `utility_bill`, `bank_statement`, `government_issued_document`, `other_poa_document`; valores: `1`–`120`, ou `-1` para ilimitado (sem verificação de idade). Padrões quando omitido: `utility_bill:3,bank_statement:3,government_issued_document:12,other_poa_document:12`. Um documento mais antigo que o limite é recusado com `POA_DOCUMENT_EXPIRED`. **Atenção:** ao informar este campo, liste *todos* os tipos que você aceita; os tipos omitidos são tratados como não aceitos (informativo `POA_DOCUMENT_NOT_SUPPORTED_FOR_APPLICATION`) e a verificação de idade deles é ignorada.", "example": "utility_bill:3,bank_statement:6" }, "poa_name_mismatch_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "Aceito, mas **atualmente não aplicado** — os avisos de divergência de nome (`NAME_MISMATCH_WITH_PROVIDED`) seguem `poa_address_mismatch_action`. Defina `poa_address_mismatch_action` para controlar o comportamento de divergência tanto de nome quanto de endereço." }, "poa_document_issues_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "O que fazer em problemas de integridade do arquivo — na prática, este endpoint só gera `DOCUMENT_METADATA_MISMATCH`." }, "poa_document_authenticity_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "O que fazer quando há suspeita de manipulação do documento (`SUSPECTED_DOCUMENT_MANIPULATION`) — por exemplo, o PDF foi modificado após a assinatura digital, processado por um editor de PDF conhecido, apresenta manipulação por sobreposição de texto ou tem datas EXIF inconsistentes." }, "poa_unsupported_language_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "O que fazer quando o idioma do documento está fora de `poa_languages_allowed` (`UNSUPPORTED_DOCUMENT_LANGUAGE`)." }, "poa_address_mismatch_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "O que fazer quando os dados extraídos divergem dos campos `expected_*`: `ADDRESS_MISMATCH_WITH_PROVIDED`, `NAME_MISMATCH_WITH_PROVIDED` e `POA_COUNTRY_MISMATCH_WITH_PROVIDED` seguem todos esta ação." }, "poa_issuer_not_identified_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "O que fazer quando nenhuma empresa ou organização emissora pode ser identificada no documento (`ISSUER_NOT_IDENTIFIED`)." }, "save_api_request": { "type": "boolean", "default": true, "description": "Quando `true` (padrão), persiste a chamada como uma sessão do tipo API: visível no Business Console, recuperável via `GET /v3/session/{sessionId}/decision/` usando o `request_id` retornado, anunciada por meio de um webhook `status.updated` e com o documento enviado armazenado. Quando `false`, nada é armazenado e `request_id` é um UUID transitório usado apenas para correlacionar a resposta.", "example": true }, "vendor_data": { "type": "string", "description": "String opaca opcional (seu ID interno de usuário, e-mail, UUID…) armazenada na sessão persistida e devolvida na resposta. Use-a para correlacionar chamadas de API com seus próprios registros e para filtrar sessões posteriormente.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objeto JSON opcional armazenado com a sessão (quando `save_api_request=true`) e devolvido na resposta. Em requisições multipart, envie-o como um campo de string codificada em JSON (por exemplo, `metadata={\"flow\":\"onboarding\"}`), que é convertido em um objeto.", "example": { "flow": "onboarding" } } } }, "example": { "document": "(binary JPEG/PNG/PDF of the utility bill or bank statement)", "expected_address": "Av. Monseñor Tavella 1291, Salta, Argentina", "expected_country": "ARG", "expected_first_name": "Sophia", "expected_last_name": "Martinez", "poa_languages_allowed": "en,es", "save_api_request": true, "vendor_data": "user-123" } } } }, "responses": { "200": { "description": "Documento processado. `poa.status` é `Approved` ou `Declined`; cada problema detectado é detalhado em `poa.warnings`. Um documento expirado, divergente ou suspeito ainda retorna `200` com `status: \"Declined\"`: inspecione o corpo, não apenas o código HTTP. Quando `save_api_request=true`, `request_id` é o id da sessão persistida.", "content": { "application/json": { "examples": { "Approved": { "summary": "Conta de consumo lida sem problemas, sem verificações de dados esperados", "value": { "request_id": "4b523a8d-ed32-45e4-8aa8-a89eda459d88", "poa": { "issuing_state": "ARG", "document_type": "UTILITY_BILL", "document_subtype": "WATER_BILL", "document_language": "es", "issuer": "Aguas del Norte", "issue_date": "2026-04-10", "expiration_date": null, "poa_address": "AVDA. MONSEÑOR TAVELLA N° 1291, B° VILLA LAVALLE CP: 4400, CAPITAL - SALTA", "poa_formatted_address": "Av. Monseñor Tavella 1291 b, A4400 Salta, Argentina", "poa_parsed_address": { "street_1": "Avenida Monseñor Tavella 1291", "street_2": "b", "city": "Salta", "region": "Salta", "country": "AR", "postal_code": "A4400", "document_location": { "latitude": -24.8208682, "longitude": -65.4130954 } }, "expected_details_address": null, "expected_details_formatted_address": null, "expected_details_parsed_address": null, "name_on_document": "OESTE EMBOTELLADORA S.A.", "extra_fields": { "bank_account_number": null, "bank_iban": null, "bank_sort_code": null, "bank_routing_number": null, "bank_swift_bic": null, "bank_branch_name": null, "bank_branch_address": null, "document_phone_number": null, "additional_names": [ "LA EMBOTELLADORA DEL NORTE SA" ] }, "detected_codes": [ { "type": "QR_CODE", "page_number": 1, "position": [ [ 820, 1120 ], [ 1002, 1120 ], [ 1002, 1302 ], [ 820, 1302 ] ], "x": 820, "y": 1120, "width": 182, "height": 182, "page_width": 1190, "page_height": 1684, "raw_payload": "aHR0cHM6Ly9hZ3Vhc2RlbG5vcnRlLmNvbS9mYWN0dXJhLzk5ODgxMQ==", "parsed_payload": "https://aguasdelnorte.com/factura/998811" }, { "type": "CODE_128", "page_number": 1, "position": [ [ 112, 1480 ], [ 560, 1480 ], [ 560, 1540 ], [ 112, 1540 ] ], "x": 112, "y": 1480, "width": 448, "height": 60, "page_width": 1190, "page_height": 1684, "raw_payload": "MDA5OTg4MTEwMDA0Mg==", "parsed_payload": "0099881100042" } ], "status": "Approved", "warnings": [] }, "vendor_data": "user-123", "metadata": null, "created_at": "2026-06-12T02:29:02.439655+00:00" } }, "Declined - document too old": { "summary": "Data de emissão mais antiga que o `poa_document_age_months` permitido", "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` não correspondem a `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 da sessão persistida quando `save_api_request=true` (utilizável com `GET /v3/session/{sessionId}/decision/`); caso contrário, um UUID de correlação transitório." }, "poa": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Approved` quando nenhum aviso resulta em recusa; `Declined` caso contrário. A lista `warnings` explica o motivo." }, "issuing_state": { "type": "string", "nullable": true, "description": "País em que o documento foi emitido, conforme extraído do documento — geralmente ISO 3166-1 alpha-3 (por exemplo, `ARG`).", "example": "ARG" }, "document_type": { "type": "string", "enum": [ "UTILITY_BILL", "BANK_STATEMENT", "GOVERNMENT_ISSUED_DOCUMENT", "OTHER_POA_DOCUMENT", "UNKNOWN" ], "description": "Categoria de documento detectada. `UNKNOWN` significa que o documento não pôde ser classificado como um Comprovante de endereço aceitável e é recusado automaticamente com `INVALID_DOCUMENT_TYPE`. Nunca é nulo: falhas de classificação retornam `UNKNOWN`." }, "document_subtype": { "type": "string", "description": "Classificação mais detalhada dentro de `document_type`, por exemplo `ELECTRICITY_BILL`, `WATER_BILL`, `GAS_BILL`, `INTERNET_BILL`, `PHONE_BILL` (contas de serviços públicos); `ACCOUNT_STATEMENT`, `CREDIT_CARD_STATEMENT` (extratos bancários); `TAX_ASSESSMENT`, `RESIDENCY_CERTIFICATE` (documentos governamentais). `UNKNOWN` quando não foi possível determinar nenhum subtipo. Nunca é nulo: falhas de classificação retornam `UNKNOWN`.", "example": "WATER_BILL" }, "document_language": { "type": "string", "nullable": true, "description": "Idioma do documento detectado (ISO 639-1).", "example": "es" }, "issuer": { "type": "string", "nullable": true, "description": "Empresa ou organização que emitiu o documento. `null` adiciona `ISSUER_NOT_IDENTIFIED`.", "example": "Aguas del Norte" }, "issue_date": { "type": "string", "format": "date", "nullable": true, "description": "Data de emissão do documento (`YYYY-MM-DD`). `null` quando não foi possível extraí-la, o que resulta em recusa com `UNABLE_TO_EXTRACT_ISSUE_DATE` neste endpoint.", "example": "2021-02-10" }, "expiration_date": { "type": "string", "format": "date", "nullable": true, "description": "Data explícita de validade impressa no documento, quando houver. Independente da verificação de idade `poa_document_age_months`." }, "poa_address": { "type": "string", "nullable": true, "description": "Endereço exatamente como impresso no documento. `null` resulta em recusa automática com `MISSING_ADDRESS_INFORMATION`." }, "poa_formatted_address": { "type": "string", "nullable": true, "description": "Versão geocodificada e normalizada de `poa_address`.", "example": "Av. Monseñor Tavella 1291 b, A4400 Salta, Argentina" }, "poa_parsed_address": { "type": "object", "nullable": true, "description": "Detalhamento estruturado e geocodificado do endereço do documento. `null` quando o endereço não pôde ser interpretado.", "properties": { "street_1": { "type": "string", "nullable": true, "example": "Avenida Monseñor Tavella 1291" }, "street_2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true, "example": "Salta" }, "region": { "type": "string", "nullable": true, "example": "Salta" }, "country": { "type": "string", "nullable": true, "description": "Código de país ISO 3166-1 alpha-2.", "example": "AR" }, "postal_code": { "type": "string", "nullable": true, "example": "A4400" }, "document_location": { "type": "object", "nullable": true, "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "description": "Coordenadas geocodificadas do endereço do documento." } } }, "expected_details_address": { "type": "string", "nullable": true, "description": "Eco do `expected_address` que você enviou, ou `null`." }, "expected_details_formatted_address": { "type": "string", "nullable": true, "description": "Versão geocodificada e normalizada de `expected_address`; `null` quando não fornecido ou não geocodificável." }, "expected_details_parsed_address": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Resultado completo da geocodificação de `expected_address` (rua/cidade/região/país/código postal, além da saída bruta do geocodificador e de um indicador `is_verified`). `null` quando `expected_address` não foi informado." }, "name_on_document": { "type": "string", "nullable": true, "description": "Nome do titular principal extraído do documento; comparado com `expected_first_name`/`expected_last_name` quando informados. `null` resulta em recusa com `POA_NAME_NOT_DETECTED` neste endpoint.", "example": "OESTE EMBOTELLADORA S.A." }, "extra_fields": { "type": "object", "description": "Dados extras específicos do documento. Os campos bancários são preenchidos para extratos bancários quando estão impressos no documento; caso contrário, `null`.", "properties": { "bank_account_number": { "type": "string", "nullable": true }, "bank_iban": { "type": "string", "nullable": true }, "bank_sort_code": { "type": "string", "nullable": true }, "bank_routing_number": { "type": "string", "nullable": true }, "bank_swift_bic": { "type": "string", "nullable": true }, "bank_branch_name": { "type": "string", "nullable": true }, "bank_branch_address": { "type": "string", "nullable": true }, "document_phone_number": { "type": "string", "nullable": true, "description": "Número de telefone de contato impresso no documento." }, "additional_names": { "type": "array", "items": { "type": "string" }, "description": "Outros nomes de titulares encontrados no documento (por exemplo, cotitulares da conta, nomes anteriores da conta)." } } }, "warnings": { "type": "array", "description": "Vazio em uma aprovação sem ressalvas. Cada entrada explica um risco detectado; entradas com `log_type: \"error\"` definem `status` como `Declined`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "description": "Código de risco legível por máquina. Sempre resultam em recusa: `MISSING_ADDRESS_INFORMATION`, `POA_DOCUMENT_EXPIRED`, `INVALID_DOCUMENT_TYPE`, `UNABLE_TO_VALIDATE_DOCUMENT_AGE`, além de `UNABLE_TO_EXTRACT_ISSUE_DATE` e `POA_NAME_NOT_DETECTED` (fixados como recusa neste endpoint). Controlados por opções da requisição: `NAME_MISMATCH_WITH_PROVIDED` / `ADDRESS_MISMATCH_WITH_PROVIDED` / `POA_COUNTRY_MISMATCH_WITH_PROVIDED` (`poa_address_mismatch_action`), `POOR_DOCUMENT_QUALITY` (nunca gerado por este endpoint) / `DOCUMENT_METADATA_MISMATCH` (`poa_document_issues_action`), `SUSPECTED_DOCUMENT_MANIPULATION` (`poa_document_authenticity_action`), `UNSUPPORTED_DOCUMENT_LANGUAGE` (`poa_unsupported_language_action`), `ISSUER_NOT_IDENTIFIED` (`poa_issuer_not_identified_action`). Informativos neste endpoint: `POA_DOCUMENT_NOT_SUPPORTED_FOR_APPLICATION`, `UNPARSABLE_OR_INVALID_ADDRESS`.", "example": "POA_DOCUMENT_EXPIRED" }, "feature": { "type": "string", "enum": [ "PROOF_OF_ADDRESS" ], "description": "Recurso que emitiu o aviso. Sempre `PROOF_OF_ADDRESS` neste endpoint." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Contexto adicional para alguns riscos. Por exemplo, `POA_DOCUMENT_EXPIRED` inclui `expiration_reason` (`printed_expiration` ou `age_window`), `document_type`, `document_subtype` e `issue_date`, além de `expiration_date` no caso `printed_expiration` ou `max_age_months` no caso `age_window`; `SUSPECTED_DOCUMENT_MANIPULATION` inclui `reason` e `detection_method`. `null` para a maioria dos riscos." }, "log_type": { "type": "string", "enum": [ "error", "information" ], "description": "Severidade. Avisos `error` levam `status` a `Declined`; entradas `information` são apenas informativas e nunca recusam por si só. (`warning` não é produzido por este endpoint: suas opções aceitam apenas `DECLINE` ou `NO_ACTION`.)" }, "short_description": { "type": "string", "description": "Resumo legível do risco em uma linha." }, "long_description": { "type": "string", "description": "Explicação legível do risco." } } } }, "detected_codes": { "type": "array", "description": "QR codes e códigos de barras detectados em todas as páginas processadas do documento. Vazio quando nenhum é encontrado. Um QR code localizado, mas que não pôde ser decodificado, tem `parsed_payload: null`.", "items": { "$ref": "#/components/schemas/DocumentAIDetectedCode" } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco do `vendor_data` que você enviou, ou `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Eco do objeto `metadata` que você enviou, ou `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp ISO 8601 (UTC) do momento em que a resposta foi gerada." } } } } } }, "400": { "description": "Erro de validação ou de processamento. Problemas em nível de campo retornam o envelope padrão do DRF (um array de mensagens para cada campo com problema). Problemas com PDFs criptografados retornam `{\"detail\": ...}`. Um documento que o pipeline de extração não consegue processar retorna `{\"error\": [\"Error extracting POA information\"]}`.", "content": { "application/json": { "examples": { "Missing document": { "summary": "`document` não incluído nos dados do formulário", "value": { "document": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Extensão de arquivo fora de tiff/jpg/jpeg/png/pdf/webp", "value": { "document": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, pdf, webp." ] } }, "File too large": { "summary": "O upload excede o limite de 15 MB", "value": { "document": [ "File size should not exceed 15 MB" ] } }, "Encrypted PDF": { "summary": "PDF enviado sem a senha exigida", "value": { "detail": "The PDF is encrypted. Please upload a decrypted PDF or a photo instead." } }, "Wrong PDF password": { "summary": "`document_password` não descriptografa o PDF", "value": { "detail": "The PDF password is incorrect. Please provide the correct password." } }, "Invalid language code": { "summary": "`poa_languages_allowed` contém um código não suportado", "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": "O documento não pôde ser processado pelo pipeline de extração", "value": { "error": [ "Error extracting POA information" ] } } } } } }, "403": { "description": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente e também quando o saldo da organização que faz a chamada não cobre a chamada; uma chave incorreta, revogada ou expirada retorna `401`. Uma chave ausente retorna `403` com `{\"detail\": ...}`; uma chave incorreta, revogada ou expirada retorna `401`. Créditos insuficientes retornam `403` com `{\"error\": ...}` antes de qualquer processamento do documento.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "O saldo da organização não cobre a chamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Limite de requisições excedido. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API. A resposta inclui os cabeçalhos `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Mais de 300 requisições de escrita no minuto atual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X POST 'https://verification.didit.me/v3/poa/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'document=@./utility-bill.pdf' \\\n -F 'expected_address=Av. Monseñor Tavella 1291, Salta, Argentina' \\\n -F 'expected_country=ARG' \\\n -F 'expected_first_name=Sophia' \\\n -F 'expected_last_name=Martinez' \\\n -F 'poa_languages_allowed=en,es' \\\n -F 'vendor_data=user-123' \\\n --max-time 45" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.proof_of_address.verify(\n document=open(\"document.pdf\", \"rb\"),\n expected_address=\"Av. Monseñor Tavella 1291, Salta, Argentina\",\n expected_country=\"ARG\",\n expected_first_name=\"Sophia\",\n expected_last_name=\"Martinez\",\n poa_languages_allowed=\"en,es\",\n save_api_request=True,\n vendor_data=\"user-123\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.proofOfAddress.verify({\n document: await fileFromPath(\"document.pdf\"),\n expected_address: \"Av. Monseñor Tavella 1291, Salta, Argentina\",\n expected_country: \"ARG\",\n expected_first_name: \"Sophia\",\n expected_last_name: \"Martinez\",\n poa_languages_allowed: \"en,es\",\n save_api_request: true,\n vendor_data: \"user-123\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.ProofOfAddress.Verify(ctx, didit.ProofOfAddressVerifyParams{\n\tDocument: didit.FileFromPath(\"document.pdf\"),\n\tExpectedAddress: didit.String(\"Av. Monseñor Tavella 1291, Salta, Argentina\"),\n\tExpectedCountry: didit.String(\"ARG\"),\n\tExpectedFirstName: didit.String(\"Sophia\"),\n\tExpectedLastName: didit.String(\"Martinez\"),\n\tPOALanguagesAllowed: didit.String(\"en,es\"),\n\tSaveAPIRequest: didit.Bool(true),\n\tVendorData: didit.String(\"user-123\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.types.ProofOfAddressVerifyParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.proofOfAddress().verify(ProofOfAddressVerifyParams.builder()\n .document(Path.of(\"document.pdf\"))\n .expectedAddress(\"Av. Monseñor Tavella 1291, Salta, Argentina\")\n .expectedCountry(\"ARG\")\n .expectedFirstName(\"Sophia\")\n .expectedLastName(\"Martinez\")\n .poaLanguagesAllowed(\"en,es\")\n .saveApiRequest(true)\n .vendorData(\"user-123\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "proofOfAddress->verify([\n 'document' => File::fromPath('document.pdf'),\n 'expected_address' => 'Av. Monseñor Tavella 1291, Salta, Argentina',\n 'expected_country' => 'ARG',\n 'expected_first_name' => 'Sophia',\n 'expected_last_name' => 'Martinez',\n 'poa_languages_allowed' => 'en,es',\n 'save_api_request' => true,\n 'vendor_data' => 'user-123',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.proof_of_address.verify(\n document: Pathname(\"document.pdf\"),\n expected_address: \"Av. Monseñor Tavella 1291, Salta, Argentina\",\n expected_country: \"ARG\",\n expected_first_name: \"Sophia\",\n expected_last_name: \"Martinez\",\n poa_languages_allowed: \"en,es\",\n save_api_request: true,\n vendor_data: \"user-123\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.ProofOfAddress.VerifyAsync(new ProofOfAddressVerifyParams\n{\n Document = FileUpload.FromPath(\"document.pdf\"),\n ExpectedAddress = \"Av. Monseñor Tavella 1291, Salta, Argentina\",\n ExpectedCountry = \"ARG\",\n ExpectedFirstName = \"Sophia\",\n ExpectedLastName = \"Martinez\",\n PoaLanguagesAllowed = \"en,es\",\n SaveApiRequest = true,\n VendorData = \"user-123\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/document-ai/": { "post": { "summary": "Document AI (extração de campos personalizados + verificações de adulteração)", "description": "Extraia os campos que **você** define de qualquer documento de apoio (holerites, comprovantes de fundos, cartas de origem do patrimônio, declarações fiscais, contratos, faturas) em uma única chamada. Envie o arquivo junto com uma definição de `fields` (chave, nome, instrução de extração, tipo) e receba valores tipados (`text`, `number`, `date` como `YYYY-MM-DD`), uma pontuação opcional de correspondência de nome com a pessoa ou empresa esperada, sinais de adulteração de PDF/EXIF, um `status` `Approved`/`Declined`/`In Review` e uma lista `warnings` que explica cada problema encontrado. Este é o equivalente servidor a servidor da etapa Document AI do fluxo de verificação (workflow) hospedado (veja `/core-technology/document-ai/overview`). Ele usa o modelo de extração padrão da Didit e não expõe a seleção de provedor.\n\n**Latência.** A extração é baseada em LLM: chamadas típicas levam **5–15 segundos**, e PDFs com várias páginas levam até **~30 segundos**. Configure um timeout de cliente de **pelo menos 45 segundos** e não tente novamente antes de a chamada terminar.\n\n**Formato da requisição.** Apenas `multipart/form-data`. `fields` é **uma única string com um array codificado em JSON** (1–30 itens, no máximo 16 KB). Arrays de formulário no estilo de colchetes são rejeitados com `400`. Cada item é `{key, name, instruction, type, required, is_full_name}`: `key` é a chave JSON que você recebe de volta (`^[a-z0-9_]{1,64}$`, única), `instruction` diz ao modelo o que ler, `type` é `text` (padrão) | `number` | `date`, `required` gera `DOCUMENT_AI_MISSING_REQUIRED_FIELDS` quando o valor não pode ser lido, e no máximo um campo pode definir `is_full_name: true` para marcar o valor comparado com o nome esperado.\n\n**Correspondência de nome.** Envie `expected_first_name` + `expected_last_name` (pessoa) **ou** `expected_company_name` (+ `expected_company_country` opcional), mas não ambos. O valor do campo `is_full_name` (ou, quando nenhum estiver marcado, o primeiro campo de texto cuja chave pareça um nome) é comparado de forma aproximada. `name_match_score` (0–100) e `name_on_document` são sempre retornados quando os dois lados existem, e uma pontuação abaixo de `document_ai_name_match_score_threshold` (padrão 80) adiciona `DOCUMENT_AI_NAME_MISMATCH`, regido por `document_ai_name_mismatch_action`.\n\n**Lógica de decisão.** Cada risco corresponde a uma ação configurável: `DECLINE` → `status: \"Declined\"`, `REVIEW` → `status: \"In Review\"`, `NO_ACTION` → apenas informativo. Os padrões espelham a etapa do fluxo: documento ilegível `REVIEW`, campos obrigatórios ausentes `REVIEW`, suspeita de manipulação `DECLINE`, divergência de nome `NO_ACTION`, arquivo não suportado `REVIEW`. Um documento que não pode ser processado de forma alguma retorna `400`. Um documento legível, mas problemático, retorna `200` com `Declined`/`In Review`. Sempre inspecione `document_ai.status` e `document_ai.warnings`, não apenas o código HTTP.\n\n**Faturamento.** Cada resposta `200` consome um crédito de API do Document AI, **$0.20 por documento** pelo preço de tabela, pago com o crédito do seu plano ou com o saldo de recarga. Quando o saldo da organização não cobre a chamada, o endpoint retorna `403` antes de qualquer processamento. Chaves de API de sandbox retornam uma resposta simulada determinística e não são cobradas.\n\n**Persistência.** Com `save_api_request=true` (padrão), a chamada é armazenada como uma sessão do tipo API: o documento, os valores extraídos, as definições de campos e o snapshot da correspondência de nome são mantidos, a sessão aparece no Business Console e `request_id` funciona com `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": "O documento a ser lido. Extensões permitidas: `tiff`, `jpg`, `jpeg`, `png`, `pdf`, `webp`, `zip`. Tamanho máximo de upload: **30 MB** (arquivos maiores são rejeitados com `400`). PDFs com várias páginas são compatíveis (espere maior latência); PDFs criptografados são rejeitados com `400`. As imagens são compactadas automaticamente antes do processamento." }, "fields": { "type": "string", "description": "Uma string com um array codificado em JSON contendo **1–30** definições de campos (máximo de 16 KB). Cada item: `key` (obrigatório, `^[a-z0-9_]{1,64}$`, único; a chave retornada em `extracted_data`), `name` (≤100 caracteres, exibido nas mensagens), `instruction` (≤500 caracteres, o que o modelo deve ler), `type` (`text` padrão | `number` | `date`), `required` (booleano, padrão `false`), `is_full_name` (booleano, padrão `false`, no máximo um por requisição). Arrays de formulário no estilo de colchetes, JSON inválido, chaves duplicadas ou mais de um `is_full_name` retornam `400` antes de qualquer processamento ou faturamento.", "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": "Primeiro nome a ser verificado em relação ao campo de nome do documento (correspondência aproximada, considerando transliteração). Use junto com `expected_last_name`; não pode ser combinado com `expected_company_name`.", "example": "Sophia" }, "expected_last_name": { "type": "string", "description": "Sobrenome a ser verificado em relação ao campo de nome do documento, combinado com `expected_first_name` para `name_match_score`.", "example": "Martinez" }, "expected_company_name": { "type": "string", "description": "Nome da empresa a ser verificado em relação ao campo de nome do documento (para documentos de empresas). Não pode ser combinado com `expected_first_name` / `expected_last_name` (sem valor de exemplo de propósito: o exemplo de requisição gerado usa os campos de pessoa; substitua-os por este ao verificar um documento de empresa)." }, "expected_company_country": { "type": "string", "description": "Código de país ISO 3166-1 alfa-2 opcional (duas letras ASCII, por exemplo `FR`) que ajusta a normalização do nome da empresa para `expected_company_name`. Usado apenas com `expected_company_name`." }, "document_ai_name_match_score_threshold": { "type": "integer", "minimum": 0, "maximum": 100, "default": 80, "description": "`name_match_score` mínimo (0–100) para considerar que o nome corresponde. Uma pontuação menor adiciona `DOCUMENT_AI_NAME_MISMATCH`, regido por `document_ai_name_mismatch_action`.", "example": 80 }, "document_ai_unreadable_document_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "REVIEW", "description": "O que fazer quando nenhum campo pôde ser lido do documento (`DOCUMENT_AI_UNREADABLE_DOCUMENT`)." }, "document_ai_missing_required_fields_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "REVIEW", "description": "O que fazer quando pelo menos um campo `required` não pôde ser lido (`DOCUMENT_AI_MISSING_REQUIRED_FIELDS`; `additional_data.missing_fields` os lista)." }, "document_ai_document_tampering_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "DECLINE", "description": "O que fazer quando a análise forense de PDF/EXIF suspeita de manipulação — modificação após a assinatura digital, editor de PDF conhecido, manipulação por sobreposição de texto, reexportação suspeita, anomalias de imagem (`DOCUMENT_AI_SUSPECTED_MANIPULATION`)." }, "document_ai_name_mismatch_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "NO_ACTION", "description": "O que fazer quando `name_match_score` está abaixo do limiar (`DOCUMENT_AI_NAME_MISMATCH`)." }, "document_ai_unsupported_file_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ], "default": "REVIEW", "description": "O que fazer quando o envio está vazio ou não é um arquivo processável (`DOCUMENT_AI_UNSUPPORTED_FILE`)." }, "save_api_request": { "type": "boolean", "default": true, "description": "Quando `true` (padrão), persiste a chamada como uma sessão do tipo API: visível no Business Console, recuperável via `GET /v3/session/{sessionId}/decision/` usando o `request_id` retornado, com o documento enviado, os valores extraídos, as definições de campos e o snapshot da correspondência de nome armazenados. Quando `false`, nada é armazenado e `request_id` é um UUID transitório usado apenas para correlacionar a resposta; a chamada continua sendo cobrada.", "example": true }, "vendor_data": { "type": "string", "description": "String opaca opcional (seu ID interno de usuário, e-mail, UUID…) armazenada na sessão persistida e devolvida na resposta. Use-a para correlacionar chamadas de API com seus próprios registros e para filtrar sessões posteriormente.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objeto JSON opcional armazenado com a sessão (quando `save_api_request=true`) e devolvido na resposta. Em requisições multipart, envie-o como um campo de string codificada em JSON (por exemplo, `metadata={\"flow\":\"onboarding\"}`), que é convertido em um objeto.", "example": { "flow": "onboarding" } } } } } } }, "responses": { "200": { "description": "Documento processado. `document_ai.status` é `Approved`, `Declined` ou `In Review`; cada problema detectado é detalhado em `document_ai.warnings`. Um documento com problemas ainda retorna `200`: inspecione o corpo, não apenas o código HTTP. Quando `save_api_request=true`, `request_id` é o id da sessão persistida.", "content": { "application/json": { "examples": { "Approved": { "summary": "Holerite lido sem problemas, nome correspondente", "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": "Não foi possível ler `net_pay`; ação padrão 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": "A análise forense de PDF identificou um editor conhecido; ação padrão 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 da sessão persistida quando `save_api_request=true` (utilizável com `GET /v3/session/{sessionId}/decision/`); caso contrário, um UUID de correlação transitório." }, "document_ai": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review" ], "description": "`Approved` quando nenhum aviso resulta em recusa ou revisão; `Declined` quando pelo menos um risco é mapeado para `DECLINE`; caso contrário, `In Review` quando pelo menos um é mapeado para `REVIEW`. A lista `warnings` explica o motivo." }, "extracted_data": { "type": "object", "additionalProperties": true, "description": "Uma entrada por chave de campo solicitada. Os valores são tipados conforme o `type` do campo (strings para `text`, números para `number`, strings `YYYY-MM-DD` para `date`) ou `null` quando o valor não pôde ser lido.", "example": { "employer_name": "Acme Payments Ltd", "employee_name": "Sophia Martinez", "net_pay": 3120.5, "pay_date": "2026-07-31" } }, "detected_codes": { "type": "array", "description": "QR codes e códigos de barras detectados em todas as páginas processadas. Vazio quando nenhum é encontrado. Um QR code localizado, mas que não pôde ser decodificado, tem `parsed_payload: null`.", "items": { "$ref": "#/components/schemas/DocumentAIDetectedCode" } }, "fields": { "type": "array", "description": "As definições de campos normalizadas usadas nesta extração, devolvidas na resposta (também armazenadas com a sessão quando `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": "Similaridade aproximada (0–100) entre `name_on_document` e o nome esperado da pessoa/empresa. Retornada sempre que existem tanto um valor de nome quanto um nome esperado, em correspondências **e** em divergências; caso contrário, `null`.", "example": 96.0 }, "name_on_document": { "type": "string", "nullable": true, "description": "O valor de nome extraído do documento (o campo `is_full_name` ou o primeiro campo de texto semelhante a um nome) que foi comparado com o nome esperado. `null` quando nenhum valor de nome estava disponível.", "example": "Sophia Martinez" }, "warnings": { "type": "array", "description": "Vazio em uma aprovação sem ressalvas. Cada entrada explica um risco detectado; entradas com `log_type: \"error\"` definem `status` como `Declined`, e entradas com `log_type: \"warning\"` o definem como `In Review`.", "items": { "type": "object", "properties": { "risk": { "type": "string", "enum": [ "DOCUMENT_AI_UNREADABLE_DOCUMENT", "DOCUMENT_AI_MISSING_REQUIRED_FIELDS", "DOCUMENT_AI_SUSPECTED_MANIPULATION", "DOCUMENT_AI_NAME_MISMATCH", "DOCUMENT_AI_UNSUPPORTED_FILE" ], "description": "Código de risco legível por máquina. Cada um é controlado pela opção de requisição `document_ai_*_action` correspondente.", "example": "DOCUMENT_AI_MISSING_REQUIRED_FIELDS" }, "feature": { "type": "string", "enum": [ "DOCUMENT_AI" ], "description": "Recurso que emitiu o aviso. Sempre `DOCUMENT_AI` neste endpoint." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Contexto adicional sobre o risco: `{\"missing_fields\": [\"Net pay\"]}` para campos obrigatórios ausentes, `{\"name_on_document\", \"score\", \"threshold\"}` para divergência de nome e o achado forense (`detection_method`, detalhes do produtor/editor) para suspeita de manipulação. `null` quando não há nada a acrescentar.", "example": { "missing_fields": [ "Net pay" ] } }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Severidade derivada da ação configurada: `error` (DECLINE), `warning` (REVIEW), `information` (NO_ACTION)." }, "short_description": { "type": "string", "description": "Descrição legível de uma linha do risco.", "example": "Required fields could not be extracted" }, "long_description": { "type": "string", "description": "Explicação legível, interpolada com `additional_data` quando relevante." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco do `vendor_data` que você enviou, ou `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Eco do objeto `metadata` que você enviou, ou `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Quando a requisição foi processada (UTC, ISO 8601)." } } } } } }, "400": { "description": "Erro de validação ou de processamento. Problemas em nível de campo retornam o envelope padrão do DRF (um array de mensagens para cada campo com problema). Documentos criptografados ou ilegíveis e falhas de extração retornam `{\"error\": ...}`.", "content": { "application/json": { "examples": { "Missing document": { "summary": "`document` não incluído nos dados do formulário", "value": { "document": [ "No file was submitted." ] } }, "Invalid fields payload": { "summary": "`fields` não é uma única string de array codificada em JSON", "value": { "fields": [ "fields must be a valid JSON array string." ] } }, "Duplicate field keys": { "summary": "Dois itens compartilham a mesma `key`", "value": { "fields": [ "Every fields item must have a unique key." ] } }, "Conflicting expectations": { "summary": "Expectativas de pessoa e de empresa enviadas juntas", "value": { "non_field_errors": [ "Provide either person expected-name fields or expected_company_name, not both." ] } }, "Invalid metadata": { "summary": "`metadata` não é um objeto JSON (ou contém um caractere NUL)", "value": { "metadata": [ "Metadata must be a JSON object." ] } }, "Oversized vendor_data": { "summary": "`vendor_data` acima do limite de 2.000 bytes", "value": { "vendor_data": [ "vendor_data is too long (maximum 2000 bytes)." ] } }, "Encrypted PDF": { "summary": "PDF protegido por senha", "value": { "error": "The PDF is encrypted. Please upload a decrypted PDF or a photo instead." } }, "Extraction failed": { "summary": "O pipeline de extração não conseguiu processar o documento", "value": { "error": [ "Error extracting Document AI information" ] } } }, "schema": { "type": "object", "additionalProperties": true } } } }, "403": { "description": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente e também quando o saldo da organização que faz a chamada não cobre a chamada; uma chave incorreta, revogada ou expirada retorna `401`. Uma chave ausente retorna `403` com `{\"detail\": ...}`; uma chave incorreta, revogada ou expirada retorna `401`. Créditos insuficientes (e organizações faturadas por contrato cuja tabela de tarifas não tem uma entrada para a Document AI API) retornam `403` com `{\"error\": ...}` antes de qualquer processamento do documento.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "O saldo da organização não cobre a chamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } }, "Contract rate missing": { "summary": "Organização com faturamento por contrato cuja tabela de tarifas não tem entrada para a 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": "Limite de requisições excedido. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API. A resposta inclui os cabeçalhos `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Mais de 300 requisições de escrita no minuto atual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.document_ai.analyze(\n document=open(\"document.pdf\", \"rb\"),\n fields=\"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.documentAi.analyze({\n document: await fileFromPath(\"document.pdf\"),\n fields: \"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.DocumentAi.Analyze(ctx, didit.DocumentAiAnalyzeParams{\n\tDocument: didit.FileFromPath(\"document.pdf\"),\n\tFields: \"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.types.DocumentAiAnalyzeParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.documentAi().analyze(DocumentAiAnalyzeParams.builder()\n .document(Path.of(\"document.pdf\"))\n .fields(\"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "documentAi->analyze([\n 'document' => File::fromPath('document.pdf'),\n 'fields' => '[{\"key\": \"employer_name\", \"name\": \"Employer name\", \"instruction\": \"The employer or company issuing the payslip.\", \"type\": \"text\", \"required\": true, \"is_full_name\": false}, {\"key\": \"employee_name\", \"name\": \"Employee name\", \"instruction\": \"The full name of the employee as printed on the payslip.\", \"type\": \"text\", \"required\": true, \"is_full_name\": true}, {\"key\": \"net_pay\", \"name\": \"Net pay\", \"instruction\": \"The net amount paid to the employee for the period.\", \"type\": \"number\", \"required\": true, \"is_full_name\": false}, {\"key\": \"pay_date\", \"name\": \"Pay date\", \"instruction\": \"The payment date shown on the payslip.\", \"type\": \"date\", \"required\": false, \"is_full_name\": false}]',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.document_ai.analyze(\n document: Pathname(\"document.pdf\"),\n fields: \"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.DocumentAi.AnalyzeAsync(new DocumentAiAnalyzeParams\n{\n Document = FileUpload.FromPath(\"document.pdf\"),\n Fields = \"[{\\\"key\\\": \\\"employer_name\\\", \\\"name\\\": \\\"Employer name\\\", \\\"instruction\\\": \\\"The employer or company issuing the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"employee_name\\\", \\\"name\\\": \\\"Employee name\\\", \\\"instruction\\\": \\\"The full name of the employee as printed on the payslip.\\\", \\\"type\\\": \\\"text\\\", \\\"required\\\": true, \\\"is_full_name\\\": true}, {\\\"key\\\": \\\"net_pay\\\", \\\"name\\\": \\\"Net pay\\\", \\\"instruction\\\": \\\"The net amount paid to the employee for the period.\\\", \\\"type\\\": \\\"number\\\", \\\"required\\\": true, \\\"is_full_name\\\": false}, {\\\"key\\\": \\\"pay_date\\\", \\\"name\\\": \\\"Pay date\\\", \\\"instruction\\\": \\\"The payment date shown on the payslip.\\\", \\\"type\\\": \\\"date\\\", \\\"required\\\": false, \\\"is_full_name\\\": false}]\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/aml/": { "post": { "summary": "Análise AML (independente)", "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": "Chave opcional para repetir requisições com segurança, com até 255 caracteres. Reutilizar a mesma chave com o mesmo corpo de requisição retorna a resposta original, sem executar nem cobrar uma segunda análise. Reutilizar a chave com um corpo diferente retorna `409`.", "schema": { "type": "string", "maxLength": 255 } } ], "description": "Analise uma pessoa ou empresa em bases de dados de PEP, sanções, avisos/listas de monitoramento e mídia adversa em uma única chamada.\n\n**Modelo de duas pontuações.** Cada ocorrência traz um `match_score` (0–100, confiança na identidade) e um `risk_score` (0–100, risco da entidade). As ocorrências cujo `match_score` fica abaixo de `aml_match_score_threshold` (padrão **93**) recebem a marcação `review_status: \"False Positive\"` e são ignoradas para fins de risco; o maior `risk_score` entre as ocorrências restantes se torna `aml.score`. O `aml.status` final segue seus limiares: `score` > `aml_score_review_threshold` (padrão **100**) → `Declined`; `score` > `aml_score_approve_threshold` (padrão **80**) → `In Review`; caso contrário, `Approved`. Sempre que `score` for diferente de zero e ≥ ao limiar de aprovação, um aviso `POSSIBLE_MATCH_FOUND` é adicionado (uma pontuação exatamente igual a 0 nunca gera aviso).\n\n**Pesos da pontuação de correspondência.** `aml_name_weight` + `aml_dob_weight` + `aml_country_weight` devem somar exatamente 100 (padrões 60/25/15). Os componentes ausentes da requisição são descartados e os pesos restantes são renormalizados; um `document_number` correspondente atua como chave definitiva (golden key), que substitui o `match_score` por 100.\n\n**Latência.** Análises simples normalmente terminam em poucos segundos. Com `include_adverse_media=true`, a API aguarda o enriquecimento de mídia adversa (uma pausa inicial de ~5 s, mais até ~25 s de polling); configure no cliente um timeout de **pelo menos 60 segundos**.\n\n**Persistência.** `save_api_request` tem como padrão **true**: a análise é armazenada como uma sessão (`request_id` funciona com `GET /v3/session/{sessionId}/decision/`), aparece no console, um webhook `status.updated` é disparado e os status de revisão das ocorrências podem ser atualizados depois. Com `save_api_request=false`, nada é armazenado e `request_id` é um ID de correlação temporário. `include_ongoing_monitoring=true` continua reanalisando o perfil e exige `save_api_request=true` (validado com um `400`).\n\n**Idempotência.** Envie um cabeçalho `Idempotency-Key` ao tentar novamente após um timeout ou erro transitório. A chave tem como escopo a sua aplicação e o corpo exato da requisição. A primeira requisição concluída armazena a resposta; novas tentativas idênticas posteriores retornam essa mesma resposta e não executam nem cobram outra análise AML. Se a requisição original ainda estiver em execução, tente novamente mais tarde com a mesma chave. Se a mesma chave for reutilizada com um corpo diferente, a API retorna `409`.\n\n**Faturamento.** Um crédito da API AML é cobrado após a primeira análise bem-sucedida. Respostas idempotentes reproduzidas não são cobradas novamente; saldo insuficiente retorna `403` antes que qualquer nova análise aconteça.\n\n**Sandbox.** Chaves de aplicações de sandbox ignoram totalmente a análise e o faturamento e retornam um resultado simulado: `Approved` sem ocorrências, a menos que você envie `sandbox_scenario`. `save_api_request` funciona da mesma forma que nas chaves de produção, então uma análise de sandbox salva pode ser recuperada por meio de `GET /v3/session/{sessionId}/decision/` e `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": "Nome completo da pessoa ou empresa a ser analisada. Mínimo de **2 caracteres**, o limite mínimo do próprio provedor de análise. Um nome mais curto ou em branco retorna `400` neste campo antes de qualquer análise ser executada, portanto nada é cobrado.", "example": "Antonio Ejemplo Modelo" }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "default": "person", "description": "Tipo de entidade a ser analisada. O padrão é `person`." }, "date_of_birth": { "type": "string", "format": "date", "description": "Data de nascimento (pessoas) ou data de constituição (empresas), `YYYY-MM-DD`. Melhora a precisão da correspondência por meio do peso da data de nascimento.", "example": "1972-02-29" }, "nationality": { "type": "string", "description": "Código de país ISO 3166-1 **alpha-2** (por exemplo, `ES`). Códigos inválidos retornam `400`. Melhora a precisão da correspondência por meio do peso do país.", "example": "ES" }, "document_number": { "type": "string", "description": "Número do documento de identidade. Não tem peso: funciona como uma chave de ouro. Uma correspondência exata eleva a `match_score` do resultado para 100, e uma divergência clara a penaliza. É enviado ao provedor de análise como filtro de busca apenas quando tem **2-50 caracteres**; um valor fora desse intervalo é aceito e armazenado, e a análise ainda é executada e cobrada, apenas sem ser restringida pelo número do documento." }, "aml_score_approve_threshold": { "type": "number", "minimum": 0, "maximum": 100, "default": 80, "description": "Limiar da pontuação de risco igual ou abaixo do qual o resultado é `Approved`. Deve ser ≤ `aml_score_review_threshold` (caso contrário, `400`)." }, "aml_score_review_threshold": { "type": "number", "minimum": 0, "maximum": 100, "default": 100, "description": "Limiar da pontuação de risco acima do qual o resultado é `Declined`. Pontuações entre os dois limiares resultam em `In Review`." }, "aml_name_weight": { "type": "integer", "minimum": 0, "maximum": 100, "default": 60, "description": "Peso da similaridade de nome na pontuação de correspondência por ocorrência. Os três pesos devem somar exatamente 100 (caso contrário, `400`)." }, "aml_dob_weight": { "type": "integer", "minimum": 0, "maximum": 100, "default": 25, "description": "Peso da data de nascimento na pontuação de correspondência por ocorrência." }, "aml_country_weight": { "type": "integer", "minimum": 0, "maximum": 100, "default": 15, "description": "Peso do país/nacionalidade na pontuação de correspondência por ocorrência." }, "aml_match_score_threshold": { "type": "integer", "minimum": 0, "maximum": 100, "default": 93, "description": "Limite de corte por resultado: resultados com `match_score` abaixo deste valor são `False Positive` (excluídos da avaliação de risco); os que estão neste valor ou acima são possíveis correspondências `Unreviewed`." }, "include_adverse_media": { "type": "boolean", "default": false, "description": "Também pesquisa veículos de notícias em busca de cobertura negativa. Adiciona até ~30 s de latência enquanto os resultados são coletados; use um timeout de cliente de ≥60 s." }, "include_ongoing_monitoring": { "type": "boolean", "default": false, "description": "Continua a reanalisar este perfil e envia as alterações via webhook. Requer `save_api_request=true` (caso contrário, `400`)." }, "save_api_request": { "type": "boolean", "default": true, "description": "Salva a análise como uma sessão (visibilidade no console, endpoint de decisão, webhooks, revisão de ocorrências). Defina como `false` para uma verificação sem estado." }, "vendor_data": { "type": "string", "description": "Seu identificador para o usuário analisado; retornado na resposta e armazenado com a sessão." }, "metadata": { "type": "object", "nullable": true, "description": "JSON livre armazenado com a requisição e retornado na resposta." }, "sandbox_scenario": { "type": "string", "description": "Slug de cenário exclusivo de sandbox. Só é aceito quando a chave de API pertence a uma aplicação em modo sandbox; é rejeitado em aplicações em produção. Uma triagem avulsa não tem sessão para preparar, então o slug vai na própria requisição de triagem: `decline_aml_hit` retorna um resultado com formato de produção e conclui a triagem como `Declined`, `review_aml_possible_match` a conclui como `In Review`, e um cenário que não prepara nenhum resultado AML deixa a triagem limpa. Consulte o catálogo de cenários em GET /v1/sandbox/scenarios/ ou [Sandbox e dados de teste](/pt-br/integration/sandbox-testing).", "example": "decline_aml_hit" } } }, "example": { "full_name": "Antonio Ejemplo Modelo", "entity_type": "person", "date_of_birth": "1972-02-29", "nationality": "ES", "include_adverse_media": false, "vendor_data": "user-1234" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/aml/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -H 'Idempotency-Key: aml-user-1234-2026-08-20' \\\n -d '{\n \"full_name\": \"Antonio Ejemplo Modelo\",\n \"entity_type\": \"person\",\n \"date_of_birth\": \"1972-02-29\",\n \"nationality\": \"ES\",\n \"include_adverse_media\": false,\n \"vendor_data\": \"user-1234\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.aml.screen(\n full_name=\"Antonio Ejemplo Modelo\",\n entity_type=\"person\",\n date_of_birth=\"1972-02-29\",\n nationality=\"ES\",\n include_adverse_media=False,\n vendor_data=\"user-1234\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.aml.screen({\n full_name: \"Antonio Ejemplo Modelo\",\n entity_type: \"person\",\n date_of_birth: \"1972-02-29\",\n nationality: \"ES\",\n include_adverse_media: false,\n vendor_data: \"user-1234\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.AML.Screen(ctx, didit.AMLScreenParams{\n\tFullName: \"Antonio Ejemplo Modelo\",\n\tEntityType: didit.Some(didit.AMLScreenParamsEntityType(\"person\")),\n\tDateOfBirth: didit.String(\"1972-02-29\"),\n\tNationality: didit.String(\"ES\"),\n\tIncludeAdverseMedia: didit.Bool(false),\n\tVendorData: didit.String(\"user-1234\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport me.didit.Didit;\nimport me.didit.types.AmlScreenParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.aml().screen(AmlScreenParams.builder()\n .fullName(\"Antonio Ejemplo Modelo\")\n .entityType(AmlScreenParams.EntityType.of(\"person\"))\n .dateOfBirth(LocalDate.parse(\"1972-02-29\"))\n .nationality(\"ES\")\n .includeAdverseMedia(false)\n .vendorData(\"user-1234\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "aml->screen([\n 'full_name' => 'Antonio Ejemplo Modelo',\n 'entity_type' => 'person',\n 'date_of_birth' => '1972-02-29',\n 'nationality' => 'ES',\n 'include_adverse_media' => false,\n 'vendor_data' => 'user-1234',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.aml.screen(\n full_name: \"Antonio Ejemplo Modelo\",\n entity_type: \"person\",\n date_of_birth: \"1972-02-29\",\n nationality: \"ES\",\n include_adverse_media: false,\n vendor_data: \"user-1234\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Aml.ScreenAsync(new AmlScreenParams\n{\n FullName = \"Antonio Ejemplo Modelo\",\n EntityType = new AmlScreenParamsEntityType(\"person\"),\n DateOfBirth = \"1972-02-29\",\n Nationality = \"ES\",\n IncludeAdverseMedia = false,\n VendorData = \"user-1234\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Análise concluída. `aml.status` reflete seus limiares; toda ocorrência igual ou acima do piso interno de inclusão é listada em `aml.hits` com seu `match_score` de identidade, o `risk_score` da entidade e um `score_breakdown` que explica a correspondência.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID da sessão persistida quando `save_api_request=true` (utilizável com `GET /v3/session/{sessionId}/decision/`); caso contrário, um UUID de correlação transitório." }, "aml": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "`Declined` quando `score` > `aml_score_review_threshold`; `In Review` quando `score` > `aml_score_approve_threshold`; `Approved` caso contrário (inclusive quando não há pontuação disponível)." }, "total_hits": { "type": "integer", "description": "Número de entradas em `hits`." }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Eco do tipo de entidade analisada." }, "hits": { "type": "array", "items": { "type": "object", "description": "Uma ocorrência da análise. `match_score` (0–100) mede a confiança na identidade: ocorrências abaixo de `aml_match_score_threshold` são marcadas com `review_status: \"False Positive\"` e excluídas da avaliação de risco; ocorrências iguais ou acima dele são possíveis correspondências `\"Unreviewed\"`. `risk_score` (0–100) mede o quão arriscada é a entidade correspondida e determina o `aml.score` de nível superior.", "properties": { "id": { "type": "string", "nullable": true, "description": "Identificador estável da Didit para o hit: `hit_` seguido de 24 caracteres hexadecimais. A mesma entidade correspondente mantém o mesmo `id` quando o titular é analisado novamente. Passe-o como `hit_id` para os endpoints de revisão de hits AML." }, "url": { "type": "string", "nullable": true, "description": "URL de origem da entidade correspondente, quando disponível." }, "match": { "type": "boolean", "nullable": true, "description": "Flag legada de correspondência exata. Prefira `match_score` + `review_status`." }, "score": { "type": "number", "nullable": true, "description": "OBSOLETO. Pontuação de correspondência ponderada no intervalo de 0 a 1. Use `match_score` em vez disso." }, "match_score": { "type": "number", "nullable": true, "description": "Confiança de identidade (0–100). Comparada com `aml_match_score_threshold` para separar Falsos Positivos de Possíveis Correspondências." }, "risk_score": { "type": "number", "nullable": true, "description": "Pontuação de risco da entidade (0–100). A maior `risk_score` entre os resultados que não são falsos positivos se torna o `aml.score` de nível superior." }, "target": { "type": "boolean", "nullable": true }, "caption": { "type": "string", "nullable": true, "description": "Nome de exibição da entidade correspondente." }, "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": "Categorias de risco em que a entidade está listada: `PEP` (com seu nível, de `PEP Level 1` a `PEP Level 4`), `Sanctions`, `Adverse Media`, `Warnings and Regulatory Enforcement`, `Fitness and Probity`, `SIP`, `SIE` ou `Insolvency`. `Other Lists` quando a fonte da entidade não indica nenhuma dessas categorias." }, "features": { "type": "object", "nullable": true }, "properties": { "type": "object", "nullable": true, "description": "Perfil da entidade: `name`, `alias`, `notes`, `gender`, `birthDate`, `birthPlace`, `nationality`, `position` e outros arrays biográficos (cada um pode ser nulo)." }, "rca_name": { "type": "string", "nullable": true, "description": "Nome do associado próximo relacionado por meio do qual a entidade foi correspondida, quando o resultado é um RCA." }, "pep_matches": { "type": "array", "description": "Entradas da lista de PEP que fundamentam este resultado.", "items": { "type": "object", "properties": { "list_name": { "type": "string" }, "publisher": { "type": "string" }, "source_url": { "type": "string" }, "description": { "type": "string" }, "matched_name": { "type": "string" }, "pep_position": { "type": "string" }, "date_of_birth": { "type": "string" }, "place_of_birth": { "type": "string" }, "aliases": { "type": "array", "items": { "type": "string" } }, "education": { "type": "array", "items": { "type": "string" } }, "other_sources": { "type": "array", "items": { "type": "string" } } } } }, "sanction_matches": { "type": "array", "items": { "type": "object" }, "description": "Entradas da lista de sanções que sustentam este resultado (mesmo formato de lista de origem de `pep_matches`, mais campos específicos de sanções)." }, "warning_matches": { "type": "array", "items": { "type": "object" }, "description": "Entradas de aviso/lista de monitoramento que fundamentam esta ocorrência." }, "adverse_media_matches": { "type": "array", "description": "Artigos de mídia adversa. Preenchido apenas quando `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": "Sentimento agregado de mídia adversa para a entidade (`sentiment`, `sentiment_score`, mapa de frequência `adverse_keywords`). Preenchido apenas quando `include_adverse_media=true`." }, "first_seen": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a entidade apareceu pela primeira vez nos conjuntos de dados." }, "last_seen": { "type": "string", "format": "date-time", "nullable": true, "description": "Atualização mais recente do conjunto de dados que incluiu a entidade." }, "linked_entities": { "type": "array", "description": "Relacionamentos conhecidos da entidade correspondente (familiares, associados, empresas).", "items": { "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" } }, "relation": { "type": "array", "items": { "type": "string" } }, "status": { "type": "array", "items": { "type": "string" } }, "details": { "type": "array", "items": { "type": "string" } }, "active": { "type": "array", "items": { "type": "string" } } } } }, "risk_view": { "type": "object", "nullable": true, "description": "Detalhamento do risco por dimensão (`crimes`, `countries`, `categories`, `custom_list`), cada uma com `score`, `weightage`, `risk_level` e um mapa `risk_scores`." }, "additional_information": { "type": "object", "nullable": true, "description": "Contexto adicional livre, por exemplo, um array `flag_summary` que explica por que a entidade foi sinalizada." }, "review_status": { "type": "string", "nullable": true, "enum": [ "False Positive", "Unreviewed", "Confirmed Match", "Inconclusive" ], "description": "`False Positive`: `match_score` abaixo de `aml_match_score_threshold`, excluído da avaliação de risco. `Unreviewed`: possível correspondência aguardando revisão. `Confirmed Match` / `Inconclusive`: definidos manualmente por um revisor (pelo Business Console) em sessões salvas; esse recurso de revisão não faz parte desta especificação." }, "score_breakdown": { "type": "object", "nullable": true, "description": "Como `match_score` foi calculado. Nome, data de nascimento e país contribuem, cada um, com `_score` × `_weight_normalized` pontos; os pesos são renormalizados quando um componente está ausente dos dados analisados. O número do documento não tem peso; ele funciona como uma 'chave de ouro': `MATCH` substitui a pontuação por 100, `NEUTRAL` a mantém inalterada e `HARD_MISMATCH` aplica uma penalidade.", "properties": { "name_score": { "type": "integer", "nullable": true, "description": "Similaridade bruta de nome (0–100)." }, "name_weight": { "type": "integer", "nullable": true, "description": "Peso configurado do nome (`aml_name_weight`)." }, "name_weight_normalized": { "type": "number", "nullable": true, "description": "Peso do nome após a renormalização (0–100)." }, "name_contribution": { "type": "number", "nullable": true, "description": "Pontos com que o nome contribuiu para `total_score`." }, "dob_score": { "type": "integer", "nullable": true, "description": "Pontuação da data de nascimento como porcentagem do seu peso (−100 a 100)." }, "dob_weight": { "type": "integer", "nullable": true, "description": "Peso configurado da data de nascimento (`aml_dob_weight`)." }, "dob_weight_normalized": { "type": "number", "nullable": true, "description": "Peso da data de nascimento após a renormalização (0 a 100)." }, "dob_contribution": { "type": "number", "nullable": true, "description": "Pontos com que a data de nascimento contribuiu para `total_score`." }, "country_score": { "type": "integer", "nullable": true, "description": "Pontuação do país como porcentagem do seu peso (−100 a 100)." }, "country_weight": { "type": "integer", "nullable": true, "description": "Peso configurado do país (`aml_country_weight`)." }, "country_weight_normalized": { "type": "number", "nullable": true, "description": "Peso do país após a renormalização (0–100)." }, "country_contribution": { "type": "number", "nullable": true, "description": "Pontos com que o país contribuiu para `total_score`." }, "document_number_match_type": { "type": "string", "nullable": true, "enum": [ "MATCH", "NEUTRAL", "HARD_MISMATCH" ], "description": "Resultado golden key da comparação do número do documento." }, "document_number_effect": { "type": "string", "nullable": true, "description": "Descrição legível do efeito do número do documento." }, "total_score": { "type": "integer", "nullable": true, "description": "Pontuação de correspondência ponderada final (0–100), espelha `match_score`." } } } } } }, "score": { "type": "number", "nullable": true, "description": "Pontuação de risco AML geral (0–100): o maior `risk_score` entre os resultados que não são falsos positivos. Determina o `status` por meio dos dois limiares." }, "screened_data": { "type": "object", "description": "Eco do que foi analisado: `full_name`, `date_of_birth`, `nationality`, `document_number` (campos ausentes são `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": "Recurso que emitiu o aviso." }, "risk": { "type": "string", "description": "Identificador de risco legível por máquina." }, "additional_data": { "type": "object", "nullable": true, "description": "Contexto adicional sobre o aviso, quando disponível." }, "log_type": { "type": "string", "description": "`warning`, `information` ou `error`: como o risco afetou o resultado." }, "short_description": { "type": "string", "description": "Resumo legível de uma linha." }, "long_description": { "type": "string", "description": "Explicação completa e legível." } } }, "description": "Contém um aviso `POSSIBLE_MATCH_FOUND` sempre que `score` é diferente de zero e ≥ `aml_score_approve_threshold` (uma pontuação exatamente 0 nunca gera aviso); vazio caso contrário." } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco dos `vendor_data` que você enviou." }, "metadata": { "type": "object", "nullable": true, "description": "Eco do `metadata` que você enviou." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "No hits (Approved)": { "summary": "Triagem limpa: nenhuma correspondência", "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": "Uma possível correspondência de PEP; a pontuação de risco 73 fica abaixo do limiar padrão de aprovação 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": "Erro de validação. Problemas no nível de campo retornam o envelope padrão do DRF (um array de mensagens por campo com problema); regras entre campos (soma dos pesos, ordem dos limiares, monitoramento sem salvar) retornam `{\"error\": [...]}`.", "content": { "application/json": { "examples": { "Missing full_name": { "summary": "`full_name` é o único campo obrigatório", "value": { "full_name": [ "This field is required." ] } }, "Short full_name": { "summary": "`full_name` deve ter pelo menos 2 caracteres", "value": { "full_name": [ "Ensure this field has at least 2 characters." ] } }, "Invalid nationality": { "summary": "`nationality` deve estar no formato 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": "Limiar de aprovação acima do limiar de revisão", "value": { "error": [ "Approve threshold (90.0) cannot be greater than review threshold (80.0)" ] } }, "Monitoring without saving": { "summary": "`include_ongoing_monitoring=true` com `save_api_request=false`", "value": { "error": [ "Ongoing monitoring can only be enabled when the API request is saved." ] } } } } } }, "403": { "description": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente e também quando o saldo da organização que faz a chamada não cobre a chamada; uma chave incorreta, revogada ou expirada retorna `401`. Uma chave ausente retorna `403` com `{\"detail\": ...}`; uma chave incorreta, revogada ou expirada retorna `401`. Créditos insuficientes retornam `403` com `{\"error\": ...}` antes de qualquer análise ou chamada a provedores.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "O saldo da organização não cobre a chamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Limite de requisições excedido. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API. A resposta inclui os cabeçalhos `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Mais de 300 requisições de escrita no minuto atual", "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": "Busca facial", "description": "Pesquise uma imagem de rosto (1:N) no índice de busca facial da sua aplicação — rostos cadastrados a partir de sessões de verificação, chamadas avulsas à API que foram salvas, envios diretos de rostos para perfis de usuário e suas listas de bloqueio/permissão — e receba correspondências de similaridade ordenadas, além de avisos de lista de bloqueio e de duplicidade.\n\n**Como funciona.** O maior rosto detectado em `user_image` é convertido em embedding e pesquisado no índice, restrito à sua aplicação. Até **5 correspondências** acima do limite mínimo de similaridade são retornadas em `matches`, cada uma com `similarity_percentage`, a sessão de origem (`session_id`, `session_number`, `status`, `vendor_data`), os `user_details` extraídos durante a verificação de documento dessa sessão, as flags `is_blocklisted` / `is_allowlisted` e um discriminador `source` (`session`, `imported` ou `list_entry`).\n\n- `search_type=most_similar` (padrão) ordena todos os rostos cadastrados por similaridade — use-o para deduplicação e investigação de redes de fraude.\n- `search_type=blocklisted_or_approved` restringe os candidatos a rostos na lista de bloqueio, rostos na lista de permissão, rostos de sessões aprovadas e rostos importados de perfis de usuário, ordenando primeiro as entradas da lista de bloqueio — use-o quando o objetivo principal for a triagem na lista de bloqueio.\n\n`status` é `Declined` somente quando um aviso `FACE_IN_BLOCKLIST` ou `POSSIBLE_FACE_IN_BLOCKLIST` é disparado; `DUPLICATED_FACE` / `POSSIBLE_DUPLICATED_FACE` (`information`) e `MULTIPLE_FACES_DETECTED` (`warning`) nunca causam recusa. Diferentemente da Prova de vida passiva, este endpoint **não** exclui da correspondência sessões anteriores com o mesmo `vendor_data`. Uma análise de prova de vida passiva também é executada internamente e armazenada com a sessão persistida, mas seu resultado não faz parte desta resposta.\n\n**Faturamento.** Cada resposta `200` consome um crédito da API de Busca facial (pago com o crédito do seu plano ou com o saldo de recarga). Saldo insuficiente retorna `403` antes de qualquer processamento de imagem.\n\n**Persistência da sessão e cadastro do rosto (`save_api_request`, padrão `true`).** Quando `true`, a chamada é persistida como uma sessão do tipo API (Business Console, `GET /v3/session/{sessionId}/decision/` por meio do `request_id` retornado, webhook `status.updated`) e o rosto pesquisado é cadastrado no seu índice de busca facial. Rostos cadastrados por chamadas de Busca facial são excluídos dos resultados futuros da Busca facial, de modo que pesquisas repetidas nunca correspondem entre si. Quando `false`, a chamada é avulsa: nada é armazenado, o rosto não é cadastrado e os valores de `match_image_url` são caminhos de armazenamento internos, e não URLs para download.\n\n**Sandbox.** Chaves de API de sandbox ignoram todo o processamento e o faturamento: após a validação da requisição (entradas malformadas ainda retornam `400`), o endpoint retorna um payload simulado estático `Approved`, nenhuma sessão é persistida e nenhum crédito é consumido.\n\n**Autenticação.** Envie a chave de API da sua aplicação no cabeçalho `x-api-key`. Credenciais ausentes ou inválidas retornam `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`) — esta API nunca retorna `401`.\n\n**Limite de requisições.** Cota de escrita compartilhada de 300 requisições/min por chave de API em todos os endpoints POST/PATCH/DELETE; ao excedê-la, a API retorna `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": "Imagem frontal do rosto a ser usada na busca. Extensões permitidas: `tiff`, `jpg`, `jpeg`, `png`, `webp`. Tamanho máximo de upload: **5 MB** (arquivos maiores são rejeitados com `400`). As imagens são comprimidas automaticamente para ~0,5 MB antes do processamento, portanto resoluções muito altas não melhoram a precisão. A imagem deve conter pelo menos um rosto detectável; caso contrário, o endpoint retorna `400`. Quando há vários rostos, a busca é feita pelo maior e um aviso `MULTIPLE_FACES_DETECTED` é adicionado." }, "search_type": { "type": "string", "default": "most_similar", "enum": [ "most_similar", "blocklisted_or_approved" ], "description": "Política de busca. `most_similar` (padrão) classifica todos os rostos cadastrados na sua aplicação por similaridade. `blocklisted_or_approved` restringe os candidatos a rostos da lista de bloqueio, rostos da lista de permissões, rostos de sessões aprovadas e rostos importados de perfis de usuário — com as entradas da lista de bloqueio classificadas primeiro.", "example": "most_similar" }, "rotate_image": { "type": "boolean", "default": false, "description": "Quando `true`, o serviço testa rotações de 90 graus da entrada e usa a orientação que produz a melhor detecção de rosto. Útil quando a orientação EXIF está ausente. Aumenta a latência.", "example": false }, "save_api_request": { "type": "boolean", "default": true, "description": "Quando `true` (padrão), persiste a chamada como uma sessão do tipo API, emite um webhook `status.updated`, gera URLs pré-assinadas para os valores de `match_image_url` e cadastra o rosto pesquisado no seu índice de busca facial (os cadastros da Busca facial são excluídos de buscas futuras). Quando `false`, a busca é avulsa: nenhuma sessão é armazenada e o rosto não é cadastrado.", "example": true }, "vendor_data": { "type": "string", "description": "Identificador opaco opcional (seu ID de usuário, e-mail, UUID…) armazenado na sessão persistida e devolvido. Ele não exclui rostos do mesmo usuário dos resultados da busca.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objeto JSON opcional armazenado com a sessão (quando `save_api_request=true`) e devolvido. Em requisições multipart, envie-o como um campo de string codificada em JSON, que é convertido em um objeto.", "example": { "flow": "dedup_check" } } } }, "example": { "user_image": "(binary JPEG/PNG selfie)", "search_type": "most_similar", "rotate_image": false, "save_api_request": true, "vendor_data": "user-123", "metadata": { "flow": "dedup_check" } } } } }, "responses": { "200": { "description": "Busca facial concluída. `face_search.matches` contém até 5 rostos semelhantes ordenados por similaridade; um array vazio significa que nenhum rosto cadastrado ultrapassou o limite mínimo de similaridade. `status` é `Declined` apenas em ocorrências na lista de bloqueio: correspondências duplicadas por si só retornam `Approved`, portanto verifique `matches` e `warnings`, não apenas `status`. Quando `save_api_request=true`, `request_id` é o ID da sessão persistida. Cada correspondência traz `source` (`session`, `imported`, `list_entry` ou `retained_template`), `vendor_user_id` e `biometric_template_id`; uma correspondência `retained_template` vem de um template biométrico sem imagem mantido após a exclusão da sessão de origem e tem campos de sessão, `match_image_url` e `user_details` como `null`.", "content": { "application/json": { "examples": { "Blocklist hit (Declined)": { "summary": "O rosto corresponde a um rosto da lista de bloqueio", "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": "O rosto já apareceu em outra sessão aprovada — apenas informativo, sem recusa", "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": "Nenhuma face cadastrada superou o limite mínimo de similaridade", "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 da sessão persistida quando `save_api_request=true` (utilizável com `GET /v3/session/{sessionId}/decision/`); caso contrário, um UUID de correlação transitório." }, "face_search": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Declined` somente quando um aviso `FACE_IN_BLOCKLIST` ou `POSSIBLE_FACE_IN_BLOCKLIST` foi disparado. Correspondências duplicadas e avisos de múltiplos rostos nunca causam recusa." }, "total_matches": { "type": "integer", "description": "Número de entradas em `matches` (0–5).", "example": 1 }, "matches": { "type": "array", "maxItems": 5, "description": "Até 5 rostos do seu índice de busca facial que ultrapassam o limite mínimo de similaridade, ordenados por similaridade (com as entradas da lista de bloqueio classificadas primeiro quando `search_type=blocklisted_or_approved`). Vazio quando nenhum rosto cadastrado é suficientemente semelhante.", "items": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID da sessão de verificação à qual pertence o rosto correspondente. `null` quando `source` é `imported`, `list_entry` ou `retained_template`.", "example": "882c42d5-8a4d-4d20-8080-a22f57822c86" }, "session_number": { "type": "integer", "nullable": true, "description": "Número de sessão de fácil leitura exibido no Business Console. `null` para correspondências que não são sessões.", "example": 323442 }, "similarity_percentage": { "type": "number", "format": "float", "minimum": 0, "maximum": 100, "description": "Similaridade entre o rosto enviado e o rosto correspondente (0–100).", "example": 99.99 }, "source": { "type": "string", "enum": [ "session", "imported", "list_entry", "retained_template" ], "description": "De onde o rosto correspondente foi cadastrado: `session`: uma sessão de verificação ou uma chamada avulsa à API salva; `imported`: um rosto enviado diretamente para um perfil de usuário; `list_entry`: um rosto vinculado a uma das suas listas; `retained_template`: um template biométrico sem imagem armazenado em um usuário, listado em `/v3/biometric-templates/`." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` da sessão correspondente ou do User vinculado, para rostos importados e com template biométrico retido.", "example": "user-1" }, "vendor_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID do User vinculado. `null` para entradas de lista e correspondências de sessão sem User.", "example": "2f7c1a9e-4b28-4a6d-97f1-83576f80e1b4" }, "biometric_template_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Id do template biométrico retido. Definido somente quando `source` é `retained_template`; caso contrário, `null`.", "example": null }, "verification_date": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o rosto correspondente foi capturado originalmente, ou quando um template retido foi criado (`YYYY-MM-DDThh:mm:ssZ`). `null` para correspondências `list_entry`.", "example": "2025-01-01T00:00:00Z" }, "user_details": { "type": "object", "nullable": true, "description": "Dados de identidade extraídos durante a verificação de documento da sessão correspondente. `null` quando a sessão correspondente não tem dados de documento (por exemplo, sessões apenas de prova de vida) e sempre `null` para correspondências `retained_template`. Para correspondências `source: imported`, é preenchido a partir do perfil do usuário: `full_name` preenchido, `document_type`/`document_number` nulos.", "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 com tempo limitado (`https:///...`) da imagem de referência do rosto correspondente quando `save_api_request=true`. Com `save_api_request=false`, este é um caminho de armazenamento interno que não pode ser baixado diretamente. Sempre `null` para correspondências `retained_template`, porque os templates retidos não contêm imagem.", "example": "https:///face/3f6a1c2e/reference.jpg" }, "status": { "type": "string", "nullable": true, "description": "Status da sessão correspondente (`Approved`, `Declined`, `In Review`, …). `null` para correspondências `imported`/`list_entry`.", "example": "Approved" }, "is_blocklisted": { "type": "boolean", "description": "`true` quando o rosto correspondente está na sua lista de bloqueio de rostos. Qualquer correspondência suficientemente semelhante na lista de bloqueio recusa a busca." }, "is_allowlisted": { "type": "boolean", "description": "`true` quando o rosto correspondente está em uma das suas listas de permissão. Correspondências em listas de permissão suprimem os avisos de duplicidade." }, "api_service": { "type": "string", "nullable": true, "description": "Preenchido quando o rosto correspondente foi cadastrado por uma chamada de API independente (por exemplo, `PASSIVE_LIVENESS`); `null` para sessões de verificação comuns e rostos importados.", "example": null } } } }, "user_image": { "type": "object", "description": "Resultados da detecção facial para a imagem enviada. Os itens aqui contêm apenas `bbox` e `confidence`.", "properties": { "entities": { "type": "array", "description": "Uma entrada por rosto detectado. O maior rosto é o usado na busca.", "items": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Caixa delimitadora `[x_min, y_min, x_max, y_max]` em pixels.", "example": [ 40, 40, 120, 120 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Confiança da detecção facial (0–1).", "example": 0.732973 } } } }, "best_angle": { "type": "integer", "description": "Rotação (em graus) que produziu a melhor detecção de rosto; diferente de zero apenas quando `rotate_image=true` corrigiu a orientação. Nunca é nula neste endpoint (o padrão é 0 quando o modelo a omite).", "example": 0 } } }, "warnings": { "type": "array", "description": "Sinais de risco. `FACE_IN_BLOCKLIST` / `POSSIBLE_FACE_IN_BLOCKLIST` (`error`) recusam a busca. `MULTIPLE_FACES_DETECTED` (`warning`) e `DUPLICATED_FACE` / `POSSIBLE_DUPLICATED_FACE` (`information`) são apenas informativos.", "items": { "type": "object", "properties": { "risk": { "type": "string", "enum": [ "MULTIPLE_FACES_DETECTED", "FACE_IN_BLOCKLIST", "POSSIBLE_FACE_IN_BLOCKLIST", "DUPLICATED_FACE", "POSSIBLE_DUPLICATED_FACE" ], "description": "Código de risco legível por máquina." }, "feature": { "type": "string", "enum": [ "LIVENESS" ], "description": "Recurso que emitiu o aviso. Sempre `LIVENESS` neste endpoint." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "`null` para `MULTIPLE_FACES_DETECTED`. Ocorrências na lista de bloqueio trazem `{blocklisted_session_id, blocklisted_session_number, api_service}`; ocorrências de duplicata trazem `{duplicated_session_id, duplicated_session_number, api_service}`, apontando para a primeira sessão correspondente." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Severidade. Avisos `error` levam o `status` para `Declined`; entradas `warning` e `information` são apenas informativas e nunca recusam a sessão por conta própria." }, "short_description": { "type": "string", "description": "Resumo legível do risco em uma linha." }, "long_description": { "type": "string", "description": "Explicação legível do risco." } } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco do `vendor_data` que você enviou, ou `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Eco do objeto `metadata` que você enviou, ou `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp ISO 8601 (UTC) do momento em que a resposta foi gerada, por exemplo `2026-06-12T01:04:42.763237+00:00`." } } } } } }, "400": { "description": "Erro de validação. Retornado quando `user_image` está ausente, excede 5 MB ou tem uma extensão não suportada, ou quando **nenhum rosto é detectado** na imagem enviada. Erros de campo usam o envelope `{field: [messages]}` do DRF; falhas de detecção facial usam `{\"error\": ...}`.", "content": { "application/json": { "examples": { "No face detected": { "summary": "A imagem é decodificada corretamente, mas não contém nenhum rosto detectável", "value": { "error": "No face detected in the image" } }, "Missing image": { "summary": "`user_image` não incluído nos dados do formulário", "value": { "user_image": [ "No file was submitted." ] } }, "Unsupported file extension": { "summary": "Extensão de arquivo fora de tiff/jpg/jpeg/png/webp", "value": { "user_image": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, webp." ] } }, "File too large": { "summary": "O upload excede o limite de 5 MB", "value": { "user_image": [ "File size should not exceed 5 MB" ] } } } } } }, "403": { "description": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente e também quando o saldo da organização que faz a chamada não cobre a chamada; uma chave incorreta, revogada ou expirada retorna `401`. Uma chave ausente retorna `403` com `{\"detail\": ...}`; uma chave incorreta, revogada ou expirada retorna `401`. Créditos insuficientes retornam `403` com `{\"error\": ...}` antes de qualquer processamento da imagem.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "O saldo da organização não cobre a chamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Limite de requisições excedido. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API. A resposta inclui os cabeçalhos `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Mais de 300 requisições de escrita no minuto atual", "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": "Listar sessões de verificação (KYC e/ou KYB) com filtros e paginação", "description": "Retorna uma lista paginada das sessões de verificação da aplicação identificada pela sua chave de API, das mais recentes para as mais antigas (`session_number` em ordem decrescente).\n\n**URL canônica:** a rota é `/v3/sessions/` (com barra final). Requisições para `/v3/sessions` sem a barra recebem um redirecionamento `301` para a URL com barra, com a query string preservada; a maioria dos clientes HTTP segue esse redirecionamento de forma transparente em GET.\n\n**Quando usar este endpoint e quando usar webhooks.** Use este endpoint para painéis, buscas de back-office, conciliação e exportações em lote. Não faça polling dele para acompanhar o andamento de verificações individuais: configure [webhooks](/pt-br/integration/webhooks), que enviam eventos `status.updated` no momento em que uma sessão muda. Para o resultado completo de uma sessão, chame `GET /v3/session/{sessionId}/decision/`.\n\n**Sessões KYC e KYB.** `session_kind` define quais tipos são listados:\n- `user` (padrão): somente sessões de Verificação de usuários (KYC). Comportamento compatível com versões anteriores.\n- `business`: somente sessões de Verificação de empresas (KYB). As linhas têm um formato diferente e mais reduzido (veja o schema da resposta).\n- `all`: os dois tipos em uma única resposta: a página KYC e a página KYB para os mesmos `limit`/`offset` são concatenadas em `results` (linhas KYC primeiro), então uma página pode conter até `2 x limit` linhas. `count` é a soma dos dois tipos e `next`/`previous` refletem a paginação do lado KYC. Para uma paginação estrita de dados mistos, chame `user` e `business` separadamente.\n\nCada linha traz um discriminador `session_kind` (`\"user\"` ou `\"business\"`).\n\n**Paginação.** Paginação padrão por limit/offset: `limit` (padrão 50) e `offset` (padrão 0), com `next`/`previous` como URLs de página prontas. Para linhas KYC, `count` é exato. Para linhas KYB, `count` é calculado com uma varredura limitada e tem teto de 100: quando há mais de 100 correspondências, ele permanece em 100, então itere usando `next` (ou verificando se uma página completa foi retornada) em vez de calcular o total de páginas a partir de `count`.\n\n**Semântica dos filtros.** Todos os filtros são combinados com AND e se aplicam às linhas KYC. Quando `session_kind` é `business` ou `all`, o lado KYB respeita os parâmetros compartilhados `vendor_data`, `status`, `workflow_id`, `country` (código do país da empresa no registro), `date_from`, `date_to`, `search` (nome da empresa, número de registro — digite os números de registro sem separadores, por exemplo `DPC001` e não `DPC-001` —, vendor_data, número da sessão ou UUID da sessão), `warning` e `organization_name`; os demais filtros exclusivos de KYC são ignorados nas linhas KYB. Parâmetros separados por vírgula (`status`, `country`, `document_type`, `region`, `workflow_id`, `document_name`, `warning`, `organization_name`, `session_type`) correspondem a qualquer um dos valores listados (OR dentro do parâmetro). `vendor_data` é uma correspondência exata: use `search` para correspondência parcial. Valores desconhecidos em filtros de lista simplesmente não retornam linhas (sem erro); valores tipados malformados (`date_from`, `date_to`, `didit_internal_id`, `api_service`, `session_kind`) retornam `400` com um objeto de erro por campo.\n\n**Busca.** `search` se adapta à entrada: um UUID completo busca pelo `session_id`; dígitos (opcionalmente com `+ - . space`) correspondem ao prefixo do número da sessão, a números de documento ou pessoais, ao prefixo do número de telefone ou a `vendor_data`; valores que contêm `@` correspondem a prefixos de e-mail; qualquer outro texto corresponde a nomes (sem diferenciar acentos) e a `vendor_data`.\n\nNão há um limite de requisições fixo por endpoint, mas faça polling da lista com pouca frequência e use webhooks para atualizações em tempo 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": "Qual tipo de sessão listar: `user` (somente KYC, padrão), `business` (somente KYB) ou `all` (ambos, concatenados - consulte a descrição para a semântica da paginação combinada). A correspondência não diferencia maiúsculas de minúsculas (`BUSINESS` funciona); qualquer valor que não seja uma variação de maiúsculas e minúsculas de `user`/`business`/`all` retorna `400`.", "schema": { "type": "string", "enum": [ "user", "business", "all" ], "default": "user" }, "example": "all" }, { "name": "limit", "in": "query", "required": false, "description": "Número máximo de linhas por página (por tipo quando `session_kind=all`). O padrão é 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "example": 20 }, { "name": "offset", "in": "query", "required": false, "description": "Número de linhas a pular antes da primeira linha retornada. O padrão é 0. Prefira seguir as URLs `next`/`previous` da resposta.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "example": 20 }, { "name": "status", "in": "query", "required": false, "description": "Lista separada por vírgula de status de sessão a incluir, por exemplo, `Approved,In Review`. Os valores diferenciam maiúsculas de minúsculas; consulte [Status de verificação](/pt-br/integration/verification-statuses). Valores desconhecidos não correspondem a nada.", "schema": { "type": "string" }, "example": "Approved,In Review" }, { "name": "vendor_data", "in": "query", "required": false, "description": "Filtro de correspondência exata no `vendor_data` que você enviou na criação da sessão (seu próprio identificador de usuário/empresa). Para correspondências parciais, use `search`.", "schema": { "type": "string" }, "example": "your-user-id-123" }, { "name": "search", "in": "query", "required": false, "description": "Uma referência exibida completa, como `S-0001` (usuário) ou `B-0001` (empresa), corresponde apenas àquele número e tipo de sessão; zeros à esquerda e maiúsculas ou minúsculas não afetam a correspondência. Busca inteligente de texto livre. Um UUID completo corresponde a `session_id`; uma entrada numérica corresponde ao prefixo do número da sessão, a números de documento ou pessoais, ao prefixo do telefone ou a `vendor_data`; uma entrada contendo `@` corresponde a prefixos de e-mail; outros textos correspondem a nomes (sem diferenciar acentos) e a `vendor_data`. Um texto livre que contém dígitos também corresponde aos campos de busca de número de documento ou pessoal e a prefixos de número de sessão.", "schema": { "type": "string" }, "example": "jane doe" }, { "name": "workflow_id", "in": "query", "required": false, "description": "UUIDs de fluxo separados por vírgula (encontre-os na página Workflows do Console). UUIDs malformados na lista são ignorados; se nenhum for válido, o resultado fica vazio.", "schema": { "type": "string" }, "example": "9f9b1234-aaaa-bbbb-cccc-1234567890ab" }, { "name": "date_from", "in": "query", "required": false, "description": "Somente sessões criadas nesta data ou depois dela (UTC), no formato `YYYY-MM-DD`. Datas malformadas retornam `400`.", "schema": { "type": "string", "format": "date" }, "example": "2026-06-01" }, { "name": "date_to", "in": "query", "required": false, "description": "Somente sessões criadas até esta data (UTC), no formato `YYYY-MM-DD`. Para linhas de KYC, o dia inteiro é incluído; para linhas de KYB, a comparação é `created_at <= date_to` (meia-noite), então use a data do dia seguinte para incluir um dia completo de sessões de KYB.", "schema": { "type": "string", "format": "date" }, "example": "2026-06-30" }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "string" }, "description": "IDs de tags separados por vírgula (`tags` da sua aplicação). Retorna as sessões que têm qualquer um deles. IDs que não são UUIDs válidos são ignorados e, quando nenhum é válido, a lista fica vazia." }, { "name": "decided_from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Data e hora ISO 8601. Retorna as sessões cujo status mudou pela última vez nesse momento ou depois dele. O filtro considera o momento da última mudança de status, não o momento de criação." }, { "name": "decided_to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Data e hora ISO 8601. Retorna as sessões cujo status mudou pela última vez antes desse momento. Combine com `decided_from` para obter um intervalo semiaberto." }, { "name": "country", "in": "query", "required": false, "description": "Filtro de país separado por vírgula. Para linhas de KYC: códigos ISO 3166-1 alpha-3 do Estado emissor do documento de identidade (por exemplo, `ESP,USA`), que pode ser diferente da nacionalidade. Para linhas de KYB: o código de país da empresa no registro de empresas.", "schema": { "type": "string" }, "example": "ESP,USA" }, { "name": "document_type", "in": "query", "required": false, "description": "Códigos de tipo de documento de identidade verificados na sessão, separados por vírgula (apenas linhas de KYC): `P` (passaporte), `ID` (carteira de identidade), `DL` (carteira de motorista), `RP` (autorização de residência), `SSC` (cartão de seguridade social), `HIC` (cartão de plano de saúde), `WP` (autorização de trabalho), `TC` (cartão fiscal), `VISA`, `PSC` (cartão de serviço público), `BC` (certidão de nascimento), `OTHER`. Observe que o campo `document_type` da resposta contém o nome de exibição, não o código.", "schema": { "type": "string" }, "example": "P,ID" }, { "name": "document_name", "in": "query", "required": false, "description": "Nomes exatos de documentos; é possível passar vários nomes separados por vírgula, mas o valor só é dividido nas vírgulas quando contém mais de um separador ` - ` (um nome isolado com uma vírgula interna é comparado por inteiro). Os nomes são os reconhecidos pela verificação de documentos (frente ou verso), por exemplo `Spain - Id Card (2021)`. Somente linhas de KYC.", "schema": { "type": "string" }, "example": "Spain - Id Card (2021)" }, { "name": "region", "in": "query", "required": false, "description": "Valores de região/estado do documento separados por vírgula (para documentos emitidos por região, como carteiras de motorista dos EUA). Somente linhas de KYC.", "schema": { "type": "string" }, "example": "CA,TX" }, { "name": "didit_internal_id", "in": "query", "required": false, "description": "Filtre pelo identificador interno de usuário da Didit (o campo de resposta `didit_internal_id`) para listar todas as sessões de um usuário verificado. Deve ser um UUID válido; valores malformados retornam `400`. Somente linhas de KYC.", "schema": { "type": "string", "format": "uuid" }, "example": "d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147" }, { "name": "session_type", "in": "query", "required": false, "description": "Canais de criação de sessão separados por vírgula: `API`, `HOSTED`, `MIGRATED`. O valor especial `ALL` (ou a omissão do parâmetro) desativa o filtro. Somente linhas de KYC.", "schema": { "type": "string" }, "example": "HOSTED" }, { "name": "api_service", "in": "query", "required": false, "description": "Filtra sessões de API avulsas por serviço. Valores inválidos retornam `400`. Somente linhas 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": "Busca por nome sem distinção de acentos nos dados analisados por AML e por validação de banco de dados. Quando combinada com `api_service=AML` ou `api_service=DATABASE_VALIDATION`, a busca fica restrita aos dados analisados desse recurso. Somente linhas de KYC.", "schema": { "type": "string" }, "example": "Jane Doe" }, { "name": "warning", "in": "query", "required": false, "description": "Códigos de risco de aviso separados por vírgula; retorna as sessões que geraram qualquer um deles (por exemplo, `POSSIBLE_FRAUD`). Os códigos de risco estão listados por recurso na [documentação de avisos](/pt-br/integration/webhooks). Aplica-se às linhas de KYC e, com códigos de aviso de empresas, às linhas de KYB.", "schema": { "type": "string" }, "example": "POSSIBLE_FRAUD" }, { "name": "status_initialized_as_in_review", "in": "query", "required": false, "description": "Quando `true`, apenas sessões cuja decisão caiu inicialmente em `In Review` (útil para auditar o volume de revisão manual). Somente linhas de KYC.", "schema": { "type": "boolean" }, "example": true }, { "name": "is_kyc_to_be_reviewed", "in": "query", "required": false, "description": "`true` retorna as sessões cuja verificação de documento está sinalizada para revisão manual; `false` retorna as sessões com a verificação de documento explicitamente não sinalizada. Omita para desativar. Apenas linhas de KYC.", "schema": { "type": "boolean" }, "example": true }, { "name": "euuid", "in": "query", "required": false, "description": "Filtra pelo euuid do usuário final (UUID atribuído ao usuário em verificação, usado pelos deep links do Console). Deve ser um UUID válido; valores malformados retornam um erro de campo 400. Somente linhas de KYC.", "schema": { "type": "string", "format": "uuid" }, "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, { "name": "organization_name", "in": "query", "required": false, "description": "Nomes de organização separados por vírgula. Voltado ao Console; com uma chave de API (já restrita a uma aplicação), corresponde apenas ao nome da sua própria organização.", "schema": { "type": "string" }, "example": "Acme Inc" } ], "responses": { "200": { "description": "Lista paginada de sessões. Os itens de `results` são linhas KYC, linhas KYB ou ambas, dependendo de `session_kind`; diferencie-os pelo campo `session_kind` de cada linha.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Número de sessões que correspondem aos filtros: exato até 100 e limitado a 100 acima disso, portanto não o use como total. Use `next` para saber se existem mais páginas. Para `session_kind=all`, é a soma dos dois tipos, cada um limitado a 100.", "example": 2 }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta da próxima página, ou `null` na última página.", "example": "https://verification.didit.me/v3/sessions/?limit=20&offset=20" }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta da página anterior, ou `null` na primeira página.", "example": null }, "results": { "type": "array", "description": "Linhas de sessões, das mais recentes para as mais antigas. Com `session_kind=all`, as linhas KYC vêm primeiro e depois as linhas 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 - uma sessão concluída e uma não 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 - linha de KYC seguida de uma linha 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": "Redirecionamento para a URL canônica com barra final. Retornado quando o caminho da requisição é `/v3/sessions` (sem barra final); o cabeçalho `Location` aponta para `/v3/sessions/` com a query string preservada. Clientes GET normalmente seguem o redirecionamento automaticamente." }, "400": { "description": "Parâmetro de consulta inválido. O corpo é um objeto indexado pelo parâmetro problemático.", "content": { "application/json": { "examples": { "Invalid session_kind": { "summary": "session_kind não é nenhum de user/business/all", "value": { "session_kind": "Must be \"user\", \"business\", or \"all\"." } }, "Invalid date": { "summary": "date_from/date_to com formato inválido", "value": { "date_from": [ "Enter a valid date." ] } }, "Invalid didit_internal_id": { "summary": "didit_internal_id não é um UUID", "value": { "didit_internal_id": [ "Enter a valid UUID." ] } }, "Invalid api_service": { "summary": "api_service não está entre as opções permitidas", "value": { "api_service": [ "Select a valid choice. FOO is not one of the available choices." ] } } } } } }, "403": { "description": "Chave de API ausente, malformada ou revogada. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.\n\n**Aplicação excluída:** por alguns minutos após a exclusão de uma aplicação, uma requisição feita com uma de suas chaves de API pode responder `{\"detail\": \"This application was deleted.\", \"code\": \"application_deleted\"}`. Não tente novamente: a aplicação e suas chaves de API não existem mais. Passados esses minutos, a chave é recusada como qualquer outra chave inválida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "You do not have permission to perform this action." }, "code": { "type": "string", "description": "Motivo legível por máquina, presente apenas em algumas falhas. `application_deleted`: a chave de API pertence a uma aplicação que foi excluída.", "example": "application_deleted" } }, "required": [ "detail" ] }, "examples": { "Forbidden": { "summary": "x-api-key ausente ou inválido", "value": { "detail": "You do not have permission to perform this action." } }, "ApplicationDeleted": { "summary": "Chave de API de uma aplicação excluída", "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": "Gerar um token de compartilhamento para uma sessão de verificação concluída", "description": "Gera um JWT de curta duração que permite que uma aplicação específica da Didit importe esta sessão concluída. Use em conjunto com `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 compartilhamento emitido.", "content": { "application/json": { "schema": { "type": "object", "properties": { "share_token": { "type": "string", "description": "JWT assinado com HS256. Passe-o literalmente como `share_token` para [`POST /v3/session/import-shared/`](/sessions-api/import-shared-session) na aplicação de destino.", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." }, "for_application_id": { "type": "string", "format": "uuid", "description": "Retorna o UUID da aplicação de destino à qual o token está vinculado.", "example": "a5f3bca2-46e2-411e-90ef-a580900a57ee" }, "session_kind": { "type": "string", "enum": [ "user", "business" ], "description": "Se a sessão de origem é uma sessão de Verificação de usuários (KYC) ou de Verificação de empresas (KYB)." } } }, "examples": { "User session": { "summary": "Compartilhar uma sessão de KYC", "value": { "share_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXNzaW9uX2lkIjoiMjBiYjNjM2ItNjE0Ni00MzlmLTg0YTQtYmQzMGQwMGFjNmEyIiwiZnJvbV9hcHBsaWNhdGlvbl9pZCI6ImRiZDIwZTM0LTQyZTktNGYyYy1iYTkxLWNmMDc2MjAxNmY2NCIsImZvcl9hcHBsaWNhdGlvbl9pZCI6ImE1ZjNiY2EyLTQ2ZTItNDExZS05MGVmLWE1ODA5MDBhNTdlZSIsImlhdCI6MTc1MzYzMDY2NiwiZXhwIjoxNzUzNjM0MjY2fQ.JJ9pNE_hqZsOtbR0XYZIWw4JzidjdEl279iUrsIkhGE", "for_application_id": "a5f3bca2-46e2-411e-90ef-a580900a57ee", "session_kind": "user" } }, "Business session": { "summary": "Compartilhar uma sessão de KYB", "value": { "share_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "for_application_id": "a5f3bca2-46e2-411e-90ef-a580900a57ee", "session_kind": "business" } } } } } }, "401": { "description": "Credenciais ausentes ou inválidas. Diferentemente da maioria dos endpoints v3, este endpoint autentica por meio do decorator de permissão e retorna `401` quando nenhum token/chave válido é apresentado.", "content": { "application/json": { "examples": { "Unauthorized": { "summary": "Não autorizado", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "404": { "description": "Não existe nenhuma sessão com o `session_id` informado na sua aplicação.", "content": { "application/json": { "examples": { "Not Found": { "summary": "Sessão não encontrada", "value": { "detail": "Not found." } } } } } }, "400": { "description": "Erro de validação. Os erros de campo são indexados pelo nome do campo; o erro de não finalizado chega na chave `detail` (como um array).", "content": { "application/json": { "examples": { "Wrong status": { "summary": "A sessão de origem não foi concluída", "value": { "detail": [ "Only finished sessions (\"Approved\", \"Declined\", \"In Review\") can be shared." ] } }, "Target missing": { "summary": "A aplicação de destino não existe", "value": { "for_application_id": [ "Target application does not exist." ] } }, "Self-share": { "summary": "O destino é a própria aplicação que faz a chamada", "value": { "for_application_id": [ "Cannot share a session with the same application." ] } }, "TTL bounds": { "summary": "ttl_in_seconds fora dos limites", "value": { "ttl_in_seconds": [ "Ensure this value is greater than or equal to 60." ] } } } } } }, "403": { "description": "As credenciais são válidas, mas não têm a permissão `write:sessions` para esta aplicação.", "content": { "application/json": { "examples": { "No Permission": { "value": { "detail": "You do not have permission to perform this action." }, "summary": "Sem permissão" } } } } } }, "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID da sessão de verificação de origem para a qual o token será emitido.", "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 da aplicação Didit que vai resgatar o token. Ela deve existir, não pode ter sido excluída e deve ser diferente da aplicação que faz a chamada. Você a encontra no Business Console em **Settings → Application**.", "example": "a5f3bca2-46e2-411e-90ef-a580900a57ee" }, "ttl_in_seconds": { "type": "integer", "description": "Tempo de vida do token, em segundos. Mínimo `60`, máximo `86400` (24 h). O padrão é `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": "Resgatar um token de compartilhamento para clonar uma sessão de verificação na sua aplicação", "description": "Resgate um token de compartilhamento para clonar uma sessão de KYC ou KYB na aplicação que faz a chamada, com um novo `session_id`. Não é idempotente: um token é resgatado uma única vez por destinatário.", "operationId": "post_v3_session_import_shared", "x-didit-sdk": { "resource": "sessions", "method": "import_shared", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "responses": { "201": { "description": "Sessão clonada. O corpo é o payload de decisão V3 para os dois tipos, diferenciados por `session_kind`: `\"user\"` (KYC), com blocos de recursos em lista como `id_verifications`, `liveness_checks` e `aml_screenings`; `\"business\"` (KYB), com blocos como `registry_checks` e `key_people_checks`. Ambos incluem `shared_from_session`, o `session_id` da sessão original na aplicação de origem. Com `trust_review: false`, o `status` da sessão clonada é forçado para `In Review`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionDecision" }, "examples": { "User session imported": { "summary": "Sessão KYC clonada (truncada; na prática, é o payload completo de decisão da 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": "Sessão KYB clonada (truncada; na prática, é o payload completo de decisão KYB da V3)", "value": { "session_id": "22222222-3333-4444-5555-666666666666", "session_kind": "business", "shared_from_session": "88888888-7777-6666-5555-444444444444", "session_number": 982, "session_url": null, "status": "Approved", "workflow_id": "9f9b1234-aaaa-bbbb-cccc-1234567890ab", "vendor_data": "company-1" } } } } } }, "400": { "description": "Erro de validação (token inválido, expirado, com destino incorreto ou que referencia uma sessão que não existe mais).", "content": { "application/json": { "examples": { "Invalid Share Token": { "summary": "JWT inválido", "value": { "share_token": [ "Invalid share token." ] } }, "Expired Share Token": { "summary": "Token com `exp` ultrapassado", "value": { "share_token": [ "Share token has expired." ] } }, "Wrong audience": { "summary": "Token não vinculado a esta aplicação", "value": { "share_token": [ "This token is not valid for this application." ] } }, "Original missing": { "summary": "A sessão de origem foi excluída", "value": { "share_token": [ "Original session does not exist." ] } } } } } }, "403": { "description": "Chave de API ausente (uma chave incorreta, revogada ou expirada recebe `401`), ou esta sessão de origem já foi importada para a aplicação chamadora (um resgate por receptor).", "content": { "application/json": { "examples": { "Forbidden": { "summary": "Proibido", "value": { "detail": "You do not have permission to perform this action." } }, "Already imported": { "summary": "Origem já importada uma vez", "value": { "detail": "This session has already been shared with your application." } } } } } }, "404": { "description": "`workflow_id` não pertence à aplicação que fez a chamada.", "content": { "application/json": { "examples": { "Workflow not found": { "summary": "Fluxo desconhecido", "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 de compartilhamento JWT emitido por [`POST /v3/session/{sessionId}/share/`](/sessions-api/share-session).", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." }, "trust_review": { "type": "boolean", "description": "Se `true`, a sessão clonada mantém o `status` final da sessão de origem. Se `false`, ela é forçada para `In Review`.", "example": false }, "workflow_id": { "type": "string", "format": "uuid", "description": "UUID de um fluxo de verificação (workflow) na aplicação que faz a chamada. IDs de outras aplicações são rejeitados com `404`.", "example": "9f9b1234-aaaa-bbbb-cccc-1234567890ab" }, "vendor_data": { "type": "string", "nullable": true, "description": "Substituição opcional do `vendor_data` da sessão 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": "Busca de empresa no registro KYB (avulsa)", "operationId": "post_v3_kyb_search", "x-didit-sdk": { "resource": "kyb", "method": "search", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [], "description": "Pesquise registros oficiais de empresas em busca de empresas candidatas por nome e/ou número de registro. Esta é a etapa 1 do fluxo de registro em duas etapas: a **busca** retorna candidatos resumidos e, em seguida, `POST /v3/kyb/select/` recupera o perfil completo de um candidato.\n\n**Faturamento da busca.** Buscas bem-sucedidas que usam uma fonte paga de dados de empresas custam USD 0.50 por requisição, independentemente do número de candidatos. Resultados vazios, falhas e resultados fornecidos apenas por outras fontes não são cobrados. O preço aplicável é reservado antes da busca; saldo insuficiente retorna 403 com o código `insufficient_credits`. Tarifas contratuais se aplicam quando acordadas, e uma tarifa contratual de busca não configurada retorna 403. Buscas no sandbox são gratuitas. Repetir uma busca bem-sucedida pode gerar outra cobrança; a entrega do callback não gera cobrança adicional. A recuperação do perfil é cobrada separadamente. Esta tarifa de busca também se aplica à v2. Os candidatos sempre retornam com `fetch_status: \"pending\"`: os dados completos da empresa só são obtidos (e cobrados) na seleção.\n\n**`kyb_response_id` é efêmero.** É um identificador por busca, não um ID estável da empresa. Faça a seleção logo após a busca e busque novamente para obter um novo identificador, em vez de armazená-lo.\n\n**`tier` define a cadeia de provedores.** `tier` indica o nível de registro em que a busca é executada: `basic` (o padrão, a cadeia Lite), `shareholders` ou `ubo`. A busca usa a cadeia de provedores que atende a esse nível, e ela nem sempre é a mesma cadeia que a busca Lite consulta; portanto, uma busca Lite vazia não prova que o registro não contém a empresa — busque novamente no nível de que você precisa. Um país que não oferece o nível indicado é pesquisado no nível mais alto que ele oferece até esse nível. Recupere o candidato no endpoint que vende esse nível: `POST /v3/kyb/select/` (Lite), `POST /v3/kyb/shareholders/` ou `POST /v3/kyb/ubo/`.\n\n**Autenticação.** `POST /v3/kyb/search/` (e `/v2/`) recebe a chave de API da sua aplicação no cabeçalho `x-api-key`. O `POST /v1/kyb/search/` hospedado é a rota autenticada por sessão que um fluxo de verificação hospedado chama: ele responde `403` a uma chave de API e não aceita `tier` — a configuração de registro KYB do fluxo define a cadeia.\n\n**Dois modos.**\n- *Síncrono (padrão):* a API consulta o registro repetidamente até que a busca seja resolvida e retorna a lista final de candidatos (`search_resolved: true`).\n- *Assíncrono:* passe `webhook_url` e a API retorna imediatamente — geralmente com `search_status: \"pending\"` e uma lista de candidatos vazia — e depois envia via POST um callback `kyb.registry_search.resolved` para a sua URL quando o registro terminar. O corpo do callback é `{\"event_id\", \"event_type\": \"kyb.registry_search.resolved\", \"request_id\", \"vendor_data\", \"metadata\", \"search_status\", \"search_resolved\", \"kyb_registry\", \"timestamp\", \"created_at\"}` — observe que `timestamp` e `created_at` no callback são inteiros epoch, ao contrário do `created_at` em ISO deste endpoint — e é enviado **sem assinatura** (cabeçalho `X-Didit-Unsigned-Callback: true`, sem `X-Signature`).\n\n**Códigos de país.** ISO 3166-1 alpha-2 (`GB`, `DE`), além de códigos de subdivisão `XX-YY` onde os registros são regionais — por exemplo, `US-CA` para a Califórnia.\n\n**Sandbox.** Chaves de aplicações de sandbox retornam um candidato estático sem contatar nenhum registro.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "country_code" ], "properties": { "country_code": { "type": "string", "maxLength": 10, "description": "Código ISO 3166-1 alpha-2 do país em cujo registro de empresas a busca será feita. Por exemplo, `GB`. Onde os registros de empresas operam em nível estadual ou provincial, acrescente o código de subdivisão ISO 3166-2 no formato `XX-YY`: `US-CA` busca no registro da Califórnia. Buscas nos Estados Unidos sempre exigem a subdivisão: um `US` sozinho é rejeitado. Não diferencia maiúsculas de minúsculas; é normalizado para maiúsculas.", "example": "GB" }, "name": { "type": "string", "maxLength": 255, "description": "Nome da empresa a pesquisar. É obrigatório informar `name` ou `registration_number`.", "example": "Tesco" }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registro a ser pesquisado no registro. É obrigatório informar `name` ou `registration_number`." }, "tier": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "default": "basic", "description": "Nível do registro em cuja cadeia de provedores esta pesquisa é executada. `basic` (padrão) pesquisa a cadeia Lite do país; `shareholders` e `ubo` pesquisam a cadeia de propriedade desse nível, que pode ser uma fonte diferente, portanto uma pesquisa Lite vazia não prova que o registro não tenha a empresa. Um país que não oferece o nível indicado é pesquisado no nível mais alto que oferece até esse nível. Obtenha o candidato pelo endpoint que vende o nível pesquisado: `POST /v3/kyb/select/` (Lite), `POST /v3/kyb/shareholders/` ou `POST /v3/kyb/ubo/`.", "example": "basic" }, "search_type": { "type": "string", "enum": [ "contains" ], "default": "contains", "description": "Estratégia de correspondência de nomes aplicada pela busca no registro. `contains` é o único valor aceito: nenhuma fonte de registro por trás da busca oferece modo por prefixo ou aproximado, então `start_with` e `fuzzy` são rejeitados com `400` (`not a valid choice`)." }, "vendor_data": { "type": "string", "description": "Seu identificador para esta consulta; retornado na resposta e incluído no callback do webhook." }, "metadata": { "type": "object", "nullable": true, "description": "JSON livre; retornado na resposta e incluído no callback do webhook." }, "webhook_url": { "type": "string", "format": "uri", "maxLength": 500, "description": "Muda a busca para o modo assíncrono: a API retorna imediatamente e envia por POST um callback `kyb.registry_search.resolved` não assinado para esta URL quando a lista de candidatos estiver pronta." } } }, "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": "Pesquisa aceita. O modo síncrono retorna a lista de candidatos resolvida; o modo webhook retorna imediatamente (muitas vezes com `search_status: \"pending\"`) e entrega a lista final por meio do callback `kyb.registry_search.resolved`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Com `webhook_url`: o id persistido da requisição de busca, retornado como `request_id` no callback `kyb.registry_search.resolved`. Sem `webhook_url`: um UUID de correlação transitório (a busca não é armazenada)." }, "kyb_registry": { "$ref": "#/components/schemas/KYBRegistrySearchResults" }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco dos `vendor_data` que você enviou." }, "metadata": { "type": "object", "nullable": true, "description": "Eco do `metadata` que você enviou." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Resolved search": { "summary": "Modo síncrono — lista final de candidatos", "value": { "request_id": "0c7e9a40-3a13-4f7e-8a44-9d2e2f1c5b6a", "kyb_registry": { "companies": [ { "kyb_response_id": "69aeeb95febb0f1704042259", "name": "Tesco PLC", "registration_number": "00445790", "status": "active", "type": "Public Limited Company", "risk_level": null, "fetch_status": "pending" }, { "kyb_response_id": "69aeeb95febb0f170404225a", "name": "E-TESCO LTD", "registration_number": "15168476", "status": "active", "type": "Private Limited Company", "risk_level": null, "fetch_status": "pending" } ], "pagination": { "total": 2, "page": 1, "per_page": 25 }, "search_status": "resolved", "search_resolved": true }, "vendor_data": "company-1234", "metadata": null, "created_at": "2026-06-11T10:40:00.000000+00:00" } }, "Pending search (webhook mode)": { "summary": "`webhook_url` informado: os candidatos chegam pelo 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": "Erro de validação. Problemas no nível de campo usam o envelope padrão do DRF; a regra de nome/número de registro é informada em `non_field_errors`. Um país que os registros não cobrem responde `400` com `code: kyb_registry_country_unsupported`.", "content": { "application/json": { "examples": { "Missing search criteria": { "summary": "Nem `name` nem `registration_number` foram informados", "value": { "non_field_errors": [ "Either 'name' or 'registration_number' is required." ] } }, "Invalid country_code": { "summary": "Deve ser `XX` (alpha-2) ou uma subdivisão `XX-YY`", "value": { "country_code": [ "country_code must be a 2-letter ISO code." ] } }, "Invalid search_type": { "summary": "Somente `contains` é aceito", "value": { "search_type": [ "\"start_with\" is not a valid choice." ] } }, "Invalid webhook_url": { "summary": "`webhook_url` deve ser uma URL válida", "value": { "webhook_url": [ "Enter a valid URL." ] } }, "Country not covered": { "summary": "Nenhum registro de empresas cobre o 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": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente; uma chave incorreta, revogada ou expirada retorna `401`. Uma chave ausente retorna `403` com `{\"detail\": ...}`; uma chave incorreta, revogada ou expirada retorna `401`. Também é retornado antes da busca quando a tarifa de busca aplicável não pode ser coberta (`code: \"insufficient_credits\"`) ou quando falta uma tarifa de busca contratual.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições excedido ou cota de buscas esgotada. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API, com os cabeçalhos `X-RateLimit-*` e `Retry-After`. Separadamente, as buscas pagas em registros são limitadas a 600 por aplicação por hora: acima disso, a resposta é `429` com `code: kyb_registry_search_limit_reached`, e as buscas atendidas apenas por fontes gratuitas continuam funcionando. Aguarde e busque novamente mais tarde.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Mais de 300 requisições de escrita no minuto atual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } }, "Search allowance spent": { "summary": "Mais de 600 buscas pagas na ú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": "O provedor de registro de empresas do KYB está temporariamente indisponível - uma resposta 5xx, timeout ou falha de conexão do registro de origem. A busca não é cobrada. Tente novamente mais tarde ou, no fluxo de verificação hospedado da Didit, o usuário recebe automaticamente a opção de inserir os dados da empresa manualmente, em vez de um erro que só permite tentar novamente.", "content": { "application/json": { "examples": { "Registry provider outage": { "summary": "O provedor do registro não respondeu à busca", "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": "Seleção de empresa no registro KYB, nível Lite (avulsa)", "operationId": "post_v3_kyb_select", "x-didit-sdk": { "resource": "kyb", "method": "select", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [], "description": "Obtenha o perfil de registro **Lite** de um candidato retornado por `POST /v3/kyb/search/`: dados da empresa, endereço registrado, identificadores, status, atividade e os administradores, além do payload bruto do registro. Acionistas e beneficiários finais são vendidos por `POST /v3/kyb/shareholders/` e `POST /v3/kyb/ubo/`.\n\n**Uso com a busca.** Envie o `kyb_response_id` do candidato exatamente como retornado por uma busca da mesma aplicação. O identificador é temporário e restrito a essa busca: selecione logo e faça uma nova busca para obter um identificador novo em vez de armazená-lo.\n\n**Faturamento.** Cada seleção é cobrada pelo preço Lite do país (qualquer tarifa de busca é cobrada à parte); consulte [Preços do registro KYB](/pt-br/getting-started/kyb-registry-pricing). O saldo é verificado antes de qualquer chamada ao registro (`403` quando insuficiente) e a cobrança é registrada na sessão de empresa criada.\n\n**A persistência é obrigatória.** Cada seleção cria uma sessão de empresa (o seu id é o `request_id`) para que o faturamento e a consulta possam ser acompanhados; ela aparece no console. `save_api_request` é aceito por simetria, mas deve ser `true` (o padrão): 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 obtida e faturada. `kyb_registry` contém o perfil completo; verifique `data_resolved`: quando é `false`, o registro ainda estava em processamento, e o registro armazenado é completado automaticamente assim que for resolvido.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Id da sessão de empresa criada para esta consulta. O registro armazenado (visível no console) continua sendo atualizado se o registro de empresas responder depois da resposta." }, "registry_tier_requested": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "O nível que este endpoint vende: `basic` (Lite) para países selecionados, `shareholders`, `ubo`." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "O nível efetivamente entregue e faturado. Inferior ao solicitado quando os registros do país não contêm dados de propriedade ou quando o registro não possui informações de propriedade desta empresa." }, "kyb_registry": { "type": "object", "description": "Perfil completo da empresa no registro.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID da Didit para este registro de empresa." }, "node_id": { "type": "string", "example": "feature_kyb_registry" }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review" ], "description": "Avaliação da Didit sobre a verificação no registro de empresas (por exemplo, `In Review` quando a empresa não está ativa no registro ou quando não foi possível derivar os dados de propriedade)." }, "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": "Status normalizado da empresa conforme informado pelo registro." }, "data_resolved": { "type": "boolean", "description": "`true` quando o registro retornou o perfil completo. `false` quando o registro ainda estava processando após a consulta periódica; o registro armazenado é completado automaticamente assim que o registro resolve." }, "company_name": { "type": "string", "example": "Tesco PLC" }, "registration_number": { "type": "string", "nullable": true, "example": "00445790" }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2.", "example": "GB" }, "region": { "type": "string", "nullable": true, "description": "Código da subdivisão quando o registro é regional (por exemplo `CA` para `US-CA`); vazio caso contrário." }, "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": "Nível de risco informado pelo registro, quando disponível." }, "verification_status": { "type": "string", "nullable": true, "description": "Status de verificação do registro, quando disponível." }, "is_from_registry": { "type": "boolean", "description": "Sempre `true` para este endpoint: o perfil foi obtido de um registro oficial." }, "fetch_status": { "type": "string", "enum": [ "pending", "resolved" ], "description": "Ciclo de vida da consulta ao registro. Refletido por `data_resolved`." }, "alternative_names": { "type": "string", "nullable": true, "description": "Nomes alternativos, comerciais, anteriores ou no idioma original da empresa, em texto, quando informados." }, "nature_of_business": { "type": "string", "nullable": true, "description": "Descrição da atividade ou código de classificação, quando informado." }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "nullable": true, "description": "Valor decimal como string, quando informado." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Código ISO 4217, quando informado." }, "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, quando informado." }, "location_of_registration": { "type": "string", "nullable": true, "description": "Registro/jurisdição em que a empresa está registrada, quando informado." }, "vat_number": { "type": "string", "nullable": true, "description": "Número de IVA da UE (EU VAT), quando coletado durante a etapa de registro no fluxo hospedado ou editado posteriormente. No momento da seleção, normalmente ainda não está definido: a validação de IVA e de identificação fiscal é executada quando o usuário final envia a etapa de registro no fluxo hospedado." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Resultado da validação do número de VAT ou, quando não houver, do `tax_number`, no envio ao registro. `valid` / `invalid`: decidido pelo registro oficial do país (EU VIES, Noruega, Suíça, Brasil, Colômbia, Costa Rica, Equador, Paraguai; a Polônia também pelo seu registro nacional de VAT). `format_valid` / `invalid_format`: decidido pelas regras de formato e dígito verificador do país quando nenhum registro pode ser consultado. `could_not_validate`: o registro estava indisponível. `not_applicable`: nenhum número, um país sem registro nem regras, ou uma sessão de sandbox." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "O número que foi verificado, como a fonte o conhece (por exemplo, o número de IVA derivado de um SIREN francês ou de um RSIN holandês). `null` quando nenhuma verificação foi executada." }, "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": "A fonte que determinou `vat_validation_status`: um registro oficial ou `format_rules`. `null` quando nenhuma verificação foi executada." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Nome registrado na fonte que validou o número, quando ela o informa. Preenchido apenas quando o status é `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Endereço registrado na fonte que validou o número, quando ela o informa. Definido apenas quando o status é `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data e hora da verificação. `null` quando nenhuma verificação foi executada." }, "financial_summary": { "type": "object", "nullable": true, "description": "Detalhes de ações/capital informados pelo registro (moeda, total de ações, classes de ações), quando disponíveis." }, "officers": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "example": "MELISSA BETHELL" }, "designation": { "type": "string", "nullable": true, "description": "Designação bruta do registro (por exemplo, `Director`, `Secretary`)." }, "role": { "type": "string", "description": "Função normalizada derivada do cargo. Conjunto completo de 17 valores do modelo; a análise do registro neste endpoint normalmente retorna director, non_executive_director, secretary, chairman ou 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` quando o registro marca a nomeação como encerrada por renúncia." }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending" ], "description": "Status de uma sessão de KYC associada, quando uma foi iniciada para este administrador. `null` caso contrário." }, "kyc_session_url": { "type": "string", "nullable": true, "description": "URL de verificação da sessão de KYC associada, quando existir." }, "first_name": { "type": "string", "nullable": true, "description": "Nome próprio, quando informado explicitamente pelo registro; não é inferido a partir do nome completo." }, "last_name": { "type": "string", "nullable": true, "description": "Sobrenome, quando informado explicitamente pelo registro." }, "address": { "type": "string", "nullable": true, "description": "Endereço do administrador informado pelo registro de empresas." }, "appointment_date": { "type": "string", "nullable": true, "description": "Data em que o administrador foi nomeado.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Data em que o cargo terminou, quando informada.", "format": "date" }, "date_of_birth": { "type": "string", "nullable": true, "description": "Data de nascimento completa informada pelo registro. Nula quando apenas o ano ou o mês de nascimento é conhecido.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Ano de nascimento informado pelo registro, inclusive quando a data completa não está disponível." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Mês de nascimento informado pelo registro. Nulo quando apenas o ano é conhecido." } } }, "description": "Diretores, secretários e outros administradores extraídos do registro." }, "beneficial_owners": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Se o proprietário é uma pessoa física ou uma pessoa jurídica." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Funções normalizadas (por exemplo, `ubo`, `shareholder`)." }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Limite inferior da faixa de propriedade informada pelo registro (por exemplo, `25%`)." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Limite superior da faixa de propriedade informada pelo registro." }, "is_active": { "type": "boolean" }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending" ] }, "kyc_session_url": { "type": "string", "nullable": true }, "effective_ownership_percent": { "type": "number", "nullable": true, "description": "Percentual de propriedade interpretado (limite máximo, recorrendo ao limite mínimo)." }, "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 nascimento completa, quando informada.", "format": "date" }, "appointment_date": { "type": "string", "nullable": true, "description": "Data de nomeação, quando informada.", "format": "date" }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } } }, "description": "Beneficiários finais / pessoas com controle significativo extraídos do registro. Pode estar vazio quando o registro não expõe a propriedade." }, "addresses": { "type": "array", "nullable": true, "description": "Todos os endereços que o registro informa, em um único formato canônico. Nulo quando não informa nenhum.", "items": { "$ref": "#/components/schemas/KYBRegistryAddress" } }, "industries": { "type": "array", "nullable": true, "description": "As atividades em que o registro classifica a empresa, em um único formato canônico. Null quando ele não informa nenhuma.", "items": { "$ref": "#/components/schemas/KYBRegistryIndustry" } }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Datas de arquivamento no registro, quando disponíveis. Declarações anuais e assembleias gerais usam last_annual_return_date e last_agm_date; elas são distintas das demonstrações financeiras." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "nullable": true, "description": "Sempre `null` neste endpoint (usado pelo fluxo KYB hospedado quando usuários finais editam dados do registro)." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Sempre `null` neste endpoint." }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Preenchido quando um revisor do console edita o registro posteriormente." }, "is_editable": { "type": "boolean", "description": "Se os dados obtidos do registro ainda podem ser editados no fluxo hospedado/console." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "Igual ao `registry_tier_delivered` de nível superior." }, "registry_ownership_status": { "type": "string", "nullable": true, "enum": [ "not_requested", "delivered", "not_held", "unavailable" ], "description": "`delivered` quando os dados de propriedade foram retornados, `not_held` quando o registro de propriedade respondeu e não lista esta empresa (consulte `registry_data.ownership_error`), `unavailable` quando um nível com propriedade foi solicitado, mas o registro não tinha esses dados para esta empresa ou não pôde ser consultado (consulte `registry_data.ownership_error`), `not_requested` no nível Lite." }, "ownership": { "$ref": "#/components/schemas/KYBRegistryOwnership" }, "registry_tier": { "type": "string", "nullable": true, "description": "O nível de registro solicitado pelo fluxo: `basic`, `shareholders` ou `ubo`. Também em `ownership.tier_requested`." }, "registry_monitoring": { "type": "object", "nullable": true, "description": "O monitor de registro mais recente da empresa, ou `null` quando não existe nenhum.", "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": "Os campos da empresa que o monitor acompanha." } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco dos `vendor_data` que você enviou." }, "metadata": { "type": "object", "nullable": true, "description": "Eco do `metadata` que você enviou." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Resolved company": { "summary": "Perfil completo do registro (lista de administradores truncada por brevidade)", "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": "A seleção continuou pendente após o polling: campos esparsos, conclusão automática no 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": "Erro de validação. Problemas no nível de campo usam o envelope padrão do DRF. Um país que os registros não cobrem responde `400` com `code: kyb_registry_country_unsupported`.", "content": { "application/json": { "examples": { "Missing kyb_response_id": { "summary": "`kyb_response_id` é obrigatório", "value": { "kyb_response_id": [ "This field is required." ] } }, "save_api_request=false rejected": { "summary": "As seleções são sempre persistidas", "value": { "save_api_request": [ "KYB registry select must be saved so billing and retrieval can be tracked." ] } }, "Country not covered": { "summary": "Nenhum registro de empresas cobre o 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": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente e também quando o saldo da organização que faz a chamada não cobre a chamada; uma chave incorreta, revogada ou expirada retorna `401`. Uma chave ausente retorna `403` com `{\"detail\": ...}`; uma chave incorreta, revogada ou expirada retorna `401`. Créditos insuficientes retornam `403` com `{\"error\": ...}` antes de qualquer análise ou chamada a provedores.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "O saldo da organização não cobre a chamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Limite de requisições excedido. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API. A resposta inclui os cabeçalhos `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Mais de 300 requisições de escrita no minuto atual", "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": "Detecte ataques de apresentação, como fotos impressas, reproduções em tela, máscaras e deepfakes, a partir de uma única imagem facial. Não exige vídeo, movimento nem interação do usuário.\n\n**Como funciona.** Um modelo biométrico analisa a imagem, avalia o maior rosto detectado e calcula uma pontuação de prova de vida `score` (0–100). O `status` é `Declined` quando qualquer aviso de severidade `error` é disparado:\n- `NO_FACE_DETECTED`: o modelo de prova de vida não encontrou nenhum rosto,\n- `LOW_LIVENESS_SCORE`: pontuação igual ou inferior a `face_liveness_score_decline_threshold` (padrão `30`),\n- `LIVENESS_FACE_ATTACK`: o modelo detectou um ataque de apresentação,\n- `FACE_IN_BLOCKLIST` / `POSSIBLE_FACE_IN_BLOCKLIST`: o rosto corresponde a uma entrada da sua lista de bloqueio facial.\n\n`MULTIPLE_FACES_DETECTED` é um sinal de severidade `warning` (não recusa a sessão). `DUPLICATED_FACE` / `POSSIBLE_DUPLICATED_FACE` são sinais de severidade `information` de que o mesmo rosto já apareceu em outra sessão aprovada (nunca recusam a sessão). `face_quality` e `face_luminance` (0–100, anuláveis) descrevem a qualidade da captura.\n\n**Triagem de lista de bloqueio e de duplicados.** É executada em **todas** as chamadas, com ou sem `save_api_request`, comparando o rosto detectado com o índice de busca facial da sua aplicação. Rostos anteriores com o mesmo `vendor_data` são excluídos de toda a busca no índice. Por isso, executar novamente a prova de vida para o mesmo usuário não dispara `DUPLICATED_FACE`. Da mesma forma, um rosto da lista de bloqueio originado de uma sessão com o próprio `vendor_data` de quem faz a chamada NÃO é sinalizado (a triagem `FACE_IN_BLOCKLIST` é ignorada para rostos com o mesmo `vendor_data`).\n\n**Faturamento.** Cada resposta `200` consome um crédito da API de Prova de vida passiva, pago com o crédito do seu plano ou com o saldo recarregado. Saldo insuficiente retorna `403` antes de qualquer processamento da imagem.\n\n**Persistência da sessão e cadastro facial (`save_api_request`, padrão `true`).** Quando o valor é `true`, a chamada é persistida como uma sessão do tipo API (no Business Console, em `GET /v3/session/{sessionId}/decision/` por meio do `request_id` retornado e no webhook `status.updated`). A imagem de referência e o recorte do rosto são armazenados, e o rosto detectado é **cadastrado no seu índice de busca facial** para que chamadas posteriores de Busca facial e verificações de duplicidade possam encontrá-lo. Quando o valor é `false`, a chamada é única: nada é armazenado e o rosto não é cadastrado (a triagem de lista de bloqueio e de duplicados continua sendo executada).\n\n**Sandbox.** Chaves de API de sandbox ignoram todo o processamento e o faturamento. Após a validação da requisição (entradas malformadas continuam retornando `400`), o endpoint retorna um payload simulado estático `Approved`, nenhuma sessão é persistida e nenhum crédito é consumido.\n\n**Autenticação.** Envie a chave de API da sua aplicação no cabeçalho `x-api-key`. Credenciais ausentes ou inválidas retornam `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`). Esta API nunca retorna `401`.\n\n**Limite de requisições.** Há uma cota de escrita compartilhada de 300 requisições/min por chave de API em todos os endpoints POST/PATCH/DELETE. Ultrapassá-la 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": "Imagem frontal do rosto (por exemplo, uma selfie). Extensões permitidas: `tiff`, `jpg`, `jpeg`, `png`, `webp`. Tamanho máximo de upload: **5 MB** (arquivos maiores são rejeitados com `400`). As imagens são comprimidas automaticamente para ~0,5 MB antes do processamento, portanto resoluções muito altas não melhoram a precisão. A imagem deve conter uma única pessoa: quando há vários rostos, o maior é avaliado e um aviso `MULTIPLE_FACES_DETECTED` é adicionado." }, "face_liveness_score_decline_threshold": { "type": "number", "format": "float", "default": 30, "minimum": 0, "maximum": 100, "description": "Limiar da pontuação de prova de vida (0–100). Uma pontuação calculada **igual ou inferior** a este valor emite um aviso `LOW_LIVENESS_SCORE` e define `status` como `Declined`. O padrão é `30`. Aumente esse valor para uma proteção antispoofing mais rigorosa. Valores fora do intervalo 0–100 retornam `400`.", "example": 30 }, "rotate_image": { "type": "boolean", "default": false, "description": "Quando `true`, o serviço testa rotações de 90 graus da entrada e usa a orientação que produz a melhor detecção de rosto. Útil quando a orientação EXIF está ausente. Aumenta a latência.", "example": false }, "save_api_request": { "type": "boolean", "default": true, "description": "Quando `true` (padrão), persiste a chamada como uma sessão do tipo API, armazena as imagens do rosto, emite um webhook `status.updated` e cadastra o rosto detectado no seu índice de busca facial. Quando `false`, a chamada é avulsa: nada é armazenado e o rosto não é cadastrado. A triagem de lista de bloqueio e de duplicados é executada em ambos os casos.", "example": true }, "vendor_data": { "type": "string", "description": "Identificador opaco opcional (seu ID de usuário, e-mail, UUID…) armazenado na sessão persistida e devolvido. Também é usado para excluir sessões anteriores com o mesmo `vendor_data` da verificação de rosto duplicado, de modo que reverificar o mesmo usuário não gere `DUPLICATED_FACE`.", "example": "user-123" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Objeto JSON opcional armazenado com a sessão (quando `save_api_request=true`) e devolvido. Em requisições multipart, envie-o como um campo de string codificada em JSON, que é convertido em um objeto.", "example": { "flow": "withdrawal" } } } }, "example": { "user_image": "(binary JPEG/PNG selfie)", "face_liveness_score_decline_threshold": 30, "rotate_image": false, "save_api_request": true, "vendor_data": "user-123", "metadata": { "flow": "withdrawal" } } } } }, "responses": { "200": { "description": "Prova de vida passiva concluída. `liveness.score` é a confiança do modelo, de 0 a 100, de que a imagem mostra uma pessoa real; `status` é `Approved`, a menos que um aviso de severidade `error` tenha sido disparado. Um rosto falsificado ou presente na lista de bloqueio ainda retorna `200`: verifique `liveness.status` e `liveness.warnings`, não apenas o código HTTP. Quando `save_api_request=true`, `request_id` é o id da sessão persistida.", "content": { "application/json": { "examples": { "Approved": { "summary": "Rosto real — sem avisos", "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": "O modelo sinalizou um spoofing (impressão, reprodução, 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": "Rosto real, mas corresponde a uma entrada da lista de bloqueio", "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 da sessão persistida quando `save_api_request=true` (utilizável com `GET /v3/session/{sessionId}/decision/`); caso contrário, um UUID de correlação transitório." }, "liveness": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "`Declined` quando pelo menos um aviso com severidade `error` foi disparado (nenhum rosto, pontuação baixa, ataque de apresentação ou ocorrência na lista de bloqueio); `Approved` caso contrário. Entradas `warning`/`information` (múltiplos rostos, duplicatas) nunca causam recusa por si só." }, "method": { "type": "string", "enum": [ "PASSIVE" ], "description": "Sempre `PASSIVE` neste endpoint." }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Confiança da prova de vida (0–100, com duas casas decimais) de que a imagem mostra uma pessoa real, e não um spoofing. `null` quando o modelo não retornou nenhuma confiança.", "example": 95.0 }, "user_image": { "type": "object", "description": "Resultados da detecção facial para a imagem enviada.", "properties": { "entities": { "type": "array", "items": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 4, "description": "Caixa delimitadora do rosto detectado, como coordenadas em pixels `[x_min, y_min, x_max, y_max]` na imagem processada.", "example": [ 661, 728, 1688, 2188 ] }, "confidence": { "type": "number", "format": "float", "minimum": 0, "maximum": 1, "description": "Confiança da detecção facial (0–1).", "example": 0.732973 }, "age": { "type": "number", "format": "float", "description": "Idade do rosto detectado estimada pelo modelo, em anos. Apenas informativa: não afeta a decisão de prova de vida.", "example": 26.91 }, "gender": { "type": "string", "description": "Gênero do rosto detectado previsto pelo modelo (`male` ou `female`). Apenas informativo.", "example": "male" }, "race": { "type": "string", "nullable": true, "description": "Campo reservado: sempre `null` nas respostas deste endpoint.", "example": null } } }, "description": "Uma entrada por rosto detectado. O maior rosto é o avaliado." }, "best_angle": { "type": "integer", "nullable": true, "description": "Rotação (em graus) que produziu a melhor detecção de rosto; diferente de zero apenas quando `rotate_image=true` corrigiu a orientação.", "example": 0 } } }, "warnings": { "type": "array", "description": "Sinais de risco. Gravidade `error` (recusam): `NO_FACE_DETECTED`, `LOW_LIVENESS_SCORE` (pontuação igual ou abaixo do limiar), `LIVENESS_FACE_ATTACK`, `FACE_IN_BLOCKLIST`, `POSSIBLE_FACE_IN_BLOCKLIST`. Gravidade `warning` (revisão, sem recusa): `MULTIPLE_FACES_DETECTED`. Gravidade `information` (sem recusa): `DUPLICATED_FACE`, `POSSIBLE_DUPLICATED_FACE`, quando o mesmo rosto já apareceu em outra sessão 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": "Código de risco legível por máquina." }, "feature": { "type": "string", "enum": [ "LIVENESS" ], "description": "Recurso que emitiu o aviso. Sempre `LIVENESS` neste endpoint." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "`null` para a maioria dos avisos. Ocorrências na lista de bloqueio trazem `{blocklisted_session_id, blocklisted_session_number, api_service}`; ocorrências de duplicidade trazem `{duplicated_session_id, duplicated_session_number, api_service}`, que apontam para a sessão correspondente." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Severidade. Avisos `error` levam o `status` para `Declined`; entradas `warning` e `information` são apenas informativas e nunca recusam a sessão por conta própria." }, "short_description": { "type": "string", "description": "Resumo legível do risco em uma linha." }, "long_description": { "type": "string", "description": "Explicação legível do risco." } } } }, "face_quality": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Pontuação da qualidade de captura do rosto detectado, normalizada de 0 a 100. `null` quando o modelo não conseguiu gerar um valor confiável.", "example": 84.21 }, "face_luminance": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Brilho do rosto detectado, normalizado de 0 a 100. `null` quando indisponível.", "example": 50.33 } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco do `vendor_data` que você enviou, ou `null`." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Eco do objeto `metadata` que você enviou, ou `null`." }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp ISO 8601 (UTC) do momento em que a resposta foi gerada, por exemplo `2026-06-12T01:04:42.763237+00:00`." } } } } } }, "400": { "description": "Erro de validação. Retornado quando `user_image` está ausente, excede 5 MB, tem uma extensão não suportada ou falha na decodificação da imagem no servidor, ou quando uma opção está fora do intervalo permitido. Erros de campo usam o envelope `{field: [messages]}` do DRF; falhas de decodificação de imagem usam `{\"error\": ...}`.", "content": { "application/json": { "examples": { "Missing image": { "summary": "`user_image` não incluído nos dados do formulário", "value": { "user_image": [ "No file was submitted." ] } }, "Invalid image format": { "summary": "Extensão permitida, mas conteúdo de imagem que não pode ser decodificado", "value": { "error": "Invalid user image format.", "code": "invalid_image" } }, "Unsupported file extension": { "summary": "Extensão de arquivo fora de tiff/jpg/jpeg/png/webp", "value": { "user_image": [ "File extension “txt” is not allowed. Allowed extensions are: tiff, jpg, jpeg, png, webp." ] } }, "File too large": { "summary": "O upload excede o limite de 5 MB", "value": { "user_image": [ "File size should not exceed 5 MB" ] } } } } } }, "403": { "description": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente e também quando o saldo da organização que faz a chamada não cobre a chamada; uma chave incorreta, revogada ou expirada retorna `401`. Uma chave ausente retorna `403` com `{\"detail\": ...}`; uma chave incorreta, revogada ou expirada retorna `401`. Créditos insuficientes retornam `403` com `{\"error\": ...}` antes de qualquer processamento da imagem.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "O saldo da organização não cobre a chamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Limite de requisições excedido. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API. A resposta inclui os cabeçalhos `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Mais de 300 requisições de escrita no minuto atual", "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": "Validação de banco de dados (avulsa)", "operationId": "post_v3database-validation", "x-didit-sdk": { "resource": "database_validation", "method": "validate", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [], "description": "Valide os dados de identidade de uma pessoa em fontes oficiais de governos e registros: CPF no Brasil, RENAPER na Argentina, registros de DNI na Espanha e no Peru, INE no México e mais de 100+ outros serviços em 60+ países.\n\n**Seleção de serviços.** Cada país oferece um ou mais serviços do catálogo, identificados por um `service_id` (por exemplo, `bra_cpf`, `arg_renaper`, `pan_cedula_sib`). Defina os serviços desejados com o array `services`. Se você omiti-lo, exatamente **um** serviço padrão é executado (o serviço ativo mais antigo do país). Enviar `services` também muda a resposta para o formato estendido, com `services_used` e `match_score`. Descubra os serviços, os campos obrigatórios de cada um e os preços por meio de `GET /v1/organization/database-validation-countries/` (um endpoint de catálogo não documentado nesta especificação) ou do editor de fluxos de verificação (workflow) do Business Console. Alguns serviços estão marcados com `requires_consent=true` no catálogo e exigem `consent=true`; outros exigem onboarding da sua organização antes de poderem ser chamados.\n\n**Campos de entrada.** `identification_number` é um campo universal que é mapeado automaticamente para o campo específico do país correto (veja a descrição dele). As regras de formato de cada país são aplicadas antes de qualquer provedor ser chamado (por exemplo, o CPF do BRA deve ter exatamente 11 dígitos), e falhas de formato nunca são cobradas. Serviços biométricos precisam do envio de uma `selfie` (somente multipart); o RENAPER da Argentina também exige `gender`.\n\n**Resultados.** Cada serviço retorna um mapa `validation` campo a campo, além de um `outcome_code` independente de fornecedor (`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`). Observe as diferenças: `NO_MATCH` é uma divergência definitiva, `INCONCLUSIVE` significa que o registro não conseguiu confirmar nem negar (revisão, não recusa) e `BIOMETRIC_IMAGE_UNUSABLE` é um problema técnico da selfie (nova captura), ao contrário do definitivo `BIOMETRIC_NO_MATCH`. O `match_type` geral agrega os resultados de todos os serviços (qualquer correspondência completa → `full_match`; caso contrário, qualquer parcial → `partial_match`; caso contrário, `no_match`), e `no_match_action`/`partial_match_action` o convertem no `status` final. `validation_type` é derivado: `two_by_two` quando dois ou mais serviços distintos produziram uma correspondência completa (no número de identificação, no nome completo + data de nascimento em conjunto ou no endereço sem contradições); caso contrário, `one_by_one`.\n\n**Persistência.** `save_api_request` tem como padrão **true**: o resultado é armazenado como uma sessão (`request_id` funciona com `GET /v3/session/{sessionId}/decision/`), aparece no console e dispara um webhook `status.updated`. Ele também controla o formato de `validations`: objetos por serviço quando salvo, um mapa `{field: match}` mesclado quando não salvo.\n\n**Faturamento.** Por serviço: cada serviço que retorna um resultado faturável é cobrado pelo seu próprio preço de catálogo. Serviços com falha ou ignorados não são cobrados, e requisições rejeitadas com `400` não custam nada. A verificação prévia de saldo cobre a soma dos preços dos serviços selecionados (`403` quando o saldo é insuficiente).\n\n**Falhas.** Quando nenhum serviço selecionado retorna um resultado utilizável, a API retorna `400` com `validation_errors` se todas as tentativas sem resposta recusaram explicitamente a entrada (`provider_rejected_input`, `retryable: false`). Corrija a entrada antes de tentar novamente. Caso contrário, ela retorna `502` com `validation_errors` (`empty_provider_response`, `retryable: true`), inclusive quando há rejeição de entrada combinada com tentativas alternativas indisponíveis; nada é cobrado (uma sessão ainda é registrada com status `Not Finished` quando `save_api_request=true`). Quando apenas alguns serviços falham, a resposta `200` traz essas falhas em `database_validation.errors`.\n\n**Sandbox.** Chaves de aplicações de sandbox ignoram as chamadas aos registros e o faturamento e retornam uma resposta estática `full_match`. O payload de sandbox sempre inclui `services_used` e `match_score: 100`, independentemente de como `services` foi enviado, portanto não valide nas respostas de sandbox a condição do formato estendido do ambiente de produção nem a fração de `match_score` de 0.0 a 1.0.\n\nEnvie a requisição como `application/json` ou como `multipart/form-data` ao enviar uma `selfie`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "issuing_state" ], "properties": { "issuing_state": { "type": "string", "description": "Código de país ISO 3166-1 **alpha-3** do registro a ser usado na validação (por exemplo, `BRA`, `ESP`, `COL`). Determina quais serviços estão disponíveis. Códigos não suportados retornam `400` com a lista completa de opções válidas.", "example": "BRA" }, "services": { "type": "array", "items": { "type": "string" }, "description": "`service_id`s do catálogo a executar para este país (por exemplo, `[\"bra_cpf\"]`). Também aceita uma única string ou uma string separada por vírgulas ou codificada em JSON. **Se omitido ou vazio, exatamente um serviço padrão é executado**: o serviço ativo mais antigo do país; serviços mais novos, biométricos e com pagamento por uso devem ser indicados explicitamente. Enviar `services` muda a resposta para o formato estendido (adiciona `services_used` e `match_score`). Todo id deve existir e estar ativo para o `issuing_state`; serviços que exigem onboarding retornam `400` até serem ativados para a sua organização. Descubra os serviços disponíveis por país via `GET /v1/organization/database-validation-countries/` (um endpoint de catálogo não documentado nesta especificação) ou no editor de fluxos do Business Console.", "example": [ "bra_cpf" ] }, "validation_type": { "type": "string", "deprecated": true, "description": "OBSOLETO. Aceito por compatibilidade com versões anteriores, mas ignorado: o `validation_type` da resposta agora é derivado de quantos serviços tiveram correspondência total. Use `services` para fixar serviços específicos." }, "consent": { "type": "boolean", "default": false, "description": "Defina como `true` quando o usuário final tiver consentido explicitamente com os serviços de validação selecionados. Obrigatório para serviços marcados com `requires_consent=true` no catálogo; sem isso, esses serviços retornam `400` com `services_requiring_consent`." }, "identification_number": { "type": "string", "description": "Número de identificação universal, mapeado automaticamente para o campo específico do país correto, para que você possa usá-lo em vez de `personal_number`/`tax_number`/`document_number`: ARG→document_number (DNI), BOL→document_number (CI), BRA→tax_number (CPF, 11 dígitos), CHL→personal_number (RUT), COL→personal_number (Cédula), CRI→personal_number (Cédula), DOM→personal_number (Cédula, 11 dígitos), ECU→personal_number (Cédula, 10 dígitos), ESP→personal_number (DNI/NIE), GTM→document_number (DPI), HND→document_number (DNI), MEX→personal_number (CURP, 18 caracteres), PAN→personal_number (Cédula), PER→personal_number (DNI, 8 dígitos), PRY→document_number (CI), SLV→document_number (DUI), URY→personal_number (CI), VEN→document_number (Cédula). Ele nunca substitui um campo específico do país informado explicitamente." }, "first_name": { "type": "string", "description": "O nome da pessoa física. Obrigatório para alguns serviços/países.", "example": "John" }, "last_name": { "type": "string", "description": "O sobrenome da pessoa física. Obrigatório para alguns serviços/países.", "example": "Doe" }, "middle_name": { "type": "string", "description": "Nome do meio, usado por alguns serviços de países (AUS, NZL, …)." }, "full_name": { "type": "string", "description": "Nome completo. Alguns serviços aceitam este campo no lugar do nome e sobrenome (por exemplo, os serviços CHN, que fazem a correspondência com o nome na escrita nativa)." }, "date_of_birth": { "type": "string", "format": "date", "description": "Data de nascimento, `YYYY-MM-DD`. Exigida por muitos serviços.", "example": "1980-01-01" }, "personal_number": { "type": "string", "description": "Identificador pessoal único emitido pelo governo. Usado por: CHL (RUT), COL (Cédula), CRI, DOM, ECU, ESP (DNI/NIE), MEX (CURP), PAN (Cédula), PER (DNI), URY. Considere usar `identification_number` em vez disso." }, "tax_number": { "type": "string", "description": "Número de identificação fiscal. Usado por: BRA (CPF, 11 dígitos). Considere usar `identification_number`." }, "document_number": { "type": "string", "description": "Número do documento. Usado por: ARG (DNI), BOL (CI), GTM (DPI), HND (DNI), PRY (CI), SLV (DUI), VEN (Cédula). Considere usar `identification_number` em vez dele." }, "document_type": { "type": "string", "enum": [ "P", "DL", "ID", "RP", "SSC", "HIC", "WP", "TC", "VISA", "PSC", "BC", "OTHER" ], "description": "Tipo de documento validado: `P` passaporte, `DL` carteira de motorista, `ID` documento nacional de identidade, `RP` autorização de residência (além de `SSC`, `HIC`, `WP`, `TC`, `VISA`, `PSC`, `BC`, `OTHER`). Exigido por alguns serviços (por exemplo, ESP)." }, "expiration_date": { "type": "string", "format": "date", "description": "Data de validade do documento, `YYYY-MM-DD`. Obrigatória para a validação ESP (Espanha).", "example": "2030-01-15" }, "date_of_issue": { "type": "string", "format": "date", "description": "Data de emissão do documento, `YYYY-MM-DD` (fecha de expedición). Obrigatória para a validação da cédula COL (Colômbia).", "example": "2015-06-20" }, "nationality": { "type": "string", "description": "Nacionalidade no formato ISO 3166-1 alpha-3. Obrigatória para alguns serviços." }, "gender": { "type": "string", "enum": [ "M", "F", "X" ], "description": "Gênero: `M`, `F` ou `X` (outro/desconhecido). Obrigatório para a validação RENAPER da Argentina (`arg_renaper`)." }, "address": { "description": "Endereço residencial. Prefira o objeto estruturado `{\"street_1\":\"123 Main St\",\"street_2\":\"Apt 4B\",\"city\":\"Springfield\",\"region\":\"IL\",\"postal_code\":\"62701\",\"country\":\"US\"}`; uma string completa em uma única linha ainda é aceita. Obrigatório para serviços de verificação de endereço; quando um serviço define requisitos de endereço, partes ausentes retornam `400` com `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": "Endereço completo em uma única linha (legado)." } ] }, "address_element_1": { "type": "string", "description": "Endereço incluindo número e tipo de logradouro. Se omitido, é derivado de `address`." }, "address_element_2": { "type": "string", "description": "Apartamento, unidade, edifício, andar ou linha adicional do endereço. Envie apenas quando tiver essa informação explicitamente." }, "address_element_3": { "type": "string", "description": "Cidade, subúrbio, distrito, localidade ou bairro. Se omitido, é derivado de `address`." }, "address_element_4": { "type": "string", "description": "Estado, província, região ou cidade. Se omitido, é derivado de `address`." }, "address_element_5": { "type": "string", "description": "CEP ou código postal. `postal_code` é aceito como alias." }, "postal_code": { "type": "string", "description": "Código postal para serviços baseados em endereço (alias de `address_element_5`)." }, "driver_license_number": { "type": "string", "description": "Número da carteira de motorista para serviços governamentais de verificação de documentos (AUS, NZL, IND)." }, "driver_license_card_number": { "type": "string", "description": "Número do cartão físico da carteira de motorista, quando exigido separadamente do número da carteira (AUS)." }, "driver_license_state": { "type": "string", "description": "Estado ou território emissor da carteira de motorista (AUS)." }, "driver_license_version": { "type": "string", "description": "Código de versão da carteira de motorista (NZL)." }, "passport_number": { "type": "string", "description": "Número do passaporte para serviços governamentais de verificação de passaporte (AUS, NZL, IND, CHN)." }, "passport_expiration_date": { "type": "string", "format": "date", "description": "Data de validade do passaporte, `YYYY-MM-DD`, para serviços de verificação de passaporte." }, "passport_file_number": { "type": "string", "description": "Número de arquivo do passaporte (IND)." }, "passport_issue_country": { "type": "string", "description": "País emissor do passaporte (ISO 3166-1 alpha-3) para serviços de verificação de passaporte." }, "medicare_card_number": { "type": "string", "description": "Número do cartão Medicare (AUS)." }, "immi_card_number": { "type": "string", "description": "Número do ImmiCard australiano." }, "immi_card_expiry_date": { "type": "string", "format": "date", "description": "Data de validade do ImmiCard australiano." }, "citizenship_certificate_number": { "type": "string", "description": "Número do certificado de cidadania (AUS)." }, "birth_registration_number": { "type": "string", "description": "Número de registro da certidão de nascimento (AUS)." }, "birth_registration_date": { "type": "string", "format": "date", "description": "Data de registro da certidão de nascimento (AUS)." }, "birth_registration_state": { "type": "string", "description": "Estado de registro da certidão de nascimento (AUS)." }, "marriage_certificate_number": { "type": "string", "description": "Número da certidão de casamento (AUS)." }, "change_of_name_certificate_number": { "type": "string", "description": "Número da certidão de mudança de nome (AUS)." }, "first_partner_name": { "type": "string", "description": "Primeiro nome do cônjuge em uma certidão de casamento (AUS)." }, "last_partner_name": { "type": "string", "description": "Sobrenome do cônjuge em uma certidão de casamento (AUS)." }, "voter_id": { "type": "string", "description": "Número de registro eleitoral (IND EPIC, IRL)." }, "epic_card": { "type": "string", "description": "Número do título de eleitor EPIC da Índia." }, "pan": { "type": "string", "description": "PAN (Permanent Account Number) da Índia." }, "national_id": { "type": "string", "description": "Número de identidade nacional (CHN, MYS, KEN, KHM, NGA, ZAF, …)." }, "cic": { "type": "string", "description": "Código de Identificación de Credencial (CIC) do INE/IFE mexicano, 9 dígitos. Usado pelo serviço de validade da credencial INE do México (`mex_ine_vigencia`)." }, "identificador_ciudadano": { "type": "string", "description": "Identificador del Ciudadano do INE mexicano (9 dígitos). Usado com `cic` para os modelos modernos do INE (E/F/G/H) em `mex_ine_vigencia`." }, "ocr": { "type": "string", "description": "Número OCR do INE mexicano (13 dígitos, no verso do cartão). Usado com `cic` para o Modelo D em `mex_ine_vigencia`." }, "voter_number": { "type": "string", "description": "Clave de Elector do INE mexicano (18 caracteres). Usada com `emission_number` para os modelos antigos do IFE (A/B/C) em `mex_ine_vigencia`." }, "emission_number": { "type": "string", "description": "Número de Emisión do INE mexicano. Usado com `voter_number` para os modelos antigos do IFE (A/B/C) em `mex_ine_vigencia`." }, "bvn": { "type": "string", "description": "Bank Verification Number (BVN) da Nigéria." }, "bank_card_number": { "type": "string", "description": "Número do cartão bancário (verificação de cartão bancário da CHN)." }, "company_registration_number": { "type": "string", "description": "Número de registro da empresa emitido pelo registro de empresas: o CNPJ no Brasil (por exemplo, `11222333000181`), o número de registro na África do Sul (por exemplo, `1936/007721/06`). Obrigatório para os serviços de registro de empresas e de diretores de empresas (`bra_company_registry`, `bra_company_directors`, `zaf_company_registry`, `zaf_company_directors`)." }, "company_name": { "type": "string", "description": "Razão social registrada, verificada em relação ao registro. Opcional para `zaf_company_registry`." }, "initials": { "type": "string", "description": "As iniciais da pessoa conforme impressas no documento. Obrigatório para `zaf_drivers_license`; aceito por `zaf_bank_account_holder`." }, "licence_number": { "type": "string", "description": "Número da carteira de motorista conforme impresso no cartão, para `zaf_drivers_license`. Quando omitido, é usado o `document_number`." }, "refugee_file_number": { "type": "string", "description": "Número do processo de refugiado emitido pelo Department of Home Affairs da África do Sul. Obrigatório para `zaf_refugee`." }, "bank_name": { "type": "string", "description": "Nome do banco que mantém a conta. Obrigatório para `zaf_bank_account_holder`." }, "bank_account_number": { "type": "string", "description": "Número da conta bancária. Obrigatório para `zaf_bank_account_holder`; aceito por `zaf_fraud_prevention`." }, "account_type": { "type": "string", "description": "Tipo de conta bancária para `zaf_bank_account_holder`: `current`, `savings`, `transmission`, `subscriptionShare` ou `notKnown`, sem diferenciar maiúsculas de minúsculas. Qualquer outro valor retorna `400`. Omita-o quando não souber o tipo: nesse caso, a verificação cruzada do tipo de conta é reportada como não confirmada." }, "phone_number": { "type": "string", "description": "Número de celular de contato, para os serviços que verificam a contactabilidade (`zaf_bank_account_holder`, `zaf_fraud_prevention`, `zaf_refugee`)." }, "right_thumb": { "type": "string", "description": "Impressão digital do polegar direito codificada em Base64 para `zaf_dha_fingerprint_match`, junto com `left_thumb` ou sozinha." }, "left_thumb": { "type": "string", "description": "Impressão digital do polegar esquerdo codificada em Base64 para `zaf_dha_fingerprint_match`, junto com `right_thumb` ou sozinha." }, "score_level": { "type": "integer", "description": "Nível mínimo de pontuação biométrica para `zaf_criminal_face_screening`. O padrão é `3`." }, "max_matches": { "type": "integer", "description": "Número máximo de correspondências candidatas que `zaf_criminal_face_screening` retorna. O padrão é `1`." }, "vehicle_register_number": { "type": "string", "description": "Número de registro do veículo. Obrigatório, junto com `vehicle_licence_plate` e `vin`, para `zaf_vehicle_ownership`." }, "vehicle_licence_plate": { "type": "string", "description": "Número da placa do veículo. Obrigatório, junto com `vehicle_register_number` e `vin`, para `zaf_vehicle_ownership`." }, "vin": { "type": "string", "description": "Número de identificação do veículo (VIN ou número do chassi). Obrigatório, junto com `vehicle_register_number` e `vehicle_licence_plate`, para `zaf_vehicle_ownership`." }, "ssn": { "type": "string", "description": "Número do Seguro Social (Social Security Number, EUA)." }, "phone": { "type": "string", "description": "Número de telefone para serviços de verificação de telefone." }, "landline": { "type": "string", "description": "Número de telefone fixo para serviços de verificação de telefone." }, "email": { "type": "string", "format": "email", "description": "Endereço de e-mail para serviços de verificação de identidade." }, "country_of_residence": { "type": "string", "description": "País de residência em ISO 3166-1 alpha-2. Usado por serviços globais de enriquecimento de identidade (por exemplo, `glb_identity_enrichment`) para direcionar a consulta.", "example": "US" }, "partial_match_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "NO_ACTION", "description": "O efeito de um `partial_match` em `database_validation.status`. O padrão é `NO_ACTION` (o status permanece `Approved`, com um aviso)." }, "no_match_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "O efeito de um `no_match` em `database_validation.status`. O padrão é `DECLINE`." }, "save_api_request": { "type": "boolean", "default": true, "description": "Persiste a validação como uma sessão (visibilidade no console, endpoint de decisão, webhook `status.updated`). Também altera o formato da resposta `validations`: objetos por serviço quando `true` (padrão), um mapa de campos mesclado quando `false`." }, "vendor_data": { "type": "string", "description": "Seu identificador para o usuário validado; retornado na resposta e armazenado com a sessão." }, "metadata": { "type": "object", "nullable": true, "description": "JSON livre armazenado com a requisição e retornado na 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": "Código de país ISO 3166-1 **alpha-3** do registro a ser usado na validação (por exemplo, `BRA`, `ESP`, `COL`). Determina quais serviços estão disponíveis. Códigos não suportados retornam `400` com a lista completa de opções válidas.", "example": "BRA" }, "services": { "type": "array", "items": { "type": "string" }, "description": "`service_id`s do catálogo a executar para este país (por exemplo, `[\"bra_cpf\"]`). Também aceita uma única string ou uma string separada por vírgulas ou codificada em JSON. **Se omitido ou vazio, exatamente um serviço padrão é executado**: o serviço ativo mais antigo do país; serviços mais novos, biométricos e com pagamento por uso devem ser indicados explicitamente. Enviar `services` muda a resposta para o formato estendido (adiciona `services_used` e `match_score`). Todo id deve existir e estar ativo para o `issuing_state`; serviços que exigem onboarding retornam `400` até serem ativados para a sua organização. Descubra os serviços disponíveis por país via `GET /v1/organization/database-validation-countries/` (um endpoint de catálogo não documentado nesta especificação) ou no editor de fluxos do Business Console.", "example": [ "bra_cpf" ] }, "validation_type": { "type": "string", "deprecated": true, "description": "OBSOLETO. Aceito por compatibilidade com versões anteriores, mas ignorado: o `validation_type` da resposta agora é derivado de quantos serviços tiveram correspondência total. Use `services` para fixar serviços específicos." }, "consent": { "type": "boolean", "default": false, "description": "Defina como `true` quando o usuário final tiver consentido explicitamente com os serviços de validação selecionados. Obrigatório para serviços marcados com `requires_consent=true` no catálogo; sem isso, esses serviços retornam `400` com `services_requiring_consent`." }, "identification_number": { "type": "string", "description": "Número de identificação universal, mapeado automaticamente para o campo específico do país correto, para que você possa usá-lo em vez de `personal_number`/`tax_number`/`document_number`: ARG→document_number (DNI), BOL→document_number (CI), BRA→tax_number (CPF, 11 dígitos), CHL→personal_number (RUT), COL→personal_number (Cédula), CRI→personal_number (Cédula), DOM→personal_number (Cédula, 11 dígitos), ECU→personal_number (Cédula, 10 dígitos), ESP→personal_number (DNI/NIE), GTM→document_number (DPI), HND→document_number (DNI), MEX→personal_number (CURP, 18 caracteres), PAN→personal_number (Cédula), PER→personal_number (DNI, 8 dígitos), PRY→document_number (CI), SLV→document_number (DUI), URY→personal_number (CI), VEN→document_number (Cédula). Ele nunca substitui um campo específico do país informado explicitamente." }, "first_name": { "type": "string", "description": "O nome da pessoa física. Obrigatório para alguns serviços/países.", "example": "John" }, "last_name": { "type": "string", "description": "O sobrenome da pessoa física. Obrigatório para alguns serviços/países.", "example": "Doe" }, "middle_name": { "type": "string", "description": "Nome do meio, usado por alguns serviços de países (AUS, NZL, …)." }, "full_name": { "type": "string", "description": "Nome completo. Alguns serviços aceitam este campo no lugar do nome e sobrenome (por exemplo, os serviços CHN, que fazem a correspondência com o nome na escrita nativa)." }, "date_of_birth": { "type": "string", "format": "date", "description": "Data de nascimento, `YYYY-MM-DD`. Exigida por muitos serviços.", "example": "1980-01-01" }, "personal_number": { "type": "string", "description": "Identificador pessoal único emitido pelo governo. Usado por: CHL (RUT), COL (Cédula), CRI, DOM, ECU, ESP (DNI/NIE), MEX (CURP), PAN (Cédula), PER (DNI), URY. Considere usar `identification_number` em vez disso." }, "tax_number": { "type": "string", "description": "Número de identificação fiscal. Usado por: BRA (CPF, 11 dígitos). Considere usar `identification_number`." }, "document_number": { "type": "string", "description": "Número do documento. Usado por: ARG (DNI), BOL (CI), GTM (DPI), HND (DNI), PRY (CI), SLV (DUI), VEN (Cédula). Considere usar `identification_number` em vez dele." }, "document_type": { "type": "string", "enum": [ "P", "DL", "ID", "RP", "SSC", "HIC", "WP", "TC", "VISA", "PSC", "BC", "OTHER" ], "description": "Tipo de documento validado: `P` passaporte, `DL` carteira de motorista, `ID` documento nacional de identidade, `RP` autorização de residência (além de `SSC`, `HIC`, `WP`, `TC`, `VISA`, `PSC`, `BC`, `OTHER`). Exigido por alguns serviços (por exemplo, ESP)." }, "expiration_date": { "type": "string", "format": "date", "description": "Data de validade do documento, `YYYY-MM-DD`. Obrigatória para a validação ESP (Espanha).", "example": "2030-01-15" }, "date_of_issue": { "type": "string", "format": "date", "description": "Data de emissão do documento, `YYYY-MM-DD` (fecha de expedición). Obrigatória para a validação da cédula COL (Colômbia).", "example": "2015-06-20" }, "nationality": { "type": "string", "description": "Nacionalidade no formato ISO 3166-1 alpha-3. Obrigatória para alguns serviços." }, "gender": { "type": "string", "enum": [ "M", "F", "X" ], "description": "Gênero: `M`, `F` ou `X` (outro/desconhecido). Obrigatório para a validação RENAPER da Argentina (`arg_renaper`)." }, "address": { "description": "Endereço residencial. Prefira o objeto estruturado `{\"street_1\":\"123 Main St\",\"street_2\":\"Apt 4B\",\"city\":\"Springfield\",\"region\":\"IL\",\"postal_code\":\"62701\",\"country\":\"US\"}`; uma string completa em uma única linha ainda é aceita. Obrigatório para serviços de verificação de endereço; quando um serviço define requisitos de endereço, partes ausentes retornam `400` com `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": "Endereço completo em uma única linha (legado)." } ] }, "address_element_1": { "type": "string", "description": "Endereço incluindo número e tipo de logradouro. Se omitido, é derivado de `address`." }, "address_element_2": { "type": "string", "description": "Apartamento, unidade, edifício, andar ou linha adicional do endereço. Envie apenas quando tiver essa informação explicitamente." }, "address_element_3": { "type": "string", "description": "Cidade, subúrbio, distrito, localidade ou bairro. Se omitido, é derivado de `address`." }, "address_element_4": { "type": "string", "description": "Estado, província, região ou cidade. Se omitido, é derivado de `address`." }, "address_element_5": { "type": "string", "description": "CEP ou código postal. `postal_code` é aceito como alias." }, "postal_code": { "type": "string", "description": "Código postal para serviços baseados em endereço (alias de `address_element_5`)." }, "driver_license_number": { "type": "string", "description": "Número da carteira de motorista para serviços governamentais de verificação de documentos (AUS, NZL, IND)." }, "driver_license_card_number": { "type": "string", "description": "Número do cartão físico da carteira de motorista, quando exigido separadamente do número da carteira (AUS)." }, "driver_license_state": { "type": "string", "description": "Estado ou território emissor da carteira de motorista (AUS)." }, "driver_license_version": { "type": "string", "description": "Código de versão da carteira de motorista (NZL)." }, "passport_number": { "type": "string", "description": "Número do passaporte para serviços governamentais de verificação de passaporte (AUS, NZL, IND, CHN)." }, "passport_expiration_date": { "type": "string", "format": "date", "description": "Data de validade do passaporte, `YYYY-MM-DD`, para serviços de verificação de passaporte." }, "passport_file_number": { "type": "string", "description": "Número de arquivo do passaporte (IND)." }, "passport_issue_country": { "type": "string", "description": "País emissor do passaporte (ISO 3166-1 alpha-3) para serviços de verificação de passaporte." }, "medicare_card_number": { "type": "string", "description": "Número do cartão Medicare (AUS)." }, "immi_card_number": { "type": "string", "description": "Número do ImmiCard australiano." }, "immi_card_expiry_date": { "type": "string", "format": "date", "description": "Data de validade do ImmiCard australiano." }, "citizenship_certificate_number": { "type": "string", "description": "Número do certificado de cidadania (AUS)." }, "birth_registration_number": { "type": "string", "description": "Número de registro da certidão de nascimento (AUS)." }, "birth_registration_date": { "type": "string", "format": "date", "description": "Data de registro da certidão de nascimento (AUS)." }, "birth_registration_state": { "type": "string", "description": "Estado de registro da certidão de nascimento (AUS)." }, "marriage_certificate_number": { "type": "string", "description": "Número da certidão de casamento (AUS)." }, "change_of_name_certificate_number": { "type": "string", "description": "Número da certidão de mudança de nome (AUS)." }, "first_partner_name": { "type": "string", "description": "Primeiro nome do cônjuge em uma certidão de casamento (AUS)." }, "last_partner_name": { "type": "string", "description": "Sobrenome do cônjuge em uma certidão de casamento (AUS)." }, "voter_id": { "type": "string", "description": "Número de registro eleitoral (IND EPIC, IRL)." }, "epic_card": { "type": "string", "description": "Número do título de eleitor EPIC da Índia." }, "pan": { "type": "string", "description": "PAN (Permanent Account Number) da Índia." }, "national_id": { "type": "string", "description": "Número de identidade nacional (CHN, MYS, KEN, KHM, NGA, ZAF, …)." }, "cic": { "type": "string", "description": "Código de Identificación de Credencial (CIC) do INE/IFE mexicano, 9 dígitos. Usado pelo serviço de validade da credencial INE do México (`mex_ine_vigencia`)." }, "identificador_ciudadano": { "type": "string", "description": "Identificador del Ciudadano do INE mexicano (9 dígitos). Usado com `cic` para os modelos modernos do INE (E/F/G/H) em `mex_ine_vigencia`." }, "ocr": { "type": "string", "description": "Número OCR do INE mexicano (13 dígitos, no verso do cartão). Usado com `cic` para o Modelo D em `mex_ine_vigencia`." }, "voter_number": { "type": "string", "description": "Clave de Elector do INE mexicano (18 caracteres). Usada com `emission_number` para os modelos antigos do IFE (A/B/C) em `mex_ine_vigencia`." }, "emission_number": { "type": "string", "description": "Número de Emisión do INE mexicano. Usado com `voter_number` para os modelos antigos do IFE (A/B/C) em `mex_ine_vigencia`." }, "bvn": { "type": "string", "description": "Bank Verification Number (BVN) da Nigéria." }, "bank_card_number": { "type": "string", "description": "Número do cartão bancário (verificação de cartão bancário da CHN)." }, "company_registration_number": { "type": "string", "description": "Número de registro da empresa emitido pelo registro de empresas: o CNPJ no Brasil (por exemplo, `11222333000181`), o número de registro na África do Sul (por exemplo, `1936/007721/06`). Obrigatório para os serviços de registro de empresas e de diretores de empresas (`bra_company_registry`, `bra_company_directors`, `zaf_company_registry`, `zaf_company_directors`)." }, "company_name": { "type": "string", "description": "Razão social registrada, verificada em relação ao registro. Opcional para `zaf_company_registry`." }, "initials": { "type": "string", "description": "As iniciais da pessoa conforme impressas no documento. Obrigatório para `zaf_drivers_license`; aceito por `zaf_bank_account_holder`." }, "licence_number": { "type": "string", "description": "Número da carteira de motorista conforme impresso no cartão, para `zaf_drivers_license`. Quando omitido, é usado o `document_number`." }, "refugee_file_number": { "type": "string", "description": "Número do processo de refugiado emitido pelo Department of Home Affairs da África do Sul. Obrigatório para `zaf_refugee`." }, "bank_name": { "type": "string", "description": "Nome do banco que mantém a conta. Obrigatório para `zaf_bank_account_holder`." }, "bank_account_number": { "type": "string", "description": "Número da conta bancária. Obrigatório para `zaf_bank_account_holder`; aceito por `zaf_fraud_prevention`." }, "account_type": { "type": "string", "description": "Tipo de conta bancária para `zaf_bank_account_holder`: `current`, `savings`, `transmission`, `subscriptionShare` ou `notKnown`, sem diferenciar maiúsculas de minúsculas. Qualquer outro valor retorna `400`. Omita-o quando não souber o tipo: nesse caso, a verificação cruzada do tipo de conta é reportada como não confirmada." }, "phone_number": { "type": "string", "description": "Número de celular de contato, para os serviços que verificam a contactabilidade (`zaf_bank_account_holder`, `zaf_fraud_prevention`, `zaf_refugee`)." }, "right_thumb": { "type": "string", "description": "Impressão digital do polegar direito codificada em Base64 para `zaf_dha_fingerprint_match`, junto com `left_thumb` ou sozinha." }, "left_thumb": { "type": "string", "description": "Impressão digital do polegar esquerdo codificada em Base64 para `zaf_dha_fingerprint_match`, junto com `right_thumb` ou sozinha." }, "score_level": { "type": "integer", "description": "Nível mínimo de pontuação biométrica para `zaf_criminal_face_screening`. O padrão é `3`." }, "max_matches": { "type": "integer", "description": "Número máximo de correspondências candidatas que `zaf_criminal_face_screening` retorna. O padrão é `1`." }, "vehicle_register_number": { "type": "string", "description": "Número de registro do veículo. Obrigatório, junto com `vehicle_licence_plate` e `vin`, para `zaf_vehicle_ownership`." }, "vehicle_licence_plate": { "type": "string", "description": "Número da placa do veículo. Obrigatório, junto com `vehicle_register_number` e `vin`, para `zaf_vehicle_ownership`." }, "vin": { "type": "string", "description": "Número de identificação do veículo (VIN ou número do chassi). Obrigatório, junto com `vehicle_register_number` e `vehicle_licence_plate`, para `zaf_vehicle_ownership`." }, "ssn": { "type": "string", "description": "Número do Seguro Social (Social Security Number, EUA)." }, "phone": { "type": "string", "description": "Número de telefone para serviços de verificação de telefone." }, "landline": { "type": "string", "description": "Número de telefone fixo para serviços de verificação de telefone." }, "email": { "type": "string", "format": "email", "description": "Endereço de e-mail para serviços de verificação de identidade." }, "country_of_residence": { "type": "string", "description": "País de residência em ISO 3166-1 alpha-2. Usado por serviços globais de enriquecimento de identidade (por exemplo, `glb_identity_enrichment`) para direcionar a consulta.", "example": "US" }, "partial_match_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "NO_ACTION", "description": "O efeito de um `partial_match` em `database_validation.status`. O padrão é `NO_ACTION` (o status permanece `Approved`, com um aviso)." }, "no_match_action": { "type": "string", "enum": [ "DECLINE", "NO_ACTION" ], "default": "DECLINE", "description": "O efeito de um `no_match` em `database_validation.status`. O padrão é `DECLINE`." }, "save_api_request": { "type": "boolean", "default": true, "description": "Persiste a validação como uma sessão (visibilidade no console, endpoint de decisão, webhook `status.updated`). Também altera o formato da resposta `validations`: objetos por serviço quando `true` (padrão), um mapa de campos mesclado quando `false`." }, "vendor_data": { "type": "string", "description": "Seu identificador para o usuário validado; retornado na resposta e armazenado com a sessão." }, "metadata": { "type": "object", "nullable": true, "description": "JSON livre armazenado com a requisição e retornado na resposta." }, "selfie": { "type": "string", "format": "binary", "description": "Imagem da selfie (`jpg`, `jpeg`, `png`, `webp`; máximo de 2 MB, as imagens são comprimidas para cerca de 1,5 MB antes do envio ao registro) para serviços de validação biométrica, por exemplo RENAPER da Argentina (`arg_renaper`) e SIB do Panamá (`pan_cedula_sib`, `pan_cedula_sib_plus`). Obrigatória sempre que um serviço selecionado a listar como campo obrigatório. Disponível somente via `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": "Validação concluída: pelo menos um serviço selecionado retornou um resultado utilizável. Consulte `database_validation.match_type` para o resultado agregado, `validations` para as comparações de campos por serviço e os `outcome_code`s, e `errors` (quando presente) para os serviços que falharam.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID da sessão persistida quando `save_api_request=true` (utilizável com `GET /v3/session/{sessionId}/decision/`); caso contrário, um UUID de correlação transitório." }, "database_validation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review" ], "description": "`Declined` quando o `match_type` geral aciona uma ação `DECLINE` (`no_match_action` tem `DECLINE` como padrão, e `partial_match_action` tem `NO_ACTION`); `In Review` quando nenhum serviço produziu uma comparação utilizável, por exemplo quando o único serviço selecionado retornou `REGISTRY_UNAVAILABLE` ou `INCONCLUSIVE`; `Approved` caso contrário. Uma requisição que selecionou vários serviços pode ficar `Approved` pela correspondência de um serviço enquanto outro estava indisponível, então verifique também `errors` e os `outcome_code`s de cada serviço." }, "issuing_state": { "type": "string", "description": "Eco do país ISO 3166-1 alpha-3 usado na validação.", "example": "BRA" }, "validation_type": { "type": "string", "enum": [ "one_by_one", "two_by_two" ], "description": "Derivado dos resultados: `two_by_two` quando ≥2 serviços distintos produziram uma correspondência completa (no número de identificação, no nome completo + data de nascimento juntos, ou no endereço sem contradições); `one_by_one` caso contrário. (O campo de mesmo nome na requisição está obsoleto e é ignorado.)" }, "screened_data": { "type": "object", "description": "Eco dos campos de entrada enviados aos serviços selecionados (datas normalizadas para `YYYY-MM-DD`; uma `selfie`, quando enviada, é retornada como URL pré-assinada; `consent_obtained: true` é adicionado quando o consentimento foi dado)." }, "match_type": { "type": "string", "nullable": true, "enum": [ "full_match", "partial_match", "no_match" ], "description": "Resultado geral agregado entre os serviços com comparações em nível de campo: qualquer `full_match` → `full_match`; caso contrário, qualquer `partial_match` → `partial_match`; caso contrário, `no_match`. Serviços que retornam apenas um resultado, como a triagem criminal biométrica, podem retornar `null`; consulte cada item em `validations` para ver o seu `outcome_code`." }, "validations": { "description": "O formato depende de `save_api_request`. **`true` (padrão):** um array de objetos por serviço (`service_id`, `service_name`, `validation`, `outcome_code`, `outcome_detail`, `source_data`). **`false`:** um único objeto plano que combina os resultados por campo de todos os serviços (`{\"full_name\": \"full_match\", ...}`).", "oneOf": [ { "type": "array", "items": { "type": "object", "description": "Resultado da validação por serviço (retornado quando `save_api_request=true`, o padrão).", "properties": { "service_id": { "type": "string", "description": "Id de catálogo do serviço que gerou este resultado (por exemplo, `bra_cpf`).", "example": "bra_cpf" }, "service_name": { "type": "string", "description": "Nome legível do serviço no catálogo.", "example": "Brazil - CPF status check" }, "validation": { "type": "object", "description": "Comparação campo a campo entre os seus dados de entrada e o registro oficial. As chaves são nomes canônicos de campo (`full_name`, `date_of_birth`, `identification_number`, `address`, …); os valores são `full_match`, `partial_match` ou `no_match`.", "additionalProperties": { "type": "string", "enum": [ "full_match", "partial_match", "no_match" ] } }, "outcome_code": { "type": "string", "enum": [ "MATCH", "PARTIAL_MATCH", "NO_MATCH", "DOCUMENT_NOT_FOUND", "INVALID_DOCUMENT_FORMAT", "INVALID_INPUT", "MINOR_BLOCKED", "DECEASED", "BIOMETRIC_NO_MATCH", "BIOMETRIC_IMAGE_UNUSABLE", "INCONCLUSIVE", "DOCUMENT_SUPERSEDED", "REGISTRY_UNAVAILABLE", "REGISTRY_ERROR" ], "description": "Resultado da consulta ao registro, independente de fornecedor. `MATCH`/`PARTIAL_MATCH`/`NO_MATCH` descrevem a comparação; `DOCUMENT_NOT_FOUND` significa que o identificador não está no registro; `INCONCLUSIVE` significa que o registro não conseguiu confirmar nem negar (encaminhado para revisão, NÃO é uma não correspondência); `BIOMETRIC_NO_MATCH` é uma divergência facial definitiva, enquanto `BIOMETRIC_IMAGE_UNUSABLE` é um problema técnico de imagem (refaça a selfie); `DECEASED`/`MINOR_BLOCKED` são resultados decorrentes da política do registro; `DOCUMENT_SUPERSEDED` significa que a identidade correspondeu, mas a edição do documento apresentado não é a que consta no registro (uma edição mais recente foi emitida); `INVALID_DOCUMENT_FORMAT`/`INVALID_INPUT` significam que o próprio registro rejeitou os dados enviados; `REGISTRY_UNAVAILABLE`/`REGISTRY_ERROR` indicam falhas no serviço de origem." }, "outcome_detail": { "type": "string", "nullable": true, "description": "Detalhe bruto do status upstream que embasa o código de resultado (por exemplo, um código de status HTTP ou do registro)." }, "source_data": { "type": "object", "nullable": true, "description": "Visão limpa e normalizada do registro, com nomes de campo canônicos (`identification_number`, `first_name`, `last_name`, `date_of_birth`, além de indicadores específicos do registro). Os campos de imagem, quando presentes, são retornados como URLs pré-assinadas." } } } }, { "type": "object", "additionalProperties": { "type": "string", "enum": [ "full_match", "partial_match", "no_match" ] }, "description": "Resultados mesclados no nível do campo (formato sem estado de `save_api_request=false`)." } ] }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Recurso que emitiu o aviso." }, "risk": { "type": "string", "description": "Identificador de risco legível por máquina." }, "additional_data": { "type": "object", "nullable": true, "description": "Contexto adicional sobre o aviso, quando disponível." }, "log_type": { "type": "string", "description": "`warning`, `information` ou `error`: como o risco afetou o resultado." }, "short_description": { "type": "string", "description": "Resumo legível de uma linha." }, "long_description": { "type": "string", "description": "Explicação completa e legível." } } }, "description": "`DATABASE_VALIDATION_NO_MATCH` ou `DATABASE_VALIDATION_PARTIAL_MATCH`, quando aplicável; vazio em uma correspondência total." }, "errors": { "type": "array", "description": "Presente somente quando alguns (mas não todos) os serviços selecionados falharam. Cada entrada contém `service_id`, `code`, `message` e `retryable`. Um serviço informado aqui não aparece em `validations` nem em `services_used` e não é cobrado. Este array é o único lugar onde ele aparece, portanto inspecione-o mesmo quando `status` for `Approved`.", "items": { "type": "object", "properties": { "service_id": { "type": "string" }, "code": { "type": "string", "example": "empty_provider_response" }, "message": { "type": "string" }, "retryable": { "type": "boolean", "description": "`true` quando o serviço não produziu resposta e tentar novamente mais tarde pode funcionar; `false` quando a fonte rejeitou os dados enviados e a entrada precisa ser corrigida antes.", "example": true } } } }, "services_used": { "type": "array", "items": { "type": "string" }, "description": "Ids de catálogo dos serviços que retornaram um resultado faturável. **Presente apenas quando a requisição enviou `services` explicitamente.**" }, "match_score": { "type": "number", "description": "Fração (0.0–1.0) dos serviços tentados que produziram uma correspondência completa (no número de identificação, no nome completo + data de nascimento em conjunto, ou no endereço sem contradições). **Presente apenas quando a requisição enviou `services` explicitamente.**" } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco dos `vendor_data` que você enviou." }, "metadata": { "type": "object", "nullable": true, "description": "Eco do `metadata` que você enviou." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Full match (Approved)": { "summary": "Padrão save_api_request=true: objetos `validations` por serviço", "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": "A requisição enviou `services`: a resposta adiciona `services_used` e `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": "O registro não corresponde — padrão `no_match_action=DECLINE`", "value": { "request_id": "0a1b2c3d-4e5f-6789-abcd-ef0123456789", "database_validation": { "status": "Declined", "issuing_state": "BRA", "validation_type": "one_by_one", "screened_data": { "tax_number": "12345678900", "first_name": "John", "last_name": "Doe", "date_of_birth": "1980-01-01" }, "match_type": "no_match", "validations": [ { "validation": { "full_name": "no_match", "date_of_birth": "no_match", "identification_number": "no_match" }, "outcome_code": "NO_MATCH", "outcome_detail": "200", "service_id": "bra_cpf", "service_name": "Brazil - CPF status check", "source_data": { "identification_number": "00987654321", "first_name": "TOTALLY", "last_name": "DIFFERENT NAME", "date_of_birth": "1999-01-01", "lgpd_minor": false, "minor_under_16": false, "minor_under_18": false } } ], "warnings": [ { "feature": "DATABASE_VALIDATION", "risk": "DATABASE_VALIDATION_NO_MATCH", "additional_data": null, "log_type": "error", "short_description": "Database validation no match", "long_description": "The system identified a no match in the database validation, requiring further investigation." } ] }, "vendor_data": null, "metadata": null, "created_at": "2026-06-11T10:31:00.000000+00:00" } }, "Stateless (save_api_request=false)": { "summary": "`validations` é condensado em um mapa de campos mesclado; nada é armazenado", "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": "Erro de validação: nada é faturado. Os erros de campo da verificação prévia ocorrem antes de qualquer chamada externa. Se todas as tentativas sem resposta recusarem explicitamente a entrada, a resposta passa a incluir `validation_errors` com `code: provider_rejected_input` e `retryable: false`; corrija a entrada antes de tentar novamente. Problemas no nível de campo usam o envelope padrão do DRF. Problemas de catálogo retornam um array `services` (mais `requires_onboarding` ou `services_requiring_consent`, quando relevante). Erros de campo ausente incluem `fields_required_by`, que mapeia cada campo ausente para os serviços que o exigem. Serviços que precisam de pelo menos um identificador extra (por exemplo, `usa_states_credit_bureau`, que não consegue verificar apenas um nome) retornam `any_field_required_by`, que mapeia cada serviço para os campos dos quais pelo menos um deve estar presente. Problemas de formato verificados por serviço retornam `invalid_fields_by_service`.", "content": { "application/json": { "examples": { "Invalid issuing_state": { "summary": "País não suportado — a mensagem lista todos os códigos alpha-3 válidos", "value": { "error": [ "Invalid issuing state. Valid options are: ARE, ARG, AUS, AUT, BEL, BGD, BOL, BRA, CAN, CHE, CHL, CHN, CIV, COL, CRI, CZE, DEU, DNK, DOM, ECU, ESP, FIN, FRA, GBR, GHA, GLB, GRC, GTM, HKG, HND, IDN, IND, IRL, ITA, KEN, KHM, MAR, MEX, MYS, NGA, NLD, NOR, NZL, OMN, PAN, PER, PHL, POL, PRT, PRY, QAT, SGP, SLV, SVK, SWE, THA, UGA, URY, USA, VEN, ZAF, ZMB, ZWE" ] } }, "Missing required fields": { "summary": "União dos campos obrigatórios dos serviços selecionados, com a indicação de campo 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ém um id que não está no catálogo", "value": { "services": [ "Unknown service_id(s): ['bogus_service']" ] } }, "Service not live for country": { "summary": "`services` indica um serviço de outro país (ou uma entrada provisória)", "value": { "services": [ "Services not currently live for PER: ['bra_cpf']. Available services: ['per_dni', 'per_residential', 'per_tax_registration']" ] } }, "Service requires onboarding": { "summary": "O serviço existe, mas ainda não foi ativado para a sua organização", "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": "Um serviço selecionado está marcado com requires_consent=true e `consent` não 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": "O identificador não atende à regra de formato do país (comprimento/dígitos/regex)", "value": { "tax_number": [ "Invalid tax number for BRA: Brazilian CPF (exactly 11 digits). Must be exactly 11 characters long (got 10)." ] } }, "Service-specific format violation": { "summary": "Um campo não atende aos requisitos de formato do próprio serviço selecionado", "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": "Corrija a entrada antes de tentar novamente", "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": "Explicação no nível da requisição ou erros de campo da verificação prévia.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "validation_errors": { "type": "array", "description": "Presente quando todas as tentativas sem resposta recusaram a entrada após a pré-verificação.", "items": { "type": "object", "properties": { "service_id": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean", "description": "Indica se tentar novamente mais tarde pode resolver esta falha do serviço. False significa que é preciso corrigir primeiro a entrada fornecida." } } } } } } } } }, "403": { "description": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente e também quando o saldo da organização que faz a chamada não cobre a chamada; uma chave incorreta, revogada ou expirada retorna `401`. Uma chave ausente retorna `403` com `{\"detail\": ...}`; uma chave incorreta, revogada ou expirada retorna `401`. Créditos insuficientes retornam `403` com `{\"error\": ...}` antes de qualquer análise ou chamada a provedores.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "O saldo da organização não cobre a chamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Limite de requisições excedido. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API. A resposta inclui os cabeçalhos `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Mais de 300 requisições de escrita no minuto atual", "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": "Nenhum serviço selecionado retornou um resultado utilizável. Inspecione cada entrada de validation_errors antes de tentar novamente; um HTTP 502 por si só não indica uma falha transitória. Uma entrada empty_provider_response com retryable: true indica resultados indisponíveis ou sem explicação, incluindo uma recusa do provedor principal seguida de um fallback indisponível. Já as entradas legadas provider_invalid_input e provider_validation_error exigem a correção da entrada e podem omitir retryable. Nada é cobrado. Quando save_api_request=true, a tentativa com falha é registrada como uma sessão com status Not Finished. Falhas parciais retornam 200 com 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 se tentar novamente mais tarde pode resolver esta falha do serviço. False significa que é preciso corrigir primeiro a entrada fornecida." } } } } } }, "examples": { "Provider returned no result": { "summary": "Todos os serviços selecionados falharam", "value": { "error": "Database validation could not be performed. The external validation service did not return a result. Please try again later.", "validation_errors": [ { "service_id": "bra_cpf", "code": "empty_provider_response", "message": "The provider did not return a database validation result.", "retryable": true } ] } } } } } } } } }, "/v3/phone/send/": { "post": { "summary": "Enviar código por telefone", "description": "Envie um código de uso único (OTP) para um número de telefone por WhatsApp, SMS ou outro canal compatível e depois verifique-o com [`POST /v3/phone/check/`](/pt-br/standalone-apis/phone-check).\n\n**Como o envio e a verificação se relacionam.** O estado da verificação é identificado pela sua aplicação e pelo `phone_number` no formato E.164. A chamada de verificação não recebe `request_id`. Cada novo envio cria uma verificação pendente com validade de **5 minutos**: chame a verificação com o mesmo número e o código que o usuário recebeu antes do fim desse prazo. Se você chamar o envio de novo para o mesmo número enquanto houver uma verificação pendente, um código será reenviado para essa mesma verificação (`status: \"Retry\"`, mesmo `request_id`). No máximo uma nova tentativa é vinculada dessa forma (dois envios no total). Um envio adicional inicia uma nova verificação com um novo `request_id`. O prazo de 5 minutos é contado a partir do primeiro envio e não é estendido pelas novas tentativas.\n\n**Canais de entrega.** `options.preferred_channel` define o canal (`whatsapp` por padrão; `sms`, `telegram`, `voice`, `rcs`, `viber` e `zalo` também são compatíveis). Quando o canal preferido não está disponível para o país ou número de destino, a entrega passa automaticamente para SMS. O envio continua retornando `Success`, e o canal efetivamente usado é informado na resposta da verificação (`phone.verification_method` e os eventos de `lifecycle`).\n\n**Identidade da marca.** Os códigos por SMS levam o nome de remetente de SMS da sua aplicação, configurado no Business Console, sem custo adicional. Envie `options.sms_sender_name` para assinar um código com outro nome, ou `options.use_white_label_customization: true` para usar o nome público da sua marca própria quando nenhum nome de remetente estiver configurado. Os códigos por WhatsApp usam uma mensagem fixa. Conecte seu próprio número do WhatsApp Business no Business Console para enviá-los com o nome e o número da sua empresa, cobrados apenas pela tarifa da Didit.\n\n**Status de envio.** `Success`: OTP enviado para uma nova verificação; `Retry`: OTP reenviado para a verificação pendente; `Blocked`: a camada antifraude recusou o envio (consulte `reason`, por exemplo `repeated_attempts`, `suspicious`, `spam`). Um envio `Blocked` finaliza imediatamente a verificação como `Declined` com um aviso de alto risco, então uma verificação posterior retorna `Expired or Not Found`.\n\n**Faturamento.** O preço depende do país de destino e do canal que efetivamente entrega a mensagem. Consulte [Preços da Verificação de telefone](/pt-br/getting-started/phone-verification-pricing). Apenas os envios `Blocked` são garantidamente gratuitos: qualquer outra tentativa de envio não faturada é cobrada na finalização ou na expiração da verificação, mesmo que a entrega nunca tenha sido confirmada ou que o provedor de entrega tenha informado que a mensagem não pôde ser entregue. As verificações de código são sempre gratuitas. Como medida antiabuso, a verificação de telefone fica desativada até a primeira recarga da sua organização (`403`).\n\n**Persistência da sessão.** Toda nova verificação é persistida como uma sessão do tipo API: `request_id` é um ID de sessão real que você pode passar para `GET /v3/session/{sessionId}/decision/`, a verificação aparece no Business Console e webhooks `status.updated` são disparados conforme ela avança.\n\n**Sandbox.** As chaves de API de sandbox ignoram a entrega e o faturamento: após a validação da requisição (entradas malformadas continuam retornando `400`), o endpoint retorna um payload estático `Success` com um `request_id` aleatório. Nenhuma mensagem é enviada e nada é persistido. Use o código `123456` na verificação em sandbox.\n\n**Autenticação.** Envie a chave de API da sua aplicação no cabeçalho `x-api-key`. Credenciais ausentes ou inválidas retornam `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`). Esta API nunca retorna `401`.\n\n**Limites de requisições.** Cota de escrita compartilhada de 300 requisições/min por chave de API entre todos os endpoints POST/PATCH/DELETE, além de um limite antiabuso de 4 tentativas de envio por número de telefone por hora. Exceder qualquer um deles 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 telefone do destinatário no formato E.164, com `+` inicial e código do país (por exemplo, `+14155552671`). Os números são validados e normalizados para E.164; números que não podem ser interpretados ou inválidos retornam `400` com um erro no campo `phone_number`.", "example": "+14155552671" }, "options": { "type": "object", "description": "Opções de entrega do OTP. Todos os campos são opcionais.", "properties": { "code_size": { "type": "integer", "minimum": 4, "maximum": 8, "default": 6, "description": "Número de dígitos do OTP." }, "locale": { "type": "string", "maxLength": 5, "pattern": "^[a-z]{2,3}(-[A-Z]{2,3})?$", "description": "Locale BCP-47 usado para localizar a mensagem de verificação (por exemplo, `en-US`, `fr`, `es`). Formatos inválidos retornam `400`.", "example": "en-US" }, "preferred_channel": { "type": "string", "enum": [ "whatsapp", "sms", "telegram", "voice", "rcs", "viber", "zalo" ], "default": "whatsapp", "description": "Canal de entrega preferencial. Se o canal não estiver disponível para o país ou número de destino, a mensagem recorre automaticamente ao SMS, e o envio ainda informa `Success`." }, "use_white_label_customization": { "type": "boolean", "default": false, "description": "Quando `true`, o envio usa marca própria: se a sua aplicação não tiver um nome de remetente de SMS, o SMS cita o nome público da sua marca própria (\"123456 é o seu código de verificação do Acme Bank\"). O seu nome de remetente de SMS, quando definido, é usado com ou sem esta flag. Aplica-se a mensagens SMS, incluindo um fallback por SMS a partir de outro canal; os códigos por WhatsApp são enviados com uma mensagem fixa e não levam a sua marca. O padrão é `false`." }, "sms_sender_name": { "type": "string", "nullable": true, "maxLength": 30, "example": "Acme Bank", "description": "O nome que o SMS deste código exibe (\"123456 is your verification code for Acme Bank\"), em vez do nome de remetente de SMS da sua aplicação. Gratuito. De 1 a 30 caracteres: apenas letras, dígitos, espaços e ' & - !, não somente dígitos, com espaços simples entre as palavras; qualquer outro valor retorna `400` e nenhum código é enviado. Se omitido, `null` ou em branco, é usado o nome de remetente de SMS da sua aplicação. Cada aplicação pode começar a usar até dois nomes novos por dia (UTC); acima disso, o código é enviado com o nome da sua aplicação. Aplica-se a mensagens SMS, incluindo um fallback por SMS a partir de outro canal; os códigos por WhatsApp não levam marca.", "pattern": "^$|^(?![\\d ]+$)[\\p{L}\\p{N}'&!-]+( [\\p{L}\\p{N}'&!-]+)*$" } } }, "signals": { "type": "object", "description": "Sinais opcionais de dispositivo e rede sobre o usuário final, encaminhados à camada antifraude para melhorar a detecção de tráfego abusivo ou automatizado. Todos os campos são opcionais.", "properties": { "ip": { "type": "string", "description": "Endereço IP do dispositivo do usuário final. IPv4 ou IPv6.", "example": "192.0.2.1" }, "device_id": { "type": "string", "maxLength": 255, "description": "Identificador único do dispositivo do usuário final. Android: `ANDROID_ID`; iOS: `identifierForVendor`.", "example": "8F0B8FDD-C2CB-4387-B20A-56E9B2E5A0D2" }, "device_platform": { "type": "string", "enum": [ "android", "ios", "ipados", "tvos", "web" ], "description": "Plataforma do dispositivo do usuário final." }, "device_model": { "type": "string", "maxLength": 255, "description": "Modelo do dispositivo do usuário final.", "example": "iPhone17,2" }, "os_version": { "type": "string", "maxLength": 64, "description": "Versão do sistema operacional do dispositivo do usuário final.", "example": "18.0.1" }, "app_version": { "type": "string", "maxLength": 64, "description": "Versão da sua aplicação.", "example": "1.2.34" }, "user_agent": { "type": "string", "maxLength": 512, "description": "User agent do navegador ou app do usuário final.", "example": "Mozilla/5.0 (iPhone; CPU iPhone OS 14_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Mobile/15E148 Safari/604.1" } } }, "vendor_data": { "type": "string", "description": "Identificador opcional controlado por quem faz a chamada (seu id interno de usuário, um e-mail, um UUID etc.), persistido na sessão e devolvido na resposta do envio, na resposta da verificação correspondente, nos webhooks e no Business Console. Use-o para correlacionar o `request_id` da Didit com o registro do seu usuário." }, "metadata": { "type": "object", "nullable": true, "description": "Objeto JSON livre e opcional, persistido na sessão e devolvido na resposta de envio, na resposta da verificação correspondente, nos webhooks e no Business Console." } }, "required": [ "phone_number" ] }, "examples": { "WhatsApp (default)": { "summary": "OTP de 6 dígitos via WhatsApp, com fallback automático para SMS", "value": { "phone_number": "+14155552671", "options": { "preferred_channel": "whatsapp", "locale": "en-US" }, "vendor_data": "user-1234" } }, "SMS with custom code length": { "summary": "Forçar a entrega por SMS com um código de 4 dígitos", "value": { "phone_number": "+34699999999", "options": { "preferred_channel": "sms", "code_size": 4, "locale": "es" } } }, "With fraud signals": { "summary": "Encaminhe sinais do dispositivo para reforçar a triagem antifraude", "value": { "phone_number": "+14155552671", "signals": { "ip": "192.0.2.1", "device_id": "8F0B8FDD-C2CB-4387-B20A-56E9B2E5A0D2", "device_platform": "ios", "device_model": "iPhone17,2", "os_version": "18.0.1", "app_version": "1.2.34" }, "vendor_data": "user-1234" } } } } } }, "responses": { "200": { "description": "Envio confirmado. Verifique `status`: `Success` e `Retry` significam que um código está a caminho; `Blocked` significa que a camada antifraude recusou o envio e a verificação já foi finalizada como `Declined`. `request_id` é o id da sessão persistida (o mesmo id em um `Retry`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneVerificationSendResponse" }, "examples": { "Success": { "summary": "OTP enviado para uma nova verificação", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Success", "reason": null, "vendor_data": "user-1234", "metadata": null } }, "Retry": { "summary": "Segundo envio para o mesmo número dentro da janela de 5 minutos — mesmo request_id", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Retry", "reason": null, "vendor_data": "user-1234", "metadata": null } }, "Blocked": { "summary": "Recusa antifraude: verificação finalizada como recusada, nada é cobrado", "value": { "request_id": "0d8af1f4-0c43-46d7-b75c-6e4e22c0a7b3", "status": "Blocked", "reason": "repeated_attempts", "vendor_data": "user-1234", "metadata": null } } } } } }, "400": { "description": "Erro de validação. Uma entrada malformada retorna o envelope de erros de campo do DRF (um array de mensagens por campo com problema, aninhado em `options` para erros de opção). Um número que é interpretado corretamente, mas é rejeitado no momento do envio (inalcançável ou com um tipo de linha não elegível, como um código curto), retorna em vez disso um envelope `{\"detail\": ...}`.", "content": { "application/json": { "examples": { "Invalid phone number (field error)": { "summary": "O número não é um E.164 válido", "value": { "phone_number": [ "Invalid phone number provided." ] } }, "Missing phone number": { "summary": "`phone_number` não foi incluído no corpo", "value": { "phone_number": [ "This field is required." ] } }, "Invalid options": { "summary": "`code_size` fora do intervalo, `locale` malformado, `preferred_channel` desconhecido", "value": { "options": { "code_size": [ "Ensure this value is less than or equal to 8." ], "locale": [ "Ensure this field has no more than 5 characters." ], "preferred_channel": [ "\"carrier_pigeon\" is not a valid choice." ] } } }, "Number rejected at send time": { "summary": "Formato E.164 válido, mas o número não pode receber um OTP", "value": { "detail": "Invalid phone number provided." } }, "Ineligible line type": { "summary": "O tipo de linha não pode receber um OTP (por exemplo, código curto)", "value": { "detail": "Invalid phone line type provided." } } } } } }, "403": { "description": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente (`{\"detail\": ...}`); uma chave incorreta, revogada ou expirada retorna `401`. Também é retornado antes de qualquer envio quando a organização nunca fez uma recarga (barreira antiabuso) ou quando o saldo dela não cobre o preço de envio para o destino (`{\"error\": ...}`).", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } }, "Top-up required": { "summary": "A verificação de telefone permanece desativada até a primeira recarga da organização", "value": { "detail": "To protect against abuse, phone verification is disabled until your first top-up." } }, "Not enough credits": { "summary": "O saldo da organização não cobre o preço do envio", "value": { "error": "You don't have enough credits to perform this request." } } } } } }, "429": { "description": "Limite de requisições excedido. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API. Além disso, um teto antiabuso de 4 tentativas de verificação por número de telefone por hora é aplicado na origem. A resposta inclui os cabeçalhos `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`. Observação: os cabeçalhos `X-RateLimit-*`/`Retry-After` acompanham apenas o 429 do limite de escrita de 300/min; o 429 do teto por número não inclui cabeçalhos de limite de requisições.", "content": { "application/json": { "examples": { "Per-number cap": { "summary": "Mais de 4 tentativas de verificação para o mesmo número na ú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": "Mais de 300 requisições de escrita no minuto atual", "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": "O provedor de verificação de telefone está temporariamente indisponível - uma resposta 5xx, timeout ou falha de conexão que persistiu após as novas tentativas automáticas. É seguro tentar novamente; nada é cobrado e nenhuma tentativa é consumida.", "content": { "application/json": { "examples": { "Provider outage": { "summary": "O provedor não respondeu à requisição de envio", "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": "Falha inesperada ao criar a verificação que não corresponde a uma indisponibilidade conhecida do provedor. É seguro tentar novamente.", "content": { "application/json": { "examples": { "Provider error": { "summary": "Não foi possível iniciar a entrega do OTP", "value": { "detail": "Error creating phone verification" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/phone/check/": { "post": { "summary": "Verificar código de telefone", "description": "Verifique o OTP enviado por [`POST /v3/phone/send/`](/pt-br/standalone-apis/phone-send) e obtenha o resultado final da verificação junto com a inteligência do telefone: nome da operadora e tipo de linha, indicadores de número virtual (VoIP) e descartável, e uso duplicado do número entre as suas sessões.\n\n**Como a checagem encontra a verificação.** A correspondência é feita pela sua aplicação mais o `phone_number` em formato E.164; o `request_id` não é uma entrada. A verificação pendente mais recente criada nos últimos **5 minutos** é a que é checada. Se não houver nenhuma (nunca enviada, já finalizada ou com mais de 5 minutos), o endpoint retorna `200` com `status: \"Expired or Not Found\"`.\n\n**Limite de tentativas.** Cada verificação permite **3 tentativas de código**. Os dois primeiros códigos errados retornam `status: \"Failed\"` com as tentativas restantes e `phone: null`; o terceiro código errado finaliza a verificação como `Declined` com um aviso `VERIFICATION_CODE_ATTEMPTS_EXCEEDED` e retorna o relatório completo do telefone.\n\n**Resultados.** `Approved`: código correto e nenhum risco que leve à recusa. `Declined`: definitivo; o código estava correto, mas houve correspondência com um risco que leva à recusa (uma ação `DECLINE` abaixo, um número na lista de bloqueio ou de alto risco), ou as tentativas se esgotaram. `Failed`: código errado, ainda com tentativas restantes. `Expired or Not Found`: nada a checar. Em `Approved`/`Declined`, o `request_id` é igual ao `request_id` do envio (o id da sessão) e `phone` traz o relatório completo (`carrier`, `is_virtual`, `is_disposable`, `warnings`, `lifecycle`, `matches`); em `Failed` e `Expired or Not Found`, o `request_id` é um UUID aleatório avulso.\n\n**Ações de risco.** `duplicated_phone_number_action`, `disposable_number_action` e `voip_number_action` definem o que acontece quando o risco correspondente é detectado com um código correto: `DECLINE` muda o status final para `Declined`; `NO_ACTION` (padrão) registra o risco em `phone.warnings` sem afetar o status.\n\n**Faturamento.** As checagens são gratuitas; a entrega é cobrada no envio (consulte [Preços da Verificação de telefone](/pt-br/getting-started/phone-verification-pricing)).\n\n**Persistência da sessão.** Uma checagem finalizada atualiza a sessão criada pelo envio (visível no Business Console e consultável via `GET /v3/session/{sessionId}/decision/`) e dispara um webhook `status.updated`.\n\n**Sandbox.** As chaves de API de sandbox ignoram todo o processamento: qualquer código bem formado (de 4 a 8 dígitos, incluindo `123456`) retorna um payload estático `Approved` com um objeto `phone` simplificado e plano (`status`, `phone_number`, `country_code`, `carrier_name`, `line_type`, `flags`); entradas malformadas continuam retornando `400`. Nada é persistido.\n\n**Autenticação.** Envie a chave de API da sua aplicação no cabeçalho `x-api-key`. Credenciais ausentes ou inválidas retornam `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); esta API nunca retorna `401`.\n\n**Limites de requisições.** Cota de escrita compartilhada de 300 requisições/min por chave de API, mais o limite antiabuso do provedor upstream de 4 tentativas por número por hora; exceder qualquer um deles retorna `429`.\n\n**Presença em redes sociais.** Defina `enable_social` como `true` para adicionar um bloco `phone_social`: as plataformas online em que este número está cadastrado, com contagens por categoria e os detalhes de perfil disponíveis. `profiles_registered: 0` significa que as plataformas foram checadas e o número não foi encontrado em nenhuma delas, uma resposta válida e cobrável. O bloco fica ausente quando o complemento não foi solicitado ou quando a checagem não pôde ser concluída, e nesse caso não é cobrado. O faturamento adiciona uma unidade `phone_social` por requisição, além do preço deste 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": "O mesmo número de telefone usado na chamada correspondente a [`POST /v3/phone/send/`](/pt-br/standalone-apis/phone-send), no formato E.164. É isso que vincula a verificação ao envio.", "example": "+14155552671" }, "code": { "type": "string", "minLength": 4, "maxLength": 8, "pattern": "^[0-9]{4,8}$", "description": "O OTP que o usuário final recebeu. Deve ter de 4 a 8 dígitos numéricos — qualquer outro valor retorna `400` sem consumir uma tentativa. Um código bem formado, mas incorreto, retorna `200` com `status: \"Failed\"` e consome uma das 3 tentativas.", "example": "123456" }, "duplicated_phone_number_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "O que fazer quando o mesmo número já foi usado por outro usuário (`vendor_data` diferente) da sua aplicação. `DECLINE` altera o `status` final para `Declined`; `NO_ACTION` registra o risco em `phone.warnings` e preenche `phone.matches`." }, "disposable_number_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "O que fazer quando a consulta à operadora sinaliza o número como linha temporária/descartável (`phone.is_disposable`). `DECLINE` muda o `status` final para `Declined`; `NO_ACTION` registra o risco em `phone.warnings`." }, "voip_number_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "O que fazer quando a consulta à operadora informa um tipo de linha virtual — `voip`, `isp` ou `vpn` (`phone.is_virtual`). `DECLINE` muda o `status` final para `Declined`; `NO_ACTION` registra o risco em `phone.warnings`." }, "enable_enrichment": { "type": "boolean", "default": false, "description": "Quando `true`, também executa a inteligência de telefone no número: uma pontuação de risco, o tipo de linha, se o número foi portado recentemente e um índice de confiança. Cobrado como uma unidade `phone_intelligence_api` por requisição ($0.05 pelo preço de tabela), além do preço próprio deste endpoint. A requisição retorna `403` quando o seu saldo não é suficiente para cobri-la.", "example": false }, "phone_intelligence_score_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Ação quando a pontuação de risco da inteligência de telefone está acima do limiar. `DECLINE` muda o `status` final para `Declined`; `NO_ACTION` registra o sinal sem recusar. Só tem efeito quando `enable_enrichment` é `true`." }, "phone_type_risk_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Ação quando o número é de um tipo de linha de alto risco. `DECLINE` muda o `status` final para `Declined`; `NO_ACTION` registra o sinal sem recusar. Só tem efeito quando `enable_enrichment` é `true`." }, "recent_port_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Ação quando o número foi portado para outra operadora recentemente. `DECLINE` muda o `status` final para `Declined`; `NO_ACTION` registra o sinal sem recusar. Só tem efeito quando `enable_enrichment` é `true`." }, "low_phone_trust_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Ação quando o índice de confiança da inteligência de telefone está igual ou abaixo do limiar. `DECLINE` muda o `status` final para `Declined`; `NO_ACTION` registra o sinal sem recusar. Só tem efeito quando `enable_enrichment` é `true`." }, "enable_social": { "type": "boolean", "default": false, "description": "Quando verdadeiro, também consulta a presença digital do número: as plataformas de mensagens, redes sociais, e-commerce e profissionais em que ele está cadastrado. Cobrado como uma unidade `phone_social` por requisição, além do preço deste endpoint.", "example": true }, "phone_no_social_presence_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Ação quando a verificação de pegada social não encontra o número registrado em nenhuma das plataformas que ela cobre. Somente NO_ACTION e DECLINE são aceitos neste endpoint; REVIEW está disponível na chave de configuração do fluxo de mesmo nome." } }, "required": [ "phone_number", "code" ] }, "examples": { "Default": { "summary": "Registrar todos os riscos, mas nunca recusar automaticamente", "value": { "phone_number": "+14155552671", "code": "123456" } }, "Strict risk policy": { "summary": "Recusar automaticamente linhas VoIP e descartáveis", "value": { "phone_number": "+14155552671", "code": "123456", "voip_number_action": "DECLINE", "disposable_number_action": "DECLINE" } } } } } }, "responses": { "200": { "description": "Verificação concluída — códigos incorretos e verificações inexistentes também retornam `200`; confira `status`, não o código HTTP. `phone` é preenchido apenas em resultados finalizados (`Approved`/`Declined`), é `null` em `Failed` e fica ausente em `Expired or Not Found`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneVerificationCheckResponse" }, "examples": { "Approved": { "summary": "Código correto: relatório de telefone completo com operadora, ciclo de vida e correspondências", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Approved", "message": "The verification code is correct.", "phone": { "status": "Approved", "phone_number_prefix": "+1", "phone_number": "4155552671", "full_number": "+14155552671", "country_code": "US", "country_name": "United States", "carrier": { "name": "AT&T", "type": "mobile" }, "is_disposable": false, "is_virtual": false, "verification_method": "whatsapp", "verification_attempts": 1, "verified_at": "2026-06-12T01:24:47.311323Z", "warnings": [], "lifecycle": [ { "type": "PHONE_VERIFICATION_MESSAGE_SENT", "timestamp": "2026-06-12T01:23:39.580554+00:00", "details": { "status": "Success", "reason": null, "channel": "whatsapp", "actual_channel": "whatsapp" }, "fee": 0.0509 }, { "type": "PHONE_DELIVERY_DELIVERED", "timestamp": "2026-06-12T01:23:43.118220+00:00", "details": { "channel": "whatsapp", "status": "delivered" }, "fee": 0 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:47.311201+00:00", "details": { "code_tried": "123456", "status": "Approved" }, "fee": 0 }, { "type": "PHONE_VERIFICATION_APPROVED", "timestamp": "2026-06-12T01:24:47.384292+00:00", "details": null, "fee": 0 } ], "matches": [] }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:47.401719+00:00" } }, "Failed (attempts remaining)": { "summary": "Código incorreto: o usuário pode tentar novamente; aqui o request_id é um UUID de uso único", "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": "Terceiro código incorreto: verificação finalizada como Recusada", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Declined", "message": "The verification code is incorrect. Maximum attempts reached.", "phone": { "status": "Declined", "phone_number_prefix": "+1", "phone_number": "4155552671", "full_number": "+14155552671", "country_code": "US", "country_name": "United States", "carrier": { "name": "AT&T", "type": "mobile" }, "is_disposable": false, "is_virtual": false, "verification_method": "whatsapp", "verification_attempts": 1, "verified_at": null, "warnings": [ { "feature": "PHONE", "risk": "VERIFICATION_CODE_ATTEMPTS_EXCEEDED", "additional_data": null, "log_type": "error", "short_description": "Verification code attempts exceeded", "long_description": "The system detected that the phone number has exceeded the maximum number of verification code attempts." } ], "lifecycle": [ { "type": "PHONE_VERIFICATION_MESSAGE_SENT", "timestamp": "2026-06-12T01:23:39.580554+00:00", "details": { "status": "Success", "reason": null, "channel": "whatsapp", "actual_channel": "whatsapp" }, "fee": 0.0509 }, { "type": "INVALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:01.118220+00:00", "details": { "code_tried": "111111", "status": "Failed" }, "fee": 0 }, { "type": "INVALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:21.512340+00:00", "details": { "code_tried": "222222", "status": "Failed" }, "fee": 0 }, { "type": "INVALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:47.311201+00:00", "details": { "code_tried": "333333", "status": "Failed" }, "fee": 0 }, { "type": "PHONE_VERIFICATION_DECLINED", "timestamp": "2026-06-12T01:24:47.384292+00:00", "details": { "reason": "VERIFICATION_CODE_ATTEMPTS_EXCEEDED" }, "fee": 0 } ], "matches": [] }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:47.401719+00:00" } }, "Declined (risk policy)": { "summary": "Código correto, mas a linha é VoIP e 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": "Nenhuma verificação pendente para este número nos últimos 5 minutos", "value": { "request_id": "69cc35c6-280a-47a6-ab8c-4f32abc02ed0", "status": "Expired or Not Found", "message": "No pending phone verification found in the last 5 minutes.", "vendor_data": null, "metadata": null, "created_at": "2026-06-12T01:24:47.311323+00:00" } } } } } }, "400": { "description": "Erro de validação: envelope de erros de campo do DRF, com um array de mensagens por campo com problema.", "content": { "application/json": { "examples": { "Invalid code format": { "summary": "`code` não tem de 4 a 8 dígitos numéricos", "value": { "code": [ "Invalid code format. Enter 4 to 8 numeric digits." ] } }, "Invalid phone number": { "summary": "`phone_number` não está em um formato E.164 válido", "value": { "phone_number": [ "Invalid phone number provided." ] } }, "Invalid action": { "summary": "Ações de risco aceitam apenas NO_ACTION ou DECLINE", "value": { "voip_number_action": [ "\"REVIEW\" is not a valid choice." ] } } } } } }, "403": { "description": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente; uma chave incorreta, revogada ou expirada retorna `401`. As verificações são gratuitas, portanto não há checagem de créditos aqui.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições excedido. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API. Além disso, um teto antiabuso de 4 tentativas de verificação por número de telefone por hora é aplicado na origem. A resposta inclui os cabeçalhos `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`. Observação: os cabeçalhos `X-RateLimit-*`/`Retry-After` acompanham apenas o 429 do limite de escrita de 300/min; o 429 do teto por número não inclui cabeçalhos de limite de requisições.", "content": { "application/json": { "examples": { "Per-number cap": { "summary": "Mais de 4 tentativas de verificação para o mesmo número na ú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": "Mais de 300 requisições de escrita no minuto atual", "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": "O provedor de verificação de telefone está temporariamente indisponível - uma resposta 5xx, timeout ou falha de conexão que persistiu após as novas tentativas automáticas. É seguro tentar novamente; o limite de tentativas não é consumido.", "content": { "application/json": { "examples": { "Provider outage": { "summary": "O provedor não respondeu à requisição de verificação", "value": { "detail": "Phone verification is temporarily unavailable. Please try again shortly.", "code": "phone_provider_unavailable" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string" } } } } } }, "500": { "description": "Falha inesperada ao verificar o código no provedor que não corresponde a uma indisponibilidade conhecida do provedor. É seguro tentar novamente; o limite de tentativas só é consumido por verificações concluídas.", "content": { "application/json": { "examples": { "Provider error": { "summary": "Não foi possível concluir a verificação do código", "value": { "detail": "Error checking phone verification" } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/bank/account-check/": { "post": { "summary": "Verificar uma conta bancária", "description": "**Ainda não disponível em produção.** A Verificação bancária está desativada em produção; por isso, até que seja ativada, este endpoint responde `404` com `bank_verification_not_available`. Não construa nada sobre ele ainda. O restante desta descrição explica o que o endpoint faz quando estiver disponível.\n\nConfirme que uma conta bancária pertence à pessoa ou à empresa que você indica antes de enviar dinheiro para ela. Sem sessão e sem login: envie o nome e a conta e leia o resultado. É a [verificação de conta](/pt-br/core-technology/bank-verification/account-check) da etapa de Verificação bancária, executada a partir do seu backend.\n\n**O que você envia.** O `country` da conta (ISO 3166-1 alpha-3), o `account` no formato usado nesse país e o nome do `holder`: `full_name` para uma pessoa ou `business_name` para uma empresa. Um nome de empresa verifica uma conta empresarial.\n\n**O que você recebe.** `result` é `match`, `close_match`, `no_match` ou `cannot_verify`. Em um `close_match`, `holder_name` é o nome sob o qual o banco mantém a conta, quando o banco o retorna. `account` volta mascarado, exceto pelos últimos 4 caracteres.\n\n**Faturamento.** Cada verificação respondida pelo banco é cobrada uma vez pelo preço de verificação de conta do país da conta, qualquer que seja o resultado: um `no_match`, uma conta inexistente e um `cannot_verify` também são cobrados. Uma requisição respondida com erro nunca é cobrada.\n\n**Cada requisição é uma nova verificação.** Não há chave de idempotência nem endpoint para consultar uma verificação depois; portanto, uma requisição repetida é executada, e cobrada, novamente. Armazene a resposta.\n\n**Sandbox.** Onde a Verificação bancária estiver disponível, uma chave de sandbox não chama nenhum banco e não gera cobrança. Os últimos 4 caracteres do IBAN, ou, na falta dele, do número da conta, definem a resposta: `0001` gera um `close_match` com `holder_name`, `0002` um `close_match` sem ele, `0003` e `0006` um `no_match`, `0004` `cannot_verify`, `0005` um `503` e `0009` um `400`. Qualquer outro final gera um `match`.\n\n**Chaves de API.** Uma chave de API com escopo precisa de acesso de escrita a sessões.", "operationId": "post_v3_bank_account_check", "tags": [ "Standalone APIs" ], "x-didit-sdk": { "resource": "bank", "method": "account_check", "auth": "api_key", "server": true }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckRequest" }, "examples": { "Person, United Kingdom": { "summary": "Um sort code e um número de conta, verificados em relação ao nome de uma pessoa", "value": { "country": "GBR", "account": { "sort_code": "20-45-67", "account_number": "31926819" }, "holder": { "full_name": "Maria Oliveira" }, "vendor_data": "payout_20481" } }, "Company, IBAN": { "summary": "Um IBAN, verificado em relação ao nome de uma empresa", "value": { "country": "DEU", "account": { "iban": "DE89 3704 0044 0532 0130 00" }, "holder": { "business_name": "Northwind Trading GmbH" } } } } } } }, "responses": { "200": { "description": "O banco respondeu. A verificação é cobrada, seja qual for o resultado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckResponse" }, "examples": { "Close match": { "summary": "O banco mantém a conta em um nome semelhante", "value": { "request_id": "c2f4a9e0-7b1d-4c3a-9e55-1d0a6b8f2a47", "result": "close_match", "holder_name": "MARIA R OLIVEIRA", "account": "****6819", "vendor_data": "payout_20481", "created_at": "2026-10-21T14:32:08Z" } }, "Match": { "summary": "O banco mantém a conta no nome enviado", "value": { "request_id": "5b0e2d7c-41a8-4f6e-9c3b-8e7d1a2f6c90", "result": "match", "holder_name": null, "account": "****3000", "vendor_data": null, "created_at": "2026-10-21T14:35:41Z" } } } } } }, "400": { "description": "Recusado como enviado e não cobrado. `field` indica o campo do corpo a corrigir e `reason` informa o motivo, com os mesmos motivos exibidos no formulário de conta hospedado. Apenas o primeiro campo recusado é informado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Missing field": { "summary": "A verificação deste país exige um sort code", "value": { "detail": "The sort code is not valid (required).", "code": "invalid_account_input", "field": "account.sort_code", "reason": "required" } }, "Invalid IBAN": { "summary": "O IBAN tem o comprimento incorreto para o 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": "O banco recusou a conta como enviada", "value": { "detail": "The account was refused as typed (rejected).", "code": "invalid_account_input", "field": "account.account_number", "reason": "rejected" } }, "No name": { "summary": "`holder` não tem `full_name` nem `business_name`", "value": { "detail": "Send full_name for a person or business_name for a company.", "code": "invalid_account_input", "field": "holder", "reason": "required" } } } } } }, "401": { "description": "A chave de API com escopo expirou.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Expired key": { "summary": "A data de validade da chave já passou", "value": { "detail": "This API key has expired." } } } } } }, "402": { "description": "A verificação não pode ser paga, por isso não foi executada. Recarregue seu saldo e envie-a novamente.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Out of credit": { "summary": "Seu saldo não cobre uma verificação", "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": "Seu contrato não tem preço para a API Account check", "value": { "detail": "Your contract does not price the Account check API. Contact your account manager.", "code": "contract_rate_missing" } } } } } }, "403": { "description": "O cabeçalho `x-api-key` ou o bearer token está ausente ou é inválido, a requisição veio de um endereço fora da lista de IPs da chave, ou uma chave com escopo não tem acesso de escrita a sessões.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Missing or invalid credentials": { "summary": "Nenhuma chave de API ou token válido", "value": { "detail": "You do not have permission to perform this action." } }, "No sessions write": { "summary": "Uma chave com escopo sem acesso de escrita a sessões", "value": { "detail": "This API key has no write access to sessions." } } } } } }, "404": { "description": "Nenhuma verificação de conta atende esta conta ainda, então nada foi verificado nem cobrado. `country_not_covered`: nenhuma atende o país da conta, ou o tipo de conta (pessoa física ou empresa) nesse país. `bank_not_covered`: nenhuma atende o banco da conta. `bank_verification_not_available`: a Verificação bancária ainda não está habilitada em produção, e essa é a resposta para todas as requisições nesse ambiente até que ela seja ativada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Country not covered": { "summary": "Nenhuma verificação de conta atende o país", "value": { "detail": "No account check serves this country yet.", "code": "country_not_covered" } }, "Bank not covered": { "summary": "Nenhuma verificação de conta atende o banco da conta", "value": { "detail": "No account check serves this account's bank yet.", "code": "bank_not_covered" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" }, "503": { "description": "O banco não conseguiu responder. Nada foi verificado nem cobrado; envie a verificação novamente mais tarde.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountCheckError" }, "examples": { "Unavailable": { "summary": "O banco não respondeu", "value": { "detail": "The account check is temporarily unavailable and this request was not charged. Please try again.", "code": "account_check_unavailable" } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/bank/account-check/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"country\": \"GBR\",\n \"account\": {\"sort_code\": \"20-45-67\", \"account_number\": \"31926819\"},\n \"holder\": {\"full_name\": \"Maria Oliveira\"},\n \"vendor_data\": \"payout_20481\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.bank.account_check(\n country=\"GBR\",\n account={\n \"account_number\": \"31926819\",\n \"sort_code\": \"20-45-67\",\n },\n holder={\n \"full_name\": \"Maria Oliveira\",\n },\n vendor_data=\"payout_20481\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.bank.accountCheck({\n country: \"GBR\",\n account: {\n account_number: \"31926819\",\n sort_code: \"20-45-67\",\n },\n holder: {\n full_name: \"Maria Oliveira\",\n },\n vendor_data: \"payout_20481\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.AccountCheck(ctx, didit.BankAccountCheckRequest{\n\tCountry: \"GBR\",\n\tAccount: didit.BankAccountCheckRequestAccount{\n\t\tAccountNumber: didit.String(\"31926819\"),\n\t\tSortCode: didit.String(\"20-45-67\"),\n\t},\n\tHolder: didit.BankAccountCheckHolder{\n\t\tFullName: didit.String(\"Maria Oliveira\"),\n\t},\n\tVendorData: didit.String(\"payout_20481\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BankAccountCheckHolder;\nimport me.didit.types.BankAccountCheckPersonHolder;\nimport me.didit.types.BankAccountCheckRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.bank().accountCheck(BankAccountCheckRequest.builder()\n .country(\"GBR\")\n .account(BankAccountCheckRequest.Account.builder()\n .accountNumber(\"31926819\")\n .sortCode(\"20-45-67\")\n .build())\n .holder(BankAccountCheckHolder.ofBankAccountCheckPersonHolder(BankAccountCheckPersonHolder.builder()\n .fullName(\"Maria Oliveira\")\n .build()))\n .vendorData(\"payout_20481\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "bank->accountCheck([\n 'country' => 'GBR',\n 'account' => [\n 'account_number' => '31926819',\n 'sort_code' => '20-45-67',\n ],\n 'holder' => [\n 'full_name' => 'Maria Oliveira',\n ],\n 'vendor_data' => 'payout_20481',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.bank.account_check(\n country: \"GBR\",\n account: {\n account_number: \"31926819\",\n sort_code: \"20-45-67\",\n },\n holder: {\n full_name: \"Maria Oliveira\",\n },\n vendor_data: \"payout_20481\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Bank.AccountCheckAsync(new BankAccountCheckRequest\n{\n Country = \"GBR\",\n Account = new()\n {\n AccountNumber = \"31926819\",\n SortCode = \"20-45-67\",\n },\n Holder = new()\n {\n FullName = \"Maria Oliveira\",\n },\n VendorData = \"payout_20481\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/email/send/": { "post": { "summary": "Enviar código por e-mail", "description": "Envie uma senha de uso único (OTP) para um endereço de e-mail e depois verifique-a com [`POST /v3/email/check/`](/pt-br/standalone-apis/email-check).\n\n**Como o envio e a verificação se relacionam.** O estado da verificação é identificado pela sua aplicação mais o endereço `email`; a chamada de verificação não recebe `request_id`. Cada novo envio cria uma verificação pendente que dura **5 minutos**: chame a verificação com o mesmo endereço e o código que o usuário recebeu antes do fim desse prazo. Chamar o envio novamente para o mesmo endereço enquanto há uma verificação pendente gera um novo código para essa mesma verificação (`status: \"Retry\"`, mesmo `request_id`); o código anterior deixa de funcionar. No máximo uma nova tentativa é vinculada dessa forma (dois envios no total); um envio seguinte inicia uma nova verificação com um novo `request_id`. O prazo de 5 minutos é contado a partir do primeiro envio e não é estendido por novas tentativas.\n\n**Pré-verificação de entregabilidade.** Antes de qualquer envio, o endereço passa por validação de sintaxe e de DNS/MX. Endereços que não podem receber e-mails retornam `200` com `status: \"Undeliverable\"` e `reason: \"email_can_not_be_delivered\"`: nenhum e-mail é enviado, nada é cobrado e a verificação é finalizada imediatamente como `Declined` (uma verificação posterior retorna `Expired or Not Found`). Uma falha de envio downstream é informada da mesma forma.\n\n**Formato do código e identidade visual.** Os códigos têm de 4 a 8 caracteres (`options.code_size`, padrão 6) e são numéricos por padrão; defina `options.alphanumeric_code: true` para usar letras maiúsculas e dígitos (a comparação na verificação não diferencia maiúsculas de minúsculas). O modelo de e-mail é localizado via `options.locale` (54 idiomas compatíveis) e pode usar a identidade visual de marca própria da sua aplicação via `options.use_white_label_customization`.\n\n**Faturamento.** Um crédito da API de Verificação de e-mail por envio bem-sucedido (`status: \"Success\"`), cobrado no momento do envio. Envios `Retry` e `Undeliverable` são gratuitos, assim como as verificações.\n\n**Persistência da sessão.** Toda nova verificação é salva como uma sessão do tipo API: `request_id` é um ID de sessão real que você pode passar para `GET /v3/session/{sessionId}/decision/`, a verificação aparece no Business Console e webhooks `status.updated` são disparados conforme ela avança.\n\n**Sandbox.** Chaves de API de sandbox ignoram a entrega e o faturamento: após a validação da requisição (entradas malformadas ainda retornam `400`), o endpoint retorna um payload estático `Success` com um `request_id` aleatório; nenhum e-mail é enviado e nada é salvo. Use o código `123456` na verificação em sandbox.\n\n**Autenticação.** Envie a chave de API da sua aplicação no cabeçalho `x-api-key`. Credenciais ausentes ou inválidas retornam `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); esta API nunca retorna `401`.\n\n**Limite de requisições.** Cota de escrita compartilhada de 300 requisições/min por chave de API em todos os endpoints POST/PATCH/DELETE; ultrapassá-la 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": "Endereço de e-mail do destinatário. Endereços malformados retornam `400`; endereços sintaticamente válidos que não podem receber e-mails (falha na validação de DNS/MX) retornam `200` com `status: \"Undeliverable\"`.", "example": "alice@example.com" }, "options": { "type": "object", "description": "Opções de formato, localização e identidade visual do OTP. Todos os campos são opcionais.", "properties": { "code_size": { "type": "integer", "minimum": 4, "maximum": 8, "default": 6, "description": "Número de caracteres do OTP (dígitos por padrão; letras maiúsculas e dígitos quando `alphanumeric_code` é `true`)." }, "alphanumeric_code": { "type": "boolean", "default": false, "description": "Quando `true`, o OTP é composto por letras maiúsculas `A–Z` e dígitos `0–9`, em vez de apenas dígitos. A comparação em `/v3/email/check/` não diferencia maiúsculas de minúsculas." }, "locale": { "type": "string", "maxLength": 5, "enum": [ "en", "ar", "bn", "bg", "bs", "ca", "cs", "da", "de", "el", "es", "et", "fa", "fi", "fr", "he", "hi", "hr", "hu", "hy", "id", "it", "ja", "ka", "kk", "ko", "ky", "lt", "lv", "cnr", "mk", "mn", "ms", "nl", "no", "pl", "pt-BR", "pt", "ro", "ru", "sk", "sl", "so", "sq", "sr", "sv", "th", "tr", "uk", "uz", "vi", "zh-CN", "zh-TW", "zh" ], "description": "Idioma do modelo de e-mail do OTP. O padrão é `en`. Valores não suportados retornam `400` com a lista de todos os locales suportados.", "example": "en" }, "use_white_label_customization": { "type": "boolean", "default": false, "description": "Quando `true`, o e-mail de OTP usa a personalização de marca própria da sua aplicação (logotipo, cores, identidade do remetente) em vez do modelo padrão da Didit." } } }, "signals": { "type": "object", "description": "Sinais opcionais de dispositivo e rede sobre o usuário final, encaminhados à camada antifraude para melhorar a detecção de tráfego abusivo ou automatizado. Todos os campos são opcionais.", "properties": { "ip": { "type": "string", "description": "Endereço IP do dispositivo do usuário final. IPv4 ou IPv6.", "example": "192.0.2.1" }, "device_id": { "type": "string", "maxLength": 255, "description": "Identificador único do dispositivo do usuário final. Android: `ANDROID_ID`; iOS: `identifierForVendor`.", "example": "8F0B8FDD-C2CB-4387-B20A-56E9B2E5A0D2" }, "device_platform": { "type": "string", "enum": [ "android", "ios", "ipados", "tvos", "web" ], "description": "Plataforma do dispositivo do usuário final." }, "device_model": { "type": "string", "maxLength": 255, "description": "Modelo do dispositivo do usuário final.", "example": "iPhone17,2" }, "os_version": { "type": "string", "maxLength": 64, "description": "Versão do sistema operacional do dispositivo do usuário final.", "example": "18.0.1" }, "app_version": { "type": "string", "maxLength": 64, "description": "Versão da sua aplicação.", "example": "1.2.34" }, "user_agent": { "type": "string", "maxLength": 512, "description": "User agent do navegador ou app do usuário final.", "example": "Mozilla/5.0 (iPhone; CPU iPhone OS 14_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Mobile/15E148 Safari/604.1" } } }, "vendor_data": { "type": "string", "description": "Identificador opcional controlado por quem faz a chamada (seu id interno de usuário, um e-mail, um UUID etc.), persistido na sessão e devolvido na resposta do envio, na resposta da verificação correspondente, nos webhooks e no Business Console. Use-o para correlacionar o `request_id` da Didit com o registro do seu usuário." }, "metadata": { "type": "object", "nullable": true, "description": "Objeto JSON livre e opcional, persistido na sessão e devolvido na resposta de envio, na resposta da verificação correspondente, nos webhooks e no Business Console." } }, "required": [ "email" ] }, "examples": { "Numeric 6-digit code": { "summary": "Padrão: código numérico de 6 dígitos em inglês", "value": { "email": "alice@example.com", "options": { "locale": "en" }, "vendor_data": "user-1234" } }, "Alphanumeric 8-character code": { "summary": "Letras maiúsculas + dígitos, modelo espanhol", "value": { "email": "bob@example.com", "options": { "code_size": 8, "alphanumeric_code": true, "locale": "es" } } }, "White-label branding": { "summary": "Enviar o e-mail de OTP com a personalização de marca própria da sua aplicação", "value": { "email": "carol@example.com", "options": { "locale": "en", "use_white_label_customization": true }, "vendor_data": "user-5678" } } } } } }, "responses": { "200": { "description": "Envio confirmado. Verifique `status`: `Success` e `Retry` significam que um código está a caminho; `Undeliverable` significa que o endereço não pode receber e-mails e a verificação já foi finalizada como `Declined`. `request_id` é o id da sessão persistida (o mesmo id em um `Retry`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailVerificationSendResponse" }, "examples": { "Success": { "summary": "OTP enviado por e-mail para uma nova verificação (cobrado)", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Success", "reason": null, "vendor_data": "user-1234", "metadata": null } }, "Retry": { "summary": "Segundo envio dentro da janela de 5 minutos — novo código, mesmo request_id, gratuito", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Retry", "reason": null, "vendor_data": "user-1234", "metadata": null } }, "Undeliverable": { "summary": "O endereço falhou na validação de DNS/MX: verificação finalizada como Recusada, nada cobrado", "value": { "request_id": "cb1a5011-344d-444d-bdce-218904745d7f", "status": "Undeliverable", "reason": "email_can_not_be_delivered", "vendor_data": "user-1234", "metadata": null } } } } } }, "400": { "description": "Erro de validação: envelope de erros de campo do DRF, com um array de mensagens por campo com problema, aninhado em `options` para erros de opção.", "content": { "application/json": { "examples": { "Invalid email": { "summary": "Endereço de e-mail com formato inválido", "value": { "email": [ "Enter a valid email address." ] } }, "Unsupported locale": { "summary": "`options.locale` fora do conjunto suportado", "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 do intervalo 4–8", "value": { "options": { "code_size": [ "Ensure this value is less than or equal to 8." ] } } } } } } }, "403": { "description": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente (`{\"detail\": ...}`); uma chave incorreta, revogada ou expirada retorna `401`. Também é retornado antes de qualquer envio quando o saldo da organização não cobre um crédito da API de Verificação de e-mail (`{\"error\": ...}`).", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "O saldo da organização não cobre o preço do envio", "value": { "error": "You don't have enough credits to perform this request." } } } } } }, "429": { "description": "Limite de requisições excedido. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API. A resposta inclui os cabeçalhos `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Mais de 300 requisições de escrita no minuto atual", "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": "Não foi possível acessar o provedor de e-mail (uma indisponibilidade ou um tempo limite esgotado), então nenhum código foi enviado e nada foi cobrado nem contado como tentativa de envio. Repita a mesma requisição.", "content": { "application/json": { "examples": { "Email delivery unavailable": { "summary": "O provedor de e-mail falhou após uma nova tentativa automática", "value": { "detail": "Email delivery is temporarily unavailable. Please try again." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/email/check/": { "post": { "summary": "Verificar código de e-mail", "description": "Verifique o OTP entregue por [`POST /v3/email/send/`](/pt-br/standalone-apis/email-send) e obtenha o resultado final da verificação junto com a inteligência de e-mail: capacidade de entrega, exposição a vazamentos (`is_breached` e a lista `breaches`, de um banco de dados de inteligência sobre vazamentos), detecção de provedores descartáveis e uso duplicado do endereço entre as suas sessões.\n\n**Como a verificação é localizada.** A correspondência é feita pela sua aplicação mais o endereço `email`; `request_id` não é um dado de entrada. É verificada a verificação pendente mais recente criada nos últimos **5 minutos**. Se não houver nenhuma (nunca enviada, já finalizada, impossível de entregar no momento do envio ou com mais de 5 minutos), o endpoint retorna `200` com `status: \"Expired or Not Found\"`.\n\n**Limite de tentativas.** Cada verificação permite **3 tentativas de código**. Os dois primeiros códigos incorretos retornam `status: \"Failed\"` com as tentativas restantes e `email: null`; o terceiro código incorreto finaliza a verificação como `Declined` com um aviso `EMAIL_CODE_ATTEMPTS_EXCEEDED` e retorna o relatório de e-mail completo. Os códigos são comparados sem diferenciar maiúsculas de minúsculas (relevante para envios `alphanumeric_code`); apenas o código enviado mais recentemente é válido.\n\n**Resultados.** `Approved`: código correto e nenhum risco que leve à recusa. `Declined`: final; o código estava correto, mas houve correspondência com um risco que leva à recusa (uma ação `DECLINE` abaixo, um endereço na lista de bloqueio ou um endereço identificado como impossível de entregar na finalização), ou o limite de tentativas foi esgotado. `Failed`: código incorreto, com tentativas restantes. `Expired or Not Found`: não há nada a verificar. Em `Approved`/`Declined`, o `request_id` é igual ao `request_id` do envio (o ID da sessão) e `email` traz o relatório completo (`is_breached`, `breaches`, `is_disposable`, `is_undeliverable`, `warnings`, `lifecycle`, `matches`); em `Failed` e `Expired or Not Found`, o `request_id` é um UUID aleatório de uso único.\n\n**Ações de risco.** `duplicated_email_action`, `breached_email_action` e `disposable_email_action` definem o que acontece quando o risco correspondente é detectado com um código correto: `DECLINE` muda o status final para `Declined`; `NO_ACTION` (padrão) registra o risco em `email.warnings` sem afetar o status.\n\n**Faturamento.** As verificações de código são gratuitas: o crédito é consumido pelo envio bem-sucedido.\n\n**Persistência da sessão.** Uma verificação finalizada atualiza a sessão criada pelo envio (visível no Business Console e consultável via `GET /v3/session/{sessionId}/decision/`) e dispara um webhook `status.updated`.\n\n**Sandbox.** Chaves de API de sandbox ignoram todo o processamento: qualquer código bem formado (incluindo `123456`) retorna um payload estático `Approved` com um objeto `email` simplificado (`status`, `email`, `is_breached`, `is_disposable`, `is_undeliverable`); entradas malformadas continuam retornando `400`. Nada é persistido.\n\n**Autenticação.** Envie a chave de API da sua aplicação no cabeçalho `x-api-key`. Credenciais ausentes ou inválidas retornam `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); esta API nunca retorna `401`.\n\n**Limite de requisições.** Cota de escrita compartilhada de 300 requisições/min por chave de API entre todos os endpoints POST/PATCH/DELETE; ultrapassá-la retorna `429`.\n\n**Presença em redes sociais.** Defina `enable_social` como `true` para adicionar um bloco `email_social`: as plataformas online em que este endereço está cadastrado, com contagens por categoria e os detalhes de perfil disponíveis. `profiles_registered: 0` significa que as plataformas foram verificadas e o endereço não foi encontrado em nenhuma delas, uma resposta válida e cobrada. O bloco fica ausente quando o complemento não foi solicitado ou quando a verificação não pôde ser concluída, e nesse caso não é cobrado. O faturamento adiciona uma unidade `email_social` por requisição, além do preço deste 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": "O mesmo endereço de e-mail usado na chamada correspondente a [`POST /v3/email/send/`](/pt-br/standalone-apis/email-send). É isso que vincula a verificação ao envio.", "example": "alice@example.com" }, "code": { "type": "string", "maxLength": 10, "description": "O OTP que o usuário final recebeu: de 4 a 8 dígitos, ou de 4 a 8 letras/dígitos quando `alphanumeric_code: true` foi usado no envio. A comparação não diferencia maiúsculas de minúsculas.", "example": "123456" }, "duplicated_email_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "O que fazer quando o mesmo endereço já foi usado e aprovado por outro usuário (somente verificações aprovadas anteriormente são consideradas) (`vendor_data` diferente) da sua aplicação. `DECLINE` altera o `status` final para `Declined`; `NO_ACTION` registra o risco em `email.warnings` e preenche `email.matches`." }, "breached_email_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "O que fazer quando o endereço aparece em vazamentos de dados conhecidos (`email.is_breached`). `DECLINE` muda o `status` final para `Declined`; `NO_ACTION` registra o risco em `email.warnings`." }, "disposable_email_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "O que fazer quando o domínio pertence a um provedor de e-mail descartável/temporário (`email.is_disposable`). `DECLINE` altera o `status` final para `Declined`; `NO_ACTION` registra o risco em `email.warnings`." }, "enable_enrichment": { "type": "boolean", "default": false, "description": "Quando `true`, também executa a inteligência de e-mail no endereço: uma pontuação de risco e o histórico de vazamentos. Cobrado como uma unidade `email_intelligence_api` por requisição ($0.05 pelo preço de tabela), além do preço próprio deste endpoint. A requisição retorna `403` quando o seu saldo não é suficiente para cobri-la.", "example": false }, "email_intelligence_score_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Ação quando a pontuação de risco da inteligência de e-mail está acima do limiar. `DECLINE` muda o `status` final para `Declined`; `NO_ACTION` registra o sinal sem recusar. Só tem efeito quando `enable_enrichment` é `true`." }, "recent_email_breach_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Ação quando o endereço aparece em um vazamento de dados conhecido e recente. `DECLINE` muda o `status` final para `Declined`; `NO_ACTION` registra o sinal sem recusar. Só tem efeito quando `enable_enrichment` é `true`." }, "frequent_email_breach_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Ação quando o endereço aparece em muitos vazamentos de dados conhecidos. `DECLINE` muda o `status` final para `Declined`; `NO_ACTION` registra o sinal sem recusar. Só tem efeito quando `enable_enrichment` é `true`." }, "enable_social": { "type": "boolean", "default": false, "description": "Quando verdadeiro, também consulta a presença digital do endereço: as plataformas de e-mail, redes sociais, profissionais, e-commerce e entretenimento em que ele está cadastrado. Cobrado como uma unidade `email_social` por requisição, além do preço deste endpoint.", "example": true }, "email_no_social_presence_action": { "type": "string", "enum": [ "NO_ACTION", "DECLINE" ], "default": "NO_ACTION", "description": "Ação quando a verificação de pegada social não encontra o endereço registrado em nenhuma das plataformas que ela cobre. Somente NO_ACTION e DECLINE são aceitos neste endpoint; REVIEW está disponível na chave de configuração do fluxo de mesmo nome." } }, "required": [ "email", "code" ] }, "examples": { "Default": { "summary": "Registrar todos os riscos, mas nunca recusar automaticamente", "value": { "email": "alice@example.com", "code": "123456" } }, "Strict risk policy": { "summary": "Recusar automaticamente caixas de entrada descartáveis e vazadas", "value": { "email": "alice@example.com", "code": "123456", "disposable_email_action": "DECLINE", "breached_email_action": "DECLINE" } } } } } }, "responses": { "200": { "description": "Verificação concluída — códigos incorretos e verificações inexistentes também retornam `200`; confira `status`, não o código HTTP. `email` é preenchido apenas em resultados finalizados (`Approved`/`Declined`), é `null` em `Failed` e fica ausente em `Expired or Not Found`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailVerificationCheckResponse" }, "examples": { "Approved": { "summary": "Código correto: endereço limpo, relatório de e-mail completo", "value": { "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24", "status": "Approved", "message": "The verification code is correct.", "email": { "status": "Approved", "email": "alice@example.com", "is_breached": false, "breaches": [], "is_disposable": false, "is_undeliverable": false, "verification_attempts": 1, "verified_at": "2026-06-12T01:24:47.311323Z", "warnings": [], "lifecycle": [ { "type": "EMAIL_VERIFICATION_MESSAGE_SENT", "timestamp": "2026-06-12T01:23:39.580554+00:00", "details": { "status": "Success", "reason": null }, "fee": 0.02 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:47.311201+00:00", "details": { "code_tried": "123456", "status": "Approved" }, "fee": 0 }, { "type": "EMAIL_VERIFICATION_APPROVED", "timestamp": "2026-06-12T01:24:47.384292+00:00", "details": null, "fee": 0 } ], "matches": [] }, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:47.401719+00:00" } }, "Approved with breach exposure": { "summary": "Código correto; exposição em vazamento registrada como aviso (breached_email_action=NO_ACTION)", "value": { "request_id": "3a1f2b6c-9d4e-4f7a-8b2c-1e5d6f7a8b9c", "status": "Approved", "message": "The verification code is correct.", "email": { "status": "Approved", "email": "bob@example.com", "is_breached": true, "breaches": [ { "name": "ExampleApp", "domain": "exampleapp.com", "breach_date": "2019-03-21", "breach_emails_count": 763117, "description": "In March 2019, the social platform ExampleApp suffered a data breach that exposed email addresses and passwords.", "logo_path": "https:///logos/ExampleApp.png", "data_classes": [ "email_addresses", "passwords" ], "is_verified": true } ], "is_disposable": false, "is_undeliverable": false, "verification_attempts": 1, "verified_at": "2026-06-12T01:24:47.311323Z", "warnings": [ { "feature": "EMAIL", "risk": "BREACHED_EMAIL_DETECTED", "additional_data": null, "log_type": "information", "short_description": "Breached email detected", "long_description": "This email address was found in one or more known data breaches." } ], "lifecycle": [ { "type": "EMAIL_VERIFICATION_MESSAGE_SENT", "timestamp": "2026-06-12T01:23:39.580554+00:00", "details": { "status": "Success", "reason": null }, "fee": 0.02 }, { "type": "VALID_CODE_ENTERED", "timestamp": "2026-06-12T01:24:47.311201+00:00", "details": { "code_tried": "835126", "status": "Approved" }, "fee": 0 }, { "type": "EMAIL_VERIFICATION_APPROVED", "timestamp": "2026-06-12T01:24:47.384292+00:00", "details": null, "fee": 0 } ], "matches": [] }, "vendor_data": "user-5678", "metadata": null, "created_at": "2026-06-12T01:24:47.401719+00:00" } }, "Failed (attempts remaining)": { "summary": "Código incorreto: o usuário pode tentar novamente; aqui o request_id é um UUID de uso único", "value": { "request_id": "11111111-2222-3333-4444-555555555555", "status": "Failed", "message": "The verification code is incorrect. Attempts remaining: 2", "email": null, "vendor_data": "user-1234", "metadata": null, "created_at": "2026-06-12T01:24:21.512340+00:00" } }, "Declined (risk policy)": { "summary": "Código correto, mas o endereço é descartável e 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": "Nenhuma verificação pendente para este endereço nos últimos 5 minutos", "value": { "request_id": "88808a77-06e9-4cb0-85f5-9c052ddfd987", "status": "Expired or Not Found", "message": "No pending email verification found in the last 5 minutes.", "vendor_data": null, "metadata": null, "created_at": "2026-06-12T01:24:59.887904+00:00" } } } } } }, "400": { "description": "Erro de validação: envelope de erros de campo do DRF, com um array de mensagens por campo com problema.", "content": { "application/json": { "examples": { "Invalid email": { "summary": "Endereço de e-mail com formato inválido", "value": { "email": [ "Enter a valid email address." ] } }, "Missing code": { "summary": "`code` não incluído no corpo", "value": { "code": [ "This field is required." ] } } } } } }, "403": { "description": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente; uma chave incorreta, revogada ou expirada retorna `401`. As verificações são gratuitas, portanto não há checagem de créditos aqui.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições excedido. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API. A resposta inclui os cabeçalhos `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Mais de 300 requisições de escrita no minuto atual", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } }, "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/workflows/": { "get": { "summary": "Listar fluxos", "description": "Lista seus fluxos, dos mais recentes para os mais antigos, em um envelope de paginação limit/offset (`{count, next, previous, results}`, com tamanho de página padrão de 50). Cada linha é uma versão. `workflow_id` é o ID estável do grupo, e novas sessões usam a versão `published` mais recente.", "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": "Tamanho da página (número de fluxos por página)." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "Número de linhas a pular antes do primeiro fluxo retornado." } ], "responses": { "200": { "description": "Uma página de fluxos ordenada por `created_at` em ordem decrescente, envolvida no envelope de paginação. Cada item em `results` é um `WorkflowListItem`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número total de versões de fluxo da aplicação." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL da próxima página, ou `null` na última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL da página anterior, ou `null` na primeira página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowListItem" } } } }, "examples": { "Two workflows": { "summary": "Um fluxo de verificação (workflow) de KYC padrão e um rascunho de fluxo 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": "A chave de API está ausente, malformada, expirada ou pertence a outra aplicação. Corpo: `{\"detail\": \"You do not have permission to perform this action.\"}`. Renove o token pela [Auth API](/pt-br/auth-api/get-credentials) e tente novamente.", "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": "Limite de requisições excedido. Tente novamente com backoff exponencial e respeite qualquer cabeçalho `Retry-After`." }, "500": { "description": "Erro inesperado do servidor ao montar a lista. A requisição pode ser repetida com segurança." } }, "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": "Criar fluxo de verificação", "description": "Cria um fluxo de verificação (workflow) simples. Envie `features` na ordem de execução (aplicam-se regras de ordenação); o padrão é `published` v1. O corpo aceita SOMENTE os campos listados em `SimpleWorkflowRequest` — qualquer outra chave (incluindo `workflow_type`) é rejeitada com 400. Não é idempotente — cada chamada cria um novo fluxo. Máximo de 50 fluxos por aplicação.", "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": "Fluxo linear de documento de identidade, prova de vida e correspondê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": "Executar AML após a verificação de identidade", "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": "Executar um questionário criado com 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": "Fluxo de verificação (workflow) criado. O corpo da resposta é a configuração COMPLETA do fluxo, a mesma serialização bruta de `VerificationSettings` retornada por `GET /v3/workflows/{settings_uuid}/` (~190 campos: cada ativação de recurso, limiar, ação e o `workflow_graph` gerado), e não o item compacto da lista. Armazene o `uuid` (também exposto como `workflow_id`) para poder referenciá-lo em chamadas posteriores de criação de sessão. Observação: `features` é uma string unida por `\" + \"` e os preços são números JSON.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowDetail" }, "examples": { "Created (abbreviated)": { "summary": "Campos principais do objeto de configuração completo", "value": { "uuid": "c3d4e5f6-7890-12cd-ef34-333333333333", "workflow_id": "c3d4e5f6-7890-12cd-ef34-333333333333", "workflow_label": "Standard KYC", "workflow_type": null, "is_default": false, "is_archived": false, "total_price": 0.15, "min_price": 0.15, "max_price": 0.15, "features": "OCR + LIVENESS + FACE_MATCH", "is_simple_workflow": false, "is_editable": false, "workflow_url": "https://verify.didit.me/u/w9TkPOx8RWG3UAz5ZRQGVQ", "workflow_graph": { "start_node": "ocr", "nodes": "... one node per feature plus a final status node ..." }, "max_retry_attempts": 3, "retry_window_days": 7, "session_expiration_time": 604800, "version": 1, "status": "published", "published_at": "2026-05-17T10:30:00Z", "created_at": "2026-05-17T10:30:00Z", "updated_at": "2026-05-17T10:30:00Z" } } } } } }, "400": { "description": "Erro de validação. Causas comuns: uma chave de nível superior fora da lista de chaves aceitas (por exemplo, `workflow_type`), um valor de `feature` desconhecido, um recurso colocado antes da sua dependência (por exemplo, `FACE_MATCH` antes de `OCR`), um recurso passivo (`AML`, `IP_ANALYSIS`, `DATABASE_VALIDATION`, `KYB_KEY_PEOPLE`) usado como primeira etapa, um recurso `QUESTIONNAIRE` cujo `config.questionnaire_uuid` não existe para esta aplicação, um recurso `SIGNATURE` que entraria em produção sem nenhum documento para assinar, um recurso `SIGNATURE` com `signature_level: \"aes\"` enquanto Advanced (AES) não está disponível (`aes_not_available`, veja `signature_availability` no fluxo) ou um limiar fora do intervalo. O corpo é um objeto de erro de validação do DRF: as chaves são nomes de campos e os valores são arrays de mensagens legíveis.", "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": "A chave de API está ausente, malformada, expirada ou tem escopo para outra aplicação. Renove pela [Auth API](/pt-br/auth-api/get-credentials) e tente novamente.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "415": { "description": "Tipo de mídia não suportado. Defina `Content-Type: application/json` e envie um corpo JSON." }, "429": { "description": "Limite de requisições excedido. Tente novamente com backoff exponencial." }, "500": { "description": "Erro inesperado do servidor ao criar o fluxo. É seguro tentar novamente." } }, "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": "Obter fluxo", "description": "Obtenha a configuração completa de uma versão do fluxo de verificação (workflow) por `settings_uuid`: ativação de recursos, limiares, documentos permitidos, grafo, política de novas tentativas, callbacks e preços.", "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 da versão do fluxo (o valor `uuid` retornado pelo endpoint de listagem). Cada versão de um fluxo tem o seu próprio `settings_uuid`." } ], "responses": { "200": { "description": "Configuração completa do fluxo. O formato é a serialização bruta de `VerificationSettings` (~190 campos: cada ativação de recurso, limiar, ação de aviso, configuração de documentos permitidos, o `workflow_graph`, a política de novas tentativas, os callbacks e os preços). O exemplo abaixo está abreviado. Observações: `features` é uma string unida por `\" + \"` (por exemplo, `\"OCR + LIVENESS\"`), os preços são números JSON e `is_editable` é `true` somente para versões `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": "A chave de API está ausente, malformada, expirada ou vinculada a outra aplicação.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhum fluxo de verificação (workflow) com este `settings_uuid` para a aplicação autenticada. Ou o UUID está errado, ou ele pertence a outra aplicação: a Didit propositalmente não distingue os dois casos para evitar revelar a existência de registros de outras aplicações.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Limite de requisições excedido. Tente novamente com backoff exponencial." }, "500": { "description": "Erro inesperado do servidor. É seguro tentar novamente." } }, "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": "Atualizar fluxo de verificação", "description": "Atualiza um fluxo. O versionamento depende do campo `status` que você envia e do estado atual da versão: (1) sem `status` em uma versão **publicada** → a versão publicada é atualizada no próprio lugar (mesmo `uuid`, mesma `version`); (2) sem `status` em um **rascunho** → o rascunho é atualizado e publicado imediatamente; (3) `status: \"published\"` em uma versão **publicada** → uma NOVA versão publicada é criada sob o mesmo `workflow_id` (novo `uuid`, `version` + 1) e retornada, e qualquer rascunho existente no grupo é excluído; (4) `status: \"draft\"` mantém um rascunho como rascunho (salvamento automático), mas é rejeitado com 400 em uma versão publicada (`\"Cannot revert a published version to draft.\"`). O corpo aceita a mesma lista estrita de campos permitidos da criação: chaves desconhecidas são rejeitadas com 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 da versão do fluxo a ser atualizada." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleWorkflowUpdateRequest" }, "examples": { "Replace features": { "summary": "Enviar a ordem completa desejada dos recursos", "value": { "features": [ { "feature": "OCR" }, { "feature": "AML" } ] } }, "Rename": { "summary": "Renomear um fluxo de verificação (workflow)", "value": { "workflow_label": "Premium KYC" } }, "Set as default": { "summary": "Tornar este fluxo o padrão da aplicação", "value": { "is_default": true } }, "Update config": { "summary": "Alterar a configuração do recurso", "value": { "features": [ { "feature": "OCR" }, { "feature": "LIVENESS", "config": { "face_liveness_method": "passive" } } ] } }, "Publish a draft": { "summary": "Promover um rascunho a publicado", "value": { "status": "published" } } } } } }, "responses": { "200": { "description": "Fluxo atualizado. O corpo é a configuração COMPLETA da versão resultante (mesmo formato bruto de `VerificationSettings` que `GET /v3/workflows/{settings_uuid}/`). Quando a atualização cria uma nova versão (`status: \"published\"` enviado em um registro publicado), o `uuid` e a `version` retornados diferem dos que você alterou; use o `uuid` retornado nas chamadas seguintes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowDetail" } } } }, "400": { "description": "Erro de validação: uma chave de nível superior fora da lista de chaves aceitas, um recurso desconhecido, uma ordenação inválida, um limiar fora do intervalo, referência a um questionário inexistente, um recurso `SIGNATURE` que entraria em produção sem nenhum documento para assinar, um novo recurso `SIGNATURE` com `signature_level: \"aes\"` enquanto a assinatura avançada (AES) não está disponível (`aes_not_available`, consulte `signature_availability` no fluxo; uma etapa que já armazena `aes` o mantém) ou `status: \"draft\"` enviado para uma versão publicada (`\"Cannot revert a published version to draft.\"`). O corpo da resposta é um erro de validação do DRF com chaves por nome de campo." }, "403": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhum fluxo de verificação (workflow) com este `settings_uuid` para a aplicação autenticada." }, "415": { "description": "Tipo de mídia não suportado. Defina `Content-Type: application/json`." }, "429": { "description": "Limite de requisições excedido. Tente novamente com backoff exponencial." }, "500": { "description": "Erro inesperado do servidor. É seguro tentar novamente." } }, "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": "Excluir fluxo", "description": "Exclui permanentemente uma versão do fluxo de verificação (workflow), sem possibilidade de desfazer. As sessões existentes mantêm seus resultados de verificação, mas a referência ao fluxo é removida; as outras versões do mesmo grupo `workflow_id` não são excluídas.", "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 da versão do fluxo a ser excluída." } ], "responses": { "204": { "description": "Fluxo excluído. O corpo da resposta é vazio." }, "403": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhum fluxo de verificação (workflow) com este `settings_uuid` para a aplicação autenticada.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Limite de requisições excedido. Tente novamente com backoff exponencial." }, "500": { "description": "Erro inesperado do servidor. É seguro tentar novamente." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X DELETE 'https://verification.didit.me/v3/workflows/a1b2c3d4-5678-90ab-cdef-111111111111/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.workflows.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.workflows.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Workflows.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.workflows().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "workflows->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.workflows.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Workflows.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ] } }, "/v3/questionnaires/": { "get": { "summary": "Listar questionários", "description": "Lista seus questionários, dos mais recentes para os mais antigos, em um envelope de paginação limit/offset (`{count, next, previous, results}`, com tamanho de página padrão de 50). Cada linha é uma versão. `questionnaire_group_id` é o ID estável do grupo e aponta para a versão `published` mais recente.", "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": "Tamanho da página (número de questionários por página)." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "Número de linhas a pular antes do primeiro questionário retornado." } ], "responses": { "200": { "description": "Uma página de questionários ordenada por `created_at` em ordem decrescente, envolvida no envelope de paginação. Cada item em `results` é um `QuestionnaireListItem`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número total de versões de questionário da aplicação." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL da próxima página, ou `null` na última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL da página anterior, ou `null` na primeira página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/QuestionnaireListItem" } } } }, "examples": { "One questionnaire": { "summary": "Um questionário bilíngue simples", "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": "Chave de API ausente, malformada, expirada ou vinculada a outra aplicação.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições excedido. Tente novamente com backoff exponencial." }, "500": { "description": "Erro inesperado do servidor ao montar a lista. É seguro tentar novamente." } }, "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": "Criar questionário", "description": "Cria um questionário linear simples. Envie `form_elements` na ordem de exibição; ramificações e grupos repetíveis exigem o Console. O padrão é `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": "Questionário básico", "value": { "title": "Customer Onboarding", "description": "Additional information needed for verification", "default_language": "en", "languages": [ "en" ], "is_active": true, "form_elements": [ { "id": "occupation", "element_type": "short_text", "label": { "en": "What is your occupation?" }, "is_required": true, "placeholder": { "en": "Software engineer" } }, { "id": "source_of_funds", "element_type": "multiple_choice", "label": { "en": "Source of funds" }, "is_required": true, "options": [ { "value": "employment", "label": { "en": "Employment" } }, { "value": "business", "label": { "en": "Business" } }, { "value": "investments", "label": { "en": "Investments" } }, { "value": "other", "label": { "en": "Other" } } ] } ] } } } } } }, "responses": { "201": { "description": "Questionário criado. A resposta inclui o `questionnaire_id`; armazene-o para referenciar este questionário em fluxos ou em futuras chamadas de atualização ou exclusão.", "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": "Erro de validação. Causas comuns: um `element_type` desconhecido, um campo traduzível sem tradução para um dos `languages`, `languages` sem `en`, `default_language` fora de `languages`, uma opção sem `label`, uma pergunta que tem `branches`/`required_if`/`repeatable_config` (não suportado por este endpoint) ou o envio de um `graph` bruto em vez de `form_elements`. O corpo é um erro de validação do DRF indexado por nome de campo.", "content": { "application/json": { "examples": { "Graph not accepted": { "value": { "graph": "The v3 questionnaire API only accepts simple `form_elements`, not `graph`." } }, "Missing label": { "value": { "form_elements": [ { "label": [ "This field is required." ] } ] } } } } } }, "403": { "description": "Chave de API ausente, malformada, expirada ou vinculada a outra aplicação.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "415": { "description": "Tipo de mídia não suportado. Defina `Content-Type: application/json` e envie um corpo JSON." }, "429": { "description": "Limite de requisições excedido. Tente novamente com backoff exponencial." }, "500": { "description": "Erro inesperado do servidor ao criar o questionário. É seguro tentar novamente." } }, "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": "Obter questionário", "description": "Obtenha os detalhes completos do questionário para uma versão por `questionnaire_uuid`: título, `languages`, `graph` canônico, `sections` derivadas e metadados da versão.", "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 da versão do questionário (o valor `uuid` retornado pelo endpoint de listagem, também retornado como `questionnaire_id` nos endpoints de detalhe)." } ], "responses": { "200": { "description": "Detalhes completos do questionário, incluindo o `graph` canônico, a visualização derivada `sections`, os metadados da versão e `is_editable`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionnaireDetail" }, "examples": { "Published questionnaire": { "value": { "questionnaire_id": "11111111-2222-3333-4444-555555555555", "title": "Customer Onboarding", "description": "Additional information needed for verification", "languages": [ "en" ], "default_language": "en", "is_active": true, "is_simple_questionnaire": true, "graph": { "start_node": "occupation", "nodes": { "occupation": { "element_type": "SHORT_TEXT", "is_required": true, "title": { "en": "What is your occupation?" }, "next": "source_of_funds" }, "source_of_funds": { "element_type": "MULTIPLE_CHOICE", "is_required": true, "title": { "en": "Source of funds" }, "choices": [ { "value": "employment", "label": { "en": "Employment" } }, { "value": "business", "label": { "en": "Business" } } ], "next": null } } }, "sections": [ { "title": {}, "description": {}, "items": [ { "uuid": "11111111-2222-3333-4444-666666666666", "value": "occupation", "element_type": "SHORT_TEXT", "is_required": true, "title": { "en": "What is your occupation?" } } ] } ], "questionnaire_group_id": "11111111-2222-3333-4444-555555555555", "version": 1, "status": "published", "published_at": "2026-04-23T10:00:00Z", "is_editable": false } } } } } }, "403": { "description": "Chave de API ausente, malformada, expirada ou vinculada a outra aplicação.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhum questionário com este `questionnaire_uuid` para a aplicação autenticada. Ou o UUID está errado, ou ele pertence a outra aplicação: a API deliberadamente não distingue os dois casos.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Limite de requisições excedido. Tente novamente com backoff exponencial." }, "500": { "description": "Erro inesperado do servidor. É seguro tentar novamente." } }, "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": "Atualizar questionário", "description": "Atualiza um questionário. O versionamento depende do campo `status` que você envia e do estado atual da versão: (1) sem `status` em uma versão **publicada** → a versão publicada é atualizada no próprio lugar (mesmo `questionnaire_id`, mesma `version`); (2) sem `status` em um **rascunho** → o rascunho é atualizado e publicado imediatamente; (3) `status: \"published\"` em uma versão **publicada** → uma NOVA versão publicada é criada sob o mesmo `questionnaire_group_id` (novo `questionnaire_id`, `version` + 1) e retornada, e qualquer rascunho existente no grupo é excluído; (4) `status: \"draft\"` mantém um rascunho como rascunho (salvamento automático), mas é rejeitado com 400 em uma versão 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 da versão do questionário a ser atualizada." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleQuestionnaireUpdateRequest" }, "examples": { "Rename": { "summary": "Renomear um questionário", "value": { "title": "Updated Customer Onboarding" } }, "Replace questions": { "summary": "Substituir a lista linear completa de perguntas", "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": "Questionário atualizado. O corpo é o estado mais recente da versão resultante: a versão atualizada no próprio registro, ou a nova versão publicada criada quando você enviou `status: \"published\"` em um registro publicado (nesse caso, `questionnaire_id` e `version` diferem dos que você atualizou). O `questionnaire_id` na resposta é o UUID por versão; use `questionnaire_group_id` se precisar do identificador estável do grupo.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionnaireDetail" } } } }, "400": { "description": "Erro de validação: `element_type` desconhecido, tradução ausente, campos de ramificação/condicionais não suportados, `languages` sem `en`, `default_language` fora de `languages`, opção sem rótulo, envio de um `graph` bruto ou `status: \"draft\"` em uma versão publicada (`\"Cannot revert a published version to draft.\"`). O corpo da resposta é um erro de validação do DRF com chaves por nome de campo." }, "403": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhum questionário com este `questionnaire_uuid` para a aplicação autenticada." }, "415": { "description": "Tipo de mídia não suportado. Defina `Content-Type: application/json`." }, "429": { "description": "Limite de requisições excedido. Tente novamente com backoff exponencial." }, "500": { "description": "Erro inesperado do servidor. É seguro tentar novamente." } }, "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": "Excluir questionário", "description": "Exclui permanentemente uma versão do questionário (sem possibilidade de desfazer). As respostas de questionário armazenadas e vinculadas a essa versão são excluídas junto com ela, e as sessões que a referenciam perdem o vínculo; outras versões do mesmo grupo não são excluídas. Os fluxos que a referenciavam continuam em execução, mas a etapa de questionário não consegue mais carregá-la.", "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 da versão do questionário a ser excluída." } ], "responses": { "204": { "description": "Questionário excluído. O corpo da resposta é vazio." }, "403": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhum questionário com este `questionnaire_uuid` para a aplicação autenticada.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Limite de requisições excedido. Tente novamente com backoff exponencial." }, "500": { "description": "Erro inesperado do servidor. É seguro tentar novamente." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl -X DELETE 'https://verification.didit.me/v3/questionnaires/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.questionnaires.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.questionnaires.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Questionnaires.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.questionnaires().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "questionnaires->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.questionnaires.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Questionnaires.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ] } }, "/v3/users/": { "get": { "summary": "Listar usuários", "description": "Lista os [usuários](/entities/users) que a Didit monta a partir de sessões KYC que compartilham o mesmo `vendor_data` (string de formato livre, NÃO um UUID), além dos usuários criados pela API. Paginado e ordenado por `last_session_at` em ordem decrescente. Este endpoint não aceita parâmetros de filtro nem de busca: busque as páginas e filtre no lado do cliente.", "operationId": "list_users", "x-didit-sdk": { "resource": "users", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Users" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "description": "Tamanho da página. O padrão é 50 quando omitido. Não há máximo imposto, mas mantenha as páginas pequenas para reduzir a latência." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Deslocamento, a partir de zero, do primeiro registro a retornar. Prefira seguir a URL `next` da página anterior em vez de calcular este valor manualmente." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/users/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.users.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.users.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Users.ListAutoPaging(ctx, didit.UsersListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.users().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "users->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.users.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Users.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Lista paginada de usuários com status de verificação, contagem de sessões e detalhamento por recurso.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número de linhas correspondentes: exato até 100 e limitado a 100 acima disso, por desempenho. Não o use para detectar a última página; considere `next` igual a `null`." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta da próxima página, ou `null` na última página." }, "previous": { "type": "string", "nullable": true, "description": "URL absoluta da página anterior, ou `null` na primeira 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": "Nenhuma credencial fornecida. Requisições para caminhos `/v3/users/*` sem um cabeçalho `x-api-key` (ou token `Authorization: Bearer`) são rejeitadas pelo middleware de autenticação antes de chegarem à API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "A chave não pode listar usuários desta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `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": "Obter usuário", "description": "Busca um [usuário](/entities/users) por `vendor_data` (correspondência exata). Acrescenta `metadata`, `comments` e `updated_at` à visualização da lista e muda `tags` para o formato detalhado de vínculo de tags.", "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": "Seu identificador exclusivo do usuário: uma string livre (NÃO um UUID). É o mesmo valor que você passou como `vendor_data` ao criar a sessão que introduziu esse usuário pela primeira vez, comparado exatamente como enviado.", "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": "Detalhes completos do usuário, incluindo metadados, comentários/registro de atividades e dados agregados das sessões.", "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": "Nenhuma credencial fornecida. Requisições para caminhos `/v3/users/*` sem um cabeçalho `x-api-key` (ou token `Authorization: Bearer`) são rejeitadas pelo middleware de autenticação antes de chegarem à API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Chave de API inválida ou revogada, ou a chave não pode ler os usuários desta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhum usuário com o `vendor_data` informado nesta aplicação.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Atualizar usuário", "description": "Atualização parcial de um usuário: `display_name`, `full_name`, `date_of_birth`, `status`, `metadata`, `approved_emails`/`approved_phones`/`issuing_states`. `metadata` é substituído por completo. Alterar `status` aqui funciona como em [Update User Status](#patch-/v3/users/-vendor_data-/update-status/): registra uma atividade `STATUS_CHANGED` com o `reason` opcional, e `BLOCKED` adiciona o `vendor_data` à lista de bloqueio do sistema (sair de `BLOCKED` remove essa entrada). Alterações em `display_name`, `full_name`, `date_of_birth` ou `metadata` são registradas como uma atividade `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": "Seu identificador exclusivo do usuário (string livre, NÃO um 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": "Usuário atualizado. Retorna o registro completo e atualizado do usuário (mesmo formato de 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": "Corpo inválido: normalmente um `status` desconhecido ou uma `date_of_birth` fora do formato `YYYY-MM-DD`.", "content": { "application/json": { "examples": { "Bad status": { "value": { "status": [ "\"INVALID\" is not a valid choice." ] } }, "Bad date_of_birth": { "value": { "date_of_birth": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } }, "Reason too long": { "value": { "reason": [ "Ensure this field has no more than 1000 characters." ] } } } } } }, "401": { "description": "Nenhuma credencial fornecida. Requisições para caminhos `/v3/users/*` sem um cabeçalho `x-api-key` (ou token `Authorization: Bearer`) são rejeitadas pelo middleware de autenticação antes de chegarem à API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "A chave não pode atualizar usuários desta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhum usuário com o `vendor_data` informado nesta aplicação.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `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": "Nome completo do usuário" }, "display_name": { "type": "string", "nullable": true, "description": "Nome de exibição personalizado para este usuário" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Data de nascimento no formato YYYY-MM-DD" }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Status do ciclo de vida do usuário. Uma alteração é registrada como uma atividade `STATUS_CHANGED`, e `BLOCKED` adiciona o `vendor_data` à lista de bloqueio do sistema (sair de `BLOCKED` remove essa entrada)." }, "metadata": { "type": "object", "nullable": true, "description": "Objeto JSON arbitrário que você anexa ao usuário. **Substitui totalmente** os metadados existentes na atualização — faça a mesclagem no lado do cliente se quiser apenas adicionar chaves." }, "approved_emails": { "type": "array", "items": { "type": "string" }, "description": "Endereços de e-mail verificados deste usuário, por exemplo, `[\"john@example.com\"]`. Substitui completamente a lista armazenada." }, "approved_phones": { "type": "array", "items": { "type": "string" }, "description": "Números de telefone verificados deste usuário. Substitui completamente a lista armazenada." }, "issuing_states": { "type": "array", "items": { "type": "string" }, "description": "Países emissores (ISO 3166-1 alpha-3), por exemplo `[\"USA\"]`. Substitui integralmente a lista armazenada." }, "reason": { "type": "string", "nullable": true, "maxLength": 1000, "description": "Por que o status mudou. Registrado na entrada de mudança de status na atividade do usuário (`comments[].comment` e **Activity** no Business Console), apenas quando o status realmente muda. Os webhooks não o incluem." } } }, "examples": { "Rename": { "summary": "Definir nome de exibição", "value": { "display_name": "Jane S." } }, "Override status": { "summary": "Sinalizar o usuário para revisão", "value": { "status": "FLAGGED" } }, "Add metadata": { "summary": "Substituir o JSON de metadados", "value": { "metadata": { "tier": "premium", "risk_level": "low" } } }, "Fix extracted DOB": { "summary": "Corrigir campos de perfil extraídos", "value": { "full_name": "Jane Elizabeth Smith", "date_of_birth": "1985-11-22" } }, "Flag with reason": { "summary": "Sinalizar o usuário e registrar o motivo", "value": { "status": "FLAGGED", "reason": "Address does not match the billing country" } } } } } } } }, "/v3/users/{vendor_data}/generate-pdf/": { "get": { "summary": "Baixar o relatório em PDF do histórico completo do usuário", "description": "Gere e baixe um único PDF pronto para conformidade com o histórico completo de verificação do usuário identificado por `vendor_data`. É o mesmo documento que o Console produz em **User detail → Actions → Download PDF**, então as exportações periódicas de conformidade não dependem mais de alguém clicando no Console.\n\n**O que o relatório contém.** Uma página de capa com o resumo do perfil (nome, data de nascimento, estados emissores, e-mails e telefones aprovados), o status mais recente de cada recurso, os contadores de sessões e um índice das sessões incluídas, seguida do relatório padrão de cada sessão incluída, em ordem cronológica (da mais antiga para a mais recente). O relatório de cada sessão é o mesmo documento que `GET /v3/session/{sessionId}/generate-pdf/` retorna para essa sessão.\n\n**Sessões elegíveis.** Somente sessões de Verificação de usuários (KYC) com status `Approved`, `Declined`, `In Review` ou `Kyc Expired` são incluídas; sessões com qualquer outro status são ignoradas. Se o usuário não tiver nenhuma sessão em um desses status, o endpoint retorna `403` (veja abaixo).\n\n**Limite.** O relatório é limitado às **20 sessões mais recentes** que podem entrar no relatório. Quando um usuário tem mais, as 20 mais recentes são incluídas e a página de capa informa quantas sessões mais antigas ficaram de fora. Use `GET /v3/sessions/?vendor_data=…` para obter a lista completa em JSON.\n\n**Identidade visual.** Se a sua aplicação tiver personalização de marca própria, a capa e cada relatório de sessão são gerados com o seu logotipo e a URL da sua política de privacidade; caso contrário, levam a identidade visual da Didit. Os relatórios são gerados em inglês; não há parâmetro de idioma.\n\n**Sem cache.** Cada chamada gera o PDF novamente a partir dos dados atuais, então um relatório gerado após uma revisão manual reflete a decisão do revisor. Duas chamadas para o mesmo usuário podem produzir arquivos diferentes byte a byte; arquive o arquivo baixado se você precisar de uma cópia imutável.\n\n**Latência.** A geração é síncrona e baixa todas as imagens armazenadas de cada sessão incluída, então um usuário com muitas sessões ricas em mídia pode levar dezenas de segundos. Use um tempo limite de leitura generoso no cliente (120 s recomendados) e grave o corpo em disco via streaming. A geração para ao atingir um limite de tempo definido no servidor, em vez de continuar até o seu cliente desistir: se esse limite for atingido, a resposta ainda é um PDF válido com as sessões mais recentes, e a capa informa quantas foram omitidas.\n\n**Escopo.** O usuário é localizado dentro da aplicação dona da chave de API. Uma chave nunca pode exportar um usuário de outra aplicação: para ela, esse usuário não existe e o endpoint retorna `404`.\n\n**Barra final.** A rota canônica termina com barra (`…/generate-pdf/`). Uma requisição sem a barra é atendida diretamente com a mesma resposta; não há redirecionamento `301`, então nenhum cliente precisa seguir redirecionamentos e o `curl` não precisa de `-L`. Use a URL com barra, como nos exemplos.", "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": "Seu identificador exclusivo do usuário: uma string livre (NÃO um UUID). É o mesmo valor que você passou como `vendor_data` ao criar as sessões do usuário, comparado exatamente como enviado. Codifique-o para URL; um valor que contenha `/` não pode ser endereçado por esta rota.", "example": "user-abc-123" } ], "responses": { "200": { "description": "O documento PDF renderizado, retornado diretamente como binário `application/pdf`: não há wrapper JSON nem indireção por URL de download. O corpo começa com os bytes mágicos `%PDF`. Salve-o em um arquivo `.pdf` ou transmita-o diretamente para quem fez a chamada.", "headers": { "Content-Disposition": { "description": "`attachment; filename=user_{didit_internal_id}.pdf`: o arquivo recebe o nome do identificador estável do usuário na Didit (`didit_internal_id` em `GET /v3/users/{vendor_data}/`), e não de `vendor_data`.", "schema": { "type": "string", "example": "attachment; filename=user_f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418.pdf" } }, "Content-Length": { "description": "Tamanho total do PDF em bytes; o corpo não é dividido em partes (chunked).", "schema": { "type": "integer", "example": 148213 } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Nenhuma credencial fornecida. Requisições para caminhos `/v3/users/*` sem um cabeçalho `x-api-key` (ou token `Authorization: Bearer`) são rejeitadas pelo middleware de autenticação antes de chegarem à API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Falha de autorização ou de elegibilidade. Diferencie as duas pela string `detail`:\n\n- `\"You do not have permission to perform this action.\"`: a chave de API é inválida ou foi revogada, ou a requisição traz um token de usuário do Console em vez de uma chave de API da aplicação.\n- `\"This user has no sessions in review, declined, approved or kyc expired to report.\"`: o usuário existe na sua aplicação, mas nenhuma das sessões dele está ainda em um status que permita gerar relatório (por exemplo, todas as sessões ainda estão `In Progress`, ou o usuário foi criado por meio de `POST /v3/users/create/` e nunca fez a verificação). Aguarde um webhook `status.updated` antes de solicitar o relatório.", "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": "Chave de API revogada ou inválida, ou um token de usuário do Console", "value": { "detail": "You do not have permission to perform this action." } }, "No reportable sessions": { "summary": "O usuário existe, mas não tem nenhuma sessão Aprovada / Recusada / Em revisão / KYC expirado", "value": { "detail": "This user has no sessions in review, declined, approved or kyc expired to report." } } } } } }, "404": { "description": "Não existe nenhum usuário com o `vendor_data` informado na aplicação associada à chave de API. Usuários de outras aplicações são invisíveis para esta chave e retornam o mesmo `404`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "User not found." } } }, "examples": { "Unknown user": { "summary": "vendor_data não corresponde a nenhum usuário desta aplicação", "value": { "detail": "User not found." } } } } } }, "429": { "description": "Limite de requisições excedido. A geração de PDF tem um limite próprio de **50 requisições por minuto por credencial** (chave de API, token Bearer ou IP de origem quando não autenticado), compartilhado entre este endpoint e `GET /v3/session/{sessionId}/generate-pdf/`, além do limite global de 600/min para GET. Aguarde `Retry-After` segundos (também refletidos nos cabeçalhos `X-RateLimit-*`) e tente novamente. Os relatórios não ficam em cache no servidor, então baixe cada relatório uma vez e armazene o arquivo em vez de buscá-lo de novo.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente a requisição.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Número máximo de gerações de PDF permitidas na janela atual (50).", "schema": { "type": "integer", "example": 50 } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Timestamp Unix (segundos) em que a janela atual é reiniciada.", "schema": { "type": "integer", "example": 1750000000 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Explicação legível da violação do limite de requisições.", "example": "Session PDF generation rate limit exceeded. You can make up to 50 requests per minute." } } }, "examples": { "Throttled": { "summary": "Mais de 50 gerações de PDF em um minuto com a mesma 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": "Excluir usuários em lote", "description": "**Exclui permanentemente** usuários: os registros dos usuários são removidos de forma permanente. Para bloqueios do dia a dia, prefira [Update User Status](#patch-/v3/users/-vendor_data-/update-status/) com `BLOCKED`. Selecione usuários com `vendor_data_list`, com `didit_internal_id_list` ou com ambos ao mesmo tempo; ou envie `delete_all: true`. Este endpoint nunca restringe `delete_all` com filtros. Os filtros de People do Console são recusados com `400` (veja a resposta `400`), para que uma intenção restrita não se transforme em uma exclusão total. Há duas exceções: `filter_has_approved_sessions` e `filter_has_declined_sessions` não são recusados nem aplicados, então, com `delete_all: true`, eles ainda excluem todos os usuários; não os envie.\n\n**Templates biométricos:** a menos que você defina `retain_face_embeddings` como `true`, todo template biométrico sem imagem retido para esses usuários após a exclusão da sessão (veja `/v3/biometric-templates/`) é eliminado antes de o usuário ser excluído, de modo que a pessoa deixa de gerar correspondências na detecção de duplicatas e na Busca facial. Com `retain_face_embeddings: true` e `face_retention_days`, você opta por manter um template biométrico sem imagem por pessoa durante esse número de dias, e nada mais sobre a pessoa é mantido. Se um template não puder ser eliminado porque um armazenamento biométrico está indisponível, a chamada retorna `503`, nenhum usuário da requisição é excluído, e repetir a requisição conclui o trabalho.\n\n**Relatórios regulatórios enviados:** se os dados selecionados estiverem em um relatório regulatório finalizado, a requisição inteira é recusada com `409` e nada é excluído. O corpo usa `code: in_filed_report` e identifica cada relatório com `uuid`, `report_number`, `report_type` e `case_uuid`. Exclua os relatórios e repita a requisição.", "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": "Informe `vendor_data_list`, `didit_internal_id_list` ou `delete_all: true`. As duas listas podem ser combinadas e são unidas por OR. Quando `delete_all` é `true`, ele tem precedência e ambas as listas são ignoradas.", "properties": { "vendor_data_list": { "type": "array", "items": { "type": "string" }, "description": "Seus próprios identificadores a excluir, comparados exatamente como enviados." }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs internos de usuário da Didit a excluir: o `didit_internal_id` retornado pelos endpoints de criação e consulta." }, "delete_all": { "type": "boolean", "default": false, "description": "Se `true`, exclui todos os usuários da aplicação." }, "retain_face_embeddings": { "type": "boolean", "default": false, "description": "Sua escolha explícita de manter um template biométrico sem imagem de cada pessoa excluída para detecção de duplicatas, por `face_retention_days`. Todo o resto sobre a pessoa é excluído. Omita-o, ou envie `false`, para excluir os templates junto com os usuários. Quando `true`, `face_retention_days` é obrigatório." }, "face_retention_days": { "type": "integer", "minimum": 1, "maximum": 3650, "description": "Número de dias durante os quais o template biométrico sem imagem é mantido quando `retain_face_embeddings` é `true`. Obrigatório junto com ele e, sem ele, rejeitado com um `400` em `face_retention_days`.", "example": 365 } } }, "examples": { "Specific users": { "summary": "Excluir usuários por vendor_data", "value": { "vendor_data_list": [ "user-123", "user-456" ] } }, "By Didit internal ID": { "summary": "Excluir usuários por didit_internal_id", "value": { "didit_internal_id_list": [ "3f1c0d3e-8f0a-4c2e-9a3d-9b1f5f4a2c11" ] } }, "All users": { "summary": "Excluir todos os usuários desta aplicação", "value": { "delete_all": true } }, "Keep face templates": { "summary": "Excluir usuários e manter templates faciais anônimos por 365 dias", "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": "Usuários excluídos. Retorna o número de usuários efetivamente excluídos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "integer", "description": "Número de usuários excluídos (não inclui valores de vendor_data que não corresponderam a nada)." } } }, "examples": { "Deleted some": { "value": { "deleted": 2 } }, "Nothing matched": { "value": { "deleted": 0 } } } } } }, "400": { "description": "Erro de validação; nada é excluído. Os erros são indexados pelo nome do campo. Sem seletor (nenhuma das listas e `delete_all` diferente de `true`), o corpo é `{\"vendor_data_list\": [\"This field is required unless delete_all is true.\"]}`; uma lista vazia é recusada sob sua própria chave com `\"This list may not be empty.\"`. Um filtro exclusivo do 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` ou `filter_auth_mfa_enabled`) é recusado sempre que tiver um valor, mesmo `false`, com um objeto indexado por cada um desses campos. Qualquer outra chave `filter_*` desconhecida é recusada com `\"Unknown filter.\"`.", "content": { "application/json": { "examples": { "Missing selector": { "summary": "Nem list nem delete_all foram informados", "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": "Nenhuma credencial fornecida. Requisições para caminhos `/v3/users/*` sem um cabeçalho `x-api-key` (ou token `Authorization: Bearer`) são rejeitadas pelo middleware de autenticação antes de chegarem à API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Chave de API inválida ou revogada, ou a chave não pode excluir usuários desta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } }, "503": { "description": "Um armazenamento biométrico ficou indisponível durante a retenção ou a exclusão de um template biométrico. Nada é excluído; repita a mesma requisição. As novas tentativas são idempotentes e convergem para um único template.", "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": "A seleção inclui uma pessoa em um relatório regulatório finalizado. Nada é excluído.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InFiledReportError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/sessions/delete/": { "post": { "summary": "Excluir sessões de KYC em massa por session_number", "description": "Exclua em massa sessões de Verificação de usuários (KYC) pelo `session_number` numérico, ou todas as sessões KYC da sua aplicação com `delete_all: true`.\n\n`session_number` é o contador sequencial e legível exibido na lista de sessões do Console e retornado como `session_number` pelos endpoints de criação de sessão e de decisão; ele **não** é o UUID `session_id`. Para excluir uma sessão pelo UUID, ou para excluir uma sessão de Verificação de empresas (KYB), que este endpoint nunca afeta, use `DELETE /v3/session/{sessionId}/delete/`.\n\n**Até 20 sessões são excluídas na própria requisição; acima disso, a exclusão é executada como uma tarefa.** O que decide é o número de sessões correspondentes, sejam elas selecionadas por `session_numbers` ou com `delete_all`:\n- Até 20 sessões correspondentes: elas são excluídas antes da resposta, que é `200` com uma entrada por sessão em `results[]`.\n- Mais de 20: a resposta é `202` com uma tarefa de exclusão, e as sessões são excluídas em segundo plano. Consulte `GET /v3/sessions/delete/{job_id}/` até que `status` seja `COMPLETED` ou `FAILED`. Uma tarefa informa contagens por resultado, nunca quais sessões ela excluiu. Uma tarefa `delete_all` exclui apenas as sessões criadas antes da requisição; as sessões iniciadas durante a execução não são excluídas.\n\nCada sessão excluída recebe exatamente o mesmo tratamento do endpoint de exclusão de sessão individual: a sessão, todas as tentativas de verificação que ela contém, sua decisão e os dados extraídos, os registros dos recursos relacionados (verificação de identidade, rosto, prova de vida, correspondência facial etc.) e todos os arquivos armazenados são excluídos; ela desaparece de todos os endpoints de leitura, e as URLs de mídia emitidas anteriormente deixam de funcionar. As entregas de webhook ainda na fila para uma sessão excluída, e suas novas tentativas, são descartadas; os webhooks já entregues não são afetados. As entradas da lista de bloqueio **não** são removidas, os créditos já consumidos **não** são reembolsados e as entidades User às quais as sessões pertencem **não** são excluídas (use `POST /v3/users/delete/` para isso); nenhum webhook é emitido pela exclusão. A exclusão é permanente e irreversível.\n\n**Regras de seleção:**\n- Com `delete_all: true`, você pode restringir a seleção com os filtros de `GET /v3/sessions/`, cada um com o prefixo `filter_` (por exemplo, `filter_status`, `filter_workflow_id`, `filter_date_from`). Os filtros que aceitam vários valores em List Sessions (`status`, `workflow_id`, `country`, `region`, `document_type`, `document_name`, `session_type`, `warning`, `organization_name`) aceitam uma string separada por vírgulas ou um array; os demais aceitam um único valor. Um valor vazio é ignorado. Os filtros só se aplicam em conjunto com `delete_all`, e uma tarefa de exclusão aplica os mesmos filtros.\n- Uma chave `filter_*` desconhecida, ou um valor de filtro que não pode ser interpretado, rejeita a requisição inteira com `400` antes que qualquer coisa seja excluída, de modo que um filtro digitado errado nunca amplia a exclusão para todas as sessões.\n- As entradas de `session_numbers` que não correspondem a uma sessão KYC ativa na sua aplicação (números desconhecidos, sessões já excluídas ou sessões de outra aplicação) são **ignoradas silenciosamente**: elas não aparecem em `results` e não são contabilizadas no `total` de uma tarefa.\n- Falhas de validação (uma entrada não numérica, uma lista vazia, ausência tanto de `session_numbers` quanto de `delete_all`, ou uma retenção definida no modelo que a aplicação não consegue cumprir) rejeitam a **requisição inteira** com `400` e não excluem nada.\n- As sessões são excluídas em grupos. Se um grupo não puder ser excluído (por exemplo, porque um serviço de armazenamento está indisponível), todas as sessões desse grupo são informadas como `face_retention_outcome: failed_retryable` e permanecem onde estão; os demais grupos não são afetados. Repita a requisição para essas sessões. Uma tarefa tenta novamente esse grupo por conta própria.\n- Não há limite documentado para o tamanho da lista; o limite de requisições de escrita compartilhado (abaixo) é o limite prático.\n\n**Dados biométricos faciais:** os campos opcionais `retain_face_embeddings`, `face_retention_days`, `face_retention_deadline`, `deletion_instruction` e `instruction_id` têm o mesmo significado que em `DELETE /v3/session/{sessionId}/delete/` e se aplicam a todas as sessões correspondentes. Cada resultado informa o próprio `face_retention_outcome`.\n\n**Resposta:** `200 OK` com `results[]` para até 20 sessões correspondentes, ou `202 Accepted` com uma tarefa de exclusão para mais do que isso. Todo resultado confirma a exclusão, exceto `face_retention_outcome: failed_retryable`, que indica uma sessão que NÃO foi excluída e deve ser tentada novamente. Versões anteriores deste endpoint retornavam `204 No Content`; atualize os clientes que verificam `204`.\n\n**Idempotência:** repetir a mesma requisição não exclui mais nada: os números que não correspondem mais a uma sessão são ignorados.\n\n**`delete_all: true` (destrutivo):** exclui **todas** as sessões KYC restantes na aplicação; `session_numbers` é ignorado quando definido. Não há etapa de confirmação nem como desfazer.\n\n**Autenticação:** chave de API no cabeçalho `x-api-key`. Credenciais ausentes ou inválidas retornam `403` (`{\"detail\": \"You do not have permission to perform this action.\"}`); esta API nunca retorna `401`.\n\n**Limite de requisições:** cota de escrita compartilhada de 300 requisições/min por chave de API em todos os endpoints POST/PATCH/DELETE; ultrapassá-la retorna `429`.\n\nEste endpoint aceita apenas chaves de API. Os tokens Bearer de usuários do Business Console são rejeitados com `403` (ao contrário da exclusão de sessão individual, que aceita ambos).\n\n**Relatórios regulatórios enviados:** se os dados selecionados estiverem em um relatório regulatório finalizado, a requisição inteira é recusada com `409` e nada é excluído. O corpo usa `code: in_filed_report` e identifica cada relatório com `uuid`, `report_number`, `report_type` e `case_uuid`. Exclua os relatórios e repita a requisição.", "operationId": "batch_delete_sessions", "x-didit-sdk": { "resource": "sessions", "method": "batch_delete", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "session_numbers": { "type": "array", "description": "Valores numéricos de `session_number` das sessões de KYC a excluir, como strings contendo apenas dígitos (números JSON também são aceitos e convertidos). Obrigatório, a menos que `delete_all` seja `true`; uma lista vazia retorna `400`. Qualquer entrada que não seja composta apenas de dígitos rejeita a requisição inteira com `400` (a menos que `delete_all` seja `true`; nesse caso, a validação é ignorada e as entradas são desconsideradas). Números que não correspondem a uma sessão ativa na sua aplicação são ignorados silenciosamente.", "items": { "type": "string", "pattern": "^[0-9]+$", "example": "1001" }, "minItems": 1, "example": [ "1001", "1002", "1003" ] }, "delete_all": { "type": "boolean", "description": "Quando `true`, todas as sessões de KYC restantes na aplicação que faz a chamada são excluídas e `session_numbers` é ignorado, a menos que você restrinja a seleção com chaves `filter_*`. Mais de 20 sessões correspondentes são processadas como um job de exclusão (`202`) que abrange apenas as sessões criadas antes da requisição. O padrão é `false`. Irreversível; não há etapa de confirmação.", "default": false, "example": false }, "retain_face_embeddings": { "type": "boolean", "nullable": true, "description": "Substitui a `face_retention_policy` da aplicação para esta exclusão. `true` mantém um template biométrico facial sem imagem vinculado ao User da sessão após a exclusão da sessão; `false` exclui o embedding facial junto com a sessão; omita ou use `null` para seguir a política da aplicação. Ignorado para sessões KYB e para sessões sem embedding facial.", "example": true }, "face_retention_days": { "type": "integer", "minimum": 1, "maximum": 3650, "description": "Duração finita de retenção, em dias, de um template biométrico retido. Obrigatório quando um template é retido, a menos que a aplicação já defina `face_retention_days`. O `expires_at` do template é o mais próximo entre essa duração, o período geral de retenção de dados da aplicação e `face_retention_deadline`.", "example": 365 }, "face_retention_deadline": { "type": "string", "format": "date-time", "description": "Expiração definitiva opcional para um template retido. Deve estar no futuro.", "example": "2027-08-28T00:00:00Z" }, "deletion_instruction": { "type": "string", "enum": [ "operational_session_delete", "privacy_erasure" ], "default": "operational_session_delete", "description": "A classe de instrução que você está dando. `operational_session_delete` exclui a sessão e retém um template apenas quando a política ou `retain_face_embeddings` assim determina. `privacy_erasure` elimina todos os templates biométricos retidos vinculados ao User da sessão antes de excluir a sessão, não pode ser substituído pela política da aplicação e não pode ser combinado com `retain_face_embeddings: true` (`400`).", "example": "operational_session_delete" }, "instruction_id": { "type": "string", "maxLength": 255, "description": "Sua referência permanente para esta instrução de exclusão (por exemplo, o ID de um ticket de apagamento). Registrada na trilha de auditoria e em qualquer template retido. Gerada pela Didit quando omitida.", "example": "dsar-2026-0142" }, "filter_status": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `status` de [List Sessions](/pt-br/sessions-api/list-sessions), com os mesmos valores. Uma string separada por vírgulas ou um array. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_vendor_data": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `vendor_data` de [List Sessions](/pt-br/sessions-api/list-sessions), com o mesmo valor. Um único valor, não uma lista: um array é unido em um único texto separado por vírgulas, portanto vários valores não são tratados como alternativas. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "type": "string" }, "filter_search": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `search` de [List Sessions](/pt-br/sessions-api/list-sessions), com o mesmo valor. Um único valor, não uma lista: um array é unido em um único texto separado por vírgulas, portanto vários valores não são tratados como alternativas. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "type": "string" }, "filter_workflow_id": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `workflow_id` de [List Sessions](/pt-br/sessions-api/list-sessions), com os mesmos valores. Uma string separada por vírgulas ou um array. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_date_from": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `date_from` de [List Sessions](/pt-br/sessions-api/list-sessions), com o mesmo valor. Um único valor, não uma lista: um array é unido em um único valor separado por vírgulas, então vários valores são recusados com `400`. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "type": "string", "format": "date" }, "filter_date_to": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `date_to` de [List Sessions](/pt-br/sessions-api/list-sessions), com o mesmo valor. Um único valor, não uma lista: um array é unido em um único valor separado por vírgulas, então vários valores são recusados com `400`. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "type": "string", "format": "date" }, "filter_country": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `country` de [List Sessions](/pt-br/sessions-api/list-sessions), com os mesmos valores. Uma string separada por vírgulas ou um array. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_document_type": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `document_type` de [List Sessions](/pt-br/sessions-api/list-sessions), com os mesmos valores. Uma string separada por vírgulas ou um array. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_document_name": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `document_name` de [List Sessions](/pt-br/sessions-api/list-sessions), com os mesmos valores. Uma string separada por vírgulas ou um array. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_region": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `region` de [List Sessions](/pt-br/sessions-api/list-sessions), com os mesmos valores. Uma string separada por vírgulas ou um array. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_didit_internal_id": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `didit_internal_id` de [List Sessions](/pt-br/sessions-api/list-sessions), com o mesmo valor. Um único valor, não uma lista: um array é unido em um único valor separado por vírgulas, então vários valores são recusados com `400`. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "type": "string", "format": "uuid" }, "filter_session_type": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `session_type` de [List Sessions](/pt-br/sessions-api/list-sessions), com os mesmos valores. Uma string separada por vírgulas ou um array. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_api_service": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `api_service` de [List Sessions](/pt-br/sessions-api/list-sessions), com o mesmo valor. Um único valor, não uma lista: um array é unido em um único valor separado por vírgulas, então vários valores são recusados com `400`. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "type": "string" }, "filter_screened_full_name": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `screened_full_name` de [List Sessions](/pt-br/sessions-api/list-sessions), com o mesmo valor. Um único valor, não uma lista: um array é unido em um único texto separado por vírgulas, portanto vários valores não são tratados como alternativas. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "type": "string" }, "filter_warning": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `warning` de [List Sessions](/pt-br/sessions-api/list-sessions), com os mesmos valores. Uma string separada por vírgulas ou um array. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "filter_status_initialized_as_in_review": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `status_initialized_as_in_review` de [List Sessions](/pt-br/sessions-api/list-sessions), com os mesmos valores. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "type": "boolean" }, "filter_is_kyc_to_be_reviewed": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `is_kyc_to_be_reviewed` de [List Sessions](/pt-br/sessions-api/list-sessions), com os mesmos valores. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "type": "boolean" }, "filter_euuid": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `euuid` de [List Sessions](/pt-br/sessions-api/list-sessions), com o mesmo valor. Um único valor, não uma lista: um array é unido em um único valor separado por vírgulas, então vários valores são recusados com `400`. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "type": "string", "format": "uuid" }, "filter_organization_name": { "description": "Restringe um `delete_all` às sessões que correspondem ao filtro `organization_name` de [List Sessions](/pt-br/sessions-api/list-sessions), com os mesmos valores. Uma string separada por vírgulas ou um array. Com uma chave de API, ele só pode corresponder ao nome da sua própria organização, portanto seleciona todas as suas sessões ou nenhuma. Ignorado sem `delete_all`. Um valor vazio é ignorado e não restringe a seleção.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "examples": { "Specific sessions": { "summary": "Excluir sessões específicas pelo número", "value": { "session_numbers": [ "1001", "1002", "1003" ] } }, "All sessions": { "summary": "Excluir todas as sessões de KYC da aplicação", "value": { "delete_all": true } }, "Delete and retain templates": { "summary": "Excluir sessões, mas manter templates biométricos sem imagens por 365 dias", "value": { "session_numbers": [ "1001", "1002" ], "retain_face_embeddings": true, "face_retention_days": 365, "instruction_id": "post-approval-cleanup-2026-08" } }, "Privacy erasure": { "summary": "Excluir sessões e eliminar todos os templates retidos dos respectivos usuários", "value": { "session_numbers": [ "1001" ], "deletion_instruction": "privacy_erasure", "instruction_id": "dsar-2026-0142" } }, "Filtered delete_all": { "summary": "Excluir todas as sessões recusadas de um fluxo criadas em setembro 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": "Até 20 sessões corresponderam e foram processadas na requisição. Há um resultado por sessão correspondente; números que não corresponderam a nada (desconhecidos ou já excluídos) são ignorados e não aparecem. Um resultado confirma a exclusão, exceto quando `face_retention_outcome` é `failed_retryable`: essa sessão NÃO foi excluída e a operação deve ser tentada novamente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "A sessão excluída." }, "session_number": { "type": "integer", "nullable": true, "description": "O número da sessão excluída." }, "face_retention_outcome": { "type": "string", "enum": [ "retained_with_user", "deleted", "none", "ineligible_no_vendor_user", "failed_retryable" ], "description": "O que aconteceu com os dados biométricos faciais da sessão. `deleted`: o embedding facial foi excluído junto com a sessão (padrão). `retained_with_user`: a sessão é excluída e um template biométrico sem imagem permanece vinculado ao User; veja `biometric_template_uuid`. `none`: a sessão não tinha embedding facial (por exemplo, uma sessão de KYC somente com documento, sem selfie de prova de vida; sessões de KYB nunca são selecionadas por este endpoint). `ineligible_no_vendor_user`: a retenção foi solicitada, mas a sessão não tem um User vinculado, então o embedding foi excluído junto com a sessão. `failed_retryable` (somente no endpoint em lote): o grupo com o qual esta sessão seria excluída não pôde ser excluído (um serviço de armazenamento, um armazenamento biométrico ou um provedor de monitoramento estava indisponível); esta sessão continua existindo, repita a requisição para ela." }, "biometric_template_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Id do template biométrico retido quando `face_retention_outcome` é `retained_with_user`; caso contrário, `null`. Gerencie-o por meio de `/v3/biometric-templates/{template_uuid}/`." }, "biometric_template_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o template biométrico retido é excluído, quando `face_retention_outcome` é `retained_with_user`; `null` quando nenhum template é retido." }, "deleted_child_verifications": { "type": "integer", "description": "Sempre `0` neste endpoint, que exclui apenas sessões de KYC. Excluir uma sessão de Verificação de empresas (KYB) com `DELETE /v3/session/{sessionId}/delete/` informa as verificações criadas por ela que foram excluídas junto." } } } } } }, "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": "Mais de 20 sessões corresponderam. Elas são excluídas em segundo plano; consulte `GET /v3/sessions/delete/{job_id}/` periodicamente até que `status` seja `COMPLETED` ou `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": "Erro de validação: nada foi excluído. Os valores de erro são arrays de mensagens com chaves por nome de campo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_numbers": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": { "description": "Outras chaves: uma chave `filter_*` que não é um filtro de List Sessions (`\"Unknown filter.\"`), ou uma chave `filter_*` cujo valor não pode ser lido (indexada por essa chave `filter_*`, com um array de mensagens)." } }, "examples": { "Missing selector": { "summary": "Nem session_numbers nem delete_all foram informados", "value": { "session_numbers": [ "This field is required unless delete_all is true." ] } }, "Empty list": { "summary": "session_numbers é um array vazio", "value": { "session_numbers": [ "This list may not be empty." ] } }, "Non-numeric entry": { "summary": "session_numbers contém uma string com caracteres não numéricos", "value": { "session_numbers": [ "All session_numbers must be numeric." ] } }, "Privacy erasure cannot retain": { "summary": "deletion_instruction privacy_erasure combinado com retain_face_embeddings true", "value": { "retain_face_embeddings": [ "Privacy erasure cannot retain biometric templates." ] } }, "No finite retention duration": { "summary": "Retenção solicitada sem face_retention_days na requisição ou na aplicação", "value": { "detail": "A finite biometric-template retention duration is required." } }, "Unknown filter": { "summary": "Uma chave filter_* que o List Sessions não possui", "value": { "filter_reviewer": "Unknown filter." } }, "Unreadable filter value": { "summary": "Um valor de filtro que não pode ser lido", "value": { "filter_date_from": [ "Enter a valid date." ] } } } } } }, "403": { "description": "Chave de API ausente. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid API key": { "summary": "Cabeçalho x-api-key ausente, ou a chave é inválida", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições de escrita compartilhado excedido (300 requisições POST/PATCH/DELETE por minuto por chave de API). Verifique o `Retry-After` e os cabeçalhos de resposta `X-RateLimit-*` antes de tentar novamente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Orçamento de escrita esgotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } }, "409": { "description": "Uma sessão selecionada faz parte de um relatório regulatório finalizado. Nada é excluído.", "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": "Obter um job de exclusão de sessões em massa", "description": "Progresso de uma exclusão de sessões em massa à qual `POST /v3/sessions/delete/` respondeu com `202` (mais de 20 sessões correspondentes, selecionadas por `session_numbers` ou com `delete_all`). Consulte a cada poucos segundos enquanto `status` for `PENDING` ou `PROCESSING`; pare quando for `COMPLETED` ou `FAILED`.\n\nO job informa quantas sessões terminaram em cada resultado e quantas já processou, mas nunca quais sessões excluiu. Um job `FAILED` traz o motivo em `error`; as sessões que ele não chegou a processar continuam existindo, então repita a requisição de exclusão para excluí-las.\n\n**Autenticação:** chave de API no cabeçalho `x-api-key`. Um job só fica visível para a aplicação que o criou; qualquer outro `job_id` retorna `404`. Credenciais ausentes ou inválidas retornam `403`; esta API nunca 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": "O `job_id` retornado com o `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": "A tarefa.", "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": "Chave de API ausente. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Missing or invalid API key": { "summary": "Cabeçalho x-api-key ausente, ou a chave é inválida", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhum job de exclusão com este `job_id` para a aplicação que fez a chamada. Os jobs só são visíveis para a aplicação que os criou." } } } }, "/v3/sessions/{session_id}/reviews/": { "get": { "summary": "Listar revisões e registro de atividades da sessão", "description": "Retorna a trilha de auditoria / feed de atividades de uma sessão de Verificação de usuários (KYC), da mais recente para a mais antiga, em um envelope paginado (`count` / `next` / `previous` / `results`, 50 entradas por página por padrão).\n\nAs entradas do feed são registradas por todos os agentes que interagem com a sessão: decisões manuais tomadas por meio de `PATCH /v3/session/{session_id}/update-status/` (que registra `previous_status` → `new_status`), atividades de revisores no Console (comentários com menções `@email`, edições de dados de KYC/comprovante de endereço, envios e remoções de arquivos, alterações de tags, visualizações da página de detalhes), correspondências do monitoramento AML contínuo e notas adicionadas via `POST` neste mesmo caminho. Ler este feed equivale, pela API, ao painel **Activity** na visualização da sessão no Didit Console.\n\nApenas sessões de Verificação de usuários (KYC) podem ser consultadas aqui; IDs de sessões de Verificação de empresas (KYB) retornam `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 da sessão de Verificação de usuários (KYC). Deve pertencer à mesma aplicação da chave de API: UUIDs de outras aplicações, sessões excluídas e IDs de sessões de Verificação de empresas (KYB) retornam `404`.", "schema": { "type": "string", "format": "uuid", "example": "8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d" } }, { "name": "limit", "in": "query", "required": false, "description": "Tamanho da página. O padrão é `50`.", "schema": { "type": "integer", "default": 50, "example": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Número de entradas a pular a partir do início do feed (ordenado). O padrão é `0`. As URLs `next` / `previous` da resposta trazem os valores corretos para percorrer o feed.", "schema": { "type": "integer", "default": 0, "example": 0 } }, { "name": "ordering", "in": "query", "required": false, "description": "Ordem de classificação. Por padrão, o feed mostra os mais recentes primeiro (`-created_at`); passe `created_at` para lê-lo dos mais antigos para os mais recentes. Valores desconhecidos são ignorados silenciosamente (a ordem padrão é usada); outros nomes de campo do serializer também são aceitos.", "schema": { "type": "string", "default": "-created_at", "example": "created_at" } } ], "responses": { "200": { "description": "Feed de atividades paginado, das mais recentes para as mais antigas por padrão. `count` é o número total de entradas; `next` / `previous` são URLs de página prontas (`null` nas extremidades). Um `count` igual a `0` com `results` vazio significa que nenhuma atividade foi registrada ainda.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número total de entradas do feed desta sessão (em todas as páginas).", "example": 3 }, "next": { "type": "string", "nullable": true, "description": "URL da próxima página, ou `null` na última página.", "example": null }, "previous": { "type": "string", "nullable": true, "description": "URL da página anterior, ou `null` na primeira página.", "example": null }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewItem" }, "description": "Entradas do feed desta página." } } }, "examples": { "DecisionTrail": { "summary": "Aprovação manual com notas adicionadas via 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": "Primeira página com limit=2: next contém a URL da página seguinte", "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": "Sessão ainda sem atividade registrada", "value": { "count": 0, "next": null, "previous": null, "results": [] } } } } } }, "403": { "description": "`x-api-key` ausente, malformada, expirada ou revogada. A autenticação é verificada antes da busca da sessão, então uma chave ausente retorna `403` mesmo quando o UUID da sessão não existe.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "You do not have permission to perform this action." } } }, "examples": { "InvalidKey": { "summary": "Cabeçalho x-api-key ausente ou inválido", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Nenhuma sessão de Verificação de usuários (KYC) com este UUID está visível para sua aplicação: o UUID não existe, a sessão foi excluída ou pertence a outra aplicação. IDs de sessão de Verificação de empresas (KYB) também retornam `404` aqui, pois o feed de revisões só pode ser acessado para sessões de KYC.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Session not found." } } }, "examples": { "NotFound": { "summary": "UUID de sessão desconhecido, excluído ou de outra aplicação", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Limite de requisições excedido. Verifique os cabeçalhos de resposta `Retry-After` e `X-RateLimit-*`. Consulte [Limite de requisições](/pt-br/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": "Adicionar uma nota de revisão à trilha de auditoria de uma sessão", "description": "Adiciona uma nota ao feed de revisão / atividade de uma sessão de Verificação de usuários (KYC). **Este endpoint apenas registra uma entrada e nunca altera a sessão.** O `status` da sessão permanece inalterado, nenhuma validação de transição de status é executada e nenhum webhook é disparado. Para de fato aprovar, recusar ou reabrir uma sessão (o que também grava neste feed uma entrada `STATUS_UPDATED` com atribuição completa), use `PATCH /v3/session/{session_id}/update-status/`.\n\nOs dois campos do corpo são opcionais e um objeto JSON vazio é aceito. `new_status` é armazenado apenas como rótulo da entrada e aceita qualquer um dos dez valores de status de sessão (diferencia maiúsculas de minúsculas). Menções `@email` dentro de `comment` são armazenadas apenas como texto simples: elas não disparam nenhuma notificação neste endpoint, e o `mentioned_emails` da entrada permanece vazio.\n\nObservação sobre atribuição: as entradas criadas aqui não trazem nenhuma informação sobre quem as criou. No feed, elas exibem `actor_display: \"Unknown\"`, `actor_type: \"CONSOLE_USER\"` e `activity_type: \"STATUS_UPDATED\"` (valores padrão de armazenamento), e o campo `user` do corpo da resposta `201` é `\"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": "Defina como `application/json` ao enviar um corpo JSON.", "schema": { "type": "string", "example": "application/json" } }, { "name": "session_id", "in": "path", "required": true, "description": "UUID da sessão de Verificação de usuários (KYC). Deve pertencer à mesma aplicação da chave de API: UUIDs de outras aplicações, sessões excluídas e IDs de sessões de Verificação de empresas (KYB) retornam `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": "Rótulo de status opcional a ser registrado na entrada. Aceita qualquer valor de status de sessão, diferenciando maiúsculas de minúsculas (`\"approved\"` é rejeitado com `400`). Registrar um status aqui **não** altera o status real da sessão; para isso, use o endpoint de atualização de status.", "example": "In Review" }, "comment": { "type": "string", "nullable": true, "description": "Nota opcional em texto livre (sem limite de tamanho imposto). É armazenada literalmente; menções `@email` não são processadas neste endpoint.", "example": "Flagging for manual document re-check." } } }, "examples": { "NoteWithStatusLabel": { "summary": "Nota com um rótulo de status (status da sessão inalterado)", "value": { "new_status": "In Review", "comment": "Flagging for manual document re-check." } }, "CommentOnly": { "summary": "Nota simples sem rótulo de status", "value": { "comment": "Customer emailed an updated utility bill; awaiting upload." } } } } } }, "responses": { "201": { "description": "Entrada registrada na trilha de auditoria da sessão. A sessão em si não é alterada: o seu `status` mantém o valor anterior e nenhum webhook é enviado. A nova entrada também aparece no topo de `GET …/reviews/` (com `actor_display: \"Unknown\"`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "string", "description": "Nome de exibição do autor da entrada. Sempre `\"Unknown\"` para entradas criadas por este endpoint, porque ele não registra a atribuição de autoria.", "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": "O rótulo de status registrado na entrada, ou `null` se nenhum foi enviado. O status real da sessão não é afetado.", "example": "In Review" }, "comment": { "type": "string", "nullable": true, "description": "A nota registrada na entrada, ou `null` se nenhuma foi enviada.", "example": "Flagging for manual document re-check." }, "created_at": { "type": "string", "format": "date-time", "description": "Quando a entrada foi gravada, em ISO 8601 UTC.", "example": "2026-06-12T00:18:44.466537Z" } } }, "examples": { "NoteWithStatusLabel": { "summary": "Nota com um rótulo de status", "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 simples", "value": { "user": "Unknown", "new_status": null, "comment": "Note without status.", "created_at": "2026-06-12T00:18:44.504157Z" } } } } } }, "400": { "description": "Erro de validação, retornado como um mapa de mensagens por campo. A causa mais comum é um valor de `new_status` que não é um dos dez status permitidos. A verificação diferencia maiúsculas de minúsculas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "new_status": { "type": "array", "items": { "type": "string" }, "example": [ "\"approved\" is not a valid choice." ] } } }, "examples": { "InvalidStatusChoice": { "summary": "Valor de status em minúsculas / desconhecido", "value": { "new_status": [ "\"approved\" is not a valid choice." ] } } } } } }, "403": { "description": "`x-api-key` ausente, malformada, expirada ou revogada. A autenticação é verificada antes da busca da sessão, então uma chave ausente retorna `403` mesmo quando o UUID da sessão não existe.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "You do not have permission to perform this action." } } }, "examples": { "InvalidKey": { "summary": "Cabeçalho x-api-key ausente ou inválido", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Nenhuma sessão de Verificação de usuários (KYC) com este UUID está visível para sua aplicação: o UUID não existe, a sessão foi excluída ou pertence a outra aplicação. IDs de sessão de Verificação de empresas (KYB) também retornam `404` aqui, pois o feed de revisões só pode ser acessado para sessões de KYC.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "example": "Session not found." } } }, "examples": { "NotFound": { "summary": "UUID de sessão desconhecido, excluído ou de outra aplicação", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Limite de requisições excedido. Verifique os cabeçalhos de resposta `Retry-After` e `X-RateLimit-*`. Consulte [Limite de requisições](/pt-br/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": "Obter o saldo de créditos", "description": "Obtém o saldo atual de créditos pré-pagos em USD (de toda a organização) e a configuração de recarga automática. Os valores são strings decimais: faça o parsing com uma biblioteca decimal.", "operationId": "get_billing_balance", "x-didit-sdk": { "resource": "billing", "method": "retrieve_balance", "auth": "api_key", "server": true }, "tags": [ "Billing" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/billing/balance/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.billing.retrieve_balance()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.billing.retrieveBalance();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Billing.RetrieveBalance(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.billing().retrieveBalance();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "billing->retrieveBalance();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.billing.retrieve_balance\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Billing.RetrieveBalanceAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Saldo de créditos atual e a configuração de recarga automática da organização.", "content": { "application/json": { "schema": { "type": "object", "required": [ "balance", "auto_refill_enabled" ], "properties": { "balance": { "type": "string", "description": "Saldo de créditos pré-pagos atual em USD, como uma string decimal de ponto fixo. Diminui à medida que as verificações são faturadas e aumenta quando uma recarga é liquidada." }, "auto_refill_enabled": { "type": "boolean", "description": "Quando `true`, a Didit cobra automaticamente o método de pagamento salvo para adicionar créditos assim que o saldo ultrapassar `auto_refill_threshold`. Configurado em Console → Faturamento." }, "auto_refill_amount": { "type": "string", "nullable": true, "description": "Valor em USD que será cobrado e adicionado ao saldo a cada recarga automática, pelo valor nominal. Defina de \\$50 a \\$10,000 em Console → Faturamento. `null` quando a recarga automática está desativada ou não configurada." }, "auto_refill_threshold": { "type": "string", "nullable": true, "description": "Limiar de gatilho em USD. A recarga automática é acionada quando `balance` fica abaixo deste valor. `null` quando a recarga automática está desativada ou não configurada." } } }, "examples": { "Healthy balance with auto-refill": { "value": { "balance": "1234.5600", "auto_refill_enabled": true, "auto_refill_amount": "500.00", "auto_refill_threshold": "100.00" } }, "Low balance, manual top-up only": { "value": { "balance": "12.0000", "auto_refill_enabled": false, "auto_refill_amount": null, "auto_refill_threshold": null } } } } } }, "403": { "description": "Chave de API ausente, inválida ou revogada, ou a chave não pode ler dados de faturamento desta organização. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `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éditos", "description": "Adiciona créditos por meio de uma sessão hospedada do Stripe Checkout (**\\$50 a \\$10,000** por recarga). As recargas estão disponíveis nos planos Free, Growth e Scale, são adicionadas pelo valor nominal, sem desconto nem bônus, e valem por 12 meses; contratos anuais Enterprise não podem recarregar. Redirecione o cliente para a `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": 10000, "description": "Valor a cobrar, em USD. **Deve ser de 50 a 10,000.** O saldo recebe o mesmo valor, sem desconto nem bônus. O imposto é adicionado automaticamente no checkout com base no endereço de faturamento do cliente." }, "success_url": { "type": "string", "format": "uri", "description": "URL para a qual o checkout hospedado redireciona o cliente após um pagamento bem-sucedido. Atualmente, o padrão é `https://console.didit.me`. Informe explicitamente uma URL funcional; o host padrão está indisponível. Acrescente o placeholder literal `{CHECKOUT_SESSION_ID}` se quiser que o checkout hospedado o substitua pelo ID da sessão." }, "cancel_url": { "type": "string", "format": "uri", "description": "URL para a qual o checkout hospedado redireciona o cliente quando ele cancela ou fecha a janela do Checkout. Atualmente, o padrão é `https://console.didit.me`. Informe explicitamente uma URL funcional; o host padrão está indisponível." } } }, "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": "Sessão de checkout hospedada criada. Redirecione o usuário para `checkout_session_url` para concluir o pagamento.", "content": { "application/json": { "schema": { "type": "object", "required": [ "checkout_session_id", "checkout_session_url" ], "properties": { "checkout_session_id": { "type": "string", "description": "Identificador da sessão de checkout hospedada (por exemplo, `cs_test_a1B2c3...`). Útil para a conciliação no lado do servidor." }, "checkout_session_url": { "type": "string", "format": "uri", "description": "URL da página de pagamento hospedada, de uso único. Redirecione o cliente para ela para concluir o pagamento." } } }, "examples": { "Created": { "value": { "checkout_session_id": "cs_test_a1B2c3D4e5F6g7H8i9J0", "checkout_session_url": "https://checkout.example.com/c/pay/cs_test_a1B2c3D4e5F6g7H8i9J0" } } } } } }, "400": { "description": "Payload inválido: o valor está ausente, não é um número, está abaixo do mínimo de \\$50 ou acima do máximo de \\$10,000, ou a organização tem um contrato anual Enterprise. O corpo do erro é um array JSON.", "content": { "application/json": { "examples": { "Missing amount": { "value": [ "amount_in_dollars is required." ] }, "Not a number": { "value": [ "amount_in_dollars must be a number." ] }, "Below minimum": { "value": [ "Amount must be at least $50." ] }, "Above maximum": { "value": [ "Amount must be at most $10,000." ] }, "Annual plan": { "value": [ "You have an annual plan. Contact your account manager to top up." ] } } } } }, "403": { "description": "Chave de API ausente, inválida ou revogada, ou a chave não pode criar sessões de recarga para esta organização. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `Retry-After`.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/destinations/": { "get": { "summary": "Listar destinos de webhook", "description": "Lista todos os destinos do webhook (array sem paginação, do mais antigo para o mais recente). Cada item traz a configuração do destino, suas métricas de entrega dos últimos 30 dias (`metrics_window_days`), com uma entrada `daily_points` por dia, e sua saúde (`health_status`, `failing_streak`, `failing_since`, `last_success_at`). A lista não tem objeto `summary` e nunca inclui o segredo de assinatura: cada item mostra apenas `secret_last4`. Busque um único destino (`GET /v3/webhook/destinations/{destination_uuid}/`) para ler `secret_shared_key`.", "operationId": "list_webhook_destinations", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/webhook/destinations/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.list()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.list();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.List(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().list();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->list();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.webhooks.destinations.list.each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.ListAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Lista de destinos de webhook (sem paginação, os mais antigos primeiro).", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador estável do destino; use como `{destination_uuid}` para atualizar ou excluir." }, "label": { "type": "string", "description": "Nome legível exibido no Console." }, "url": { "type": "string", "format": "uri", "description": "URL de destino que recebe requisições `POST` com o payload do webhook." }, "enabled": { "type": "boolean", "description": "Quando `false`, a Didit ignora silenciosamente a entrega para este destino." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Versão do esquema de payload enviada a este destino. `v3` é o formato atual/recomendado." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" }, "subscribed_events_count": { "type": "integer", "description": "Tamanho de `subscribed_events` armazenado em cache, útil para renderizar a interface." }, "deliveries_count": { "type": "integer", "description": "Tentativas de entrega (incluindo novas tentativas) feitas para este destino nos últimos 30 dias." }, "failed_deliveries_count": { "type": "integer", "description": "Tentativas de entrega nos últimos 30 dias às quais o destino respondeu com HTTP 400 ou superior, ou não respondeu (tempo esgotado, conexão recusada ou endereço bloqueado)." }, "average_response_time_ms": { "type": "integer", "nullable": true, "description": "Tempo médio de resposta em milissegundos nos últimos 30 dias, arredondado para um número inteiro. `null` quando não houve entregas nesse período." }, "error_rate_percentage": { "type": "integer", "description": "`round(failed_deliveries_count / deliveries_count * 100)` nos últimos 30 dias; `0` quando não há entregas." }, "last_delivery_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data e hora da tentativa de entrega mais recente (com sucesso ou falha). `null` se nunca foi entregue." }, "metrics_window_days": { "type": "integer", "description": "Duração, em dias, da janela coberta por `deliveries_count`, `failed_deliveries_count`, `average_response_time_ms`, `error_rate_percentage` e `daily_points`. Sempre `30`." }, "health_status": { "type": "string", "enum": [ "healthy", "degraded", "failing" ], "description": "Saúde das entregas. `failing`: 3 ou mais eventos consecutivos falharam na primeira tentativa de entrega desde a última vez que o destino respondeu com sucesso (consulte `failing_streak`). `degraded`: não está em falha, mas uma tentativa de entrega falhou nas últimas 24 horas e nenhuma tentativa posterior entregou esse evento; uma nova tentativa ou um reenvio que o entregue remove esse estado. `healthy`: nenhum dos dois. Independe de `enabled`. Uma tentativa com falha é aquela respondida com HTTP 400 ou superior, ou que não recebeu resposta." }, "failing_streak": { "type": "integer", "description": "Quantos eventos consecutivos falharam na primeira tentativa de entrega desde a última resposta bem-sucedida do destino, nos últimos 30 dias. Novas tentativas não são contadas, e qualquer tentativa bem-sucedida, incluindo uma nova tentativa ou um reenvio, encerra a sequência. `0` quando nenhum evento falhou desde o último sucesso." }, "failing_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando foi feita a primeira tentativa com falha do `failing_streak` atual. `null` quando `failing_streak` é `0`." }, "last_success_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o destino respondeu pela última vez a uma entrega com um status HTTP abaixo de 400, nos últimos 30 dias. `null` se isso não ocorreu nesse período." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Ambiente da aplicação proprietária do destino." }, "daily_points": { "type": "array", "description": "Uma entrada por dia UTC dos últimos 30 dias, da mais antiga para a mais recente, incluindo dias sem entregas. Conta todas as tentativas, incluindo as novas tentativas.", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "O dia em UTC." }, "total_deliveries": { "type": "integer", "description": "Tentativas de entrega feitas naquele dia." }, "failed_deliveries": { "type": "integer", "description": "Tentativas feitas naquele dia que foram respondidas com HTTP 400 ou superior, ou que não foram respondidas." } } } }, "secret_last4": { "type": "string", "description": "Últimos quatro caracteres do segredo de assinatura atual do destino, para que você possa distinguir os segredos. Não é suficiente para verificar uma assinatura." }, "created_by_email": { "type": "string", "nullable": true, "description": "E-mail do membro do Business Console que criou o destino. `null` para um destino criado com uma chave de API." }, "created_by_name": { "type": "string", "nullable": true, "description": "Nome do membro do Business Console que criou o destino. `null` para um destino criado com uma chave de API." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "examples": { "Two destinations": { "value": [ { "uuid": "11111111-2222-3333-4444-555555555555", "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "enabled": true, "webhook_version": "v3", "subscribed_events": [ "status.updated", "data.updated" ], "subscribed_events_count": 2, "deliveries_count": 12453, "failed_deliveries_count": 14, "average_response_time_ms": 187, "error_rate_percentage": 0, "last_delivery_at": "2026-05-17T09:21:18Z", "metrics_window_days": 30, "health_status": "healthy", "failing_streak": 0, "failing_since": null, "last_success_at": "2026-05-17T09:21:18Z", "environment": "live", "daily_points": [ { "date": "2026-04-18", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-19", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-20", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-21", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-22", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-23", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-24", "total_deliveries": 415, "failed_deliveries": 9 }, { "date": "2026-04-25", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-26", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-27", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-28", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-29", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-04-30", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-01", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-02", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-03", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-04", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-05", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-06", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-07", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-08", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-09", "total_deliveries": 415, "failed_deliveries": 5 }, { "date": "2026-05-10", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-11", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-12", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-13", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-14", "total_deliveries": 415, "failed_deliveries": 0 }, { "date": "2026-05-15", "total_deliveries": 416, "failed_deliveries": 0 }, { "date": "2026-05-16", "total_deliveries": 416, "failed_deliveries": 0 }, { "date": "2026-05-17", "total_deliveries": 416, "failed_deliveries": 0 } ], "secret_last4": "0xnQ", "created_by_email": null, "created_by_name": null, "created_at": "2026-01-04T08:00:00Z", "updated_at": "2026-04-22T14:09:11Z" }, { "uuid": "22222222-3333-4444-5555-666666666666", "label": "Staging mirror", "url": "https://staging.yourapp.com/webhooks/didit", "enabled": false, "webhook_version": "v3", "subscribed_events": [ "status.updated" ], "subscribed_events_count": 1, "deliveries_count": 0, "failed_deliveries_count": 0, "average_response_time_ms": null, "error_rate_percentage": 0, "last_delivery_at": null, "metrics_window_days": 30, "health_status": "healthy", "failing_streak": 0, "failing_since": null, "last_success_at": null, "environment": "live", "daily_points": [ { "date": "2026-04-18", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-19", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-20", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-21", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-22", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-23", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-24", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-25", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-26", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-27", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-28", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-29", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-04-30", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-01", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-02", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-03", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-04", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-05", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-06", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-07", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-08", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-09", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-10", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-11", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-12", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-13", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-14", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-15", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-16", "total_deliveries": 0, "failed_deliveries": 0 }, { "date": "2026-05-17", "total_deliveries": 0, "failed_deliveries": 0 } ], "secret_last4": "k9Qe", "created_by_email": "reviewer@example.com", "created_by_name": "Example Reviewer", "created_at": "2026-03-12T10:15:02Z", "updated_at": "2026-03-12T10:15:02Z" } ] } } } } }, "403": { "description": "Chave de API ausente, malformada, expirada ou vinculada a outra aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Criar destino do webhook", "description": "Cria um destino do webhook. A resposta inclui o segredo de assinatura HMAC `secret_shared_key`, gerado automaticamente (também pode ser lido depois via `GET /v3/webhook/destinations/{destination_uuid}/`). Sempre envie `subscribed_events` com pelo menos um evento (sem curingas): uma lista vazia explícita é rejeitada com 400, e omitir o campo cria um destino inscrito em nada, que nunca recebe um webhook. O par `(application, url)` deve ser único entre os destinos da aplicação.", "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": "Nome legível exibido em Console → Webhooks. Ajuda a distinguir destinos quando você tem vários (por exemplo, \"Prod\", \"Staging mirror\")." }, "url": { "type": "string", "format": "uri", "description": "URL HTTPS que receberá requisições `POST`. Deve ser única entre os destinos da aplicação. Use um endpoint estável e protegido: a Didit tenta novamente as entregas com falha seguindo um cronograma de backoff.", "maxLength": 2000 }, "enabled": { "type": "boolean", "default": true, "description": "Quando `false`, o destino é salvo, mas a Didit não enviará nenhum webhook para ele. Útil para configurações de staging que você quer manter em espera." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Versão do esquema de payload que a Didit enviará. `v3` é o formato atual/recomendado; as versões anteriores são mantidas para compatibilidade com integrações legadas." }, "subscribed_events": { "allOf": [ { "$ref": "#/components/schemas/WebhookSubscribedEvents" } ], "description": "Eventos a entregar. Na prática, obrigatório: um `[]` explícito é rejeitado com 400, e omitir o campo cria um destino sem assinaturas que não recebe nada." } } }, "examples": { "session_updates": { "summary": "Atualizações de status e de dados da sessão", "value": { "label": "Production session webhooks", "url": "https://yourapp.com/webhooks/didit", "webhook_version": "v3", "subscribed_events": [ "status.updated", "data.updated" ] } }, "transaction_updates": { "summary": "Atualizações do monitoramento de transações", "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": "Atualizações de entidades de usuário e empresa", "value": { "label": "Entity lifecycle webhooks", "url": "https://yourapp.com/webhooks/didit-entities", "webhook_version": "v3", "subscribed_events": [ "user.status.updated", "user.data.updated", "business.status.updated", "business.data.updated", "activity.created" ] } } } } } }, "responses": { "201": { "description": "Destino criado. `secret_shared_key` é o segredo de assinatura HMAC: armazene-o agora.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador estável do destino. Use como `{destination_uuid}` nas chamadas seguintes." }, "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": "Segredo de assinatura HMAC gerado automaticamente e vinculado a este destino (token seguro para URL com 43 caracteres). Use-o para verificar os cabeçalhos de assinatura nos webhooks recebidos. É sempre retornado por completo para chamadores com chave de API; usuários do Console precisam da permissão `read:webhooks`, caso contrário veem uma string vazia." }, "secret_last4": { "type": "string", "description": "Últimos quatro caracteres do segredo de assinatura atual do destino, para que você possa distinguir os segredos. Não é suficiente para verificar uma assinatura." }, "previous_secret_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Definido por 24 horas após a rotação do segredo de assinatura do destino no Business Console. Até esse momento, toda entrega ao destino também inclui `X-Signature-Previous`, `X-Signature-V2-Previous` e `X-Signature-Simple-Previous`, gerados com o segredo substituído (consulte [Verificação de assinatura](/pt-br/integration/webhooks#verificação-de-assinatura)). `null` quando nenhuma rotação ocorreu nas últimas 24 horas." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" }, "created_by_email": { "type": "string", "nullable": true, "description": "E-mail do membro do Business Console que criou o destino. `null` para um destino criado com uma chave de API." }, "created_by_name": { "type": "string", "nullable": true, "description": "Nome do membro do Business Console que criou o destino. `null` para um destino criado com uma chave de API." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "health_status": { "type": "string", "enum": [ "healthy", "degraded", "failing" ], "description": "Saúde das entregas. `failing`: 3 ou mais eventos consecutivos falharam na primeira tentativa de entrega desde a última vez que o destino respondeu com sucesso (consulte `failing_streak`). `degraded`: não está em falha, mas uma tentativa de entrega falhou nas últimas 24 horas e nenhuma tentativa posterior entregou esse evento; uma nova tentativa ou um reenvio que o entregue remove esse estado. `healthy`: nenhum dos dois. Independe de `enabled`. Uma tentativa com falha é aquela respondida com HTTP 400 ou superior, ou que não recebeu resposta." }, "failing_streak": { "type": "integer", "description": "Quantos eventos consecutivos falharam na primeira tentativa de entrega desde a última resposta bem-sucedida do destino, nos últimos 30 dias. Novas tentativas não são contadas, e qualquer tentativa bem-sucedida, incluindo uma nova tentativa ou um reenvio, encerra a sequência. `0` quando nenhum evento falhou desde o último sucesso." }, "failing_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando foi feita a primeira tentativa com falha do `failing_streak` atual. `null` quando `failing_streak` é `0`." }, "last_success_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o destino respondeu pela última vez a uma entrega com um status HTTP abaixo de 400, nos últimos 30 dias. `null` se isso não ocorreu nesse período." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Ambiente da aplicação proprietária do destino." }, "summary": { "type": "object", "description": "Métricas de entrega dos últimos `metrics_window_days` (30) dias. `last_delivery_at` é a tentativa mais recente, independentemente de quando foi feita.", "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": "Duração, em dias, da janela coberta pelas demais métricas de resumo. Sempre `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": "Falha na validação. Geralmente uma URL duplicada, `subscribed_events` ausente ou inválido, ou um nome de evento desconhecido.", "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": "Chave de API ausente, malformada, expirada ou vinculada a outra aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/destinations/{destination_uuid}/": { "get": { "summary": "Obter destino do webhook", "description": "Obtenha um destino do webhook com o seu segredo de assinatura `secret_shared_key`, a sua saúde (`health_status`, `failing_streak`, `failing_since`, `last_success_at`) e um `summary` das entregas dos últimos 30 dias. Quem chama com chave de API sempre recebe o segredo completo; usuários do Console sem `read:webhooks` veem uma string vazia.", "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 do destino (o `uuid` retornado na criação ou na listagem).", "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": "Detalhes do destino do 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": "Segredo de assinatura HMAC (token seguro para URL de 43 caracteres). Sempre retornado por completo para chamadores com chave de API; usuários do Console precisam de `read:webhooks`; caso contrário, recebem uma string vazia." }, "secret_last4": { "type": "string", "description": "Últimos quatro caracteres do segredo de assinatura atual do destino, para que você possa distinguir os segredos. Não é suficiente para verificar uma assinatura." }, "previous_secret_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Definido por 24 horas após a rotação do segredo de assinatura do destino no Business Console. Até esse momento, toda entrega ao destino também inclui `X-Signature-Previous`, `X-Signature-V2-Previous` e `X-Signature-Simple-Previous`, gerados com o segredo substituído (consulte [Verificação de assinatura](/pt-br/integration/webhooks#verificação-de-assinatura)). `null` quando nenhuma rotação ocorreu nas últimas 24 horas." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" }, "created_by_email": { "type": "string", "nullable": true, "description": "E-mail do membro do Business Console que criou o destino. `null` para um destino criado com uma chave de API." }, "created_by_name": { "type": "string", "nullable": true, "description": "Nome do membro do Business Console que criou o destino. `null` para um destino criado com uma chave de API." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "health_status": { "type": "string", "enum": [ "healthy", "degraded", "failing" ], "description": "Saúde das entregas. `failing`: 3 ou mais eventos consecutivos falharam na primeira tentativa de entrega desde a última vez que o destino respondeu com sucesso (consulte `failing_streak`). `degraded`: não está em falha, mas uma tentativa de entrega falhou nas últimas 24 horas e nenhuma tentativa posterior entregou esse evento; uma nova tentativa ou um reenvio que o entregue remove esse estado. `healthy`: nenhum dos dois. Independe de `enabled`. Uma tentativa com falha é aquela respondida com HTTP 400 ou superior, ou que não recebeu resposta." }, "failing_streak": { "type": "integer", "description": "Quantos eventos consecutivos falharam na primeira tentativa de entrega desde a última resposta bem-sucedida do destino, nos últimos 30 dias. Novas tentativas não são contadas, e qualquer tentativa bem-sucedida, incluindo uma nova tentativa ou um reenvio, encerra a sequência. `0` quando nenhum evento falhou desde o último sucesso." }, "failing_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando foi feita a primeira tentativa com falha do `failing_streak` atual. `null` quando `failing_streak` é `0`." }, "last_success_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o destino respondeu pela última vez a uma entrega com um status HTTP abaixo de 400, nos últimos 30 dias. `null` se isso não ocorreu nesse período." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Ambiente da aplicação proprietária do destino." }, "summary": { "type": "object", "description": "Métricas de entrega dos últimos `metrics_window_days` (30) dias. `last_delivery_at` é a tentativa mais recente, independentemente de quando foi feita.", "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": "Duração, em dias, da janela coberta pelas demais métricas de resumo. Sempre `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": "Chave de API ausente, malformada, expirada ou vinculada a outra aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhum destino com este UUID, ou ele pertence a outra aplicação, ou foi excluído.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Atualizar destino do webhook", "description": "Atualiza um destino do webhook. **`subscribed_events` é SUBSTITUÍDO por completo, não mesclado**: busque primeiro, acrescente e reenvie. O segredo não é rotacionado. Um `uuid` no corpo é ignorado: o caminho identifica o destino.", "operationId": "update_webhook_destination", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID do destino a ser atualizado.", "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": "Novo nome legível." }, "url": { "type": "string", "format": "uri", "description": "Nova URL de destino. Deve ser única dentro da aplicação." }, "enabled": { "type": "boolean", "description": "Defina como `false` para pausar as entregas para este destino sem excluí-lo." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Nova versão do esquema do payload para entregas futuras." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" } } }, "examples": { "Pause destination": { "value": { "enabled": false } }, "Add transaction events": { "value": { "subscribed_events": [ "status.updated", "data.updated", "transaction.created", "transaction.status.updated" ] } }, "Move target URL": { "value": { "label": "Production session webhooks v2", "url": "https://api.yourapp.com/webhooks/didit/v2" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"subscribed_events\": [\n \"status.updated\",\n \"data.updated\",\n \"transaction.created\"\n ]\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.update(\n \"11111111-2222-3333-4444-555555555555\",\n enabled=False,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.update(\"11111111-2222-3333-4444-555555555555\", {\n enabled: false,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.WebhooksDestinationsUpdateParams{\n\tEnabled: didit.Bool(false),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.WebhooksDestinationsUpdateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().update(\"11111111-2222-3333-4444-555555555555\", WebhooksDestinationsUpdateParams.builder()\n .enabled(false)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->update('11111111-2222-3333-4444-555555555555', [\n 'enabled' => false,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.destinations.update(\n \"11111111-2222-3333-4444-555555555555\",\n enabled: false\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new WebhooksDestinationsUpdateParams\n{\n Enabled = false,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Destino do webhook atualizado. O corpo tem o mesmo formato de `GET /v3/webhook/destinations/{destination_uuid}/`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "enabled": { "type": "boolean" }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ] }, "secret_shared_key": { "type": "string" }, "secret_last4": { "type": "string", "description": "Últimos quatro caracteres do segredo de assinatura atual do destino, para que você possa distinguir os segredos. Não é suficiente para verificar uma assinatura." }, "previous_secret_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Definido por 24 horas após a rotação do segredo de assinatura do destino no Business Console. Até esse momento, toda entrega ao destino também inclui `X-Signature-Previous`, `X-Signature-V2-Previous` e `X-Signature-Simple-Previous`, gerados com o segredo substituído (consulte [Verificação de assinatura](/pt-br/integration/webhooks#verificação-de-assinatura)). `null` quando nenhuma rotação ocorreu nas últimas 24 horas." }, "subscribed_events": { "$ref": "#/components/schemas/WebhookSubscribedEvents" }, "created_by_email": { "type": "string", "nullable": true, "description": "E-mail do membro do Business Console que criou o destino. `null` para um destino criado com uma chave de API." }, "created_by_name": { "type": "string", "nullable": true, "description": "Nome do membro do Business Console que criou o destino. `null` para um destino criado com uma chave de API." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "health_status": { "type": "string", "enum": [ "healthy", "degraded", "failing" ], "description": "Saúde das entregas. `failing`: 3 ou mais eventos consecutivos falharam na primeira tentativa de entrega desde a última vez que o destino respondeu com sucesso (consulte `failing_streak`). `degraded`: não está em falha, mas uma tentativa de entrega falhou nas últimas 24 horas e nenhuma tentativa posterior entregou esse evento; uma nova tentativa ou um reenvio que o entregue remove esse estado. `healthy`: nenhum dos dois. Independe de `enabled`. Uma tentativa com falha é aquela respondida com HTTP 400 ou superior, ou que não recebeu resposta." }, "failing_streak": { "type": "integer", "description": "Quantos eventos consecutivos falharam na primeira tentativa de entrega desde a última resposta bem-sucedida do destino, nos últimos 30 dias. Novas tentativas não são contadas, e qualquer tentativa bem-sucedida, incluindo uma nova tentativa ou um reenvio, encerra a sequência. `0` quando nenhum evento falhou desde o último sucesso." }, "failing_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando foi feita a primeira tentativa com falha do `failing_streak` atual. `null` quando `failing_streak` é `0`." }, "last_success_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o destino respondeu pela última vez a uma entrega com um status HTTP abaixo de 400, nos últimos 30 dias. `null` se isso não ocorreu nesse período." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Ambiente da aplicação proprietária do destino." }, "summary": { "type": "object", "properties": { "total_deliveries": { "type": "integer" }, "failed_deliveries": { "type": "integer" }, "error_rate_percentage": { "type": "integer" }, "min_response_time_ms": { "type": "integer", "nullable": true }, "avg_response_time_ms": { "type": "integer", "nullable": true }, "max_response_time_ms": { "type": "integer", "nullable": true }, "last_delivery_at": { "type": "string", "format": "date-time", "nullable": true }, "metrics_window_days": { "type": "integer", "description": "Duração, em dias, da janela coberta pelas demais métricas de resumo. Sempre `30`." } }, "description": "Métricas de entrega dos últimos `metrics_window_days` (30) dias. `last_delivery_at` é a tentativa mais recente, independentemente de quando foi feita." } } }, "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": "Falha na validação (URL duplicada, lista de eventos vazia ou com eventos desconhecidos, corpo malformado).", "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": "Chave de API ausente, malformada, expirada ou vinculada a outra aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe um destino com este UUID (ou ele foi excluído, ou pertence a outra aplicação).", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Excluir destino do webhook", "description": "Exclui permanentemente um destino do webhook, o seu segredo de assinatura e todo o seu registro de entregas. Essa ação não pode ser desfeita. Nenhum novo webhook é enviado à URL do destino; outros destinos inscritos nos mesmos eventos continuam a recebê-los. Depois disso, o destino deixa de aparecer em `GET /v3/webhook/destinations/`, e todas as rotas em `/v3/webhook/destinations/{destination_uuid}/`, incluindo as suas entregas, o detalhe de uma entrega e o seu reenvio, respondem 404. O `webhook_url` legado da aplicação passa a ser a URL do destino ativado mais antigo restante, ou é limpo quando não resta nenhum destino ativado. Chamar DELETE novamente 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 do destino a ser excluído.", "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": "Destino, segredo de assinatura e registro de entregas excluídos permanentemente. Sem corpo de resposta." }, "403": { "description": "Chave de API ausente, malformada, expirada ou vinculada a outra aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhum destino com este UUID para a aplicação (já foi excluído ou nunca existiu).", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/wallet-screening/": { "post": { "summary": "Fazer a triagem de um endereço de carteira", "description": "Executa uma triagem AML sob demanda para uma única carteira/endereço cripto sem criar uma transação. Identifica o provedor de análise de blockchain configurado na sua aplicação, faz a triagem do endereço de forma síncrona e retorna o resultado de risco normalizado. LIGHTNING está disponível apenas com uma conexão BYOK da Elliptic ou da Chainalysis adicionada pelo Marketplace. Nada é gravado na tabela de transações. Um uso de monitoramento AML é cobrado por triagem bem-sucedida (aplicações de sandbox não são cobradas).", "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": "O endereço cripto ou identificador de rede a ser analisado. Deve corresponder à rede selecionada (por exemplo, um endereço com prefixo `0x` e 40 caracteres hexadecimais para redes EVM). Alias: `address`.", "example": "0x94f1b9b64e2932f6a2db338f616844400cd58e8a" }, "blockchain": { "type": "string", "description": "Identificador de rede opcional. Quando omitido, a rede é identificada pelo formato do endereço: endereços `bc1`, `1` e `3` são Bitcoin (BTC), endereços `T` são Tron (TRX) e chaves públicas base58 são Solana (SOL). Um endereço `0x` é válido em todas as redes EVM, então omitir `blockchain` para ele retorna 422 com as redes candidatas em `candidate_chains`. A triagem gerenciada oferece suporte a 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) e HBAR (Hedera). USDT e USDC são aliases legados do Ethereum, não buscas em várias redes. A cobertura de provedores conectados varia. LIGHTNING exige um provedor conectado compatível. CELO (Celo), MODE (Mode) e PLUME (Plume) são analisados por meio de uma conta TRM Labs conectada; a triagem gerenciada retorna 400 para eles. Alias: `currency`.", "enum": [ "BTC", "LIGHTNING", "ETH", "LTC", "XRP", "BCH", "DOGE", "TRX", "SOL", "MATIC", "BNB", "USDT", "USDC", "BASE", "OP", "ARB", "AVAX", "ADA", "XLM", "HBAR", "CELO", "MODE", "PLUME" ], "example": "ETH" }, "direction": { "type": "string", "description": "Opcional. Indica se o endereço está sendo analisado como contraparte de entrada (depósito) ou de saída (saque). Aceita `inbound`, `outbound`, `deposit` ou `withdrawal`. Quando omitido, o padrão é uma análise neutra pré-transferência. Esse valor é repassado ao provedor apenas como contexto; ele não altera o `risk_score`, a `severity` nem os detalhamentos `source_of_funds`/`destination_of_funds` retornados, que são sempre retornados ambos, independentemente de `direction`. Portanto, alterar ou omitir `direction` não exige analisar o endereço novamente.", "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": "O resultado normalizado da triagem de carteiras.", "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": "Erro de validação: endereço de carteira malformado, `wallet_address` ausente, `blockchain` não suportada, `blockchain` omitida para um endereço cujo formato não indica nenhuma rede, ou LIGHTNING sem uma conexão BYOK do Marketplace com Elliptic ou Chainalysis." }, "401": { "description": "`x-api-key` ausente ou inválido." }, "409": { "description": "Nenhum provedor de AML está configurado para a aplicação, ou o provedor configurado ainda não oferece suporte à triagem de carteiras. Configure primeiro o monitoramento de transações." }, "422": { "description": "`blockchain` omitido para um endereço `0x`, que todas as redes EVM compartilham. Nada é analisado nem cobrado; reenvie com `blockchain` definido como um dos valores de `candidate_chains`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "blockchain": { "type": "array", "items": { "type": "string" }, "example": [ "A 0x address is valid on every EVM chain. Send blockchain as one of: ETH, BNB, MATIC, BASE, ARB, OP, CELO, MODE, PLUME." ] }, "candidate_chains": { "type": "array", "items": { "type": "string" }, "example": [ "ETH", "BNB", "MATIC", "BASE", "ARB", "OP", "CELO", "MODE", "PLUME" ] } } } } } }, "502": { "description": "O provedor de AML não conseguiu concluir a análise. Tente novamente mais tarde." } } } }, "/v3/wallet-screening/pdf/": { "post": { "summary": "Gerar o resultado de uma triagem de carteiras em PDF", "description": "Complemento sem estado de `POST /v3/wallet-screening/`: reenvie exatamente o corpo JSON que esse endpoint retornou, incluindo a `report_signature` que ele adicionou, e receba um PDF com a marca Didit do mesmo resultado. Nenhum provedor é chamado e nada é cobrado nem armazenado; isso apenas renderiza novamente um resultado que a Didit já produziu. A assinatura vincula o PDF a um resultado não modificado: editar `risk_score`, `severity`, `sanctions_hit` ou qualquer outro campo assinado antes de reenviar resulta em falha com `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": "O objeto JSON sem modificações retornado por `POST /v3/wallet-screening/`, incluindo `report_signature`.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WalletScreeningResult" } ], "required": [ "report_signature" ], "description": "Mesmo formato da resposta de `POST /v3/wallet-screening/`: envie de volta o corpo dessa resposta literalmente, incluindo `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": "O documento PDF renderizado, retornado diretamente como binário `application/pdf`: não há wrapper JSON.", "headers": { "Content-Disposition": { "description": "`attachment; filename=wallet_screening_{address}.pdf`, derivado de `wallet_address` (ou `transaction_hash`) no resultado reenviado.", "schema": { "type": "string", "example": "attachment; filename=wallet_screening_0x28c6c06298d514db0899.pdf" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "O corpo não é um objeto JSON que corresponda ao formato do resultado da triagem de carteiras, ou `report_signature` está ausente ou não corresponde aos campos reenviados (editados ou truncados antes do reenvio).", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Not an object": { "value": { "non_field_errors": [ "Expected a JSON object matching a wallet-screening result." ] } }, "Missing or invalid signature": { "value": { "report_signature": [ "This wallet-screening result is missing or fails its report signature - repost the exact JSON returned by the wallet-screening endpoint, unmodified." ] } } } } } }, "401": { "description": "`x-api-key` ausente ou inválido." } } } }, "/v3/transactions/": { "get": { "summary": "Listar transações", "description": "Lista paginada de transações monitoradas, das mais recentes para as mais antigas (`txn_date` desc). `count` é limitado a 100; use `total_transactions` para obter o número real de linhas. Este endpoint não aceita parâmetros de filtro nem de busca.", "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": "Tamanho da página. O padrão é 50 quando omitido. Não há máximo imposto, mas mantenha as páginas pequenas para reduzir a latência." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Deslocamento, a partir de zero, do primeiro registro a retornar. Prefira seguir a URL `next` da página anterior." }, { "name": "travel_rule_status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Retorna apenas as transações cuja transferência de Travel Rule está exatamente neste status (por exemplo, `ON_HOLD` ou `AWAITING_COUNTERPARTY`). `count` segue este filtro; `total_transactions` continua contando todas as transações da aplicação." }, { "name": "assignee", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Separados por vírgula; uma transação corresponde quando atende a qualquer valor. `unassigned` é o que ninguém assumiu ainda, `rules` é o que as regras decidiram sozinhas, sem revisor, e o e-mail de um membro corresponde ao revisor atribuído. `me` é o revisor conectado ao Console, portanto uma chave de API que envia `me` recebe `400`." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.transactions.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.transactions.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Transactions.ListAutoPaging(ctx, didit.TransactionsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.transactions().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "transactions->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Transactions.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Lista paginada de resumos de transações, dos mais recentes para os mais antigos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Contagem limitada das transações correspondentes (exata até 100, limitada a partir daí). Use `total_transactions` para obter a contagem real ao paginar." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta da próxima página, ou `null` na última página." }, "previous": { "type": "string", "nullable": true, "description": "URL absoluta da página anterior, ou `null` na primeira página." }, "total_transactions": { "type": "integer", "description": "Contagem total exata de transações (não excluídas) da aplicação. Presente nas respostas paginadas." }, "results": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador estável da Didit para a transação. Use como `{transaction_id}` nas chamadas de detalhes, notas e relacionadas." }, "transaction_number": { "type": "integer", "description": "Número sequencial da transação no escopo da aplicação exibido no Console (por exemplo, `4123`)." }, "txn_id": { "type": "string", "description": "Identificador fornecido pelo cliente na chamada de criação (máximo de 128 caracteres). Único por aplicação." }, "transaction_type": { "type": "string", "description": "Categoria de nível superior, como armazenada: `finance`, `kyc`, `travelRule`, `userPlatformEvent`, `gamblingBet`, `gamblingLimitChange`, `gamblingBonusChange`, `auditTrailEvent`. Observe que valores com várias palavras são retornados em camelCase mesmo quando enviados em snake_case." }, "action_type": { "type": "string", "description": "Subtipo dentro da categoria (por exemplo `deposit`, `withdrawal`, `transfer`)." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Veredito de monitoramento atual." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Direção em relação ao titular. Armazenada em maiúsculas, independentemente da caixa usada no envio." }, "amount": { "type": "string", "description": "Valor da transação como string decimal, sem zeros à direita (por exemplo, `\"1500\"`, `\"0.5\"`, `\"0.123456789012345678\"`). Até 18 casas decimais." }, "currency": { "type": "string", "description": "Código da moeda de `amount`. Qualquer código alfabético ISO 4217 é aceito (por exemplo, `EUR`, `USD`, `NGN`), assim como um símbolo de ativo cripto (por exemplo, `BTC`). Prefira um código atualmente em circulação. Nem todo código aceito tem taxa de câmbio: quando não há nenhuma disponível para o código (por exemplo, a unidade contábil ISO `XSU` ou um símbolo cripto que a Didit não precifica), a conversão automática falha e `preferred_currency_amount` é retornado como null, a menos que a requisição tenha fornecido um `amount_in_default_currency` já convertido." }, "preferred_currency_amount": { "type": "string", "nullable": true, "description": "`amount` convertido para a moeda preferida da aplicação, quando disponível." }, "preferred_currency_code": { "type": "string", "nullable": true, "description": "Código da moeda preferencial usado em `preferred_currency_amount`: a moeda base da aplicação, qualquer código ISO 4217 atualmente em circulação. Um código sem taxa de câmbio disponível deixa `preferred_currency_amount` como null, a menos que a requisição tenha informado um `amount_in_default_currency` já convertido." }, "payment_details": { "type": "string", "nullable": true, "description": "Referência ou memorando de pagamento em texto livre do envio." }, "score": { "type": "integer", "description": "Pontuação de risco (normalmente de 0 a 100). Quanto maior, mais arriscado." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "description": "Gravidade categórica do risco definida por regras ou provedores (`UNKNOWN`, `LOW`, `MEDIUM`, `HIGH`, `CRITICAL`). `null` até que algo a defina." }, "subject_name": { "type": "string", "nullable": true, "description": "Nome completo da parte `APPLICANT`." }, "subject_vendor_data": { "type": "string", "nullable": true, "description": "Seu identificador interno de usuário/empresa para o solicitante." }, "subject_country": { "type": "string", "nullable": true, "description": "Código do país do solicitante, a partir do `address.country` enviado (normalmente ISO 3166-1 alpha-3)." }, "counterparty_name": { "type": "string", "nullable": true, "description": "Nome completo da parte `COUNTERPARTY`, se houver." }, "counterparty_vendor_data": { "type": "string", "nullable": true, "description": "Seu identificador interno para a contraparte." }, "counterparty_country": { "type": "string", "nullable": true, "description": "Código do país da contraparte, a partir do `address.country` enviado." }, "tags": { "type": "array", "description": "Tags anexadas à transação (manualmente ou por regras).", "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": "Se a tag é uma predefinição da Didit ou uma tag personalizada." } } } }, "txn_date": { "type": "string", "format": "date-time", "description": "Quando a transação ocorreu (a partir de `transaction_at` no momento da criação)." }, "created_at": { "type": "string", "format": "date-time", "description": "Quando a Didit registrou o envio." }, "decision_reason_code": { "type": "string", "nullable": true, "description": "Motivo legível por máquina do `status` atual (por exemplo, `WALLET_HIGH_RISK`)." }, "decision_reason_label": { "type": "string", "nullable": true, "description": "Rótulo legível de `decision_reason_code`." }, "assigned_to_name": { "type": "string", "nullable": true, "description": "Nome de exibição do revisor do Console atribuído a esta transação." }, "travel_rule_status": { "type": "string", "nullable": true, "description": "Status da transferência de Travel Rule da transação (por exemplo, `COMPLETED`), ou `null` quando ela não tem nenhuma." }, "travel_rule": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/TransactionTravelRule" } ], "description": "A transferência da Travel Rule da transação, o mesmo bloco que `travel_rule` em `GET /v3/transactions/{transaction_id}/`, ou `null` quando a transação não tem nenhuma." } } } } } }, "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": "Chave de API ausente, inválida ou revogada, ou a chave não pode listar transações desta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `Retry-After`.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Criar transação", "description": "Envie uma transação para monitoramento síncrono de AML/risco. A transação é criada como `APPROVED`; em seguida, suas regras (e a triagem de cripto, quando aplicável) são executadas em linha e podem alterar o `status` retornado para `IN_REVIEW` ou `DECLINED`. **`transaction_id` é sua chave de idempotência** (máx. 128 caracteres, única por aplicação); reutilizá-la retorna 400. Um webhook `transaction.created` é disparado em caso de sucesso para aplicações em produção. Aplicações sandbox não são faturadas e não emitem webhooks `transaction.created` nem `transaction.status.updated`. As trocas de Travel Rule em sandbox emitem, sim, webhooks `travel_rule.status.updated` com `environment: sandbox`. Uma transferência de Travel Rule é armazenada e retornada antes que qualquer contraparte seja contatada: `travel_rule.status` volta como `AWAITING_COUNTERPARTY` (ou `NOT_APPLICABLE` abaixo do seu limiar, `UNCONFIRMED_OWNERSHIP` para uma carteira autocustodiada declarada, `COMPLETED` quando a outra carteira é a sua própria carteira verificada) e `travel_rule.protocol` é null. Em seguida, a Didit escolhe o canal e envia a troca, e cada mudança posterior de status da transferência, incluindo `COUNTERPARTY_VASP_NOT_FOUND` quando nenhum canal alcança a contraparte, chega como um webhook `travel_rule.status.updated`. Suas regras são executadas novamente quando o canal ou o status muda.", "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": "Seu identificador exclusivo desta transação (no máximo 128 caracteres).", "example": "your-txn-2026-05-17-001" }, "transaction_at": { "type": "string", "format": "date-time", "description": "Quando a transação ocorreu. Se omitido, o padrão é o momento atual." }, "time_zone": { "type": "string", "description": "Identificador de fuso horário IANA, por exemplo `Europe/Madrid`." }, "transaction_category": { "type": "string", "description": "Categoria da transação. Aliases em CamelCase (`travelRule`, `userPlatformEvent`, `gamblingBet`, …) também são aceitos; o valor armazenado e retornado fica em camelCase para categorias com mais de uma palavra.", "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": "Detalhes financeiros principais da transação.", "required": [ "direction", "amount", "currency" ], "properties": { "direction": { "type": "string", "description": "Direção da transação em relação ao titular. Não diferencia maiúsculas de minúsculas; `in`/`out` são aceitos como aliases. Retornada em maiúsculas (`INBOUND`/`OUTBOUND`).", "example": "outbound", "enum": [ "inbound", "outbound", "in", "out" ] }, "amount": { "type": "number", "description": "Valor da transação (até 18 casas decimais). Envie-o como string decimal (por exemplo, `\"0.123456789012345678\"`) quando a precisão exata for importante: um número JSON é primeiro interpretado como float binário, então os dígitos além de cerca de 15 dígitos significativos são arredondados antes de o valor ser armazenado. Deve ser zero ou maior: a direção carrega o sinal, e um valor negativo retorna `400`.", "example": 1500 }, "currency": { "type": "string", "description": "Código da moeda. Qualquer código alfabético ISO 4217 é aceito (por exemplo, `EUR`, `USD`, `NGN`), assim como o símbolo de um criptoativo (por exemplo, `BTC`). Prefira um código atualmente em circulação. Nem todo código aceito tem uma taxa de câmbio: quando não há nenhuma disponível para o código (por exemplo, a unidade contábil ISO `XSU` ou um símbolo de criptoativo que a Didit não precifica), a conversão automática falha e `preferred_currency_amount` é retornado como null, a menos que a requisição tenha fornecido um `amount_in_default_currency` já convertido.", "example": "EUR" }, "currency_kind": { "type": "string", "description": "Se a moeda é `fiat` ou `crypto`." }, "amount_in_default_currency": { "type": "number", "nullable": true, "description": "Valor já convertido na moeda padrão. Se omitido, tenta-se a conversão cambial automática. Deve ser zero ou maior." }, "default_currency": { "type": "string", "description": "O código de moeda padrão para o valor convertido. Qualquer código ISO 4217 atualmente em circulação." }, "payment_details": { "type": "string", "nullable": true, "description": "Referência ou memorando de pagamento em texto livre." }, "payment_reference_id": { "type": "string", "nullable": true, "description": "Referência do sistema de pagamento externo. Para a triagem AML de criptomoedas por hash de transação, envie o hash da transação na blockchain e informe também `subject.payment_method.account_id` com o endereço relacionado." }, "action_type": { "type": "string", "nullable": true, "description": "Subtipo da transação, por exemplo `deposit`, `withdrawal`, `transfer`." }, "crypto_params": { "type": "object", "description": "Seleção da rede cripto, separada da moeda (o símbolo do ativo). Registrar um símbolo de token personalizado não garante cobertura de hash de transação para o respectivo contrato.", "properties": { "crypto_chain": { "type": "string", "description": "Rede efetivamente usada na triagem. A triagem gerenciada oferece suporte a 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) e HBAR (Hedera). Nomes comuns de redes também são aceitos, por exemplo POLYGON ou POL para MATIC, BSC para BNB e TRON para TRX. Sempre especifique este campo para tokens multirrede. Quando ele estiver ausente para USDT, USDC ou ETH enviados com um hash de transação 0x, a Didit procura o hash na Ethereum, BNB Chain, Polygon, Base, Arbitrum e Optimism e faz a triagem na rede onde ele for encontrado; se nenhuma rede tiver o hash, a transação não passa pela triagem e custom_values.aml_screening_status fica como FAILED, com o motivo em custom_values.aml_screening_error. Quando ele estiver ausente para USDT ou USDC triados por carteira (sem hash de transação), um endereço Tron é triado na Tron, um endereço Solana na Solana e um endereço 0x na primeira dessas seis redes em que ele tenha enviado uma transação ou detenha o token, ou na Ethereum quando não estiver ativo em nenhuma delas. A cobertura dos provedores conectados varia; LIGHTNING exige um provedor conectado compatível.", "example": "BASE" } } } } }, "subject": { "type": "object", "description": "O titular (solicitante) da transação.", "required": [ "vendor_data", "full_name" ], "properties": { "entity_type": { "type": "string", "description": "Tipo de entidade: `individual` ou `company`." }, "vendor_data": { "type": "string", "description": "Seu identificador interno de usuário/empresa.", "example": "user-12345" }, "full_name": { "type": "string", "description": "Nome completo do titular.", "example": "Maria Garcia" }, "first_name": { "type": "string", "description": "Primeiro nome do titular." }, "last_name": { "type": "string", "description": "Sobrenome do titular." }, "date_of_birth": { "type": "string", "format": "date", "description": "Data de nascimento (YYYY-MM-DD)." }, "address": { "type": "object", "description": "Objeto de endereço.", "properties": { "country": { "type": "string", "description": "Código do país (recomenda-se ISO 3166-1 alpha-3). Copiado para o `country_code` da parte." }, "town": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" }, "post_code": { "type": "string" } } }, "institution_details": { "type": "object", "description": "Dados da instituição (para titulares institucionais).", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "address": { "type": "object" } } }, "device_context": { "type": "object", "description": "Contexto do dispositivo capturado no momento da transação. browser_family e platform devem ser enviados como chaves explícitas de nível superior, pois não são derivados de user_agent. O alias em camelCase device também é aceito na requisição.", "properties": { "fingerprint": { "type": "string", "description": "Impressão digital única do dispositivo." }, "persistent_device_id": { "type": "string", "description": "Identificador estável do dispositivo entre sessões (esquema de fingerprint v2)." }, "user_agent": { "type": "string", "description": "String de user agent do navegador ou do app. Alias em CamelCase: userAgent." }, "browser_family": { "type": "string", "description": "Família do navegador (por exemplo, Chrome, Firefox, Safari). Deve ser enviada explicitamente: não é derivada de user_agent. Alias em CamelCase: browserFamily." }, "browser_version": { "type": "string", "description": "String da versão do navegador. Deve ser enviada explicitamente. Alias em CamelCase: browserVersion." }, "platform": { "type": "string", "description": "Identificador da plataforma (web, ios, android, macos, windows, linux). Deve ser enviado explicitamente: ele não é derivado de user_agent." }, "os_family": { "type": "string", "description": "Família do sistema operacional (por exemplo, iOS, Android, Windows). Alias em CamelCase: osFamily." }, "os_version": { "type": "string", "description": "String de versão do sistema operacional. Alias em CamelCase: osVersion." }, "accept_language": { "type": "string", "description": "Valor do cabeçalho Accept-Language. Alias em CamelCase: acceptLang." }, "session_id": { "type": "string", "description": "Identificador da sessão atual do usuário. Armazenado nos metadados. Alias em CamelCase: sessionId." }, "session_age_ms": { "type": "number", "description": "Duração da sessão do usuário, em milissegundos, no momento da transação. Alias em camelCase: sessionAgeMs." }, "network_context": { "type": "object", "description": "Contexto de rede com endereço IP e geolocalização. Um bloco ipInfo de nível superior também é incorporado a este objeto.", "properties": { "ip_address": { "type": "string", "description": "Endereço IP do cliente. Alias em CamelCase: ip." }, "ip_country_code": { "type": "string", "description": "País do IP resolvido por geolocalização (ISO 3166-1 alpha-3). Alias em CamelCase: countryCode3." }, "latitude": { "type": "number", "description": "Latitude geográfica do IP. Alias em CamelCase: lat." }, "longitude": { "type": "number", "description": "Longitude geográfica do IP. Alias em CamelCase: lon." } } } } }, "payment_method": { "type": "object", "description": "Meio de pagamento usado pelo titular.", "properties": { "method_type": { "type": "string", "description": "Tipo de meio de pagamento: `bank_card`, `bank_account`, `crypto_wallet`, `ewallet`, `unhosted_wallet`, `other`." }, "account_id": { "type": "string", "description": "Identificador da conta (por exemplo, IBAN, endereço de carteira). Para triagem cripto, deve conter o endereço da carteira deste participante. A triagem de entrada por hash de transação exige o endereço de depósito do serviço/cliente no titular. A triagem de saída usa a carteira de destino na contraparte. Em uma transferência cripto em bitcoin ou Lightning, pode ser uma solicitação de pagamento Lightning (fatura BOLT11, oferta BOLT12, LNURL) ou um Lightning Address: a Didit armazena como conta o recebedor que ela indica (\"\" quando não indica nenhum) e o conteúdo da solicitação em `chain_details.lightning` da transferência da Travel Rule. No máximo 255 caracteres depois de armazenado. Em uma transferência cripto em bitcoin ou Lightning, pode ser uma solicitação de pagamento Lightning (fatura BOLT11, oferta BOLT12, LNURL) ou um Lightning Address: a Didit armazena como conta o recebedor que ela indica (\"\" quando não indica nenhum) e o conteúdo da solicitação em `chain_details.lightning` da transferência da Travel Rule. No máximo 255 caracteres depois de armazenado." }, "memo": { "type": "string", "maxLength": 256, "description": "A destination tag ou o memo que faz parte da carteira em uma rede com memo (XRP, XLM, EOS, ATOM, HBAR). Em um mesmo endereço compartilhado de exchange, cada memo é um meio de pagamento próprio. XRP: uma destination tag, um número inteiro de 0 a 4294967295 (um número JSON é aceito). XLM: um memo de texto de até 28 bytes, um id de 64 bits ou um hash de 32 bytes em hexadecimal. EOS: até 256 bytes. ATOM: até 256 caracteres. HBAR: até 100 bytes. Carteiras Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin e Lightning não aceitam memo: enviar um nelas resulta em `400`. Alias: `destinationTag` ou `destination_tag`." }, "issuing_country": { "type": "string", "description": "Código ISO 3166-1 alpha-3 do país do emissor." } } } } }, "counterparty": { "type": "object", "description": "A contraparte da transação (opcional).", "properties": { "entity_type": { "type": "string", "description": "Tipo de entidade: `individual` ou `company`." }, "vendor_data": { "type": "string", "description": "Seu identificador interno para a contraparte." }, "full_name": { "type": "string", "description": "Nome completo da contraparte." }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "address": { "type": "object", "description": "Objeto de endereço com `country` (ISO 3166-1 alpha-3)." }, "institution_details": { "type": "object" }, "device_context": { "type": "object", "description": "Contexto do dispositivo da contraparte. browser_family e platform devem ser enviados como chaves explícitas de nível superior, pois não são derivados de user_agent.", "properties": { "fingerprint": { "type": "string", "description": "Impressão digital única do dispositivo." }, "persistent_device_id": { "type": "string", "description": "Identificador estável do dispositivo entre sessões (esquema de fingerprint v2)." }, "user_agent": { "type": "string", "description": "String de user agent do navegador ou do app. Alias em CamelCase: userAgent." }, "browser_family": { "type": "string", "description": "Família do navegador (por exemplo, Chrome, Firefox, Safari). Deve ser enviada explicitamente: não é derivada de user_agent. Alias em CamelCase: browserFamily." }, "browser_version": { "type": "string", "description": "String da versão do navegador. Deve ser enviada explicitamente. Alias em CamelCase: browserVersion." }, "platform": { "type": "string", "description": "Identificador da plataforma (web, ios, android, macos, windows, linux). Deve ser enviado explicitamente: ele não é derivado de user_agent." }, "os_family": { "type": "string", "description": "Família do sistema operacional (por exemplo, iOS, Android, Windows). Alias em CamelCase: osFamily." }, "os_version": { "type": "string", "description": "String de versão do sistema operacional. Alias em CamelCase: osVersion." }, "accept_language": { "type": "string", "description": "Valor do cabeçalho Accept-Language. Alias em CamelCase: acceptLang." }, "session_id": { "type": "string", "description": "Identificador da sessão da contraparte. Armazenado nos metadados. Alias em CamelCase: sessionId." }, "session_age_ms": { "type": "number", "description": "Duração da sessão do usuário, em milissegundos, no momento da transação. Alias em camelCase: sessionAgeMs." }, "network_context": { "type": "object", "description": "Contexto de rede com endereço IP e geolocalização. Um bloco ipInfo de nível superior também é incorporado a este objeto.", "properties": { "ip_address": { "type": "string", "description": "Endereço IP do cliente. Alias em CamelCase: ip." }, "ip_country_code": { "type": "string", "description": "País do IP resolvido por geolocalização (ISO 3166-1 alpha-3). Alias em CamelCase: countryCode3." }, "latitude": { "type": "number", "description": "Latitude geográfica do IP. Alias em CamelCase: lat." }, "longitude": { "type": "number", "description": "Longitude geográfica do IP. Alias em CamelCase: lon." } } } } }, "payment_method": { "type": "object", "description": "Meio de pagamento usado pela contraparte. Em transações travelRule, `method_type: \"unhosted_wallet\"` declara a carteira da contraparte como autocustodiada: a transferência ignora o roteamento para o VASP da contraparte, é criada diretamente em `UNCONFIRMED_OWNERSHIP` e (quando `auto_wallet_verification` está ativado) uma sessão do widget de propriedade da carteira é gerada automaticamente e retornada no bloco `action_required` da transação.", "properties": { "method_type": { "type": "string", "description": "Tipo de meio de pagamento: `bank_card`, `bank_account`, `crypto_wallet`, `ewallet`, `unhosted_wallet`, `other`. Use `unhosted_wallet` para declarar uma carteira autocustodiada para a Travel Rule." }, "account_id": { "type": "string", "description": "Identificador da conta (por exemplo, IBAN ou endereço de carteira). Em uma transferência cripto em bitcoin ou Lightning, pode ser uma solicitação de pagamento Lightning (fatura BOLT11, oferta BOLT12, LNURL) ou um Lightning Address: a Didit armazena como conta o recebedor que ela indica (\"\" quando não indica nenhum) e o conteúdo da solicitação em `chain_details.lightning` da transferência da Travel Rule. No máximo 255 caracteres depois de armazenado. Em uma transferência cripto em bitcoin ou Lightning, pode ser uma solicitação de pagamento Lightning (fatura BOLT11, oferta BOLT12, LNURL) ou um Lightning Address: a Didit armazena como conta o recebedor que ela indica (\"\" quando não indica nenhum) e o conteúdo da solicitação em `chain_details.lightning` da transferência da Travel Rule. No máximo 255 caracteres depois de armazenado." }, "memo": { "type": "string", "maxLength": 256, "description": "A destination tag ou o memo que faz parte da carteira em uma rede com memo (XRP, XLM, EOS, ATOM, HBAR). Em um mesmo endereço compartilhado de exchange, cada memo é um meio de pagamento próprio. XRP: uma destination tag, um número inteiro de 0 a 4294967295 (um número JSON é aceito). XLM: um memo de texto de até 28 bytes, um id de 64 bits ou um hash de 32 bytes em hexadecimal. EOS: até 256 bytes. ATOM: até 256 caracteres. HBAR: até 100 bytes. Carteiras Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin e Lightning não aceitam memo: enviar um nelas resulta em `400`. Alias: `destinationTag` ou `destination_tag`." }, "issuing_country": { "type": "string" } } } } }, "custom_properties": { "type": "object", "description": "Pares chave-valor arbitrários anexados à transação. Cada chave pode ser referenciada nas condições de regra com o caminho de campo `custom_values.`.", "additionalProperties": true, "example": { "merchant_id": "test", "bank_name": "test_2" } }, "travel_rule_details": { "type": "object", "description": "Dados da Travel Rule. Quando a Travel Rule está ativada e transaction_category é travel_rule, a própria Didit conduz a troca: ela ignora status, protocol, required e obligations_count e usa originator_data, beneficiary_data e metadata. Caso contrário, a Didit armazena esses valores como um registro passivo da Travel Rule. Enquanto a Travel Rule estiver ativada, uma transferência de saída igual ou superior ao seu limiar deve conter o que o respectivo regime exige (EU TFR ou Recomendação 16 do FATF), verificado nos lados que você envia: um campo ausente retorna 400 em `travel_rule_details.originator_data` ou `travel_rule_details.beneficiary_data`, por exemplo \"EU TFR requires the originator name.\"", "required": [ "status" ], "properties": { "status": { "type": "string", "description": "Obrigatório sempre que você enviar travel_rule_details. Um dos status de transferência da Travel Rule (por exemplo AWAITING_COUNTERPARTY, COMPLETED, NOT_APPLICABLE); grafias em minúsculas e em camelCase e os valores legados UNKNOWN, COMPLIANT, PENDING_ACTION, PENDING_COUNTERPARTY, FAILED e EXEMPT também são aceitos e mapeados. Qualquer outro valor retorna 400." }, "protocol": { "type": "string" }, "required": { "type": "boolean" }, "obligations_count": { "type": "integer" }, "originator_data": { "type": "object", "description": "Parte remetente, como campos planos ou uma pessoa IVMS 101. Para o seu usuário com uma verificação KYC aprovada, a Didit substitui os campos que a verificação contém pelos valores verificados (consulte `metadata.originator_provenance`). Deve ser um objeto: qualquer outra coisa resulta em `400`. Em uma rede com memo, uma chave `memo` indica o memo ou a tag da carteira do remetente." }, "beneficiary_data": { "type": "object", "description": "Parte beneficiária, como campos simples ou como uma pessoa IVMS 101. Deve ser um objeto: qualquer outro valor resulta em `400`. Para encaminhar a transferência, a Didit lê `wallet_address` (quando vazio, é preenchido a partir de `counterparty.payment_method.account_id`), `chain` (preenchido a partir de `transaction_details.crypto_params.crypto_chain` ou de `currency`, quando esta indica uma chain compatível), `name` (com fallback para `counterparty.full_name`), `travel_address`, `counterparty_vasp_name`, `counterparty_vasp_lei` e `counterparty_vasp_email`. Em uma rede com memo, `memo` indica o memo ou a tag da carteira do beneficiário; `wallet_address` e `memo` têm prioridade sobre o método de pagamento da contraparte." }, "metadata": { "type": "object" }, "utxo": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleUtxo" } ], "description": "Opcional, apenas para blockchains UTXO (BTC, LTC, BCH, DOGE). As entradas e saídas da transação, a partir das quais a Didit infere a carteira do remetente e a saída do beneficiário quando você não as declara." }, "originator": { "type": "object", "description": "Um bloco de remetente IVMS 101: `originatorPersons` (um `naturalPerson` ou `legalPerson`; uma pessoa jurídica faz da parte uma empresa) e `accountNumber` (endereços de carteira). Usado para `originator_data` quando esse objeto está vazio. Um bloco malformado retorna 400 identificado pelo seu caminho, por exemplo `originator.originatorPersons`." }, "beneficiary": { "type": "object", "description": "Um bloco de beneficiário IVMS 101: `beneficiaryPersons` (um `naturalPerson` ou `legalPerson`; uma pessoa jurídica faz da parte uma empresa) e `accountNumber` (endereços de carteira). Usado para `beneficiary_data` quando esse objeto está vazio. Um bloco malformado retorna 400 identificado pelo seu caminho, por exemplo `beneficiary.beneficiaryPersons`." }, "ivms101": { "type": "object", "description": "Os blocos `originator` e `beneficiary` agrupados em um único objeto IVMS 101 (`IVMS101` também é aceito). Os blocos de nível superior prevalecem sobre os do objeto agrupador." } } }, "network_snapshot": { "type": "object", "description": "Snapshot pré-calculado do grafo da rede.", "properties": { "nodes": { "type": "array", "items": { "type": "object" } }, "edges": { "type": "array", "items": { "type": "object" } }, "metrics": { "type": "object" } } }, "include_crypto_screening": { "type": "boolean", "nullable": true, "description": "Substituição por transação para a análise de blockchain de criptoativos. Quando `true`, a análise de criptoativos é realizada independentemente do padrão da aplicação. Quando `false`, a análise de criptoativos é ignorada mesmo que esteja ativada nas configurações da aplicação. Quando omitido ou `null`, é usado o padrão da aplicação configurado no Console. A análise de criptoativos exige `transaction_details.direction`, `currency_kind: \"crypto\"`, uma rede/moeda e o endereço de carteira selecionado pela direção: a análise de entrada antes da transferência usa `counterparty.payment_method.account_id`, a análise de entrada por hash de transação usa `subject.payment_method.account_id` e a análise de saída usa `counterparty.payment_method.account_id`. Quando `transaction_details.payment_reference_id` contém um hash de transação de blockchain, a Didit realiza a análise da transação e retorna o enriquecimento com o resumo da transação, quando disponível." } }, "required": [ "transaction_id", "transaction_category", "transaction_details", "subject" ] }, "examples": { "Minimal fiat withdrawal": { "summary": "Menor payload aceitável para uma transferência fiat de saída", "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": "Saque de cripto para uma carteira não hospedada, com triagem opcional (opt-in)", "value": { "transaction_id": "your-txn-2026-05-17-002", "transaction_category": "finance", "include_crypto_screening": true, "transaction_details": { "direction": "outbound", "amount": 0.5, "currency": "BTC", "currency_kind": "crypto", "amount_in_default_currency": 32500, "default_currency": "USD", "action_type": "withdrawal" }, "subject": { "entity_type": "individual", "vendor_data": "user-12345", "full_name": "Maria Garcia", "payment_method": { "method_type": "crypto_wallet", "account_id": "bc1qexampleexchangewalletaddressxyz", "issuing_country": "ESP" } }, "counterparty": { "entity_type": "individual", "payment_method": { "method_type": "unhosted_wallet", "account_id": "bc1qexampleexternalwalletaddressabc" } } } }, "Travel Rule transfer": { "summary": "Transferência de cripto de saída com dados de remetente/beneficiário da 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": "Transação enviada e monitorada. O corpo é o detalhe completo da transação (mesmo formato de `GET /v3/transactions/{transaction_id}/`), refletindo os resultados de regras já aplicados.", "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": "Falha na validação (campos obrigatórios ausentes, `transaction_id` duplicado, valor de enum desconhecido, moeda invá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": "Chave de API ausente, inválida ou revogada, ou a chave não pode enviar transações para esta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "409": { "description": "Outra requisição com o mesmo `transaction_id` criou a transação enquanto esta estava sendo processada, por isso apenas um de dois envios simultâneos é bem-sucedido. Consulte a transação existente em vez de reenviar.", "content": { "application/json": { "examples": { "Concurrent duplicate": { "value": { "detail": "A transaction with this transaction_id already exists." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `Retry-After`.", "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-didit-sdk": { "resource": "transactions", "method": "create", "auth": "api_key", "server": true } } }, "/v3/transactions/{transaction_id}/": { "get": { "summary": "Obter transação", "description": "Recupera o registro completo de monitoramento de uma transação: partes, pontuação/gravidade, execuções de regras, alertas, resultado da Travel Rule e sessão de remediação.", "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 estável da transação na Didit (o `uuid` retornado por create / list, **não** o seu `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": "Detalhes completos da transação.", "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": "Chave de API ausente, inválida ou revogada, ou a chave não pode ler as transações desta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhuma transação com este UUID na aplicação (excluída, nunca criada, pertencente a outra aplicação, ou o segmento do caminho não é um UUID válido).", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `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": "Gerar um token de transação para SDK", "description": "Gere um token com escopo e de curta duração que seu app repassa aos SDKs da Didit para que eles enviem transações diretamente do dispositivo do usuário final via `POST /v1/transactions/`. O token é vinculado a um único `vendor_data` (o ID do seu usuário): toda transação enviada com ele tem a identidade do titular imposta no servidor a partir desse vínculo, de modo que um cliente adulterado não consegue enviar transações em nome de outro usuário. Gere tokens a partir do seu backend; nunca inclua a própria chave de API em um app. Aliases em camelCase (`vendorData`, `ttlSeconds`, `maxUses`) também são aceitos.", "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": "Seu identificador interno para o usuário final ao qual este token está restrito. É aplicado como a identidade do titular de toda transação enviada com o token.", "example": "user-042" }, "ttl_seconds": { "type": "integer", "default": 900, "maximum": 86400, "description": "Tempo de vida do token em segundos. O padrão é 900 (15 minutos); o máximo é 86400 (24 horas)." }, "max_uses": { "type": "integer", "nullable": true, "description": "Número máximo de envios bem-sucedidos permitidos com este token. Omita ou use null para usos ilimitados dentro do 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": "O token emitido. Entregue o `sdk_token` ao seu app; ele autentica os endpoints voltados ao dispositivo `/v1/transactions/` por meio do cabeçalho `X-Transaction-Token` até `expires_at`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sdk_token": { "type": "string", "description": "O token de transação com escopo a ser passado ao SDK." }, "expires_at": { "type": "string", "format": "date-time", "description": "Quando o token deixa de ser aceito." } } }, "example": { "sdk_token": "q7Zt...urlsafe", "expires_at": "2026-07-07T12:15:00Z" } } } }, "400": { "description": "Falha na validação: `vendor_data` ausente ou `ttl_seconds` fora do intervalo permitido.", "content": { "application/json": { "examples": { "Missing vendor_data": { "value": { "vendor_data": [ "This field is required." ] } } } } } }, "403": { "description": "Chave de API ausente, inválida ou revogada.", "content": { "application/json": { "examples": { "Invalid API Key": { "value": { "detail": "Invalid API Key." } } } } } } } } }, "/v1/transactions/": { "post": { "summary": "Enviar uma transação a partir de um SDK", "description": "Endpoint voltado ao dispositivo que os SDKs da Didit chamam para enviar uma transação diretamente do dispositivo do usuário final. A autenticação usa um token com escopo obtido em `POST /v3/transactions/sdk-token/` e enviado no cabeçalho `X-Transaction-Token`, em vez de uma chave de API, e o endpoint tem CORS habilitado para que os navegadores possam chamá-lo a partir de outra origem. O payload usa os aliases de transmissão em camelCase mostrados abaixo (os métodos `submitTransaction` do SDK o montam para você). Três garantias no servidor: a aplicação é sempre obtida do token; a identidade do titular (`externalUserId`) é sempre imposta a partir do `vendor_data` do token, então valores falsificados no payload são ignorados; e a inteligência de dispositivo (a impressão digital do dispositivo do SDK, além do IP e do user agent derivados pelo servidor) é associada automaticamente ao titular.", "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": "Seu identificador exclusivo desta transação (mapeado para `transaction_id`, no máximo 128 caracteres).", "example": "wd-2026-07-07-0042" }, "txnDate": { "type": "string", "format": "date-time", "description": "Quando a transação ocorreu (corresponde a `transaction_at`). Se omitido, o padrão é o momento atual." }, "zoneId": { "type": "string", "description": "Identificador de fuso horário IANA (mapeado para `time_zone`), por exemplo `Europe/Madrid`." }, "type": { "type": "string", "description": "Categoria da transação (corresponde a `transaction_category`), por exemplo, `finance`, `kyc`, `travelRule`, `userPlatformEvent`, `gamblingBet`.", "example": "travelRule" }, "info": { "type": "object", "description": "Detalhes financeiros principais da transação (correspondem a `transaction_details`).", "required": [ "direction", "amount", "currency" ], "properties": { "direction": { "type": "string", "description": "Direção em relação ao titular. Não diferencia maiúsculas de minúsculas; `in`/`out` são aceitos como aliases. Retornada em maiúsculas (`INBOUND`/`OUTBOUND`).", "example": "out" }, "amount": { "type": "number", "description": "Valor da transação (até 18 casas decimais). Uma string decimal também é aceita e é a única forma de preservar mais de cerca de 15 dígitos significativos: um número JSON é primeiro interpretado como float binário, então `0.123456789012345678` é armazenado como `0.12345678901234568`.", "example": 0.25 }, "currency": { "type": "string", "description": "Código da moeda. Qualquer código alfabético ISO 4217 é aceito (por exemplo, `EUR`, `USD`, `NGN`), assim como o símbolo de um criptoativo (por exemplo, `BTC`). Prefira um código atualmente em circulação. Nem todo código aceito tem uma taxa de câmbio: quando não há nenhuma disponível para o código (por exemplo, a unidade contábil ISO `XSU` ou um símbolo de criptoativo que a Didit não precifica), a conversão automática falha e `preferred_currency_amount` é retornado como null, a menos que a requisição tenha fornecido um `amountInDefaultCurrency` já convertido.", "example": "ETH" }, "currencyType": { "type": "string", "description": "Se a moeda é `fiat` ou `crypto` (corresponde a `currency_kind`)." }, "amountInDefaultCurrency": { "type": "number", "nullable": true, "description": "Valor já convertido na moeda padrão (corresponde a `amount_in_default_currency`). Se omitido, tenta-se a conversão cambial automática." }, "defaultCurrencyCode": { "type": "string", "description": "O código de moeda padrão para o valor convertido (corresponde a `default_currency`). Qualquer código ISO 4217 atualmente em circulação." }, "paymentDetails": { "type": "string", "nullable": true, "description": "Referência ou memorando de pagamento em texto livre (mapeado para `payment_details`)." }, "paymentTxnId": { "type": "string", "nullable": true, "description": "Referência externa de pagamento (corresponde a `payment_reference_id`); o hash da transação on-chain para transações de criptomoedas." }, "type": { "type": "string", "nullable": true, "description": "Subtipo da transação (mapeado para `action_type`), por exemplo `deposit`, `withdrawal`, `transfer`." }, "cryptoParams": { "type": "object", "description": "Parâmetros específicos de cripto, por exemplo, `{\"crypto_chain\": \"ETH\"}`." } } }, "subject": { "type": "object", "description": "O titular (solicitante) da transação. `externalUserId` é ignorado aqui: a identidade do titular é sempre imposta a partir do `vendor_data` do token.", "required": [ "fullName" ], "properties": { "type": { "type": "string", "description": "Tipo de entidade (corresponde a `entity_type`): `individual` (padrão) ou `company`." }, "externalUserId": { "type": "string", "description": "Ignorado no sujeito: aplicado no servidor a partir do `vendor_data` do token." }, "fullName": { "type": "string", "example": "Jane Doe" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "dob": { "type": "string", "format": "date", "description": "Data de nascimento (YYYY-MM-DD; corresponde a `date_of_birth`)." }, "address": { "type": "object", "description": "Objeto de endereço com `country` (ISO 3166-1 alpha-3), `town`, `state`, `street`, `post_code`." }, "institutionInfo": { "type": "object", "description": "Dados da instituição para participantes institucionais (mapeados para `institution_details`)." }, "device": { "type": "object", "description": "Contexto de dispositivo explícito e opcional. É mesclado com a inteligência de dispositivo capturada automaticamente; em caso de conflito, prevalecem os campos derivados pelo servidor." }, "paymentMethod": { "type": "object", "description": "Meio de pagamento usado pelo titular (corresponde a `payment_method`).", "properties": { "type": { "type": "string", "description": "Tipo de meio de pagamento (corresponde a `method_type`), por exemplo `bank_card`, `bank_account`, `crypto_wallet`, `ewallet`, `unhosted_wallet`, `other`." }, "accountId": { "type": "string", "description": "Identificador da conta (corresponde a `account_id`): IBAN, impressão digital do cartão ou endereço de carteira." }, "issuingCountry": { "type": "string", "description": "Código ISO 3166-1 alpha-3 do país do emissor (corresponde a `issuing_country`)." } } } } }, "counterparty": { "type": "object", "description": "A contraparte da transação (opcional). Mesmo formato de `subject`; aqui `externalUserId` tem significado.", "properties": { "type": { "type": "string", "description": "Tipo de entidade (corresponde a `entity_type`): `individual` ou `company`." }, "externalUserId": { "type": "string", "description": "Seu identificador interno para a contraparte (corresponde a `vendor_data`)." }, "fullName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "dob": { "type": "string", "format": "date" }, "address": { "type": "object" }, "institutionInfo": { "type": "object" }, "device": { "type": "object" }, "paymentMethod": { "type": "object", "description": "Meio de pagamento usado pela contraparte (corresponde a `payment_method`). Em transações travelRule, `type: \"unhosted_wallet\"` declara a carteira da contraparte como autocustodiada: a transferência ignora o roteamento para o VASP da contraparte, é criada diretamente em `UNCONFIRMED_OWNERSHIP` e (quando `auto_wallet_verification` está ativado) uma sessão do widget de propriedade da carteira é gerada automaticamente e retornada em `action_required` para que o SDK possa iniciá-la.", "properties": { "type": { "type": "string", "description": "Tipo de meio de pagamento (corresponde a `method_type`), por exemplo `bank_card`, `bank_account`, `crypto_wallet`, `ewallet`, `unhosted_wallet`, `other`. Use `unhosted_wallet` para declarar uma carteira autocustodiada para a Travel Rule." }, "accountId": { "type": "string", "description": "Identificador da conta (corresponde a `account_id`): IBAN, impressão digital do cartão ou endereço de carteira." }, "issuingCountry": { "type": "string" } } } } }, "props": { "type": "object", "additionalProperties": true, "description": "Pares de chave-valor personalizados (mapeados para `custom_properties`). Cada chave pode ser referenciada nas condições de regras como `custom_values.`." }, "travelRule": { "type": "object", "description": "Detalhes da Travel Rule (mapeados para `travel_rule_details`). Quando a Travel Rule está ativada para a aplicação, a Didit ignora qualquer `status` que você enviar e conduz a troca por conta própria.", "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": "Substituição por transação para a análise de blockchain de criptoativos (corresponde a `include_crypto_screening`)." }, "fingerprint_v2": { "type": "object", "description": "O payload de impressão digital do dispositivo `didit-fp-v2`. É injetado automaticamente pelos SDKs; relevante apenas ao chamar a API wire diretamente." } }, "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": "Transação enviada e monitorada. Mesmo formato de detalhe de `GET /v3/transactions/{transaction_id}/`, incluindo o bloco `action_required` quando o usuário final precisa concluir uma ação complementar (por padrão, os SDKs a iniciam automaticamente).", "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": "Falha na validação (campos obrigatórios ausentes, `txnId` duplicado, categoria desconhecida).", "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": "O token de transação foi rejeitado: ausente, desconhecido, revogado, acima do seu `max_uses` ou expirado. Respostas de token expirado sempre contêm a palavra `expired` no detalhe, e é assim que os SDKs distinguem erros `expired_token` de erros `invalid_token`.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "Invalid transaction token." } }, "Expired token": { "value": { "detail": "Transaction token expired." } } } } } }, "409": { "description": "Outra requisição com o mesmo `txnId` criou a transação enquanto esta estava sendo processada, por isso apenas um de dois envios simultâneos é bem-sucedido. Consulte a transação existente em vez de reenviar.", "content": { "application/json": { "examples": { "Concurrent duplicate": { "value": { "detail": "A transaction with this transaction_id already exists." } } } } } } } } }, "/v1/transactions/{transaction_id}/": { "get": { "summary": "Obter uma transação de um SDK", "description": "Endpoint de leitura voltado ao dispositivo, autenticado com o mesmo `X-Transaction-Token` usado no envio. Os SDKs o consultam periodicamente depois que um fluxo de ação iniciado automaticamente é concluído ou que sua janela é fechada, de modo que o estado final nunca dependa de uma única notificação. Retorna o mesmo detalhe da transação que a resposta do envio, incluindo o bloco `action_required` atual (`null` quando a ação é resolvida).", "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 estável da transação na Didit (o `uuid` da resposta de envio, **não** o seu `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": "O detalhe completo da transação, incluindo `action_required` (`null` assim que a ação pendente for resolvida).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetail" } } } }, "401": { "description": "O token de transação foi rejeitado: ausente, desconhecido, revogado, acima do seu `max_uses` ou expirado.", "content": { "application/json": { "examples": { "Expired token": { "value": { "detail": "Transaction token expired." } } } } } }, "404": { "description": "Não existe nenhuma transação com este UUID para a aplicação do token, ou o segmento do caminho não é um UUID válido.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } } } } }, "/v3/businesses/": { "get": { "summary": "Listar empresas", "description": "Lista as [empresas](/entities/businesses) que a Didit monta a partir de sessões KYB que compartilham o mesmo `vendor_data` (string de formato livre, NÃO um UUID), além das empresas criadas pela API. Paginado e ordenado por `last_session_at` em ordem decrescente. Este endpoint não aceita parâmetros de filtro nem de busca: busque as páginas e filtre no lado do cliente.", "operationId": "list_businesses", "x-didit-sdk": { "resource": "businesses", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Businesses" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "description": "Tamanho da página. O padrão é 50 quando omitido. Não há máximo imposto, mas mantenha as páginas pequenas para reduzir a latência." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Deslocamento, a partir de zero, do primeiro registro a retornar. Prefira seguir a URL `next` da página anterior em vez de calcular este valor manualmente." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/businesses/?limit=50' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.businesses.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.businesses.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Businesses.ListAutoPaging(ctx, didit.BusinessesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.businesses().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "businesses->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.businesses.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Businesses.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Lista paginada de empresas com status, contagem de sessões e detalhamento por recurso.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número de linhas correspondentes: exato até 100 e limitado a 100 acima disso, por desempenho. Não o use para detectar a última página; considere `next` igual a `null`." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta da próxima página, ou `null` na última página." }, "previous": { "type": "string", "nullable": true, "description": "URL absoluta da página anterior, ou `null` na primeira 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": "Chave de API ausente, inválida ou revogada, ou a chave não pode listar empresas desta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/customization/": { "get": { "summary": "Obter a personalização da marca", "description": "Retorna a identidade visual de marca própria da aplicação identificada pela chave de API: cores, fontes, raios de borda, URLs de logotipo e opções de UI/UX. As configurações de domínio personalizado e de e-mail de marca própria são gerenciadas somente no Business Console e não fazem parte desta 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": "Personalização de marca atual da aplicação.", "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": "Chave de API ausente, malformada, expirada ou vinculada a outra aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições excedido. Tente novamente com backoff exponencial." } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Atualizar a personalização da marca", "description": "Atualização parcial da identidade visual de marca própria da aplicação. Envie `application/json` para alterar cores, fontes, raios e opções de interface, ou `multipart/form-data` para enviar imagens de logotipo. Apenas os campos incluídos são alterados. Domínio personalizado e e-mail de marca própria não podem ser definidos por este endpoint; use o Business Console para isso.", "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": "Alterar cores e fonte da marca", "value": { "color_primary": "#123456", "color_button_1": "#2567FF", "font_family": "AR One Sans", "border_radius_buttons": 16 } }, "Update UI options": { "summary": "Alterar nome público e opções do fluxo", "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": "Excluir o logotipo retangular atual", "value": { "delete_logo_rectangular": true } }, "Remove the dark-mode logo": { "summary": "Excluir o logotipo atual do modo escuro", "value": { "delete_logo_rectangular_dark": true } } } }, "multipart/form-data": { "schema": { "type": "object", "description": "Use multipart/form-data apenas para enviar imagens de logotipo. Os campos de identidade visual acima também podem ser enviados como campos de formulário na mesma requisição.", "properties": { "image_square": { "type": "string", "format": "binary", "description": "Logotipo quadrado (proporção 1:1). PNG, JPG ou WebP, com pelo menos 512 px no lado maior e no máximo **1 MB**." }, "image_rectangular": { "type": "string", "format": "binary", "description": "Logo retangular (proporção 2:1). PNG, JPG ou WebP, com pelo menos 512 px no lado maior e no máximo **1 MB**." }, "image_rectangular_dark": { "type": "string", "format": "binary", "description": "Logo retangular para o modo escuro (proporção 2:1), exibido sobre fundo escuro. PNG, JPG ou WebP, com pelo menos 512 px no lado maior e no máximo **1 MB**. Retornado como `logo_rectangular_dark`." }, "image_favicon": { "type": "string", "format": "binary", "description": "Imagem do favicon. Máximo de **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": "Identidade visual atualizada. O objeto de identidade visual COMPLETO é retornado (todos os campos, não apenas os que você alterou).", "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": "Corpo inválido. Por exemplo: uma cor hexadecimal malformada, uma família ou peso de fonte desconhecido, um campo exclusivo do Business Console (`domain`, `from_email`, `verify_domain`, `force_remove_domain`, `verify_email_domain`, `force_remove_email_domain` e seus campos complementares somente leitura), ou um upload de logo que não é uma imagem PNG, JPG ou WebP, tem menos de 512 px no lado maior, tem mais de 1 MB ou tem a proporção errada. Também retornado ao definir `disable_login_with_didit` como `false` enquanto um domínio personalizado está configurado.", "content": { "application/json": { "examples": { "Bad color": { "value": { "color_primary": [ "Invalid color format. Use '#RRGGBB' or '#RRGGBBAA' format." ] } }, "Bad logo": { "value": { "image_rectangular": [ "Image aspect ratio must be 2:1. Got 1024x1024 image dimensions" ] } }, "Unsupported logo format": { "summary": "Não é uma imagem PNG, JPG ou WebP (um SVG, por exemplo)", "value": { "image_rectangular_dark": [ "Upload a PNG, JPG or WebP image." ] } }, "Logo too small": { "summary": "Menos de 512 px no lado maior", "value": { "image_rectangular": [ "Image must be at least 512 px on its long side. Got 400x200 image dimensions" ] } }, "Logo too large": { "summary": "Acima de 1 MB", "value": { "image_square": [ "File size should not exceed 1 MB" ] } }, "Console-only field": { "value": { "domain": [ "Manage this field in the Business Console." ] } }, "Bad font weight": { "value": { "font_weight": [ "Font weight 950 is not available for Inter. Available weights are: 100, 200, 300, 400, 500, 600, 700, 800, 900" ] } } } } } }, "403": { "description": "Chave de API ausente, malformada, expirada ou vinculada a outra aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Invalid token": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições excedido. Tente novamente com backoff exponencial." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/businesses/{vendor_data}/": { "get": { "summary": "Obter empresa", "description": "Obtenha uma [empresa](/entities/businesses) por `vendor_data` (correspondência exata). Acrescenta `metadata` e `updated_at` aos dados da visualização em lista. Empresas excluídas retornam 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": "Seu identificador exclusivo da empresa: uma string livre (NÃO um UUID), comparada exatamente como enviada.", "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": "Detalhes completos da empresa, incluindo metadados e dados agregados das sessões.", "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": "Chave de API ausente, inválida ou revogada, ou a chave não pode ler as empresas desta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhuma empresa (não excluída) com o `vendor_data` informado para esta aplicação.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Atualizar empresa", "description": "Atualização parcial de uma empresa: `display_name`, `legal_name`, `registration_number`, `country_code`, `status`, `metadata`. `metadata` é substituído por completo. Definir `status` como `BLOCKED` adiciona o `vendor_data` à lista de bloqueio do sistema; sair de `BLOCKED` remove essa entrada. Toda edição é registrada na atividade da empresa: uma mudança de status com o `reason` opcional, e uma alteração em `display_name`, `legal_name`, `registration_number`, `country_code` ou `metadata` como atualização 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": "Seu identificador exclusivo da empresa (string livre, NÃO um UUID).", "example": "company-123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Corpo de atualização parcial. Informe apenas os campos que deseja alterar.", "properties": { "display_name": { "type": "string", "nullable": true, "description": "Nome de exibição amigável mostrado no console (tem prioridade sobre `legal_name` na exibição da interface)." }, "legal_name": { "type": "string", "nullable": true, "description": "Razão social oficial obtida do registro de empresas ou inserida manualmente." }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registro ou de constituição da empresa." }, "country_code": { "type": "string", "nullable": true, "description": "País de constituição (ISO 3166-1 alpha-2, por exemplo, `GB`, `US`)." }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Status do ciclo de vida da empresa. Definir `BLOCKED` adiciona automaticamente o `vendor_data` à lista de bloqueio do sistema; mudar de `BLOCKED` para outro status remove essa entrada da lista de bloqueio." }, "metadata": { "type": "object", "nullable": true, "description": "Objeto JSON arbitrário que você anexa à empresa. **Substitui totalmente** os metadados existentes na atualização — faça a mesclagem no lado do cliente se quiser apenas adicionar chaves." }, "reason": { "type": "string", "nullable": true, "maxLength": 1000, "description": "Por que o status mudou. Registrado na entrada de mudança de status em **Activity** da empresa no Business Console, apenas quando o status realmente muda. Os webhooks não o incluem." } } }, "examples": { "Update name": { "summary": "Atualizar nome de exibição", "value": { "display_name": "Acme Corp" } }, "Flag for review": { "summary": "Alterar status", "value": { "status": "FLAGGED" } }, "Add metadata": { "summary": "Substituir o JSON de metadados", "value": { "metadata": { "industry": "fintech", "risk_level": "low" } } }, "Fix registry data": { "summary": "Corrigir campos extraídos", "value": { "legal_name": "Acme Trading International Ltd", "registration_number": "12345678", "country_code": "GB" } }, "Flag with reason": { "summary": "Sinalizar a empresa e registrar o motivo", "value": { "status": "FLAGGED", "reason": "Ownership structure under review" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/businesses/company-123/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"display_name\": \"Acme Corp\", \"status\": \"FLAGGED\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.businesses.update(\n \"company-123\",\n display_name=\"Acme Corp\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.businesses.update(\"company-123\", {\n display_name: \"Acme Corp\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.Update(ctx, \"company-123\", didit.BusinessesUpdateParams{\n\tDisplayName: didit.String(\"Acme Corp\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BusinessesUpdateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.businesses().update(\"company-123\", BusinessesUpdateParams.builder()\n .displayName(\"Acme Corp\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->update('company-123', [\n 'display_name' => 'Acme Corp',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.businesses.update(\n \"company-123\",\n display_name: \"Acme Corp\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.UpdateAsync(\"company-123\", new BusinessesUpdateParams\n{\n DisplayName = \"Acme Corp\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Empresa atualizada. Retorna o registro completo e atualizado da 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": "Corpo inválido: normalmente um `status` desconhecido, `metadata` malformado ou um `reason` com mais de 1000 caracteres.", "content": { "application/json": { "examples": { "Bad status": { "value": { "status": [ "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" ] } }, "Bad metadata": { "value": { "metadata": [ "Metadata must be a JSON object." ] } }, "Reason too long": { "value": { "reason": [ "Ensure this field has no more than 1000 characters." ] } } } } } }, "403": { "description": "Chave de API ausente, inválida ou revogada, ou a chave não pode atualizar empresas desta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhuma empresa (não excluída) com o `vendor_data` informado para esta aplicação.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `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": "Atualizar status da empresa", "description": "Altera apenas o `status` de ciclo de vida de uma empresa: `ACTIVE`, `FLAGGED` ou `BLOCKED` (não os status de sessão). `BLOCKED` adiciona o `vendor_data` à lista de bloqueio do sistema; sair de `BLOCKED` remove essa entrada. Cada alteração é registrada na atividade da empresa, com o `reason` opcional. Enviar o status atual não altera nada e não registra nenhum `reason`. O webhook `business.status.updated` não inclui o `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": "Seu identificador exclusivo da empresa (string livre, NÃO um UUID).", "example": "company-123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntityStatusUpdateRequest" }, { "type": "object", "properties": { "reason": { "type": "string", "nullable": true, "maxLength": 1000, "description": "Por que o status mudou. Registrado na entrada de mudança de status em **Activity** da empresa no Business Console, apenas quando o status realmente muda. Os webhooks não o incluem." } } } ] }, "examples": { "Flag": { "summary": "Sinalizar a empresa para revisão", "value": { "status": "FLAGGED" } }, "Block": { "summary": "Bloquear a empresa (adiciona à lista de bloqueio do sistema)", "value": { "status": "BLOCKED" } }, "Reactivate": { "summary": "Reativar a empresa", "value": { "status": "ACTIVE" } }, "Block with reason": { "summary": "Bloquear a empresa e registrar o motivo", "value": { "status": "BLOCKED", "reason": "Registry shows the company dissolved" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/businesses/company-123/update-status/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"status\": \"BLOCKED\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.businesses.update_status(\n \"company-123\",\n status=\"FLAGGED\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.businesses.updateStatus(\"company-123\", {\n status: \"FLAGGED\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.UpdateStatus(ctx, \"company-123\", didit.BusinessesUpdateStatusParams{\n\tStatus: \"FLAGGED\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BusinessesUpdateStatusParams;\nimport me.didit.types.EntityStatusUpdateRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.businesses().updateStatus(\"company-123\", BusinessesUpdateStatusParams.builder()\n .status(EntityStatusUpdateRequest.Status.of(\"FLAGGED\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->updateStatus('company-123', [\n 'status' => 'FLAGGED',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.businesses.update_status(\n \"company-123\",\n status: \"FLAGGED\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.UpdateStatusAsync(\"company-123\", new BusinessesUpdateStatusParams\n{\n Status = \"FLAGGED\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Status da empresa atualizado. Retorna o registro completo da empresa.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessDetailItem" }, "examples": { "Blocked": { "value": { "didit_internal_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890", "vendor_data": "company-123", "display_name": null, "legal_name": "Acme Trading Ltd", "registration_number": "12345678", "country_code": "GB", "effective_name": "Acme Trading Ltd", "status": "BLOCKED", "session_count": 2, "approved_count": 1, "declined_count": 0, "in_review_count": 1, "features": { "KYB": "Approved" }, "features_list": [ { "feature": "KYB", "status": "Approved" } ], "last_session_at": "2026-03-15T10:30:00Z", "last_activity_at": "2026-03-15T10:30:00Z", "first_session_at": "2026-01-10T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "name": "VIP", "color": "#2567FF" } ], "created_at": "2026-01-10T08:00:00Z", "metadata": { "industry": "fintech" }, "updated_at": "2026-03-15T10:30:00Z" } } } } } }, "400": { "description": "`status` ausente ou inválido, ou um `reason` com mais de 1000 caracteres.", "content": { "application/json": { "examples": { "Missing status": { "value": { "status": [ "This field is required." ] } }, "Bad status": { "value": { "status": [ "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" ] } }, "Reason too long": { "value": { "reason": [ "Ensure this field has no more than 1000 characters." ] } } } } } }, "403": { "description": "Chave de API ausente, inválida ou revogada, ou a chave não pode atualizar empresas desta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhuma empresa (não excluída) com o `vendor_data` informado para esta aplicação.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `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": "Excluir empresas em lote", "description": "**Exclui permanentemente** empresas — isso não pode ser desfeito. Para bloquear, prefira [Atualizar status da empresa](#patch-/v3/businesses/-vendor_data-/update-status/) com `BLOCKED`.\n\n**Relatórios regulatórios protocolados:** se os dados selecionados estiverem em um relatório regulatório finalizado, a requisição inteira é recusada com `409` e nada é excluído. O corpo usa `code: in_filed_report` e identifica cada relatório com `uuid`, `report_number`, `report_type` e `case_uuid`. Exclua os relatórios e repita a requisição.", "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": "Informe `vendor_data_list`, `didit_internal_id_list` ou `delete_all: true`. Precedência quando vários são enviados: `delete_all` > `vendor_data_list` > `didit_internal_id_list` (somente o seletor de maior precedência é usado).", "properties": { "vendor_data_list": { "type": "array", "items": { "type": "string" }, "description": "Seus próprios identificadores a excluir, comparados exatamente como enviados." }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "UUIDs internos da Didit (`didit_internal_id`) a excluir." }, "delete_all": { "type": "boolean", "default": false, "description": "Se `true`, exclui todas as empresas da aplicação. Não pode ser combinado com os seletores de lista." } } }, "examples": { "Specific businesses": { "summary": "Excluir por vendor_data", "value": { "vendor_data_list": [ "company-123", "company-456" ] } }, "Specific internal IDs": { "summary": "Excluir por didit_internal_id", "value": { "didit_internal_id_list": [ "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "b2c3d4e5-f6a7-8901-bcde-f12345678901" ] } }, "All businesses": { "summary": "Excluir todas as empresas desta aplicação", "value": { "delete_all": true } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/businesses/delete/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"vendor_data_list\": [\"company-123\", \"company-456\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.businesses.batch_delete(\n vendor_data_list=[\"company-123\", \"company-456\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.businesses.batchDelete({\n vendor_data_list: [\"company-123\", \"company-456\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.BatchDelete(ctx, didit.BusinessesBatchDeleteParams{\n\tVendorDataList: didit.Some([]string{\"company-123\", \"company-456\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.BusinessesBatchDeleteParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.businesses().batchDelete(BusinessesBatchDeleteParams.builder()\n .vendorDataList(List.of(\"company-123\", \"company-456\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->batchDelete([\n 'vendor_data_list' => ['company-123', 'company-456'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.businesses.batch_delete(vendor_data_list: [\"company-123\", \"company-456\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.BatchDeleteAsync(new BusinessesBatchDeleteParams\n{\n VendorDataList = new string[] { \"company-123\", \"company-456\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Empresas excluídas. Retorna o número de linhas efetivamente removidas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "integer", "description": "Número de empresas excluídas (não inclui valores de vendor_data que não corresponderam a nada)." } } }, "examples": { "Deleted some": { "value": { "deleted": 2 } }, "Nothing matched": { "value": { "deleted": 0 } } } } } }, "400": { "description": "Nenhum seletor foi informado (`vendor_data_list`, `didit_internal_id_list` e `delete_all` estão todos ausentes ou vazios). O corpo do erro é um array JSON.", "content": { "application/json": { "examples": { "Missing selector": { "value": [ "Provide vendor_data_list, didit_internal_id_list, or set delete_all=true." ] } } } } }, "403": { "description": "Chave de API ausente, inválida ou revogada, ou a chave não pode excluir empresas desta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `Retry-After`.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "detail": "Request was throttled. Expected available in 30 seconds." } } } } } }, "409": { "description": "A seleção inclui uma empresa em um relatório regulatório finalizado. Nada é excluído.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InFiledReportError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/users/aml-monitoring/": { "post": { "summary": "Ativar ou desativar o monitoramento AML contínuo para usuários", "description": "Ativa ou desativa o monitoramento contínuo AML para os usuários selecionados, com a mesma semântica do Business Console. Exatamente uma análise AML monitorada é mantida por usuário, de modo que um perfil verificado várias vezes é monitorado e cobrado uma única vez; a desativação desliga o monitoramento em todas as análises do perfil. Usuários sem nenhuma análise AML são analisados primeiro (cobrados como uma Análise AML comum) quando têm o nome completo, a data de nascimento e o país necessários; caso contrário, são reportados como `skipped_no_identity_data`.\n\nDefina `estimate_only: true` para visualizar contagens e custos sem gravar nada. Seleções de 20 perfis ou menos são resolvidas imediatamente e retornam `200` com o job concluído; seleções maiores retornam `202` e são executadas em segundo plano. Consulte periodicamente [Obter job de monitoramento AML](#get-/v3/aml-monitoring/jobs/-job_id-/) com o `job_id` retornado. A ativação é recusada com `403` quando o saldo da organização não cobre a estimativa. Identificadores sem correspondência são listados em `unmatched` e nunca fazem a requisição falhar: uma seleção sem nenhuma correspondência é concluída como um job vazio (`total` 0), a mesma convenção dos endpoints de exclusão em lote.", "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": "Selecione usuários com `vendor_data_list`, `didit_internal_id_list` ou ambos (as duas listas são combinadas com OR). No máximo 1000 identificadores por requisição, somando as duas listas.", "properties": { "is_enabled": { "type": "boolean", "description": "true para ativar o monitoramento, false para desativá-lo." }, "estimate_only": { "type": "boolean", "default": false, "description": "Quando verdadeiro, retorna a estimativa de custo e não realiza nenhuma gravação: sem triagem, sem faturamento, sem tarefa." }, "vendor_data_list": { "type": "array", "items": { "type": "string" }, "description": "Seus próprios identificadores dos usuários a alternar, comparados exatamente como enviados." }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs internos da Didit dos usuários cujo status será alternado: o `didit_internal_id` retornado pelos endpoints de criação, consulta e listagem." } } }, "examples": { "Estimate first": { "summary": "Pré-visualizar o custo sem gravar", "value": { "is_enabled": true, "estimate_only": true, "vendor_data_list": [ "user-123", "user-456" ] } }, "Enable": { "summary": "Ativar o monitoramento para dois usuários", "value": { "is_enabled": true, "vendor_data_list": [ "user-123", "user-456" ] } }, "Disable": { "summary": "Desativar o monitoramento pelo ID interno da 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": "A estimativa (quando `estimate_only` é true) ou o job concluído para uma seleção processada na própria requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLMonitoringToggleResult" } } } }, "202": { "description": "Seleções maiores são executadas em segundo plano. Consulte periodicamente o endpoint do job com `job_id`; `results` é preenchido à medida que os perfis são processados.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLMonitoringJob" } } } }, "400": { "description": "Erro de validação: `is_enabled` ausente, nenhum seletor ou mais de 1000 identificadores somando as duas listas." }, "401": { "description": "Chave de API ausente ou inválida." }, "403": { "description": "Saldo insuficiente para habilitar o monitoramento desta seleção. A resposta inclui a `estimate` para que você possa recarregar o valor correto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "estimate": { "type": "object", "description": "Prévia de custo. Retornada diretamente quando estimate_only é true (nada é gravado).", "properties": { "users_total": { "type": "integer", "description": "Perfis correspondentes à seleção." }, "already_enabled": { "type": "integer", "description": "Perfis já monitorados (nada a fazer ao ativar; são estes que a desativação desliga)." }, "with_existing_aml": { "type": "integer", "description": "Perfis cuja análise AML existente passará a ser monitorada (sem nova análise)." }, "needing_screening": { "type": "integer", "description": "Perfis sem nenhuma análise AML, que serão analisados primeiro (cobrado como uma análise AML comum)." }, "skipped_no_identity_data": { "type": "integer", "description": "Perfis que não podem ser analisados porque faltam dados de identidade." }, "skipped_blocked": { "type": "integer", "description": "Usuários bloqueados que serão ignorados (sempre 0 para empresas)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Custo único das novas análises." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Custo anual de monitoramento dos perfis que passarão a ser monitorados." }, "balance_sufficient": { "type": "boolean", "description": "Se o saldo da organização cobre a triagem mais o primeiro ano de monitoramento." } } } } } } } } } } }, "/v3/businesses/aml-monitoring/": { "post": { "summary": "Ativar ou desativar o monitoramento AML contínuo para empresas", "description": "Ativa ou desativa o monitoramento contínuo AML para as empresas selecionadas, com a mesma semântica do Business Console. Exatamente uma análise AML monitorada é mantida por empresa, de modo que um perfil verificado várias vezes é monitorado e cobrado uma única vez; a desativação desliga o monitoramento em todas as análises do perfil. Empresas sem nenhuma análise AML são analisadas primeiro (cobradas como uma Análise AML comum) quando têm a razão social ou o nome de exibição necessário; caso contrário, são reportadas como `skipped_no_identity_data`.\n\nDefina `estimate_only: true` para visualizar contagens e custos sem gravar nada. Seleções de 20 perfis ou menos são resolvidas imediatamente e retornam `200` com o job concluído; seleções maiores retornam `202` e são executadas em segundo plano. Consulte periodicamente [Obter job de monitoramento AML](#get-/v3/aml-monitoring/jobs/-job_id-/) com o `job_id` retornado. A ativação é recusada com `403` quando o saldo da organização não cobre a estimativa. Identificadores sem correspondência são listados em `unmatched` e nunca fazem a requisição falhar: uma seleção sem nenhuma correspondência é concluída como um job vazio (`total` 0), a mesma convenção dos endpoints de exclusão em lote.", "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": "Selecione empresas com `vendor_data_list`, `didit_internal_id_list` ou ambos (as duas listas são combinadas com OR). No máximo 1000 identificadores por requisição, somando as duas listas.", "properties": { "is_enabled": { "type": "boolean", "description": "true para ativar o monitoramento, false para desativá-lo." }, "estimate_only": { "type": "boolean", "default": false, "description": "Quando verdadeiro, retorna a estimativa de custo e não realiza nenhuma gravação: sem triagem, sem faturamento, sem tarefa." }, "vendor_data_list": { "type": "array", "items": { "type": "string" }, "description": "Seus próprios identificadores das empresas a alternar, comparados exatamente como enviados." }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "IDs internos da Didit das empresas cujo status será alternado: o `didit_internal_id` retornado pelos endpoints de criação, consulta e listagem." } } }, "examples": { "Estimate first": { "summary": "Pré-visualizar o custo sem gravar", "value": { "is_enabled": true, "estimate_only": true, "vendor_data_list": [ "company-123", "company-456" ] } }, "Enable": { "summary": "Ativar o monitoramento para duas empresas", "value": { "is_enabled": true, "vendor_data_list": [ "company-123", "company-456" ] } }, "Disable": { "summary": "Desativar o monitoramento pelo ID interno da 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": "A estimativa (quando `estimate_only` é true) ou o job concluído para uma seleção processada na própria requisição.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLMonitoringToggleResult" } } } }, "202": { "description": "Seleções maiores são executadas em segundo plano. Consulte periodicamente o endpoint do job com `job_id`; `results` é preenchido à medida que os perfis são processados.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AMLMonitoringJob" } } } }, "400": { "description": "Erro de validação: `is_enabled` ausente, nenhum seletor ou mais de 1000 identificadores somando as duas listas." }, "401": { "description": "Chave de API ausente ou inválida." }, "403": { "description": "Saldo insuficiente para habilitar o monitoramento desta seleção. A resposta inclui a `estimate` para que você possa recarregar o valor correto.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "estimate": { "type": "object", "description": "Prévia de custo. Retornada diretamente quando estimate_only é true (nada é gravado).", "properties": { "users_total": { "type": "integer", "description": "Perfis correspondentes à seleção." }, "already_enabled": { "type": "integer", "description": "Perfis já monitorados (nada a fazer ao ativar; são estes que a desativação desliga)." }, "with_existing_aml": { "type": "integer", "description": "Perfis cuja análise AML existente passará a ser monitorada (sem nova análise)." }, "needing_screening": { "type": "integer", "description": "Perfis sem nenhuma análise AML, que serão analisados primeiro (cobrado como uma análise AML comum)." }, "skipped_no_identity_data": { "type": "integer", "description": "Perfis que não podem ser analisados porque faltam dados de identidade." }, "skipped_blocked": { "type": "integer", "description": "Usuários bloqueados que serão ignorados (sempre 0 para empresas)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Custo único das novas análises." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Custo anual de monitoramento dos perfis que passarão a ser monitorados." }, "balance_sufficient": { "type": "boolean", "description": "Se o saldo da organização cobre a triagem mais o primeiro ano de monitoramento." } } } } } } } } } } }, "/v3/aml-monitoring/jobs/{job_id}/": { "get": { "summary": "Obter um job de monitoramento AML contínuo", "description": "Status, contadores de resultado e resultados por registro de um job de ativação/desativação do monitoramento iniciado a partir de `POST /v3/users/aml-monitoring/` ou `POST /v3/businesses/aml-monitoring/`. Consulte a cada poucos segundos enquanto `status` for `PENDING` ou `PROCESSING`; `results` está completo quando ele for `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": "O `job_id` retornado pelo endpoint de alternância." } ], "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": "A tarefa.", "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 quando o job ativa o monitoramento, false quando o desativa." }, "target_type": { "type": "string", "enum": [ "user", "business" ], "description": "Qual família de perfis a tarefa ativa ou desativa." }, "total": { "type": "integer", "description": "Perfis que o job processa." }, "processed": { "type": "integer", "description": "Perfis processados até agora." }, "outcomes": { "type": "object", "description": "Contadores de resultado por registro. Cada perfil selecionado corresponde a exatamente um contador; nada é ignorado silenciosamente.", "properties": { "enabled": { "type": "integer", "description": "Monitoramento ativado em uma análise AML existente." }, "screened_and_enabled": { "type": "integer", "description": "Uma nova análise AML foi criada (cobrada) e o monitoramento foi ativado nela." }, "already_enabled": { "type": "integer", "description": "O monitoramento já estava ativo; nada foi alterado e nada foi cobrado." }, "disabled": { "type": "integer", "description": "Monitoramento desativado em todas as análises AML do perfil." }, "skipped_no_identity_data": { "type": "integer", "description": "Ignorado: o perfil não tem o nome completo, a data de nascimento e o país (usuários) ou um nome (empresas) necessários para a análise." }, "skipped_blocked": { "type": "integer", "description": "Ignorado: o usuário está bloqueado." }, "skipped_sandbox": { "type": "integer", "description": "Ignorado: aplicação de sandbox, nenhuma análise é criada." }, "failed_provider": { "type": "integer", "description": "Não foi possível concluir a análise; tente novamente mais tarde." }, "failed_insufficient_balance": { "type": "integer", "description": "O saldo acabou enquanto a tarefa estava em execução." } } }, "results": { "type": "array", "description": "Uma entrada por perfil processado, na ordem de processamento. Cresce enquanto o job é executado; fica completa quando o status é COMPLETED. Registrado para jobs iniciados pela API; um job iniciado pelo Business Console informa apenas contadores.", "items": { "type": "object", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "ID interno da Didit para o perfil." }, "vendor_data": { "type": "string", "nullable": true, "description": "Seu próprio identificador para o 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": "Mensagem genérica de falha quando o status é FAILED; a causa detalhada é mantida no lado da plataforma." }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true } } } } } }, "401": { "description": "Chave de API ausente ou inválida." }, "404": { "description": "Job não encontrado para esta aplicação." } } } }, "/v3/users/{vendor_data}/update-status/": { "patch": { "summary": "Atualizar status do usuário", "description": "Altera apenas o `status` de ciclo de vida de um usuário: `ACTIVE`, `FLAGGED` ou `BLOCKED` (não os status de sessão). `BLOCKED` adiciona o `vendor_data` à lista de bloqueio do sistema; sair de `BLOCKED` remove essa entrada. Cada alteração é registrada como uma atividade `STATUS_CHANGED` no usuário, com o `reason` opcional como seu `comment`. Enviar o status atual não altera nada e não registra nenhum `reason`. O webhook `user.status.updated` não inclui o `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": "Seu identificador exclusivo do usuário." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntityStatusUpdateRequest" }, { "type": "object", "properties": { "reason": { "type": "string", "nullable": true, "maxLength": 1000, "description": "Por que o status mudou. Registrado na entrada de mudança de status na atividade do usuário (`comments[].comment` e **Activity** no Business Console), apenas quando o status realmente muda. Os webhooks não o incluem." } } } ] }, "examples": { "Activate": { "summary": "Reativar o usuário", "value": { "status": "ACTIVE" } }, "Flag": { "summary": "Sinalizar o usuário para revisão", "value": { "status": "FLAGGED" } }, "Block": { "summary": "Bloquear o usuário (adiciona à lista de bloqueio do sistema)", "value": { "status": "BLOCKED" } }, "Block with reason": { "summary": "Bloquear o usuário e registrar o motivo", "value": { "status": "BLOCKED", "reason": "Chargeback fraud pattern confirmed" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/update-status/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"status\": \"BLOCKED\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.users.update_status(\n \"user-123\",\n status=\"ACTIVE\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.users.updateStatus(\"user-123\", {\n status: \"ACTIVE\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.UpdateStatus(ctx, \"user-123\", didit.UsersUpdateStatusParams{\n\tStatus: \"ACTIVE\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.EntityStatusUpdateRequest;\nimport me.didit.types.UsersUpdateStatusParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.users().updateStatus(\"user-123\", UsersUpdateStatusParams.builder()\n .status(EntityStatusUpdateRequest.Status.of(\"ACTIVE\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->updateStatus('user-123', [\n 'status' => 'ACTIVE',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.users.update_status(\n \"user-123\",\n status: \"ACTIVE\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Users.UpdateStatusAsync(\"user-123\", new UsersUpdateStatusParams\n{\n Status = \"ACTIVE\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Status do usuário atualizado. Retorna o registro completo do usuário.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailItem" }, "examples": { "Blocked": { "value": { "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418", "vendor_data": "user-abc-123", "display_name": null, "full_name": "John Michael Doe", "date_of_birth": "1990-05-15", "effective_name": "John Michael Doe", "status": "BLOCKED", "metadata": { "tier": "premium", "source": "website" }, "portrait_image_url": "https:///...", "session_count": 3, "approved_count": 2, "declined_count": 0, "in_review_count": 1, "issuing_states": [ "USA" ], "approved_emails": [ "john@example.com" ], "approved_phones": [ "+14155551234" ], "features": { "ID_VERIFICATION": "Approved", "LIVENESS": "Approved", "FACE_MATCH": "Approved", "AML": "Approved" }, "features_list": [ { "feature": "ID_VERIFICATION", "status": "Approved" }, { "feature": "LIVENESS", "status": "Approved" }, { "feature": "FACE_MATCH", "status": "Approved" }, { "feature": "AML", "status": "Approved" } ], "last_session_at": "2025-06-15T10:30:00Z", "last_activity_at": "2025-06-15T10:30:00Z", "first_session_at": "2025-06-01T08:00:00Z", "tags": [ { "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "tag": { "uuid": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b", "name": "VIP", "color": "#2567FF", "description": null, "source": "custom", "created_at": "2025-05-01T09:00:00Z", "updated_at": "2025-05-01T09:00:00Z" }, "added_by_email": "analyst@acme.com", "added_by_name": "Jane Analyst", "created_at": "2025-06-02T11:00:00Z" } ], "comments": [ { "uuid": "c1111111-2222-4333-8444-555555555555", "comment_type": "STATUS_CHANGED", "comment": "Chargeback fraud pattern confirmed", "actor_email": null, "actor_name": null, "previous_status": "ACTIVE", "new_status": "BLOCKED", "previous_value": null, "new_value": null, "changed_fields": [], "metadata": null, "mentioned_emails": [], "created_at": "2025-06-15T10:30:00Z" } ], "created_at": "2025-06-01T08:00:00Z", "updated_at": "2025-06-15T10:30:00Z" } } } } } }, "400": { "description": "`status` ausente ou inválido, ou um `reason` com mais de 1000 caracteres.", "content": { "application/json": { "examples": { "Missing status": { "value": { "status": [ "This field is required." ] } }, "Bad status": { "value": { "status": [ "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" ] } }, "Reason too long": { "value": { "reason": [ "Ensure this field has no more than 1000 characters." ] } } } } } }, "401": { "description": "Nenhuma credencial fornecida. Requisições para caminhos `/v3/users/*` sem um cabeçalho `x-api-key` (ou token `Authorization: Bearer`) são rejeitadas pelo middleware de autenticação antes de chegarem à API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "A chave não pode atualizar usuários desta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhum usuário (não excluído) com o `vendor_data` informado para esta aplicação.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `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": "Criar empresa", "description": "Cria previamente uma [empresa](/entities/businesses) *sem* uma sessão KYB. Todos os campos são opcionais, mas você deve sempre enviar `vendor_data`: sem ele, o registro não pode ser vinculado a sessões nem a transações. Quando informado, `vendor_data` deve ser único entre as empresas não excluídas (correspondência exata; conflitos retornam 400). Não é idempotente.", "operationId": "create_business", "x-didit-sdk": { "resource": "businesses", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Businesses" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Seu identificador exclusivo desta empresa (string livre, NÃO um UUID). Opcional, mas fortemente recomendado. Quando informado, deve ser único entre as empresas não excluídas da aplicação; comparado exatamente como enviado." }, "display_name": { "type": "string", "nullable": true, "maxLength": 255, "description": "Nome de exibição amigável mostrado no console (tem prioridade sobre `legal_name` na exibição da interface)." }, "legal_name": { "type": "string", "nullable": true, "maxLength": 255, "description": "Razão social oficial da empresa." }, "registration_number": { "type": "string", "nullable": true, "maxLength": 100, "description": "Número de registro ou de constituição da empresa." }, "country_code": { "type": "string", "nullable": true, "maxLength": 10, "description": "País de constituição (ISO 3166-1 alpha-2, por exemplo, `GB`, `US`)." }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "default": "ACTIVE", "description": "Status inicial do ciclo de vida. O padrão é `ACTIVE`." }, "metadata": { "type": "object", "nullable": true, "description": "Objeto JSON arbitrário que você anexa à empresa. O padrão é `{}`." } } }, "examples": { "Basic": { "summary": "Mínimo recomendado", "value": { "vendor_data": "company-456", "legal_name": "New Corp Ltd", "country_code": "US" } }, "Full": { "summary": "Todos os campos", "value": { "vendor_data": "company-789", "display_name": "New Corp", "legal_name": "New Corp International Ltd", "registration_number": "98765432", "country_code": "DE", "status": "ACTIVE", "metadata": { "industry": "fintech", "tier": "enterprise" } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/businesses/create/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"vendor_data\": \"company-456\", \"legal_name\": \"New Corp Ltd\", \"country_code\": \"US\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.businesses.create(\n vendor_data=\"company-456\",\n legal_name=\"New Corp Ltd\",\n country_code=\"US\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.businesses.create({\n vendor_data: \"company-456\",\n legal_name: \"New Corp Ltd\",\n country_code: \"US\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.Create(ctx, didit.BusinessesCreateParams{\n\tVendorData: didit.String(\"company-456\"),\n\tLegalName: didit.String(\"New Corp Ltd\"),\n\tCountryCode: didit.String(\"US\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.BusinessesCreateParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.businesses().create(BusinessesCreateParams.builder()\n .vendorData(\"company-456\")\n .legalName(\"New Corp Ltd\")\n .countryCode(\"US\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->create([\n 'vendor_data' => 'company-456',\n 'legal_name' => 'New Corp Ltd',\n 'country_code' => 'US',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.businesses.create(\n vendor_data: \"company-456\",\n legal_name: \"New Corp Ltd\",\n country_code: \"US\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.CreateAsync(new BusinessesCreateParams\n{\n VendorData = \"company-456\",\n LegalName = \"New Corp Ltd\",\n CountryCode = \"US\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Empresa criada. Retorna o registro completo da empresa (mesmo formato de Get Business).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessDetailItem" }, "examples": { "Created": { "value": { "didit_internal_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890", "vendor_data": "company-456", "display_name": null, "legal_name": "New Corp Ltd", "registration_number": null, "country_code": "US", "effective_name": "New Corp Ltd", "status": "ACTIVE", "session_count": 0, "approved_count": 0, "declined_count": 0, "in_review_count": 0, "features": {}, "features_list": [], "last_session_at": null, "last_activity_at": "2026-03-15T10:30:00Z", "first_session_at": null, "tags": [], "created_at": "2026-03-15T10:30:00Z", "metadata": {}, "updated_at": "2026-03-15T10:30:00Z" } } } } } }, "400": { "description": "Corpo inválido: normalmente um `vendor_data` duplicado, um `status` desconhecido ou `metadata` malformado.", "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": "Chave de API ausente, inválida ou revogada, ou a chave não pode criar empresas para esta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `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": "Criar usuário", "description": "Cria um [usuário](/entities/users) por `vendor_data`, antes de uma sessão de verificação ou sem ela. `vendor_data` deve ser único entre os usuários da aplicação (um valor duplicado retorna `400`). Não é idempotente.\n\n**Dados de contato:** `email` e `phone_number` são armazenados em `metadata.contact`, e `country` em `metadata.address`. Quando você envia `first_name` ou `last_name` sem `full_name`, a Didit os une em `full_name`.\n\n**Link de verificação:** com `send_verification_link: true`, a Didit também cria uma sessão de verificação para a pessoa no `workflow_id` e envia o link por e-mail para `email`. A sessão executa as mesmas verificações de [Criar sessão](/pt-br/sessions-api/create-session), como a lista de bloqueio e o seu saldo de créditos. A pessoa e a sessão são criadas juntas ou não são criadas: se qualquer verificação falhar, nada é gravado e nenhum e-mail é enviado. O `verification_link` da resposta descreve a sessão e é `null` quando você não solicita um link.\n\n**Acesso por chave de API:** uma chave de API com escopo precisa de permissão de escrita em `users`. Com `send_verification_link: true`, ela também precisa de permissão de escrita em `sessions`, ou a chamada responde `403` antes de qualquer gravação. Chaves com acesso total não são afetadas. Consulte [Chaves de API](/pt-br/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": "Seu identificador exclusivo deste usuário (string livre, NÃO um UUID). Deve ser único entre os usuários da aplicação; comparado exatamente como enviado." }, "full_name": { "type": "string", "nullable": true, "maxLength": 512, "description": "Nome legal completo do usuário." }, "display_name": { "type": "string", "nullable": true, "description": "Nome de exibição amigável mostrado no console (tem prioridade sobre `full_name` na exibição da interface).", "maxLength": 255 }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Data de nascimento no formato `YYYY-MM-DD`." }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "default": "ACTIVE", "description": "Status inicial do ciclo de vida. O padrão é `ACTIVE`." }, "metadata": { "type": "object", "nullable": true, "description": "Objeto JSON arbitrário que você anexa ao usuário. O padrão é `{}`." }, "approved_emails": { "type": "array", "items": { "type": "string" }, "description": "Endereços de e-mail pré-confiáveis deste usuário, por exemplo `[\"john@example.com\"]`." }, "approved_phones": { "type": "array", "items": { "type": "string" }, "description": "Números de telefone pré-confiáveis deste usuário, por exemplo `[\"+14155551234\"]`." }, "issuing_states": { "type": "array", "items": { "type": "string" }, "description": "Países emissores pré-registrados (ISO 3166-1 alpha-3), por exemplo `[\"USA\"]`." }, "first_name": { "type": "string", "maxLength": 255, "description": "Nome próprio. Quando `full_name` não é enviado, a Didit junta `first_name` e `last_name` com um espaço em `full_name`. Não é retornado como um campo separado." }, "last_name": { "type": "string", "maxLength": 255, "description": "Sobrenome. Combinado com `first_name` em `full_name` quando `full_name` não é enviado. Não é retornado como campo separado." }, "email": { "type": "string", "format": "email", "description": "E-mail de contato, armazenado em `metadata.contact.email` (substitui um `email` que você envie dentro de `metadata.contact`). Obrigatório quando `send_verification_link` é `true`: o link é enviado para este endereço. Se `metadata.contact` não for um objeto JSON, a chamada responde `400` neste campo." }, "phone_number": { "type": "string", "maxLength": 32, "description": "Número de telefone de contato, armazenado em `metadata.contact.phone_number`. Se `metadata.contact` não for um objeto JSON, a chamada responde `400` neste campo." }, "country": { "type": "string", "maxLength": 3, "description": "País como código ISO 3166, alpha-2 ou alpha-3 (`ES` ou `ESP`). Armazenado em maiúsculas em `metadata.address.country`. Se `metadata.address` não for um objeto JSON, a chamada responde `400` neste campo." }, "send_verification_link": { "type": "boolean", "default": false, "description": "Quando `true`, a Didit cria uma sessão de verificação para a pessoa no `workflow_id` e envia o link por e-mail para `email`. Exige `email` e `workflow_id`. Uma chave de API com escopo também precisa de permissão de escrita em `sessions`." }, "workflow_id": { "type": "string", "format": "uuid", "description": "O fluxo da sessão de verificação. Obrigatório quando `send_verification_link` é `true`. Ele deve verificar uma pessoa: um fluxo de Verificação de empresas (KYB) é recusado. Ignorado caso contrário." }, "language": { "type": "string", "maxLength": 10, "description": "Idioma do e-mail de verificação, como um código de [idioma suportado](/pt-br/integration/supported-languages). Inglês quando omitido. Ignorado quando `send_verification_link` não é `true`." } } }, "examples": { "Basic": { "summary": "Criar com informações básicas", "value": { "vendor_data": "user-abc-123", "full_name": "John Doe" } }, "Full": { "summary": "Todos os campos", "value": { "vendor_data": "user-abc-456", "full_name": "Jane Smith", "display_name": "Jane S.", "date_of_birth": "1990-05-15", "status": "ACTIVE", "metadata": { "tier": "premium", "source": "api" }, "approved_emails": [ "jane@example.com" ] } }, "Contact details": { "summary": "Nome, e-mail, telefone e 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": "Criar a pessoa e enviar a ela um link de verificação por e-mail", "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": "Usuário criado. O registro completo do usuário (mesmo formato de Get User), mais `verification_link`: a sessão de verificação que a Didit enviou por e-mail quando `send_verification_link` era `true`; caso contrário, `null`.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserDetailItem" }, { "type": "object", "required": [ "verification_link" ], "properties": { "verification_link": { "type": "object", "nullable": true, "description": "A sessão de verificação que a Didit criou e enviou por e-mail à pessoa. Sempre presente: `null` quando `send_verification_link` não era `true`.", "required": [ "session_id", "session_number", "status", "url", "workflow_id", "email" ], "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID da sessão de verificação." }, "session_number": { "type": "integer", "description": "Número sequencial da sessão dentro da sua aplicação." }, "status": { "type": "string", "description": "Status da sessão; `Not Started` para uma sessão que acabou de ser criada." }, "url": { "type": "string", "format": "uri", "description": "O link de verificação que a Didit enviou por e-mail à pessoa." }, "workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "O fluxo que a sessão executa." }, "email": { "type": "string", "format": "email", "description": "O endereço para o qual o link foi enviado." } } } } } ] }, "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": "Corpo inválido, indexado por campo: normalmente um `vendor_data` duplicado, um campo obrigatório ausente ou um valor malformado. Com `send_verification_link: true`, também um `email` ou `workflow_id` ausente, um fluxo desconhecido ou de Verificação de empresas (KYB), um `language` não suportado (indexado como `contact_details.email_lang`), um `vendor_data` na lista de bloqueio ou créditos insuficientes para iniciar a sessão. Nada é gravado.", "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": "Nenhuma credencial fornecida. Requisições para caminhos `/v3/users/*` sem um cabeçalho `x-api-key` (ou token `Authorization: Bearer`) são rejeitadas pelo middleware de autenticação antes de chegarem à API.", "content": { "application/json": { "examples": { "Missing credentials": { "value": { "detail": "You must be authenticated with a valid access token to access this endpoint." } } } } } }, "403": { "description": "Chave de API inválida ou revogada, ou a chave não pode criar usuários para esta aplicação. Uma chave de API com escopo precisa de permissão de escrita em `users`, e também de escrita em `sessions` quando `send_verification_link` é `true`; nada é gravado. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } }, "No sessions write": { "summary": "Chave com escopo solicita um link de verificação sem sessions write", "value": { "detail": "This API key has no write access to sessions." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente após o intervalo indicado em `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": "Enviar rosto do usuário", "description": "Anexe uma imagem facial importada e confiável a um perfil de User existente. Use isto depois de criar ou obter um User por `vendor_data` e ler o seu `didit_internal_id`. O rosto enviado é armazenado no perfil do User e indexado para detecção de duplicatas e busca facial. Ele não é adicionado a uma lista de bloqueio 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 da organização proprietária da aplicação." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação à qual o perfil do Usuário pertence." }, { "name": "didit_internal_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID interno do usuário na Didit, retornado como `didit_internal_id` por `GET /v3/users/{vendor_data}/` e `POST /v3/users/create/`." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "image" ], "properties": { "image": { "type": "string", "format": "byte", "description": "Imagem facial bruta em JPG ou PNG codificada em base64. Não inclua o prefixo `data:image/...;base64,`. Tamanho máximo decodificado: 2 MB." }, "comment": { "type": "string", "description": "Nota opcional visível para o operador sobre o rosto enviado.", "default": "" } } }, "examples": { "Imported face": { "summary": "Anexar um rosto importado de um provedor 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": "Rosto enviado e vinculado ao perfil do usuário.", "content": { "application/json": { "schema": { "type": "object", "required": [ "uuid", "image_url", "comment", "uploaded_by", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID do registro facial de usuário enviado." }, "image_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL assinada da imagem de rosto enviada." }, "comment": { "type": "string", "nullable": true, "description": "Comentário fornecido quando o rosto foi enviado." }, "uploaded_by": { "type": "string", "nullable": true, "description": "E-mail ou identificador do ator que fez o upload, quando disponível." }, "created_at": { "type": "string", "format": "date-time", "description": "Data e hora do upload." } } }, "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": "Corpo da requisição ou imagem inválidos. Causas comuns: base64 inválido, imagem inválida, nenhum rosto detectável, imagem com mais de 2 MB, embedding ausente ou o usuário já tem 5 rostos enviados.", "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": "Chave de API ausente ou inválida.", "content": { "application/json": { "examples": { "Missing key": { "value": { "detail": "Authentication credentials were not provided." } } } } } }, "403": { "description": "A credencial é válida, mas não pode gravar perfis de usuário para esta aplicação.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não existe nenhum usuário com esse `didit_internal_id` na aplicação.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Not found." } } } } } }, "429": { "description": "Limite de requisições excedido; aguarde e tente novamente.", "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": "Atualizar os dados de KYC extraídos do documento de identidade em uma sessão de verificação", "description": "Corrija os campos de identidade extraídos (OCR / NFC) do documento de identidade do usuário, como nomes, datas e números de documento lidos incorretamente, depois que a verificação tiver sido concluída. Normalmente, quem faz a chamada é um analista de conformidade trabalhando no seu próprio back office ou um job automatizado de conciliação. Todos os campos do corpo são opcionais: somente as chaves enviadas são gravadas, e todo o resto permanece inalterado (semântica de `PATCH`).\n\nA sessão deve pertencer à sua aplicação e estar no status `Approved`, `Declined`, `In Review` ou `Kyc Expired`. Sessões em qualquer outro estado (por exemplo, ainda `In Progress`) retornam `404` com `\"No Session matches the given query.\"`, diferente do `\"Not found.\"` retornado para um `sessionId` desconhecido ou excluído. A sessão também deve ter um registro de verificação de identidade (KYC): sessões cujo fluxo nunca executou uma etapa de verificação de identidade retornam `404` (`\"The session does not have a KYC.\"`). Em fluxos baseados em grafo com várias etapas de verificação de identidade, indique uma etapa específica com `node_id` (parâmetro de query ou campo do corpo); quando omitido, o registro de KYC mais recente é atualizado.\n\nDois campos derivados são recalculados a cada chamada: `full_name` (a partir de `first_name` + `last_name`) e `issuing_state_name` (a partir de `issuing_state`). Se o `address` em texto livre mudar, o servidor também pode geocodificá-lo novamente e atualizar `parsed_address` (isso não ocorre em sessões de sandbox). `extra_fields` e `parsed_address` são mesclados chave por chave em vez de substituídos; consulte as descrições de cada campo para a semântica de `null` para excluir.\n\nEnviar pelo menos um campo válido dispara o [webhook](/pt-br/integration/webhooks) `data.updated` (gatilho `manual_review`), mesmo quando os valores enviados são iguais aos armazenados. Quando os valores realmente mudam, uma entrada de atividade `KYC_DATA_UPDATED`, que registra os campos alterados com os valores anteriores e os novos, é adicionada aos `reviews` da sessão e fica visível em [Obter decisão](#get-/v3/session/-sessionId-/decision/) e na linha do tempo de atividades do console. O status e a decisão da sessão **não** são reavaliados; use [Atualizar status](#patch-/v3/session/-sessionId-/update-status/) para alterar o resultado. Um corpo JSON vazio (`{}`) é aceito e simplesmente retorna os dados de KYC atuais, sem disparar o webhook.\n\nAceita uma chave de API ou um token de usuário do console; em ambos os casos, a credencial precisa da permissão `write:sessions`. Falhas de autenticação e de permissão retornam `403`: esta API nunca responde `401`. Observe que a busca da sessão é executada antes da verificação das credenciais, portanto um `sessionId` desconhecido retorna `404` mesmo sem credenciais. Este endpoint tem um limite de requisições próprio de 10 requisições por minuto por chave de API (requisições inválidas também contam); o limite compartilhado de escrita de 300 requisições por minuto também se 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 da sessão de Verificação de usuários (KYC) cujos dados extraídos do documento você está corrigindo. IDs de sessões de empresa (KYB) não são válidos aqui; para dados da empresa, use [Atualizar dados da empresa no KYB](#patch-/v3/session/-sessionId-/kyb/-companyUuid-/update-data/).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nó do grafo do fluxo cujo registro de KYC deve ser atualizado, para fluxos baseados em grafo com várias etapas de verificação de identidade (também aceito como campo `node_id` no corpo). Quando omitido, o registro de KYC mais recente da sessão é atualizado. Se não houver KYC para o nó informado, a chamada 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": "Todos os campos são opcionais: envie apenas o que você quer alterar.", "properties": { "document_type": { "type": "string", "description": "Código do tipo de documento. Aceita os códigos curtos listados no enum, além de seis aliases por extenso normalizados no servidor antes da validação: `Passport` → `P`, `Identity Card` → `ID`, `Driver's License` → `DL`, `Residence Permit` → `RP`, `Health Insurance Card` → `HIC`, `Tax Card` → `TC`. Qualquer outro valor (incluindo `PASSPORT` em maiúsculas) 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": "Subtipo do documento conforme o registro de documentos, incluindo o prefixo de região quando o registro distingue variantes regionais." }, "document_number": { "type": "string", "maxLength": 255, "nullable": true, "description": "Número do documento conforme impresso no documento de identidade.", "example": "PAB123456" }, "personal_number": { "type": "string", "maxLength": 255, "nullable": true, "description": "Número de identificação pessoal / nacional, quando o documento traz um (por exemplo, o DNI espanhol em um passaporte).", "example": "99999999R" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Data de nascimento em `YYYY-MM-DD`. Qualquer outro formato retorna `400`.", "example": "1980-01-01" }, "date_of_issue": { "type": "string", "format": "date", "nullable": true, "description": "Data de emissão do documento em `YYYY-MM-DD`." }, "expiration_date": { "type": "string", "format": "date", "nullable": true, "description": "Data de validade do documento no formato `YYYY-MM-DD`." }, "issuing_state": { "type": "string", "nullable": true, "description": "País emissor como código ISO 3166-1 alpha-3. Não diferencia maiúsculas de minúsculas (`esp` é armazenado como `ESP`); o `issuing_state_name` legível exibido em [Obter decisão](#get-/v3/session/-sessionId-/decision/) é recalculado a partir desse valor. Códigos inválidos retornam `400`.", "example": "ESP" }, "first_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nome(s) próprio(s). O `full_name` armazenado é recalculado como `first_name + ' ' + last_name` em cada chamada a este endpoint.", "example": "Carmen" }, "last_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Sobrenome(s). Também alimenta o `full_name` recalculado.", "example": "Espanola Espanola" }, "gender": { "type": "string", "enum": [ "M", "F", "U" ], "nullable": true, "description": "Sexo conforme impresso no documento: `M` (masculino), `F` (feminino) ou `U` (desconhecido). Qualquer outro valor, incluindo `X`, retorna `400`." }, "address": { "type": "string", "maxLength": 255, "nullable": true, "description": "Endereço em texto livre, conforme impresso no documento. Quando esse valor muda (apenas em sessões fora do sandbox) e o endereço estruturado ainda está ausente ou incompleto, o servidor refaz a geocodificação de forma síncrona antes de responder: o corpo da resposta 200 já reflete o `parsed_address` atualizado. A nova geocodificação também exige que `issuing_state` esteja presente no registro de KYC." }, "place_of_birth": { "type": "string", "maxLength": 255, "nullable": true, "description": "Local de nascimento conforme impresso no documento." }, "nationality": { "type": "string", "maxLength": 32, "nullable": true, "description": "Nacionalidade conforme impressa no documento. Texto livre de até 32 caracteres, normalmente um código ISO 3166-1 alpha-3 (por exemplo, `ESP`), mas não é validado como tal." }, "marital_status": { "type": "string", "enum": [ "SINGLE", "MARRIED", "DIVORCED", "WIDOWED", "UNKNOWN" ], "description": "Estado civil, quando o documento o informa. Qualquer outro valor retorna `400`." }, "extra_fields": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Substituições por chave para campos extras específicos do documento (por exemplo, `blood_group`, `dl_categories`, `mrz_string`). As chaves são mescladas ao mapa de substituições existente: envie uma chave com um valor para defini-la, ou com `null` / `\"\"` para remover essa chave da visão mesclada. Envie o campo inteiro como `null` para limpar todas as substituições aplicadas anteriormente. Deve ser um objeto JSON; caso contrário, retorna `400`. A resposta sempre retorna a visão mesclada (valores extraídos por OCR com as suas substituições aplicadas)." }, "parsed_address": { "type": "object", "nullable": true, "description": "Endereço estruturado. Apenas estas chaves aninhadas são aceitas: `address_type`, `city`, `region`, `street_1`, `street_2`, `postal_code`, `country` — qualquer outra chave retorna `400`. Semântica por chave: um valor define a chave, `null` a remove. `formatted_address` é recalculado no servidor juntando `street_1`, `street_2`, `city`, `region`, `postal_code` e `country` e é retornado na resposta — você não pode defini-lo diretamente.", "properties": { "address_type": { "type": "string", "nullable": true, "description": "Classificação livre do endereço (por exemplo, `home`)." }, "city": { "type": "string", "nullable": true, "example": "Madrid" }, "region": { "type": "string", "nullable": true, "description": "Estado / província / comunidade autônoma." }, "street_1": { "type": "string", "nullable": true, "example": "Avda de Madrid 34" }, "street_2": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true, "example": "28013" }, "country": { "type": "string", "nullable": true, "description": "Código de país ISO 3166-1 alpha-2. Entradas em minúsculas são normalizadas para maiúsculas; códigos alpha-3 são rejeitados com `400`.", "example": "ES" } } } } }, "examples": { "Correct name and DOB": { "summary": "Corrigir nome, data de nascimento e endereço estruturado lidos incorretamente pelo OCR", "value": { "first_name": "Carmen", "last_name": "Espanola Espanola", "date_of_birth": "1980-01-01", "issuing_state": "ESP", "marital_status": "MARRIED", "extra_fields": { "blood_group": "O+" }, "parsed_address": { "street_1": "Avda de Madrid 34", "city": "Madrid", "postal_code": "28013", "country": "ES" } } }, "Remove an extra field": { "summary": "Excluir uma chave de campo extra e manter as demais", "value": { "extra_fields": { "blood_group": null } } }, "Long-form document type": { "summary": "O alias por extenso é normalizado para o código curto (aqui, P)", "value": { "document_type": "Passport" } } } } } }, "responses": { "200": { "description": "Dados de KYC atualizados. Retorna o **registro de KYC atual completo** (cada campo atualizável com o valor armazenado, além dos `extra_fields` mesclados e do `parsed_address` atual), e não apenas os campos que você enviou. O webhook `data.updated` é disparado quando pelo menos um campo válido estava no payload.", "content": { "application/json": { "schema": { "type": "object", "properties": { "document_type": { "type": "string", "description": "Código do tipo de documento. Aceita os códigos curtos listados no enum, além de seis aliases por extenso normalizados no servidor antes da validação: `Passport` → `P`, `Identity Card` → `ID`, `Driver's License` → `DL`, `Residence Permit` → `RP`, `Health Insurance Card` → `HIC`, `Tax Card` → `TC`. Qualquer outro valor (incluindo `PASSPORT` em maiúsculas) 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": "Subtipo do documento conforme o registro de documentos, incluindo o prefixo de região quando o registro distingue variantes regionais." }, "document_number": { "type": "string", "maxLength": 255, "nullable": true, "description": "Número do documento conforme impresso no documento de identidade.", "example": "PAB123456" }, "personal_number": { "type": "string", "maxLength": 255, "nullable": true, "description": "Número de identificação pessoal / nacional, quando o documento traz um (por exemplo, o DNI espanhol em um passaporte).", "example": "99999999R" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Data de nascimento em `YYYY-MM-DD`. Qualquer outro formato retorna `400`.", "example": "1980-01-01" }, "date_of_issue": { "type": "string", "format": "date", "nullable": true, "description": "Data de emissão do documento em `YYYY-MM-DD`." }, "expiration_date": { "type": "string", "format": "date", "nullable": true, "description": "Data de validade do documento no formato `YYYY-MM-DD`." }, "issuing_state": { "type": "string", "nullable": true, "description": "País emissor como código ISO 3166-1 alpha-3. Não diferencia maiúsculas de minúsculas (`esp` é armazenado como `ESP`); o `issuing_state_name` legível exibido em [Obter decisão](#get-/v3/session/-sessionId-/decision/) é recalculado a partir desse valor. Códigos inválidos retornam `400`.", "example": "ESP" }, "first_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nome(s) próprio(s). O `full_name` armazenado é recalculado como `first_name + ' ' + last_name` em cada chamada a este endpoint.", "example": "Carmen" }, "last_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Sobrenome(s). Também alimenta o `full_name` recalculado.", "example": "Espanola Espanola" }, "gender": { "type": "string", "enum": [ "M", "F", "U" ], "nullable": true, "description": "Sexo conforme impresso no documento: `M` (masculino), `F` (feminino) ou `U` (desconhecido). Qualquer outro valor, incluindo `X`, retorna `400`." }, "address": { "type": "string", "maxLength": 255, "nullable": true, "description": "Endereço em texto livre, conforme impresso no documento. Quando esse valor muda (apenas em sessões fora do sandbox) e o endereço estruturado ainda está ausente ou incompleto, o servidor refaz a geocodificação em segundo plano na mesma requisição e pode sobrescrever `parsed_address` com o resultado do geocodificador." }, "place_of_birth": { "type": "string", "maxLength": 255, "nullable": true, "description": "Local de nascimento conforme impresso no documento." }, "nationality": { "type": "string", "maxLength": 32, "nullable": true, "description": "Nacionalidade conforme impressa no documento. Texto livre de até 32 caracteres, normalmente um código ISO 3166-1 alpha-3 (por exemplo, `ESP`), mas não é validado como tal." }, "marital_status": { "type": "string", "enum": [ "SINGLE", "MARRIED", "DIVORCED", "WIDOWED", "UNKNOWN" ], "description": "Estado civil, quando o documento o informa. Qualquer outro valor retorna `400`." }, "extra_fields": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Visão mesclada dos campos extras do documento: os valores extraídos por OCR com todas as substituições do operador aplicadas. Chaves removidas por meio de uma substituição `null` não aparecem neste mapa." }, "parsed_address": { "type": "object", "nullable": true, "description": "Endereço estruturado atual (sem as chaves de controle interno), ou `null` quando não existe nenhum. Inclui o `formatted_address` recalculado junto com as sete chaves editáveis.", "properties": { "address_type": { "type": "string", "nullable": true, "description": "Classificação livre do endereço (por exemplo, `home`)." }, "city": { "type": "string", "nullable": true, "example": "Madrid" }, "region": { "type": "string", "nullable": true, "description": "Estado / província / comunidade autônoma." }, "street_1": { "type": "string", "nullable": true, "example": "Avda de Madrid 34" }, "street_2": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true, "example": "28013" }, "country": { "type": "string", "nullable": true, "description": "Código de país ISO 3166-1 alpha-2. Entradas em minúsculas são normalizadas para maiúsculas; códigos alpha-3 são rejeitados com `400`.", "example": "ES" }, "formatted_address": { "type": "string", "nullable": true, "description": "Forma unificada e legível do endereço estruturado. Recalculada no servidor após cada edição de `parsed_address`.", "example": "Avda de Madrid 34, Madrid, 28013, ES" } } } } }, "examples": { "Updated KYC": { "summary": "Registro KYC completo após a correção", "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\": [\"\"]}`; os erros em chaves aninhadas de `parsed_address` / `extra_fields` usam um objeto como valor: `{\"parsed_address\": {\"\": \"\"}}`.", "content": { "application/json": { "examples": { "Invalid gender": { "summary": "gender deve ser M, F ou U", "value": { "gender": [ "\"X\" is not a valid choice." ] } }, "Invalid document type": { "summary": "Não é um código curto nem um alias completo", "value": { "document_type": [ "\"PASSPORT\" is not a valid choice." ] } }, "Invalid issuing state": { "summary": "issuing_state não está no formato 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 não está no enum", "value": { "marital_status": [ "\"ENGAGED\" is not a valid choice." ] } }, "Bad date format": { "summary": "As datas devem estar no formato YYYY-MM-DD", "value": { "date_of_birth": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } }, "Unsupported parsed_address key": { "summary": "Somente as sete chaves documentadas são permitidas", "value": { "parsed_address": { "zipcode": "Unsupported key. Allowed keys: address_type, city, region, street_1, street_2, postal_code, country" } } }, "Invalid parsed_address country": { "summary": "O país aninhado deve estar em alpha-2, não em alpha-3", "value": { "parsed_address": { "country": "Invalid ISO 3166-1 alpha-2 country code." } } }, "extra_fields not an object": { "summary": "extra_fields deve ser um objeto JSON", "value": { "extra_fields": [ "This field must be a JSON object." ] } } } } } }, "403": { "description": "Credenciais ausentes ou permissões insuficientes. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente ou inválido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "A credencial não tem write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Sessão desconhecida, sessão em um estado não editável ou nenhum registro de KYC para atualizar. Cada caso tem uma mensagem `detail` distinta (veja os exemplos). A busca de sessão desconhecida é executada antes das verificações de credencial.", "content": { "application/json": { "examples": { "Unknown session": { "summary": "Nenhuma sessão com este ID na sua aplicação (ou ela foi excluída)", "value": { "detail": "Not found." } }, "Wrong session state": { "summary": "A sessão existe, mas não está como Approved / Declined / In Review / Kyc Expired", "value": { "detail": "No Session matches the given query." } }, "No KYC record": { "summary": "O fluxo nunca executou uma etapa de verificação de identidade", "value": { "detail": "The session does not have a KYC." } }, "No KYC for node": { "summary": "node_id informado, mas não existe KYC para ele", "value": { "detail": "The session does not have a KYC for node 'feature_missing'." } } } } } }, "429": { "description": "Limite de requisições dedicado excedido: 10 atualizações de dados de KYC por minuto por chave de API (requisições rejeitadas contam para a cota). A cota compartilhada de escrita de 300/min também pode ser acionada, com sua própria mensagem. Verifique `Retry-After` e os cabeçalhos de resposta `X-RateLimit-*` antes de tentar novamente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Limite de atualizações de KYC esgotado", "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": "Atualizar o status de um recurso individual (etapa)", "description": "Define o status de um único recurso de verificação (etapa) em uma sessão. Identifique o recurso pelo `nodeId` do grafo do fluxo. Em fluxos que não usam grafo, cujas etapas não têm nó, use `default` e passe também `feature_type` para indicar a qual etapa você se refere.\n\nFunciona tanto para sessões de Verificação de usuários (KYC) quanto de Verificação de empresas (KYB) e para todos os tipos de etapa: ID/OCR, Prova de vida, Correspondência facial, NFC, AML, Comprovante de endereço, Telefone, E-mail, Validação de banco de dados, Questionário e as verificações de registro / documentos / pessoas-chave do KYB. Este endpoint **não** está disponível para sessões de API independentes (`session_type = API`).\n\n`new_status` deve ser `Approved`, `Declined` ou `In Review` e deve ser diferente do status atual do recurso.\n\n**Quando a substituição é aplicada.** Sem `defer_until_flow_finishes` (ou com `false`), a substituição é aplicada imediatamente, como sempre foi; quando a pessoa ainda está no fluxo, ela é registrada como `forced`. Com `defer_until_flow_finishes: true` enquanto a pessoa ainda está no fluxo (a sessão está `Not Started`, `In Progress` ou `Resubmitted` e não foi concluída), a substituição é armazenada como `pending_until_flow_finishes` e é aplicada quando o fluxo termina, depois que o fluxo chega à sua própria decisão. Em uma sessão cujo fluxo já terminou, ela é aplicada imediatamente em qualquer caso. Uma substituição em espera é cancelada, em vez de aplicada, quando a pessoa refaz a etapa correspondente antes de terminar, quando uma substituição mais recente na mesma verificação a substitui, quando a sessão sai do fluxo sem concluí-lo (abandonada, expirada ou decidida no meio do fluxo) ou quando você a cancela com `POST /v3/session/{sessionId}/features/overrides/{overrideId}/cancel/`. Liste as substituições de uma sessão com `GET /v3/session/{sessionId}/features/overrides/`.\n\n**Efeito na sessão.** Uma sessão que já tem uma decisão a mantém: apenas a verificação muda. Quando a sessão ainda não tem decisão e o fluxo está aguardando exatamente esta etapa, aplicar a substituição conclui a etapa: o fluxo avança, as etapas seguintes são executadas e um nó de status pode definir a decisão da sessão e disparar `status.updated`.\n\n**Webhooks e atividade.** Um webhook `data.updated` é disparado quando a substituição é aplicada (imediatamente ou quando o fluxo termina), nunca enquanto ela aguarda nem quando é cancelada. Toda substituição é registrada na atividade da sessão como `FEATURE_OVERRIDE_PENDING`, `FEATURE_OVERRIDE_APPLIED` ou `FEATURE_OVERRIDE_CANCELLED`, com quem a fez; a entrada da requisição inclui o seu `comment`.\n\nAutentique-se com sua chave de API (`x-api-key`) ou com um cabeçalho de autorização de usuário que tenha o privilégio `write:sessions`; uma chave de API com escopo precisa de acesso de escrita a decisões.", "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 da sessão de verificação. Aceita IDs de sessão tanto de usuário (KYC) quanto de empresa (KYB): o serviço resolve o ID entre os dois tipos de sessão.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "in": "path", "name": "nodeId", "required": true, "description": "ID do nó do grafo do fluxo do recurso a ser atualizado (por exemplo, `feature_ocr_1`). Use o valor literal `default` para fluxos sem grafo (de etapa única), nos quais o recurso não tem ID de nó.", "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": "Status de destino para este recurso. Deve ser diferente do valor atual.", "enum": [ "Approved", "Declined", "In Review" ], "example": "Approved" }, "comment": { "type": "string", "description": "Nota opcional em texto livre registrada no histórico de revisão da sessão para esta alteração de recurso.", "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": "Qual tipo de etapa visar. Necessário em fluxos que não são de grafo (`nodeId` = `default`), em que as etapas não têm nó próprio; opcional nos demais casos. Um valor desconhecido retorna `400`.", "example": "LIVENESS" }, "defer_until_flow_finishes": { "type": "boolean", "default": false, "description": "Enquanto a pessoa ainda estiver no fluxo, armazena a substituição como `pending_until_flow_finishes` e a aplica quando o fluxo terminar, em vez de imediatamente. Se omitido ou `false`, a substituição é aplicada imediatamente. Em uma sessão cujo fluxo já terminou, ela é aplicada imediatamente em qualquer caso.", "example": false } } }, "examples": { "Apply Now": { "summary": "Aprovar a etapa de identidade imediatamente", "value": { "new_status": "Approved", "comment": "Document manually verified by compliance." } }, "Wait For The Flow": { "summary": "Aprovar a etapa de prova de vida assim que a pessoa concluir o fluxo", "value": { "new_status": "Approved", "comment": "Liveness retried with a reviewer present.", "defer_until_flow_finishes": true } }, "Non-graph Workflow": { "summary": "Direcionar a etapa de prova de vida de um fluxo sem nós (nodeId = default)", "value": { "new_status": "In Review", "feature_type": "LIVENESS" } } } } } }, "responses": { "200": { "description": "A substituição foi registrada. `new_status` é o status da verificação conforme armazenado: o solicitado, depois que a substituição foi aplicada, ou o inalterado, enquanto ela aguarda a conclusão do fluxo. `override` indica o que aconteceu.", "content": { "application/json": { "schema": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid" }, "node_id": { "type": "string", "nullable": true, "description": "O nó do fluxo da etapa atualizada, ou `null` para uma etapa sem nó (o caminho `default` em um fluxo que não é baseado em grafo).", "example": "feature_ocr_1" }, "feature_type": { "type": "string", "description": "Nome do modelo do recurso atualizado (por exemplo, `KYC`, `Face`, `FaceMatch`, `AML`, `POA`).", "example": "KYC" }, "new_status": { "type": "string", "description": "O status armazenado da verificação: o solicitado, depois que a substituição foi aplicada; o inalterado, enquanto a substituição aguarda a conclusão do fluxo.", "example": "Approved" }, "override": { "$ref": "#/components/schemas/FeatureStatusOverride" } }, "required": [ "session_id", "node_id", "feature_type", "new_status", "override" ] }, "examples": { "Applied": { "summary": "A substituição foi aplicada imediatamente", "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 enquanto a pessoa ainda está no fluxo", "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": "Erro de validação. Retornado quando `new_status` é inválido ou não foi alterado, quando `feature_type` é desconhecido ou quando a sessão é uma sessão de API avulsa.", "content": { "application/json": { "examples": { "Same Status": { "summary": "new_status é igual ao status atual", "value": { "new_status": [ "The new status is the same as the current status." ] } }, "API Session": { "summary": "O status do recurso não pode ser alterado em sessões de API avulsas", "value": [ "Cannot change feature status for API sessions." ] }, "Unknown feature_type": { "summary": "feature_type não é um tipo de etapa conhecido", "value": { "feature_type": [ "Unknown feature_type 'SELFIE'." ] } } } } } }, "401": { "description": "A chave de API com escopo expirou.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Chave de API com escopo após a data de validade", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Credenciais ausentes ou permissões insuficientes.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente ou inválido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "A chave de API não tem write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Chave de API com escopo sem acesso de escrita a decisões", "value": { "detail": "This API key has no write access to decisions." } } } } } }, "404": { "description": "A sessão não foi encontrada ou não tem um recurso com o `nodeId` informado.", "content": { "application/json": { "examples": { "Session Not Found": { "summary": "session_id desconhecido", "value": { "detail": "Session not found." } }, "Feature Not Found": { "summary": "Nenhum recurso para este node_id", "value": { "detail": "No feature found with node_id 'feature_ocr_1' in this session." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH \\\n https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/features/feature_ocr_1/update-status/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"new_status\": \"Approved\",\n \"comment\": \"Document manually verified by compliance.\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_feature_status(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_ocr_1\",\n new_status=\"Approved\",\n comment=\"Document manually verified by compliance.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateFeatureStatus(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_ocr_1\",\n {\n new_status: \"Approved\",\n comment: \"Document manually verified by compliance.\",\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateFeatureStatus(ctx, \"11111111-2222-3333-4444-555555555555\", \"feature_ocr_1\", didit.SessionsUpdateFeatureStatusParams{\n\tNewStatus: \"Approved\",\n\tComment: didit.String(\"Document manually verified by compliance.\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsUpdateFeatureStatusParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateFeatureStatus(\"11111111-2222-3333-4444-555555555555\", \"feature_ocr_1\", SessionsUpdateFeatureStatusParams.builder()\n .newStatus(SessionsUpdateFeatureStatusParams.NewStatus.of(\"Approved\"))\n .comment(\"Document manually verified by compliance.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateFeatureStatus('11111111-2222-3333-4444-555555555555', 'feature_ocr_1', [\n 'new_status' => 'Approved',\n 'comment' => 'Document manually verified by compliance.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_feature_status(\n \"11111111-2222-3333-4444-555555555555\",\n \"feature_ocr_1\",\n new_status: \"Approved\",\n comment: \"Document manually verified by compliance.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateFeatureStatusAsync(\"11111111-2222-3333-4444-555555555555\", \"feature_ocr_1\", new SessionsUpdateFeatureStatusParams\n{\n NewStatus = \"Approved\",\n Comment = \"Document manually verified by compliance.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/update-aml-hit-status/": { "patch": { "summary": "Atualizar o status de revisão de uma ocorrência AML", "description": "Define o status de revisão de um **único resultado AML** (uma possível correspondência com sanções / PEP / lista de monitoramento / mídia adversa) retornado pela Análise AML, sem alterar a decisão geral da sessão. Identifique o resultado pelo seu `hit_id` (o `id` de uma entrada no array `hits` da verificação AML; consulte a decisão da sessão). Um ID de resultado retornado no formato anterior continua sendo aceito; a resposta sempre identifica o resultado pelo seu `id` atual.\n\n`review_status` é um de `Unreviewed`, `Confirmed Match`, `False Positive` ou `Inconclusive`. As decisões do revisor são preservadas nas atualizações do monitoramento contínuo, portanto um resultado que você marcar como `False Positive` permanece assim quando o provedor refaz a análise.\n\nUma chamada bem-sucedida dispara um webhook `data.updated` e adiciona uma entrada de atividade (com a atribuição do autor) ao histórico de revisão da sessão. Para fluxos baseados em grafo com várias verificações AML, informe `node_id` para direcionar uma verificação específica.\n\nAutentique-se com sua chave de API (`x-api-key`) ou com um cabeçalho de autorização de usuário; qualquer um deles deve ter o privilégio `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 da sessão de verificação. Aceita IDs de sessão tanto de usuário (KYC) quanto de empresa (KYB): o serviço resolve o ID entre os dois tipos de sessão.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "in": "query", "name": "node_id", "required": false, "description": "ID do nó do grafo do fluxo. Obrigatório apenas quando a sessão tem várias verificações AML (uma por nó); omita-o em sessões com uma única verificação 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": "O `id` da ocorrência no array `hits` da verificação AML (`hit_...`). Um id de ocorrência retornado no formato anterior ainda é aceito.", "example": "hit_7c1e9a40b2d35f86e0a4c912" }, "review_status": { "type": "string", "description": "O novo status de revisão do resultado.", "enum": [ "Unreviewed", "Confirmed Match", "False Positive", "Inconclusive" ], "example": "False Positive" }, "node_id": { "type": "string", "description": "ID opcional do nó do grafo. Use-o (aqui ou como parâmetro de consulta) quando a sessão tiver várias verificações AML.", "example": "feature_aml_1" } } }, "example": { "hit_id": "hit_7c1e9a40b2d35f86e0a4c912", "review_status": "False Positive" } } } }, "responses": { "200": { "description": "Status de revisão da ocorrência atualizado.", "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": "O `id` da ocorrência atualizada, como a decisão da sessão o retorna, inclusive quando a requisição indicou a ocorrência por um id no formato anterior." }, "review_status": { "type": "string", "enum": [ "Unreviewed", "Confirmed Match", "False Positive", "Inconclusive" ], "description": "O status de revisão agora armazenado no resultado." } } }, "example": { "message": "Hit status updated successfully", "hit_id": "hit_7c1e9a40b2d35f86e0a4c912", "review_status": "False Positive" } } } }, "400": { "description": "Erro de validação: `hit_id` vazio ou `review_status` diferente dos valores permitidos.", "content": { "application/json": { "example": { "review_status": [ "\"Maybe\" is not a valid choice." ] } } } }, "403": { "description": "Credenciais ausentes ou permissões insuficientes. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente ou inválido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "A chave de API não tem write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "A sessão não foi encontrada, a sessão não tem verificação AML (opcionalmente para o `node_id` informado) ou nenhuma ocorrência corresponde a `hit_id`.", "content": { "application/json": { "examples": { "No AML Check": { "summary": "A sessão não tem verificação AML", "value": { "detail": "The session does not have an AML check." } }, "Hit Not Found": { "summary": "hit_id desconhecido", "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": "Atualizar em massa os status de revisão de ocorrências AML", "description": "Atualize o status de revisão de **vários resultados AML** em uma única chamada. Informe `hit_updates`, uma lista de pares `{ hit_id, review_status }`. `review_status` é um dos valores `Unreviewed`, `Confirmed Match`, `False Positive` ou `Inconclusive`.\n\nA atualização é do tipo tudo ou nada: se algum `hit_id` não for encontrado na verificação AML, a requisição retorna `404` e nenhum resultado é alterado. Uma chamada bem-sucedida dispara um único webhook `data.updated` e registra uma entrada de atividade que abrange todas as alterações. Em fluxos de verificação em grafo com várias verificações AML, passe `node_id` para direcionar a uma verificação específica.\n\nAutentique-se com sua chave de API (`x-api-key`) ou com um cabeçalho de autorização de usuário; qualquer um deles deve ter o privilégio `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 da sessão de verificação. Aceita IDs de sessão tanto de usuário (KYC) quanto de empresa (KYB): o serviço resolve o ID entre os dois tipos de sessão.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "in": "query", "name": "node_id", "required": false, "description": "ID do nó do grafo do fluxo. Obrigatório apenas quando a sessão tem várias verificações AML (uma por nó); omita-o em sessões com uma única verificação AML.", "schema": { "type": "string", "example": "feature_aml_1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "hit_updates" ], "properties": { "hit_updates": { "type": "array", "description": "Lista não vazia de atualizações de ocorrências.", "items": { "type": "object", "required": [ "hit_id", "review_status" ], "properties": { "hit_id": { "type": "string", "example": "hit_7c1e9a40b2d35f86e0a4c912", "description": "O `id` da ocorrência no array `hits` da verificação AML (`hit_...`). Um id de ocorrência retornado no formato anterior ainda é aceito." }, "review_status": { "type": "string", "enum": [ "Unreviewed", "Confirmed Match", "False Positive", "Inconclusive" ], "example": "Confirmed Match" } } } }, "node_id": { "type": "string", "description": "ID opcional do nó do grafo. Use-o (aqui ou como parâmetro de consulta) quando a sessão tiver várias verificações 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": "Todas as ocorrências foram atualizadas.", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "updated_hits" ], "properties": { "message": { "type": "string", "description": "`Updated {n} hit(s) successfully`, em que `n` é o número de entradas em `hit_updates`." }, "updated_hits": { "type": "array", "items": { "type": "string" }, "description": "O `id` da ocorrência indicada por cada entrada em `hit_updates`, como a decisão da sessão o retorna, na ordem da requisição, incluindo ocorrências cujo status não mudou." } } }, "example": { "message": "Updated 2 hit(s) successfully", "updated_hits": [ "hit_7c1e9a40b2d35f86e0a4c912", "hit_3b8f20d6a91c4e75f0b2d6a8" ] } } } }, "400": { "description": "Erro de validação: `hit_updates` vazio, ou uma entrada sem `hit_id` / `review_status` ou com um valor inválido.", "content": { "application/json": { "example": { "hit_updates": [ "hit_updates cannot be empty" ] } } } }, "403": { "description": "Credenciais ausentes ou permissões insuficientes. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente ou inválido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "A chave de API não tem write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "A sessão não foi encontrada, a sessão não tem verificação AML ou um ou mais `hit_id`s não existem (nesse caso, nenhuma ocorrência é alterada).", "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": "Atualizar os dados de comprovante de endereço extraídos do documento de comprovante de endereço em uma sessão de verificação", "description": "Corrija os campos extraídos do documento de Comprovante de endereço do usuário (conta de consumo, extrato bancário ou outra prova de endereço) depois que a verificação for concluída: emissor, datas, o nome impresso, o próprio endereço e os dados bancários. Todos os campos do corpo são opcionais: somente as chaves que você enviar são gravadas, e todo o resto permanece inalterado (semântica de `PATCH`).\n\nA sessão deve pertencer à sua aplicação e estar no status `Approved`, `Declined`, `In Review` ou `Kyc Expired`. Sessões em qualquer outro estado (por exemplo, ainda em `In Progress`) retornam `404` com `\"No Session matches the given query.\"`, diferente do `\"Not found.\"` retornado para um `sessionId` desconhecido ou excluído. A sessão também deve ter um registro de POA: sessões cujo fluxo nunca executou uma etapa de Comprovante de endereço retornam `404` (`\"The session does not have a POA.\"`). Em fluxos em grafo com várias etapas de POA, indique uma etapa específica com `node_id` (parâmetro de consulta ou campo do corpo); quando omitido, o registro de POA mais recente é atualizado.\n\n`extra_fields` é mesclado chave por chave: nove chaves conhecidas (`bank_iban`, `additional_names`, …) são gravadas diretamente em colunas dedicadas de POA, qualquer outra chave é mantida como um campo extra personalizado, e `null` / `\"\"` exclui uma chave. `poa_parsed_address` aceita somente as sete chaves documentadas e recalcula `formatted_address` / `poa_formatted_address` após cada edição. Se o `poa_address` em texto livre mudar, o servidor também pode geocodificá-lo novamente e atualizar o endereço estruturado (isso não acontece em sessões de sandbox).\n\nDiferentemente da variante de KYC deste endpoint, o [webhook](/pt-br/integration/webhooks) `data.updated` (gatilho `manual_review`) só é disparado quando pelo menos um valor armazenado **realmente mudou**: reenviar valores idênticos não tem nenhum efeito, sem aviso. Quando os valores mudam, uma entrada de atividade `POA_DATA_UPDATED`, que registra os campos alterados com os valores anteriores e os novos, é adicionada a `reviews` da sessão, visível em [Obter decisão](#get-/v3/session/-sessionId-/decision/) e na linha do tempo de atividades do console. O status e a decisão da sessão **não** são reavaliados: use [Atualizar status](#patch-/v3/session/-sessionId-/update-status/) para alterar o resultado.\n\nAceita uma chave de API ou um token de usuário do console; em ambos os casos, a credencial precisa da permissão `write:sessions`. Falhas de autenticação e de permissão retornam `403`: esta API nunca responde `401`. Observe que a busca da sessão é executada antes da verificação das credenciais, então um `sessionId` desconhecido retorna `404` mesmo sem credenciais. Este endpoint tem um limite de requisições dedicado de 10 requisições por minuto por chave de API (requisições inválidas também contam); o limite compartilhado de escrita de 300 requisições por minuto também se aplica.\n\nUm corpo JSON vazio `{}` não tem efeito: retorna `200` com o registro de POA atual, sem disparar o webhook (`has_changes` permanece false).", "operationId": "patch_v3_session_update_poa_data", "x-didit-sdk": { "resource": "sessions", "method": "update_poa_data", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID da sessão de Verificação de usuários (KYC) cujo registro de comprovante de endereço (POA) anexado você está corrigindo.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nó do grafo do fluxo cujo registro de POA deve ser atualizado, para fluxos baseados em grafo com várias etapas de comprovante de endereço (também aceito como campo `node_id` no corpo). Quando omitido, o registro de POA mais recente da sessão é atualizado. Se não houver POA para o nó informado, a chamada 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": "Todos os campos são opcionais: envie apenas o que você quer alterar.", "properties": { "issuing_state": { "type": "string", "nullable": true, "description": "País que emitiu o documento de comprovante de endereço, ISO 3166-1 alpha-3. Não diferencia maiúsculas de minúsculas (normalizado para maiúsculas); códigos inválidos retornam `400`.", "example": "ESP" }, "document_type": { "type": "string", "enum": [ "UTILITY_BILL", "BANK_STATEMENT", "GOVERNMENT_ISSUED_DOCUMENT", "OTHER_POA_DOCUMENT", "UNKNOWN" ], "description": "Categoria do documento de POA. Os valores são em maiúsculas: variantes em minúsculas como `utility_bill` retornam `400`.", "example": "UTILITY_BILL" }, "document_language": { "type": "string", "maxLength": 50, "nullable": true, "description": "Idioma do documento, normalmente um código ISO 639-1 (por exemplo, `es`). Texto livre: não é validado como código de idioma.", "example": "es" }, "issuer": { "type": "string", "maxLength": 255, "nullable": true, "description": "Organização que emitiu o documento (empresa de serviços públicos, banco, órgão governamental).", "example": "Energy Provider S.A." }, "issue_date": { "type": "string", "format": "date", "nullable": true, "description": "Data de emissão do documento de comprovante de endereço em `YYYY-MM-DD`. Qualquer outro formato retorna `400`.", "example": "2026-04-12" }, "poa_address": { "type": "string", "nullable": true, "description": "Endereço em texto livre, conforme impresso no documento. Quando esse valor muda (apenas em sessões fora do sandbox) e o endereço estruturado ainda está ausente ou incompleto, o servidor refaz a geocodificação em segundo plano na mesma requisição e pode sobrescrever `poa_parsed_address` / `poa_formatted_address` com o resultado do geocodificador. A nova geocodificação também exige que `issuing_state` esteja presente no registro de comprovante de endereço.", "example": "Avda de Madrid 34, 28013 Madrid" }, "name_on_document": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nome do destinatário conforme impresso no documento.", "example": "Carmen Espanola" }, "extra_fields": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Dados extras específicos do documento, mesclados chave por chave. Nove chaves correspondem a colunas dedicadas do comprovante de endereço (POA): `bank_account_number`, `bank_iban`, `bank_sort_code`, `bank_routing_number`, `bank_swift_bic`, `bank_branch_name`, `bank_branch_address`, `document_phone_number` e `additional_names` (deve ser uma lista de strings ou `null`; caso contrário, `400`). Qualquer outra chave é armazenada como campo extra personalizado. Semântica por chave: um valor define a chave; `null` ou `\"\"` a exclui. Deve ser um objeto JSON; caso contrário, `400`." }, "poa_parsed_address": { "type": "object", "nullable": true, "description": "Endereço estruturado. Apenas estas chaves aninhadas são aceitas: `address_type`, `city`, `region`, `street_1`, `street_2`, `postal_code`, `country` — qualquer outra chave retorna `400`. Semântica por chave: um valor define a chave, `null` a remove. `formatted_address` (e o `poa_formatted_address` de nível superior) é recalculado no servidor juntando `street_1`, `street_2`, `city`, `region`, `postal_code` e `country` — você não pode defini-lo diretamente.", "properties": { "address_type": { "type": "string", "nullable": true, "description": "Classificação livre do endereço (por exemplo, `home`)." }, "city": { "type": "string", "nullable": true, "example": "Madrid" }, "region": { "type": "string", "nullable": true, "description": "Estado / província / comunidade autônoma." }, "street_1": { "type": "string", "nullable": true, "example": "Avda de Madrid 34" }, "street_2": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true, "example": "28013" }, "country": { "type": "string", "nullable": true, "description": "Código de país ISO 3166-1 alpha-2. Entradas em minúsculas são normalizadas para maiúsculas; códigos alpha-3 são rejeitados com `400`.", "example": "ES" } } } } }, "examples": { "Correct issuer and address": { "summary": "Corrigir a classificação do documento, o emissor e o endereço estruturado", "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": "Excluir uma chave de campo extra e manter as demais", "value": { "extra_fields": { "bank_iban": null } } } } } } }, "responses": { "200": { "description": "Dados de POA atualizados. Retorna o **registro de POA atual completo** (todos os campos atualizáveis com o valor armazenado, além do mapa `extra_fields` completo, `poa_parsed_address` e `poa_formatted_address`), e não apenas os campos que você enviou. O webhook `data.updated` só é disparado quando pelo menos um valor realmente mudou.", "content": { "application/json": { "schema": { "type": "object", "properties": { "issuing_state": { "type": "string", "nullable": true, "description": "País que emitiu o documento de comprovante de endereço, ISO 3166-1 alpha-3. Não diferencia maiúsculas de minúsculas (normalizado para maiúsculas); códigos inválidos retornam `400`.", "example": "ESP" }, "document_type": { "type": "string", "enum": [ "UTILITY_BILL", "BANK_STATEMENT", "GOVERNMENT_ISSUED_DOCUMENT", "OTHER_POA_DOCUMENT", "UNKNOWN" ], "description": "Categoria do documento de POA. Os valores são em maiúsculas: variantes em minúsculas como `utility_bill` retornam `400`.", "example": "UTILITY_BILL" }, "document_language": { "type": "string", "maxLength": 50, "nullable": true, "description": "Idioma do documento, normalmente um código ISO 639-1 (por exemplo, `es`). Texto livre: não é validado como código de idioma.", "example": "es" }, "issuer": { "type": "string", "maxLength": 255, "nullable": true, "description": "Organização que emitiu o documento (empresa de serviços públicos, banco, órgão governamental).", "example": "Energy Provider S.A." }, "issue_date": { "type": "string", "format": "date", "nullable": true, "description": "Data de emissão do documento de comprovante de endereço em `YYYY-MM-DD`. Qualquer outro formato retorna `400`.", "example": "2026-04-12" }, "poa_address": { "type": "string", "nullable": true, "description": "Endereço em texto livre, conforme impresso no documento. Quando esse valor muda (apenas em sessões fora do sandbox) e o endereço estruturado ainda está ausente ou incompleto, o servidor refaz a geocodificação em segundo plano na mesma requisição e pode sobrescrever `poa_parsed_address` / `poa_formatted_address` com o resultado do geocodificador.", "example": "Avda de Madrid 34, 28013 Madrid" }, "name_on_document": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nome do destinatário conforme impresso no documento.", "example": "Carmen Espanola" }, "extra_fields": { "type": "object", "additionalProperties": true, "nullable": true, "description": "Sempre presente na resposta: as nove chaves conhecidas (com `null` para as não definidas e `additional_names` com padrão `[]`), além de quaisquer chaves personalizadas armazenadas anteriormente." }, "poa_parsed_address": { "type": "object", "nullable": true, "description": "Endereço estruturado atual, ou `null` quando não existe nenhum. Inclui o `formatted_address` recalculado junto com as sete chaves editáveis. Retornado como está armazenado: após uma geocodificação no servidor, pode conter chaves de controle (por exemplo, `raw_results`) junto com as chaves editáveis.", "properties": { "address_type": { "type": "string", "nullable": true, "description": "Classificação livre do endereço (por exemplo, `home`)." }, "city": { "type": "string", "nullable": true, "example": "Madrid" }, "region": { "type": "string", "nullable": true, "description": "Estado / província / comunidade autônoma." }, "street_1": { "type": "string", "nullable": true, "example": "Avda de Madrid 34" }, "street_2": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true, "example": "28013" }, "country": { "type": "string", "nullable": true, "description": "Código de país ISO 3166-1 alpha-2. Entradas em minúsculas são normalizadas para maiúsculas; códigos alpha-3 são rejeitados com `400`.", "example": "ES" }, "formatted_address": { "type": "string", "nullable": true, "description": "Forma unificada e legível do endereço estruturado. Recalculada no servidor após cada edição de `poa_parsed_address`.", "example": "Avda de Madrid 34, Madrid, 28013, ES" } } }, "poa_formatted_address": { "type": "string", "nullable": true, "description": "Cópia de nível superior do `formatted_address` recalculado, mantida em sincronia quando o endereço estruturado muda.", "example": "Avda de Madrid 34, Madrid, 28013, ES" } } }, "examples": { "Updated POA": { "summary": "Registro POA completo após a correção", "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": "Erro de validação. Os erros de campo chegam como `{\"\": [\"\"]}`; os erros em chaves aninhadas de `poa_parsed_address` / `extra_fields` usam um objeto como valor: `{\"extra_fields\": {\"\": \"\"}}`.", "content": { "application/json": { "examples": { "Invalid document type": { "summary": "O enum é em maiúsculas: variantes em minúsculas são rejeitadas", "value": { "document_type": [ "\"utility_bill\" is not a valid choice." ] } }, "Invalid issuing state": { "summary": "issuing_state não está no formato 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 aceita uma lista de strings ou null", "value": { "extra_fields": { "additional_names": "Must be a list or null." } } }, "Unsupported poa_parsed_address key": { "summary": "Somente as sete chaves documentadas são permitidas", "value": { "poa_parsed_address": { "zipcode": "Unsupported key. Allowed keys: address_type, city, region, street_1, street_2, postal_code, country" } } }, "Bad date format": { "summary": "As datas devem estar no formato YYYY-MM-DD", "value": { "issue_date": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } } } } } }, "403": { "description": "Credenciais ausentes ou permissões insuficientes. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente ou inválido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "A credencial não tem write:sessions", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Sessão desconhecida, sessão em um estado não editável ou nenhum registro de POA para atualizar. Cada caso tem uma mensagem `detail` distinta (veja os exemplos). A busca de sessão desconhecida é executada antes das verificações de credencial.", "content": { "application/json": { "examples": { "Unknown session": { "summary": "Nenhuma sessão com este ID na sua aplicação (ou ela foi excluída)", "value": { "detail": "Not found." } }, "Wrong session state": { "summary": "A sessão existe, mas não está como Approved / Declined / In Review / Kyc Expired", "value": { "detail": "No Session matches the given query." } }, "No POA record": { "summary": "O fluxo nunca executou uma etapa de Comprovante de endereço", "value": { "detail": "The session does not have a POA." } }, "No POA for node": { "summary": "node_id informado, mas não existe POA para ele", "value": { "detail": "The session does not have a POA for node 'feature_missing'." } } } } } }, "429": { "description": "Limite de requisições dedicado excedido: 10 atualizações de dados de POA por minuto por chave de API (requisições rejeitadas contam para a cota). A cota compartilhada de escrita de 300/min também pode ser acionada, com sua própria mensagem. Verifique `Retry-After` e os cabeçalhos de resposta `X-RateLimit-*` antes de tentar novamente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Limite de atualizações de POA esgotado", "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": "Atualizar os dados da empresa extraídos do registro em uma sessão de Verificação de empresas (KYB)", "description": "Corrija os dados da empresa extraídos do registro em uma sessão de Verificação de empresas (KYB), como nome da empresa, número de registro, endereços, status e dados de contato. A empresa é identificada por `companyUuid`. Quem costuma chamar este endpoint é um analista de conformidade corrigindo uma leitura incorreta do registro ou o seu back office sincronizando dados corrigidos da empresa. Todos os campos do corpo são opcionais (semântica de `PATCH`). Um corpo JSON vazio (`{}`) não faz nenhuma alteração e apenas retorna o registro atual da empresa.\n\nAs edições são gravadas em dois lugares ao mesmo tempo. Os campos com uma coluna canônica da empresa atualizam essa coluna: nome, número de registro, país, data de constituição, número fiscal, tipo, status, campos de capital (`registered_capital`, `registered_capital_amount`, `registered_capital_currency`), nomes alternativos, natureza do negócio, site, e-mail, telefone, LEI, localização e `legal_address` → `registered_address`. Além disso, **todas** as chaves enviadas são mescladas no snapshot `registry_data` (datas como strings ISO), para que a visualização \"extraído do registro\" reflita a correção. Os campos sem coluna, `region`, `registration_date`, `dissolution_date` e `control_scheme`, vão apenas para `registry_data`. `user_provided_data` (o que o usuário final confirmou no fluxo hospedado) nunca é alterado, e `last_console_edit_at` é registrado em todo PATCH não vazio.\n\nAo contrário dos endpoints de atualização de KYC/POA, **não há restrição pelo status da sessão**: a empresa pode ser editada em qualquer momento do ciclo de vida da sessão de empresa. A empresa precisa pertencer à sessão indicada no caminho (caso contrário, retorna `404` com `\"KYB company does not belong to the given session.\"`) e à sua aplicação. Todo PATCH não vazio dispara o [webhook](/pt-br/integration/webhooks) `data.updated` na sessão de empresa (gatilho `console_registry_edit`), mesmo quando os valores enviados são iguais aos armazenados. O status e a decisão da sessão **não** são reavaliados, e nenhuma entrada de revisão ou de auditoria é registrada.\n\nAceita uma chave de API ou um token de usuário do console. Em ambos os casos, a credencial precisa da permissão `write:businesses`. Falhas de autenticação e de permissão retornam `403`: esta API nunca responde `401`. Observe que a busca da sessão é executada antes da verificação das credenciais, então um `sessionId` desconhecido retorna `404` mesmo sem credenciais. Aplica-se o limite compartilhado de escrita de 300 requisições por minuto por chave de API.\n\nPara sessões de Verificação de usuários, o equivalente de KYC é `PATCH /v3/session/{sessionId}/update-data/`. Para alterar a própria decisão da sessão, use `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 da sessão principal de Verificação de empresas (KYB).", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "companyUuid", "in": "path", "required": true, "description": "UUID do registro da empresa a ser atualizado (`registry_checks[].company.uuid` na decisão da sessão de empresa). Deve pertencer à sessão referenciada por `sessionId`.", "schema": { "type": "string", "format": "uuid", "example": "88888888-9999-aaaa-bbbb-cccccccccccc" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Todos os campos são opcionais: envie apenas o que você quer alterar. Os campos enviados atualizam as colunas canônicas da empresa (quando existem) e são mesclados no snapshot `registry_data`.", "properties": { "company_name": { "type": "string", "maxLength": 255, "description": "Razão social da empresa. Gravada na coluna canônica e no snapshot do registro.", "example": "Docs Probe Corp" }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registro oficial no registro de empresas.", "example": "DPC-001" }, "country_code": { "type": "string", "maxLength": 2, "description": "País de constituição, ISO 3166-1 alpha-2. Não diferencia maiúsculas de minúsculas (`us` é armazenado como `US`). Códigos alpha-3 excedem o limite de 2 caracteres e retornam `400`.", "example": "US" }, "region": { "type": "string", "maxLength": 10, "nullable": true, "description": "Tag de subdivisão / região quando o registro tem uma (por exemplo, estado dos EUA). Armazenada apenas no snapshot do registro — não tem coluna canônica." }, "incorporation_date": { "type": "string", "format": "date", "description": "Data de constituição no formato `YYYY-MM-DD`. Opcional, como todos os outros campos: o `PATCH` é parcial. Qualquer outro formato de data retorna `400`.", "example": "2015-04-12" }, "registration_date": { "type": "string", "format": "date", "nullable": true, "description": "Data de registro quando o registro a distingue da data de constituição. Armazenada apenas no snapshot do registro." }, "dissolution_date": { "type": "string", "format": "date", "nullable": true, "description": "Data de dissolução de empresas que não estão mais ativas. Armazenada apenas no snapshot do registro." }, "tax_number": { "type": "string", "maxLength": 100, "description": "Número de identificação fiscal." }, "legal_address": { "type": "string", "description": "Endereço legal / registrado. No servidor, é tratado como alias da coluna canônica `registered_address`: a resposta o retorna em `registered_address`, enquanto o snapshot do registro mantém a chave `legal_address` que você enviou.", "example": "1 Example Plaza, Wilmington, DE 19801" }, "company_type": { "type": "string", "maxLength": 100, "description": "Tipo de pessoa jurídica (por exemplo, `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": "Status da empresa informado pelo registro. Em minúsculas; alguns valores contêm espaços (por exemplo, `struck off`, `no longer authorised`). Qualquer outro valor retorna `400`.", "example": "active" }, "verification_status": { "type": "string", "enum": [ "verified", "failed", "unknown" ], "nullable": true, "description": "Resultado da verificação no registro. Qualquer outro valor retorna `400`.", "example": "verified" }, "alternative_names": { "type": "string", "description": "Nomes fantasia, razões sociais anteriores e nomes DBA (texto livre)." }, "nature_of_business": { "type": "string", "description": "Breve descrição da atividade da empresa.", "example": "Software development" }, "registered_capital": { "type": "string", "maxLength": 100, "description": "Capital social em formato legível (por exemplo, `USD 50000`). Use `registered_capital_amount` + `registered_capital_currency` para valores estruturados, ou este campo para texto livre.", "example": "USD 50000" }, "registered_capital_amount": { "type": "number", "format": "double", "nullable": true, "description": "Valor numérico do capital social (até 20 dígitos, 2 casas decimais). Define a coluna `registered_capital_amount` e é replicado em `registry_data` como string decimal; a resposta o devolve como string decimal (por exemplo, `\"1500000.50\"`)." }, "registered_capital_currency": { "type": "string", "maxLength": 3, "nullable": true, "description": "Código de moeda ISO 4217 de `registered_capital_amount`. Não diferencia maiúsculas de minúsculas (`usd` é armazenado como `USD`); valores que não tenham exatamente 3 letras retornam `400` com a mensagem ISO 4217. Define a coluna canônica `registered_capital_currency` e é replicado em `registry_data`.", "example": "USD" }, "website": { "type": "string", "maxLength": 500, "description": "Site da empresa. Domínios sem protocolo são aceitos e normalizados com o prefixo `https://` (`docsprobe.example.com` é armazenado como `https://docsprobe.example.com`); valores que ainda falham na validação de URL retornam `400`.", "example": "https://docsprobe.example.com" }, "email": { "type": "string", "format": "email", "description": "E-mail de contato registrado no órgão de registro.", "example": "legal@docsprobe.example.com" }, "phone": { "type": "string", "maxLength": 50, "description": "Telefone de contato. Deve conter apenas `+`, dígitos, espaços, hifens, pontos ou parênteses, com 7 a 15 dígitos no total; caso contrário, `400`.", "example": "+1 302 555 0143" }, "legal_entity_identifier": { "type": "string", "maxLength": 50, "description": "LEI, quando a empresa tiver um." }, "location_of_registration": { "type": "string", "maxLength": 255, "description": "Cidade ou subdivisão do registro de origem." }, "vat_number": { "type": "string", "maxLength": 64, "description": "Número de IVA da UE (EU VAT). Mesclado apenas no snapshot `registry_data`: editá-lo aqui não executa novamente a validação de IVA e de identificação fiscal, portanto `vat_validation_status` e os demais campos de resultado `vat_*` permanecem inalterados." }, "control_scheme": { "type": "string", "description": "Esquema de controle / governança, quando o registro o expõe. Armazenado apenas no snapshot do registro." } } }, "examples": { "Correct registry data": { "summary": "Corrigir os campos da empresa extraídos do registro", "value": { "company_name": "Docs Probe Corp", "registration_number": "DPC-001", "country_code": "US", "incorporation_date": "2015-04-12", "company_type": "Limited Liability Company", "legal_address": "1 Example Plaza, Wilmington, DE 19801", "registry_status": "active", "verification_status": "verified", "website": "docsprobe.example.com", "email": "legal@docsprobe.example.com", "phone": "+1 302 555 0143", "registered_capital": "USD 50000", "nature_of_business": "Software development" } }, "Single field": { "summary": "Somente as chaves que você envia são gravadas", "value": { "registry_status": "dissolved" } }, "No-op": { "summary": "Corpo vazio retorna o registro atual sem disparar o webhook", "value": {} } } } } }, "responses": { "200": { "description": "Dados da empresa atualizados (ou devolvidos sem alterações para um corpo vazio). Retorna o registro completo da empresa no KYB, com o mesmo formato de `registry_checks[].company` na decisão da sessão de empresa. Observe que `legal_address` volta como `registered_address`. `registered_capital_amount`/`registered_capital_currency` preenchem suas colunas canônicas e são espelhados em `registry_data`.", "content": { "application/json": { "schema": { "type": "object", "description": "Registro completo da empresa no KYB, com a mesma estrutura do objeto `company` dentro de `registry_checks[]` na decisão da sessão de empresa.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador do registro da empresa (o parâmetro de caminho `companyUuid`)." }, "node_id": { "type": "string", "nullable": true, "description": "Nó do grafo do fluxo ao qual este registro de empresa pertence, quando o fluxo é baseado em grafo." }, "status": { "type": "string", "description": "Status do ciclo de vida do recurso da verificação no registro (por exemplo, `Not Finished`, `Approved`, `Declined`, `In Review`)." }, "registry_status": { "type": "string", "nullable": true, "description": "Status da empresa informado pelo registro (por exemplo, `active`, `dissolved`, `struck off`)." }, "data_resolved": { "type": "boolean", "description": "`true` quando os dados da empresa estão completos: sempre `true` para empresas inseridas manualmente; para empresas obtidas de um registro, `true` assim que a consulta ao registro for concluída." }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true, "description": "País de constituição em ISO 3166-1 alpha-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": "Endereço registrado canônico, atualizado quando você envia `legal_address`." }, "tax_number": { "type": "string", "nullable": true }, "risk_level": { "type": "string", "nullable": true }, "verification_status": { "type": "string", "nullable": true, "description": "`verified`, `failed` ou `unknown`." }, "is_from_registry": { "type": "boolean", "description": "`true` quando a empresa foi pré-preenchida a partir de uma busca em registro, em vez de inserida manualmente." }, "fetch_status": { "type": "string", "nullable": true, "description": "Ciclo de vida da consulta ao registro para empresas obtidas do registro (`pending` / `resolved`); `null` para cadastros manuais." }, "alternative_names": { "type": "string", "nullable": true, "description": "Nomes alternativos, comerciais, anteriores ou no idioma original da empresa, em texto, quando informados." }, "nature_of_business": { "type": "string", "nullable": true }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "nullable": true, "description": "Coluna canônica. Retornada como string decimal (por exemplo, `\"2750000.00\"`)." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Coluna canônica. Definida pelo fluxo do registro de empresas ou por edições no console/API por meio deste endpoint." }, "website": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "legal_entity_identifier": { "type": "string", "nullable": true }, "location_of_registration": { "type": "string", "nullable": true }, "vat_number": { "type": "string", "nullable": true, "description": "Número de IVA da UE (EU VAT), quando coletado durante a etapa de registro no fluxo hospedado ou editado posteriormente." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Resultado da validação do número de VAT ou, quando não houver, do `tax_number`, no envio ao registro. `valid` / `invalid`: decidido pelo registro oficial do país (EU VIES, Noruega, Suíça, Brasil, Colômbia, Costa Rica, Equador, Paraguai; a Polônia também pelo seu registro nacional de VAT). `format_valid` / `invalid_format`: decidido pelas regras de formato e dígito verificador do país quando nenhum registro pode ser consultado. `could_not_validate`: o registro estava indisponível. `not_applicable`: nenhum número, um país sem registro nem regras, ou uma sessão de sandbox." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "O número que foi verificado, como a fonte o conhece (por exemplo, o número de IVA derivado de um SIREN francês ou de um RSIN holandês). `null` quando nenhuma verificação foi executada." }, "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": "A fonte que determinou `vat_validation_status`: um registro oficial ou `format_rules`. `null` quando nenhuma verificação foi executada." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Nome registrado na fonte que validou o número, quando ela o informa. Preenchido apenas quando o status é `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Endereço registrado na fonte que validou o número, quando ela o informa. Definido apenas quando o status é `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data e hora da verificação. `null` quando nenhuma verificação foi executada." }, "financial_summary": { "type": "object", "nullable": true, "additionalProperties": true }, "officers": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Diretores / administradores vinculados à empresa, incluindo o progresso de KYC de cada pessoa." }, "beneficial_owners": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Beneficiários finais vinculados à empresa, incluindo o progresso de KYC de cada pessoa." }, "addresses": { "type": "array", "nullable": true, "items": { "type": "object", "additionalProperties": true }, "description": "Detalhes do endereço no registro, quando o registro retornou algum." }, "industries": { "type": "array", "nullable": true, "items": { "type": "object", "additionalProperties": true }, "description": "Classificação setorial do registro, quando disponível." }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Datas de arquivamento no registro, quando disponíveis. Declarações anuais e assembleias gerais usam last_annual_return_date e last_agm_date; elas são distintas das demonstrações financeiras." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "O que o usuário final digitou durante a etapa hospedada de confirmação no registro. Nunca é modificado por este endpoint." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o usuário final confirmou os dados da empresa no fluxo hospedado." }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Registrado em todo PATCH bem-sucedido e não vazio, para que as interfaces possam exibir o contexto \"editado pelo operador\"." }, "is_editable": { "type": "boolean", "description": "`true` enquanto o usuário final ainda pode editar os dados obtidos do registro no fluxo hospedado (obtidos do registro e ainda não confirmados)." } } }, "examples": { "Updated company": { "summary": "Registro completo da empresa após a correção", "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": "Erro de validação. Os erros de campo chegam como `{\"\": [\"\"]}`. As verificações de tamanho máximo são executadas antes das verificações de formato, então `country_code: \"USA\"` informa o limite de 2 caracteres em vez da mensagem de ISO.", "content": { "application/json": { "examples": { "Alpha-3 country code": { "summary": "country_code deve ser alpha-2: a verificação de tamanho é executada primeiro", "value": { "country_code": [ "Ensure this field has no more than 2 characters." ] } }, "Non-alphabetic country code": { "summary": "2 caracteres, mas não letras", "value": { "country_code": [ "country_code must be a 2-letter ISO 3166-1 alpha-2 code." ] } }, "Invalid currency": { "summary": "3 caracteres, mas não um código ISO 4217", "value": { "registered_capital_currency": [ "Currency must be a 3-letter ISO 4217 code (e.g. USD, EUR, GBP)." ] } }, "Invalid phone": { "summary": "O telefone não passa na verificação de formato / quantidade de dígitos", "value": { "phone": [ "Invalid phone number format." ] } }, "Invalid registry status": { "summary": "registry_status não está no enum", "value": { "registry_status": [ "\"liquidated\" is not a valid choice." ] } }, "Invalid email": { "summary": "Endereço de e-mail com formato inválido", "value": { "email": [ "Enter a valid email address." ] } }, "Invalid website": { "summary": "O valor falha na validação de URL mesmo após a normalização com https://", "value": { "website": [ "Enter a valid URL." ] } }, "Bad date format": { "summary": "As datas devem estar no formato YYYY-MM-DD", "value": { "incorporation_date": [ "Date has wrong format. Use one of these formats instead: YYYY-MM-DD." ] } } } } } }, "403": { "description": "Credenciais ausentes ou permissões insuficientes. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente ou inválido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "A credencial não tem write:businesses", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Sessão desconhecida, empresa desconhecida ou uma empresa que pertence a outra sessão. Cada caso tem uma mensagem `detail` distinta (veja os exemplos). A busca de sessão desconhecida é executada antes das verificações de credencial.", "content": { "application/json": { "examples": { "Unknown session": { "summary": "Nenhuma sessão com este ID na sua aplicação (ou ela foi excluída)", "value": { "detail": "Not found." } }, "Unknown company": { "summary": "Nenhuma empresa com este UUID na sua aplicação", "value": { "detail": "No KYBCompany matches the given query." } }, "Company / session mismatch": { "summary": "companyUuid existe, mas pertence a outra sessão", "value": { "detail": "KYB company does not belong to the given session." } } } } } }, "429": { "description": "Limite de requisições de escrita compartilhado excedido (300 requisições POST/PATCH/DELETE por minuto por chave de API). Verifique o `Retry-After` e os cabeçalhos de resposta `X-RateLimit-*` antes de tentar novamente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Orçamento de escrita esgotado", "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": "Ignorar (ou voltar a exigir) uma parte de pessoas-chave em uma sessão de Verificação de empresas (KYB)", "description": "Isente uma parte das pessoas-chave da verificação ou coloque-a de volta no escopo. Este é o recurso de exceção do operador para uma parte que nunca conseguirá concluir a própria verificação - na maioria das vezes porque a sessão de KYC individual entregue a um UBO ou diretor foi excluída, o que congela o status dessa sessão filha e deixa o KYB parado em `Awaiting User` sem nada que possa fazê-lo avançar.\n\nDefinir `is_skipped: true` remove a parte da agregação de pessoas-chave e recalcula imediatamente a `KYBKeyPeopleCheck` e o status da sessão pai, para que a sessão da empresa possa se estabilizar e então ser aprovada ou recusada. Enviar `is_skipped: false` coloca a parte de volta no escopo, e a verificação volta a aguardar por ela.\n\nAo contrário da opção de pular voltada ao solicitante na tela hospedada de pessoas-chave, este endpoint **não** está condicionado à configuração `allow_skip` da função - essa flag limita o que o solicitante pode decidir, não o que seu analista pode substituir. `requires_verification` é deliberadamente mantido inalterado, de modo que uma parte substituída aparece como `requires_verification: true` **e** `is_skipped: true`, e o registro continua mostrando o que as regras exigiam.\n\nA parte deve pertencer à sessão indicada no caminho (caso contrário, `404` com `\"Party does not belong to the given session.\"`) e à sua aplicação. Um PATCH que de fato altera a flag dispara o [webhook](/pt-br/integration/webhooks) `data.updated` na sessão da empresa com o gatilho `console_key_people_skip`; um PATCH que define a flag com o valor atual não tem efeito e apenas retorna a parte.\n\nAceita uma chave de API ou um token de usuário do console; em ambos os casos, a credencial precisa da permissão `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 da sessão principal de Verificação de empresas (KYB).", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "partyUuid", "in": "path", "required": true, "description": "UUID da parte de pessoas-chave (Key People) a ser atualizada (`key_people_checks[].submitted.parties[].uuid` na decisão da sessão de empresa). Deve pertencer à sessão referenciada por `sessionId`.", "schema": { "type": "string", "format": "uuid", "example": "0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "is_skipped" ], "properties": { "is_skipped": { "type": "boolean", "description": "`true` isenta a parte da verificação para que a checagem de pessoas-chave possa ser concluída sem ela; `false` a coloca de volta no escopo.", "example": true } } } } } }, "responses": { "200": { "description": "Parte atualizada (ou retornada sem alterações quando a flag já tinha esse valor). Retorna a parte, no mesmo formato de uma entrada de `key_people_checks[].submitted.parties[]` na decisão da sessão de empresa.", "content": { "application/json": { "schema": { "type": "object", "description": "Registro de parte de pessoas-chave, com o mesmo formato de uma entrada de `key_people_checks[].submitted.parties[]` na decisão da sessão de empresa.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador da parte." }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Se a parte é uma pessoa física ou uma empresa." }, "name": { "type": "string", "description": "Nome de exibição da parte." }, "is_skipped": { "type": "boolean", "description": "Se a parte está isenta de verificação." }, "requires_verification": { "type": "boolean", "description": "O que as regras de função e de limiar exigiram. Este endpoint não altera esse valor." }, "kyc_session_status": { "type": "string", "nullable": true, "description": "Status da sessão de KYC individual vinculada, congelado no momento da exclusão quando a sessão foi excluída." }, "kyc_session_url": { "type": "string", "nullable": true, "description": "Link para a sessão de KYC individual vinculada. `null` quando não há nenhuma ou quando ela foi excluída." }, "kyc_session_deleted": { "type": "boolean", "description": "A sessão de KYC individual vinculada foi excluída, portanto nunca poderá ser concluída." }, "kyb_sub_session_deleted": { "type": "boolean", "description": "Equivalente de `kyc_session_deleted` para partes corporativas." } } } } } }, "400": { "description": "Erro de validação no corpo da requisição. `is_skipped` é o único campo que este endpoint lê, e ele é obrigatório. Os erros de campo chegam como `{\"\": [\"\"]}`. A validação do corpo é executada *depois* da busca da parte, então um `is_skipped` malformado enviado para uma parte que não existe retorna `404`, e não `400`.", "content": { "application/json": { "examples": { "Missing is_skipped": { "summary": "Corpo vazio, ou um corpo que omite `is_skipped`", "value": { "is_skipped": [ "This field is required." ] } }, "Non-boolean is_skipped": { "summary": "O valor não é um booleano: `\"maybe\"`, `2`, `[]`. Booleanos, além de `\"true\"`/`\"false\"`, `1`/`0` e `\"yes\"`/`\"no\"`, são todos aceitos", "value": { "is_skipped": [ "Must be a valid boolean." ] } }, "Null is_skipped": { "summary": "`is_skipped` está presente, mas é `null`", "value": { "is_skipped": [ "This field may not be null." ] } } } } } }, "403": { "description": "Credenciais ausentes ou permissões insuficientes. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente ou inválido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "A credencial não tem write:businesses", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Parte desconhecida, ou uma parte que pertence a outra sessão. Cada caso tem uma mensagem `detail` distinta (veja os exemplos). As verificações de credencial e permissão são executadas antes da busca da parte, então uma chamada não autorizada retorna `403` em vez de `404`. Não há uma busca separada da sessão: um `sessionId` desconhecido combinado com uma parte sua retorna a mensagem de incompatibilidade.", "content": { "application/json": { "examples": { "Unknown party": { "summary": "Nenhuma parte com este UUID na sua aplicação", "value": { "detail": "Not found." } }, "Party / session mismatch": { "summary": "partyUuid existe, mas está vinculado a outra sessão", "value": { "detail": "Party does not belong to the given session." } } } } } }, "429": { "description": "Limite de requisições de escrita compartilhado excedido (300 requisições POST/PATCH/DELETE por minuto por chave de API). Verifique o `Retry-After` e os cabeçalhos de resposta `X-RateLimit-*` antes de tentar novamente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Rate limited": { "summary": "Orçamento de escrita esgotado", "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": "Obter as configurações de Travel Rule", "description": "Lê as configurações de Travel Rule e o perfil de VASP da aplicação. Na primeira leitura, cria automaticamente uma linha de configurações padrão (desativada) e um perfil vazio.", "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": "Configurações atuais da Travel Rule e 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": "Atualizar configurações de Travel Rule", "description": "Cria ou atualiza as configurações de Travel Rule e o perfil de VASP da aplicação. Atualização parcial: envie apenas os campos que deseja alterar. Definir `is_enabled: true` exige um `legal_name` não vazio (já armazenado ou incluído na mesma requisição); caso contrário, 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": "Configurações e perfil atualizados, no mesmo formato do GET.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleSettingsDetail" } } } }, "400": { "description": "Erro de validação, por exemplo: ativar sem um legal_name, uma sunrise_policy ou non_responsive_policy diferente de HOLD, REJECT, PROCEED ou vazio, um campo desconhecido em `matching_rules`, ou uma escolha de `data_sharing_fields` que não atende às obrigações do remetente no regime da sua jurisdição (os erros são indexados por tipo de entidade em `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": "Enviar a confirmação de e-mail de conformidade", "description": "Envia por e-mail um link de confirmação de uso único para o compliance_email do seu perfil VASP. Abrir o link e clicar no botão de confirmação confirma o endereço, o que a rede Didit exige antes de listar seu perfil. Uma nova requisição substitui o link anterior; o link deixa de funcionar quando o e-mail de conformidade muda. Um e-mail por minuto por endereço.", "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": "O e-mail de confirmação foi enviado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sent_to": { "type": "string", "format": "email" } } }, "example": { "sent_to": "compliance@your-vasp.example" } } } }, "400": { "description": "Nenhum e-mail de conformidade está definido, ou ele já foi confirmado.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "examples": { "No compliance email": { "value": { "compliance_email": [ "Set a compliance email before confirming it." ] } }, "Already confirmed": { "value": { "compliance_email": [ "This compliance email is already confirmed." ] } } } } } }, "429": { "description": "Uma confirmação foi enviada para este endereço há menos de um minuto." }, "503": { "description": "Não foi possível enviar o e-mail. Nada foi alterado; tente novamente em instantes." } } } }, "/v3/travel-rule/wallet-addresses/": { "get": { "summary": "Listar entradas do catálogo de endereços de carteiras", "description": "Lista paginada do catálogo de endereços de carteiras da Travel Rule da sua aplicação, dos mais recentes para os mais antigos.", "operationId": "listTravelRuleWalletAddresses", "x-didit-sdk": { "resource": "travel_rule.wallet_addresses", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/wallet-addresses/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.travel_rule.wallet_addresses.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.travelRule.walletAddresses.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.TravelRule.WalletAddresses.ListAutoPaging(ctx, didit.TravelRuleWalletAddressesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.travelRule().walletAddresses().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletAddresses->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.wallet_addresses.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.TravelRule.WalletAddresses.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Entradas paginadas do catálogo de endereços de carteiras.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WalletAddressEntry" } } } } } } } } }, "post": { "summary": "Registrar um endereço de carteira", "description": "Adiciona uma entrada ao seu catálogo de endereços de carteiras da Travel Rule para que transferências recebidas pelo trilho INTERNAL possam ser resolvidas com base nele.", "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": "A entrada criada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressEntry" } } } }, "400": { "description": "Carteira duplicada (endereço, blockchain e memo) para esta aplicação, um memo ou X-address que a blockchain não suporta, `address` ausente, `travel_address` inválido, `self_declared: true` com `allow_self_declaration` desativado, ou `self_declared: true` com `ownership_validation_mode` igual a `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": "Atualizar metadados do titular do endereço de carteira", "description": "Atualização parcial de holder_name, holder_vendor_data, entity_type e travel_address. Definir travel_address vincula um endereço de roteamento TRP à entrada; valores inválidos são rejeitados com 400. A resposta retorna apenas esses quatro campos.", "operationId": "updateTravelRuleWalletAddress", "x-didit-sdk": { "resource": "travel_rule.wallet_addresses", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "entry_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressEntryUpdate" }, "example": { "holder_name": "Ana Updated", "travel_address": "ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH https://verification.didit.me/v3/travel-rule/wallet-addresses/{entry_uuid}/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"holder_name\": \"Ana Updated\", \"travel_address\": \"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.wallet_addresses.update(\n \"11111111-2222-3333-4444-555555555555\",\n holder_name=\"Ana Updated\",\n travel_address=\"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.walletAddresses.update(\"11111111-2222-3333-4444-555555555555\", {\n holder_name: \"Ana Updated\",\n travel_address: \"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.WalletAddresses.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.WalletAddressEntryUpdateParam{\n\tHolderName: didit.String(\"Ana Updated\"),\n\tTravelAddress: didit.String(\"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.WalletAddressEntryUpdate;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().walletAddresses().update(\"11111111-2222-3333-4444-555555555555\", WalletAddressEntryUpdate.builder()\n .holderName(\"Ana Updated\")\n .travelAddress(\"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletAddresses->update('11111111-2222-3333-4444-555555555555', [\n 'holder_name' => 'Ana Updated',\n 'travel_address' => 'ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.wallet_addresses.update(\n \"11111111-2222-3333-4444-555555555555\",\n holder_name: \"Ana Updated\",\n travel_address: \"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.WalletAddresses.UpdateAsync(\"11111111-2222-3333-4444-555555555555\", new WalletAddressEntryUpdate\n{\n HolderName = \"Ana Updated\",\n TravelAddress = \"ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeSEp1h9tduJcNDZ5SgKLEHeyGMcS1s2HgbM6undFrMQknhM5aTXw3G9KBzi16hx\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Os campos atualizados.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletAddressEntryUpdate" } } } }, "400": { "description": "`travel_address` não é um travel address válido.", "content": { "application/json": { "examples": { "Invalid travel address": { "value": { "travel_address": [ "Invalid travel address." ] } } } } } }, "404": { "description": "Entrada desconhecida ou excluída." } } }, "delete": { "summary": "Excluir um endereço de carteira", "description": "Exclui a entrada junto com suas provas de propriedade e as capturas de tela que elas armazenavam. Ela deixa de gerar correspondências com novas transferências imediatamente, e o endereço fica liberado para um novo registro. As transferências que já usaram a carteira mantêm seu próprio registro dela, que continua igual. A exclusão é irreversível.", "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": "Excluído." }, "404": { "description": "Entrada desconhecida ou já excluída." }, "503": { "description": "`wallet_address_deletion_incomplete`: um arquivo armazenado não pôde ser excluído, então a exclusão parou antes de terminar. A entrada do catálogo de endereços ainda existe; repita a mesma requisição para concluí-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": "Pesquisar no diretório de VASPs", "description": "Busca paginada e ordenada por nome no diretório de VASPs: as entradas do diretório compartilhado, que a Didit monta a partir do registro provisório MiCA da ESMA, do diretório público TRISA, do registro global de LEI e da sua própria curadoria, além dos membros da rede Didit. Cada linha traz as rotas que sua aplicação tem hoje até ela. O perfil da sua própria aplicação nunca é listado. As linhas também trazem a avaliação de due diligence compartilhada e a decisão, a triagem de entidade e os questionários da sua própria aplicação.", "operationId": "listTravelRuleVasps", "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string", "maxLength": 255 }, "description": "Um fragmento de nome ou alias (sem diferenciar maiúsculas de minúsculas), um LEI exato ou um domínio (example.com ou uma URL nesse domínio). Membros da rede Didit correspondem pelo nome legal, pelo LEI ou pelo domínio do seu e-mail de conformidade." }, { "name": "network", "in": "query", "schema": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA", "TRISA" ] }, "description": "Somente entradas do diretório que o diretório de membros de uma rede lista atualmente." }, { "name": "jurisdiction", "in": "query", "schema": { "type": "string" }, "description": "Código de país ISO 3166 alpha-2 ou alpha-3. Qualquer outro valor retorna 400." }, { "name": "reachable", "in": "query", "schema": { "type": "boolean" }, "description": "true: apenas VASPs para os quais sua aplicação tem uma rota disponível (incluindo membros da rede Didit). false: apenas entradas do diretório que ela não consegue alcançar hoje." }, { "name": "kind", "in": "query", "schema": { "type": "string", "enum": [ "directory", "didit" ] }, "description": "Somente entradas do diretório, ou somente membros da rede Didit." }, { "name": "risk", "in": "query", "schema": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "description": "Somente entradas do diretório cujo risk_level seja esta faixa. Membros da rede Didit, que não recebem pontuação, nunca correspondem." }, { "name": "responsiveness", "in": "query", "schema": { "type": "string", "enum": [ "RESPONSIVE", "UNRESPONSIVE", "UNKNOWN" ] }, "description": "Somente entradas do diretório cujo responsiveness.status seja este valor. Membros da rede Didit nunca correspondem." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/travel-rule/vasps/?search=counterparty&reachable=true' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.travel_rule.list_vasps():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.travelRule.listVasps()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.TravelRule.ListVASPsAutoPaging(ctx, didit.TravelRuleListVASPsParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.travelRule().listVasps()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "travelRule->listVasps() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.list_vasps.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.TravelRule.ListVaspsAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Resultados paginados do diretório de VASPs, ordenados por nome.", "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": "Um filtro não é válido: o corpo nomeia cada campo, por exemplo, uma rede, um código de país, uma faixa de risco ou um status de responsividade desconhecido.", "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": "Obter uma entrada do diretório de VASPs", "description": "Uma entrada do diretório ou um membro da rede Didit pelo id que a busca retornou, com os mesmos campos e as rotas que sua aplicação tem até ele.", "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": "O id de uma linha 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": "A entrada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaspDirectoryEntry" } } } }, "404": { "description": "Nenhuma entrada nem membro listado da rede Didit tem este id.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry has this id." } } } } } } }, "/v3/travel-rule/vasps/{vasp_id}/decision/": { "get": { "summary": "Obter sua decisão sobre um VASP", "description": "A decisão da sua aplicação sobre uma contraparte (uma entrada do diretório ou um membro da rede Didit): approved, restricted ou blocked. Uma entidade de uma marca sem decisão própria segue a decisão da marca, indicada em inherited_from. Privada da sua aplicação.", "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": "O id de uma linha de GET /v3/travel-rule/vasps/: uma entrada do diretório ou um membro da rede 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": "A decisão que se aplica, ou 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": "Nenhuma entrada do diretório nem membro listado da rede Didit tem este id. Seu próprio perfil de VASP nunca é uma contraparte sua.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } } } }, "put": { "summary": "Defina sua decisão sobre um VASP", "description": "Tome ou altere a decisão da sua aplicação sobre uma contraparte: APPROVED, RESTRICTED ou BLOCKED, com um motivo opcional. Ela nunca altera a entrada compartilhada do diretório e atua apenas por meio das suas regras de transação (counterparty_dd_status). Uma decisão sobre uma marca também abrange cada uma das suas entidades que não tenha decisão própria.", "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": "O id de uma linha de GET /v3/travel-rule/vasps/: uma entrada do diretório ou um membro da rede 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": "A decisão como se aplica agora.", "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": "A decisão está ausente ou não é APPROVED, RESTRICTED ou BLOCKED, ou o motivo tem mais de 255 caracteres.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "example": { "decision": [ "\"MAYBE\" is not a valid choice." ] } } } }, "404": { "description": "Nenhuma entrada do diretório nem membro listado da rede Didit tem este id. Seu próprio perfil de VASP nunca é uma contraparte sua.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } } } }, "delete": { "summary": "Remover sua decisão sobre um VASP", "description": "Remove a decisão da sua própria aplicação sobre uma contraparte. A resposta mostra a decisão que passa a valer: nula ou, no caso de uma entidade de uma marca, a decisão da marca, que a entidade volta 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": "O id de uma linha de GET /v3/travel-rule/vasps/: uma entrada do diretório ou um membro da rede 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": "A decisão foi removida; o corpo mostra a decisão que se aplica agora.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyDecisionResponse" }, "example": { "decision": null } } } }, "404": { "description": "Nenhuma contraparte tem este id, ou sua aplicação não tem uma decisão própria sobre ela (uma decisão que ela apenas herda da sua marca não pode ser removida aqui: remova a da 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": "Obter a triagem de entidade de um VASP", "description": "Indica se a análise de contraparte está ativada para sua aplicação, quanto uma análise custa para sua organização, por quanto tempo um resultado permanece atualizado e sua análise mais recente de sanções e mídia adversa da contraparte. A leitura é gratuita.", "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": "O id de uma linha de GET /v3/travel-rule/vasps/: uma entrada do diretório ou um membro da rede 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": "Sua configuração de análise, o preço dela e sua análise mais recente.", "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": "O contrato da sua organização não tem tarifa configurada para a análise de contrapartes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No contract rate is configured for this usage type." } } } }, "404": { "description": "Nenhuma entrada do diretório nem membro listado da rede Didit tem este id. Seu próprio perfil de VASP nunca é uma contraparte sua.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } } } }, "post": { "summary": "Fazer a triagem de um VASP", "description": "Analise a entidade contraparte em listas de sanções e mídia adversa para a sua aplicação. Opcional (opt-in): counterparty_screening_enabled precisa estar ativado nas configurações de Travel Rule. Cada nova análise é cobrada pelo preço de Análise AML de empresas (Company AML Screening) da sua organização; uma análise com menos de 30 dias é retornada em vez disso (200, sem cobrança), a menos que você envie refresh: true. Apenas uma análise de uma mesma contraparte é executada por vez em cada aplicação. O resultado é privado para a sua aplicação. Aplicações de sandbox nunca são analisadas.", "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": "O id de uma linha de GET /v3/travel-rule/vasps/: uma entrada do diretório ou um membro da rede 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": "Uma análise recente já existia e foi retornada. Nada foi cobrado.", "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": "Uma nova análise foi executada e cobrada.", "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": "O corpo não é válido ou a contraparte não tem um nome para a triagem.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "example": { "detail": [ "This counterparty has no name to screen." ] } } } }, "403": { "description": "O saldo da sua organização não cobre a análise (código insufficient_credits; nada foi executado e nada foi cobrado), ou seu contrato não tem tarifa configurada para ela.", "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": "Nenhuma entrada do diretório nem membro listado da rede Didit tem este id. Seu próprio perfil de VASP nunca é uma contraparte sua.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } }, "409": { "description": "Nada foi executado e nada foi cobrado: a triagem de contrapartes está desativada para sua aplicação, a aplicação é de sandbox ou já há uma triagem desta contraparte em andamento.", "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": "Não foi possível concluir a análise. Nada foi cobrado; tente novamente em instantes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "The screening provider did not answer. Try again in a moment." } } } } } } }, "/v3/travel-rule/vasps/{vasp_id}/questionnaires/": { "get": { "summary": "Listar questionários de due diligence com um VASP", "description": "Todos os questionários de due diligence que sua aplicação enviou à contraparte, do mais recente para o mais antigo, com o status e, depois de respondidos, as respostas. Privado para sua aplicação.", "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": "O id de uma linha de GET /v3/travel-rule/vasps/: uma entrada do diretório ou um membro da rede 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": "Seus questionários com esta contraparte.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleCounterpartyQuestionnaireList" }, "example": { "questionnaires": [ { "id": "3f9e8d7c-6b5a-4c3d-9e2f-1a0b9c8d7e6f", "status": "SENT", "form_version": "1", "sent_to": "travelrule@counterparty.example", "sent_at": "2026-10-14T10:00:00Z", "expires_at": "2026-11-13T10:00:00Z", "answered_at": null, "valid_until": null, "current": false, "answers": {} }, { "id": "8b7a6c5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d", "status": "ANSWERED", "form_version": "1", "sent_to": "travelrule@counterparty.example", "sent_at": "2026-09-02T08:00:00Z", "expires_at": "2026-10-02T08:00:00Z", "answered_at": "2026-09-04T15:20:00Z", "valid_until": "2027-09-04T15:20:00Z", "current": true, "answers": { "legal_name": "Example Counterparty VASP, incorporated in the example jurisdiction.", "licensing": "Crypto-asset service provider authorised under MiCA by its national regulator, licence active.", "jurisdictions": "EU and EEA. We do not serve the United States.", "aml_program": "Written AML/CFT policy, annual independent review, last completed in March 2026.", "compliance_officer": "Head of Compliance, reachable at compliance@counterparty.example.", "sanctions_screening": "Customers at onboarding and daily; counterparties on every transfer.", "transaction_monitoring": "Rule-based monitoring with analyst review; suspicious activity reports filed with the FIU.", "travel_rule": "TRP and email; we answer requests within one business day.", "custody": "Segregated customer wallets held with a qualified custodian, insured.", "ownership": "No shareholder holds 25 percent or more; parent company Example Holding Group.", "record_keeping": "Five-year record-keeping for Travel Rule and transaction data, as our regulator requires.", "data_protection": "Encrypted at rest and in transit, stored in the EU." } } ] } } } }, "404": { "description": "Nenhuma entrada do diretório nem membro listado da rede Didit tem este id. Seu próprio perfil de VASP nunca é uma contraparte sua.", "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 um questionário de due diligence a um VASP", "description": "Envia por e-mail o questionário padrão de due diligence da Didit para um endereço de conformidade registrado da contraparte, com um link de resposta de uso único. A contraparte tem 30 dias para responder a todas as perguntas; as respostas permanecem válidas por 365 dias. Um novo envio substitui o seu questionário anterior não respondido para a mesma contraparte, cujo link deixa de funcionar. Um e-mail por minuto por endereço.", "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": "O id de uma linha de GET /v3/travel-rule/vasps/: uma entrada do diretório ou um membro da rede 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": "O questionário foi enviado por e-mail.", "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 não é um endereço de e-mail válido ou não é um endereço de conformidade registrado para a contraparte, ou a contraparte não tem nenhum endereço de conformidade registrado.", "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": "Nenhuma entrada do diretório nem membro listado da rede Didit tem este id. Seu próprio perfil de VASP nunca é uma contraparte sua.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No directory entry or Didit network member has this id." } } } }, "429": { "description": "Um questionário foi enviado para este endereço há menos de um minuto." }, "503": { "description": "Não foi possível enviar o e-mail e nenhum questionário foi criado. Tente novamente em instantes." } } } }, "/v3/transactions/{transaction_id}/travel-rule/": { "patch": { "summary": "Concluir, cancelar, reenviar ou atualizar a carteira do remetente de uma transferência Travel Rule", "description": "Informe `payment_txn_id` para reportar o hash on-chain e mover uma transferência de saída em COMPLETED para FINISHED (a transferência correspondente no trilho INTERNAL também passa para FINISHED), `{\"action\": \"cancel\"}` para cancelar uma transferência que não esteja em status final, ou `{\"action\": \"resend\"}` para rotear novamente uma transferência de saída parada em COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE ou NOT_ENOUGH_COUNTERPARTY_DATA (melhore antes os dados da contraparte, por exemplo, adicionando um travel_address à entrada da carteira de destino). resend se aplica somente a transferências de saída. `{\"action\": \"update_compliance_email\", \"compliance_email\": \"desk@example.com\"}` substitui o e-mail de conformidade de uma transferência de saída em um desses três status, a correção para `reason: email_undeliverable`: o status não muda, e o próximo `resend` envia a requisição para esse endereço. Um resend é colocado na fila, não executado dentro da requisição: a resposta mostra a transferência de volta em AWAITING_COUNTERPARTY com uma entrada `resend queued` na linha do tempo e uma `delivery` na fila, e o destino dela chega como um webhook `travel_rule.status.updated`. Quando a transferência passou pela GTR, VerifyVASP ou Sygna Bridge, a rede toma conhecimento do hash on-chain ou do cancelamento após a resposta, com novas tentativas; `delivery` mostra a situação dessa mensagem. `{\"action\": \"update_originator_wallet\", \"wallet_address\": \"...\"}` registra a carteira da qual os fundos realmente saíram em uma transferência de saída, por exemplo, o endereço a partir do qual um saque UTXO foi transmitido, e não a carteira principal que você declarou. Isso altera apenas o registro: nada é reenviado à contraparte e o status permanece o mesmo. O remetente passa a ser `chain_details.originator` com `source: updated`, a alteração é adicionada à `timeline` com a carteira anterior e a nova, e a transferência correspondente no trilho INTERNAL é atualizada da mesma forma. `{\"action\": \"beneficiary_vasp\", \"beneficiary_vasp\": \"\"}` permite que você mesmo indique a contraparte quando a descoberta não conseguiu, em uma transferência de saída em COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE ou NOT_ENOUGH_COUNTERPARTY_DATA: a transferência é roteada para esse VASP e enviada novamente.", "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 estável da transação na Didit à qual a transferência pertence.", "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": "A transferência atualizada. Após `update_compliance_email`, o status permanece inalterado e ela mantém `reason: email_undeliverable` até o próximo `resend`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTransferDetail" } } } }, "400": { "description": "Nem payment_txn_id nem uma ação suportada foi informada, `compliance_email` está ausente ou não é um endereço de e-mail em `update_compliance_email`, ou, em `update_originator_wallet`, não há wallet_address, há uma carteira ou memo que a chain da transferência não comporta, ou uma carteira que não é uma das entradas UTXO da transferência, ou `beneficiary_vasp` está ausente ou não é um ID de VASP válido do diretório.", "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": "Transação desconhecida, a transação não tem transferência de Travel Rule ou (ação `beneficiary_vasp`) nenhuma entrada do diretório tem esse id." }, "409": { "description": "A transferência não está em um estado que permita esta operação (por exemplo, não está COMPLETED/de saída para finish, já está em estado final para cancel, ou não é uma transferência de saída com status que permita reenvio para resend). `update_compliance_email` responde `409` para uma transferência de entrada e para uma de saída fora de COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE e NOT_ENOUGH_COUNTERPARTY_DATA. `update_originator_wallet` responde `409` para uma transferência de entrada, cancelada ou expirada. `beneficiary_vasp` responde `409`, a menos que a transferência seja de saída e esteja em COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE ou 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 ou negar a propriedade da carteira", "description": "Resolve uma transferência que aguarda a confirmação de propriedade da carteira: chame-o do seu lado da transferência quando ela estiver em UNCONFIRMED_OWNERSHIP, ou quando for uma transferência de entrada em ON_HOLD. A confirmação marca a entrada correspondente no catálogo de endereços de carteiras como tendo a propriedade verificada (para uma transferência de entrada em ON_HOLD sem entrada, a Didit cria uma a partir de beneficiary_data.wallet_address) e executa a verificação do nome do beneficiário nos dois lados da transferência; a negação recusa os dois lados. Uma transferência de entrada cujo depósito já foi liquidado passa para FINISHED quando a correspondência é bem-sucedida. Quando a carteira da contraparte foi declarada autocustodiada (counterparty.payment_method.method_type: unhosted_wallet), a confirmação registra que o cliente verificou quem controla essa carteira e conclui a transferência (COMPLETED) nas duas direções, ou FINISHED para um depósito de entrada cujo hash on-chain já é conhecido. A carteira verificada é a da contraparte: o destino de um saque de saída, ou a origem (carteira do remetente) de um depósito de entrada. Se ela ainda não estiver no seu catálogo de endereços de carteiras, a Didit a adiciona com a propriedade verificada em nome da contraparte; se o catálogo já a tiver em nome de um titular diferente, a transferência passa para COUNTERPARTY_MISMATCHED_DATA. Para uma transferência TRP de entrada em UNCONFIRMED_OWNERSHIP, ON_HOLD ou COUNTERPARTY_MISMATCHED_DATA, a Didit envia a sua decisão ao VASP de origem: a aprovação retorna o endereço de pagamento (wallet_address, ou o endereço da entrada correspondente) e move a transferência para COMPLETED, e a negação a recusa. A mesma chamada também decide uma transferência de entrada enviada por uma contraparte GTR ou Sygna Bridge que aguarda a sua revisão (`UNCONFIRMED_OWNERSHIP`, `ON_HOLD` ou `COUNTERPARTY_MISMATCHED_DATA`): `confirmed: true` a aprova (informe `wallet_address` quando a transferência não indicar nenhum) e `confirmed: false` a recusa, e a rede recebe a resposta depois da resposta da API, com novas tentativas. A VerifyVASP recebe a resposta no momento em que pergunta, por isso uma transferência VerifyVASP que precisaria da sua revisão é recusada imediatamente e não pode ser decidida depois.", "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 estável da Didit da transação que sua aplicação mantém para esta transferência: a transação do lado do beneficiário em uma transferência pelo trilho INTERNAL, ou a transação que você criou (de saída ou de entrada) quando a carteira da contraparte foi declarada autocustodiada.", "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": "A transferência atualizada. Em uma transferência recebida, os originator_data/beneficiary_data da contraparte permanecem mascarados (`data_masked: true`) até que a propriedade seja confirmada; então `data_unmasked` registra quando, por que e por quem.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTransferDetail" } } } }, "409": { "description": "A transferência não está aguardando confirmação de propriedade, nenhuma entrada do catálogo de endereços de carteiras corresponde à carteira da contraparte, uma transferência INTERNAL de outro cliente da Didit precisa de uma prova de controle (uma mensagem assinada ou um depósito de teste) antes de poder ser confirmada, ou uma transferência de rede já foi respondida pela própria rede (uma transferência VerifyVASP, ou uma transferência GTR ou Sygna Bridge sobre a qual você ou a Didit já decidiram).", "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": "Erro de validação: confirmed ausente, uma aprovação TRP de entrada sem wallet_address e sem endereço para usar como alternativa, ou `confirmed: true` em uma transferência declarada de carteira autocustodiada que não indica nenhuma carteira da contraparte, sem que um `wallet_address` tenha sido enviado.", "content": { "application/json": { "examples": { "No payment address": { "value": { "wallet_address": [ "wallet_address is required to approve." ] } } } } } }, "404": { "description": "Transação desconhecida, ou a transação não tem transferência de Travel Rule." }, "502": { "description": "Somente para transferências TRP recebidas: a Didit não conseguiu entregar sua decisão ao VASP de origem, então o status da transferência não muda.", "content": { "application/json": { "examples": { "Callback not delivered": { "value": { "detail": "Counterparty inquiry-resolution callback could not be delivered." } } } } } } } } }, "/v3/transactions/{transaction_id}/travel-rule/messages/": { "get": { "summary": "Listar mensagens da Travel Rule", "description": "Mensagens e solicitações de documentos trocadas com o VASP da contraparte sobre esta 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 estável da transação na Didit à qual a transferência pertence.", "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": "As mensagens, da mais antiga para a mais recente.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleMessage" } } } } }, "404": { "description": "Transação ou token desconhecido, ou não há transferência de Travel Rule na transação." } } }, "post": { "summary": "Enviar uma mensagem de Travel Rule ou uma solicitação de documento", "description": "Envia uma mensagem ou uma requisição de documentos à VASP contraparte. Funciona em transferências INTERNAL (o outro cliente da Didit a vê no seu lado do par) e EMAIL (a contraparte recebe um e-mail e responde no portal de retirada). Uma transferência por TRP, GTR, TRUST, VerifyVASP ou Sygna não contém mensagens, porque esses protocolos não têm mensagens. Limites: 100 mensagens por transferência, 5000 caracteres por corpo, 10 documentos solicitados, 5 arquivos de 10 MB cada.", "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 estável da transação na Didit à qual a transferência pertence.", "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": "A mensagem armazenada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleMessage" } } } }, "400": { "description": "Corpo inválido, um tipo ou tamanho de arquivo não aceito, mais de 100 mensagens na transferência ou um `reply_to` que não é uma mensagem desta transferência.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "requested_documents": [ "Name at least one document the counterparty should send." ] } } } }, "404": { "description": "Transação ou token desconhecido, ou não há transferência de Travel Rule na transação." }, "409": { "description": "Nenhuma mensagem consegue chegar à contraparte. `detail` informa o motivo: a transferência passa por um trilho de rede (TRP, GTR, TRUST, VerifyVASP ou Sygna), ainda não tem contraparte, os dados de uma transferência INTERNAL não corresponderam ao titular da carteira e por isso nada chegou ao destinatário, ou o link de retirada de uma transferência EMAIL expirou ou a transferência está encerrada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } } } }, "/v3/travel-rule/pickup/{token}/": { "get": { "summary": "Obter as informações de retirada do canal de e-mail", "description": "Público, sem autenticação. Permite que um VASP contraparte que não usa a Didit visualize a troca pendente a partir do link de retirada enviado por e-mail. O próprio token é a autenticação.", "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": "O valor `?contact=` do link, o contato para o qual o link foi enviado. É retornado sem alterações como `contact`; não é validado." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl https://verification.didit.me/v3/travel-rule/pickup/{token}/" } ], "responses": { "200": { "description": "Pré-visualização da retirada.", "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 desconhecido." }, "410": { "description": "O prazo terminou: a contraparte já respondeu, a transferência saiu de AWAITING_COUNTERPARTY ou o prazo-limite passou." } } } }, "/v3/travel-rule/pickup/{token}/respond/": { "post": { "summary": "Responder a uma coleta pelo canal de e-mail", "description": "Público, sem autenticação. Aceita ou recusa a troca a partir do link de coleta enviado por e-mail. Ao aceitar, beneficiary_name é verificado conforme a política name_matching_strictness do remetente.", "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": "O valor `?contact=` do link. Usado quando o corpo não envia `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": "O status resultante da troca: COMPLETED ou COUNTERPARTY_MISMATCHED_DATA após uma aceitação, COUNTERPARTY_VASP_GENERAL_DECLINE após uma recusa, que também retorna `decline_reason`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "decline_reason": { "type": "string", "description": "Presente após uma recusa." } } }, "examples": { "accepted": { "value": { "status": "COMPLETED" } }, "declined": { "value": { "status": "COUNTERPARTY_VASP_GENERAL_DECLINE", "decline_reason": "not_our_customer" } } } } } }, "400": { "description": "Um campo é inválido: por exemplo, `decision` ausente ou diferente de `accept` ou `decline`, `decline_detail` ausente em uma recusa com `decline_reason: other`, um `ivms_response` que não é um objeto IVMS 101 ou tem mais de 16384 caracteres, ou um `contact` no corpo que não é um 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 desconhecido." }, "410": { "description": "O prazo terminou: a contraparte já respondeu, a transferência saiu de AWAITING_COUNTERPARTY ou o prazo-limite passou." } } } }, "/v3/travel-rule/pickup/{token}/messages/": { "get": { "summary": "Listar mensagens para coleta", "description": "Público, sem autenticação. As mensagens de uma transferência pelo canal EMAIL como o VASP contraparte as lê: o que o cliente enviou é `INBOUND` e é assinado com o nome do VASP do cliente. O token é a autenticação.", "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": "As mensagens, da mais antiga para a mais recente, do lado da contraparte.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleMessage" } } } } }, "404": { "description": "Token desconhecido." }, "410": { "description": "O link de retirada expirou ou a transferência está encerrada." } } }, "post": { "summary": "Responder no portal de retirada", "description": "Público, sem autenticação. O VASP contraparte responde em uma transferência pelo canal EMAIL. Mesmo corpo das mensagens da transação; os anexos devem ser PDF, PNG, JPEG ou WebP. O token é a autenticação.", "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": "A mensagem armazenada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleMessage" } } } }, "400": { "description": "Corpo inválido, um tipo ou tamanho de arquivo não aceito, mais de 100 mensagens na transferência ou um `reply_to` que não é uma mensagem desta transferência.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "requested_documents": [ "Name at least one document the counterparty should send." ] } } } }, "404": { "description": "Token desconhecido." }, "410": { "description": "O link de retirada expirou ou a transferência está encerrada." } } } }, "/v3/travel-rule/inbound/": { "post": { "summary": "Registrar uma transferência de entrada após o depósito (sunrise)", "description": "Registre os dados da Travel Rule para um depósito de cripto que já foi liquidado on-chain antes de qualquer troca. Cria uma transação travelRule de entrada (ou reutiliza um depósito não reivindicado) e associa a transferência ao seu catálogo de endereços de carteiras. Para uma transação recém-criada, a Didit envia primeiro transaction.created e, depois, os 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": "Uma transferência para este txid e wallet_address já foi registrada; a existente é retornada sem alterações (created é false).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleInboundResponse" } } } }, "201": { "description": "Uma nova transferência de Travel Rule foi registrada, em uma nova transação de entrada ou em um depósito existente não reivindicado (created é true).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleInboundResponse" } } } }, "400": { "description": "Um campo obrigatório (`chain`, `txid`, `wallet_address`, `amount`, `currency`) está ausente, `originating_vasp.lei` não é um LEI válido, `originating_vasp.travel_address` não é um travel address válido, um memo, X-address ou `utxo` que a chain não comporta, ou `originator_data` / `beneficiary_data` que não é um objeto.", "content": { "application/json": { "examples": { "Missing field": { "value": { "txid": [ "This field is required." ] } }, "Invalid LEI": { "value": { "originating_vasp": { "lei": [ "Invalid LEI: expected 20 alphanumeric characters (ISO 17442)." ] } } } } } } } } } }, "/v3/travel-rule/test-vasp/inbound/": { "post": { "summary": "Disparar uma transferência de entrada a partir do Didit Test VASP (sandbox)", "description": "Apenas aplicações de sandbox. O Didit Test VASP envia à sua aplicação uma transferência de Travel Rule de entrada, para que você possa testar o lado receptor de uma exchange de ponta a ponta antes de entrar em produção. A transferência é registrada e decidida pela mesma lógica que uma transferência de entrada real de uma rede executa contra o seu catálogo de endereços de carteiras, de modo que a caixa de entrada, a decisão e o fluxo de propriedade da carteira se comportam como em produção. Nada sai da Didit. Uma aplicação em produção recebe 400. Envie a mesma `reference` novamente para obter a transferência registrada pela primeira chamada em vez de uma segunda.", "operationId": "triggerTravelRuleTestVaspInbound", "x-didit-sdk": { "resource": "transactions.travel_rule", "method": "trigger_test_vasp_inbound", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTestVaspInboundRequest" }, "example": { "beneficiary_wallet_address": "0xYourSandboxWallet", "scenario": "accept", "amount": "1", "reference": "demo-001" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/test-vasp/inbound/ \\\n -H 'x-api-key: YOUR_SANDBOX_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"beneficiary_wallet_address\":\"0xYourSandboxWallet\",\"scenario\":\"accept\",\"reference\":\"demo-001\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.travel_rule.trigger_test_vasp_inbound(\n beneficiary_wallet_address=\"0xYourSandboxWallet\",\n scenario=\"accept\",\n amount=\"1\",\n reference=\"demo-001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.travelRule.triggerTestVaspInbound({\n beneficiary_wallet_address: \"0xYourSandboxWallet\",\n scenario: \"accept\",\n amount: \"1\",\n reference: \"demo-001\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.TravelRule.TriggerTestVASPInbound(ctx, didit.TravelRuleTestVASPInboundRequest{\n\tBeneficiaryWalletAddress: \"0xYourSandboxWallet\",\n\tScenario: didit.Some(didit.TravelRuleTestVASPInboundRequestScenario(\"accept\")),\n\tAmount: didit.String(\"1\"),\n\tReference: didit.String(\"demo-001\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleTestVaspInboundRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().travelRule().triggerTestVaspInbound(TravelRuleTestVaspInboundRequest.builder()\n .beneficiaryWalletAddress(\"0xYourSandboxWallet\")\n .scenario(TravelRuleTestVaspInboundRequest.Scenario.of(\"accept\"))\n .amount(\"1\")\n .reference(\"demo-001\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->travelRule->triggerTestVaspInbound([\n 'beneficiary_wallet_address' => '0xYourSandboxWallet',\n 'scenario' => 'accept',\n 'amount' => '1',\n 'reference' => 'demo-001',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.travel_rule.trigger_test_vasp_inbound(\n beneficiary_wallet_address: \"0xYourSandboxWallet\",\n scenario: \"accept\",\n amount: \"1\",\n reference: \"demo-001\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.TravelRule.TriggerTestVaspInboundAsync(new TravelRuleTestVaspInboundRequest\n{\n BeneficiaryWalletAddress = \"0xYourSandboxWallet\",\n Scenario = new TravelRuleTestVaspInboundRequestScenario(\"accept\"),\n Amount = \"1\",\n Reference = \"demo-001\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "A transferência recebida foi registrada e decidida. Uma repetição com a mesma `reference` retorna o mesmo corpo.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleTestVaspInboundResponse" } } } }, "400": { "description": "Corpo inválido, um `scenario` desconhecido ou não suportado, ou a aplicação é uma aplicação de produção.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Não foi possível registrar a transferência, por exemplo porque a Travel Rule não está habilitada para a aplicação.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } } } }, "/v3/travel-rule/widget-session/": { "post": { "summary": "Gerar uma sessão de widget de propriedade de carteira", "description": "Gera uma URL/token do widget hospedado de comprovação de propriedade de carteira. Envie o cliente para a url retornada para comprovar o controle de uma carteira (assinatura de mensagem, teste Satoshi, captura de tela ou autodeclaração). Nesta versão, o widget é apenas web: abra a url no navegador do sistema ou em uma custom tab, nunca dentro de uma webview de SDK móvel.", "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": "A sessão de widget emitida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetSessionResponse" } } } }, "400": { "description": "Corpo inválido: `callback_url` não é uma URL http(s) absoluta, `expires_in_minutes` está fora do intervalo de 5 a 10080, `transaction_id` não é um UUID ou um campo excede seu limite de tamanho.", "content": { "application/json": { "examples": { "Invalid callback_url": { "value": { "callback_url": [ "callback_url must be an absolute http(s) URL." ] } } } } } }, "404": { "description": "`transaction_id` não identifica uma transferência da Travel Rule nesta aplicação." } } } }, "/v3/travel-rule/widget/{token}/": { "get": { "summary": "Obter o contexto do widget de propriedade de carteira", "description": "Endpoint público de leitura identificado pelo token de sessão do widget, sem necessidade de chave de API. Retorna o contexto do widget e o status de cada prova, para que você possa consultá-lo periodicamente (polling) e detectar a conclusão; completed_at deixa de ser nulo quando uma prova é verificada. Uma prova SATOSHI_TEST pode permanecer com status PENDING enquanto seu depósito foi detectado on-chain, mas ainda não confirmado; um job em segundo plano a verifica novamente de forma automática e a conclui quando o depósito é confirmado, então nenhuma ação do cliente é necessária durante a espera. Cada prova traz os campos de que seu método precisa: deposit_address, expected_amount e seu próprio expires_at para SATOSHI_TEST; challenge para MESSAGE_SIGNING. Prefira o webhook travel_rule.status.updated ao polling quando a sessão estiver vinculada a uma 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 sessão opaco retornado quando a sessão do widget foi criada.", "schema": { "type": "string" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl https://verification.didit.me/v3/travel-rule/widget/{token}/" } ], "responses": { "200": { "description": "O contexto do widget e os status das provas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetContext" } } } }, "404": { "description": "Token desconhecido." }, "410": { "description": "A sessão expirou sem ser concluída." } } } }, "/v3/travel-rule/widget/{token}/vasps/": { "get": { "summary": "Pesquisar VASPs a partir do widget de carteira", "description": "Endpoint público de leitura identificado pelo token de sessão do widget, sem necessidade de chave de API: o seletor de VASP do widget do usuário final. Mesma busca e mesmos filtros de GET /v3/travel-rule/vasps/ para a aplicação do widget, informando apenas quem é cada VASP e se ele pode ser contatado.", "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 sessão opaco retornado quando a sessão do widget foi criada.", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string", "maxLength": 255 }, "description": "Um fragmento de nome ou alias (sem diferenciar maiúsculas de minúsculas), um LEI exato ou um domínio (example.com ou uma URL nesse domínio). Membros da rede Didit correspondem pelo nome legal, pelo LEI ou pelo domínio do seu e-mail de conformidade." }, { "name": "network", "in": "query", "schema": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA", "TRISA" ] }, "description": "Somente entradas do diretório que o diretório de membros de uma rede lista atualmente." }, { "name": "jurisdiction", "in": "query", "schema": { "type": "string" }, "description": "Código de país ISO 3166 alpha-2 ou alpha-3. Qualquer outro valor retorna 400." }, { "name": "reachable", "in": "query", "schema": { "type": "boolean" }, "description": "true: apenas VASPs para os quais sua aplicação tem uma rota disponível (incluindo membros da rede Didit). false: apenas entradas do diretório que ela não consegue alcançar hoje." }, { "name": "kind", "in": "query", "schema": { "type": "string", "enum": [ "directory", "didit" ] }, "description": "Somente entradas do diretório, ou somente membros da rede Didit." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl 'https://verification.didit.me/v3/travel-rule/widget/{token}/vasps/?search=counterparty'" } ], "responses": { "200": { "description": "Resultados paginados, ordenados por nome.", "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": "Um filtro não é válido: o corpo nomeia cada campo, por exemplo, uma rede ou um código de país desconhecido.", "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 desconhecido." }, "410": { "description": "A sessão expirou." } } }, "post": { "summary": "Selecione o VASP da contraparte no widget da carteira", "description": "Endpoint público de escrita identificado pelo token de sessão do widget, sem necessidade de chave de API: o usuário final escolheu o VASP de destino que a descoberta automática não conseguiu identificar. Somente uma transferência de saída em COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE ou NOT_ENOUGH_COUNTERPARTY_DATA aceita essa escolha. A transferência é encaminhada para esse VASP e enviada novamente; a descoberta automática nunca substitui a escolha.", "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 sessão opaco retornado quando a sessão do widget foi criada.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "vasp" ], "properties": { "vasp": { "type": "string", "format": "uuid", "description": "O `id` de um VASP retornado por `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": "A escolha foi registrada e a transferência está sendo enviada novamente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "transfer_status": { "type": "string", "description": "O status da transferência após a escolha." }, "counterparty_vasp": { "type": "string", "description": "O nome do VASP que o usuário final escolheu." } } }, "example": { "detail": "Counterparty VASP selected; the transfer is being resent.", "transfer_status": "AWAITING_COUNTERPARTY", "counterparty_vasp": "Northwind Exchange" } } } }, "400": { "description": "`vasp` está ausente, ou nenhuma entrada ativa do diretório tem esse id.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "example": { "vasp": [ "No directory entry has this id." ] } } } }, "404": { "description": "Token desconhecido." }, "409": { "description": "A sessão do widget não está vinculada a uma transferência da Travel Rule, ou a transferência não é de saída em um status que aceite uma contraparte." }, "410": { "description": "A sessão expirou." } } } }, "/v3/organization/{organization_id}/application/{application_id}/vendor-users/toggle-ongoing-monitoring/": { "patch": { "summary": "Ativar ou desativar o monitoramento AML contínuo para usuários", "description": "Ativa ou desativa o monitoramento AML contínuo no nível do usuário. Exatamente uma análise AML monitorada é mantida por usuário; usuários sem nenhuma análise AML (por exemplo, usuários importados) recebem uma, criada e executada primeiro, cobrada como uma análise AML comum. Defina estimate_only para visualizar previamente as contagens e os custos sem gravar nada. Lotes de 20 ou menos são resolvidos na própria requisição (200, COMPLETED); lotes maiores retornam 202 e são executados de forma assí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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." } ], "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": "Estimativa (quando estimate_only) ou o job concluído, para lotes pequenos processados de forma síncrona.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringToggleResult" } } } }, "202": { "description": "Lotes maiores são processados de forma assíncrona; consulte periodicamente o endpoint do job com o job_id retornado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "403": { "description": "Privilégio write:sessions ausente, ou saldo insuficiente para ativar (a estimativa é incluída no corpo do erro)." } }, "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": "Obter um job de monitoramento AML contínuo", "description": "Progresso e contadores por resultado de um job de ativação ou desativação do monitoramento. Consulte a cada poucos segundos enquanto o status for PENDING ou 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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID do job de monitoramento retornado pelo endpoint de ativação." } ], "responses": { "200": { "description": "A tarefa.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "404": { "description": "Job desconhecido para esta aplicação." } }, "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": "Ativar ou desativar o monitoramento AML contínuo para empresas", "description": "Equivalente, no nível de empresa, da alternância de usuários: uma análise AML monitorada por empresa, e as empresas sem nenhuma análise AML são analisadas primeiro (entidade empresa). Mesmo contrato de estimate_only, caminho rápido inline e job assíncrono.", "operationId": "toggle_vendor_businesses_ongoing_monitoring", "x-didit-sdk": { "resource": "businesses", "method": "set_ongoing_monitoring", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Businesses" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." } ], "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": "Estimativa (quando estimate_only) ou o job concluído, para lotes pequenos processados de forma síncrona.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringToggleResult" } } } }, "202": { "description": "Lotes maiores são processados de forma assíncrona; consulte periodicamente o endpoint do job com o job_id retornado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "403": { "description": "Privilégio write:sessions ausente, ou saldo insuficiente para ativar (a estimativa é incluída no corpo do erro)." } }, "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": "Obter um job de monitoramento AML contínuo", "description": "Progresso e contadores por resultado de um job de ativação ou desativação do monitoramento. Consulte a cada poucos segundos enquanto o status for PENDING ou 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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID do job de monitoramento retornado pelo endpoint de ativação." } ], "responses": { "200": { "description": "A tarefa.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "404": { "description": "Job desconhecido para esta aplicação." } }, "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": "Ativar ou desativar o monitoramento AML contínuo para sessões de empresas", "description": "Alternância no nível da sessão para verificações KYB, identificada pelo número da sessão. Sessões sem uma análise AML recebem uma, criada e vinculada à própria sessão. Mesmo contrato de estimate_only, caminho rápido inline e job assíncrono dos endpoints no nível do usuário. Substitui o comportamento síncrono legado, que ignorava as sessões sem análise 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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "is_enabled" ], "properties": { "is_enabled": { "type": "boolean", "description": "true para ativar o monitoramento, false para desativá-lo." }, "estimate_only": { "type": "boolean", "default": false, "description": "Quando verdadeiro, retorna a estimativa de custo e não realiza nenhuma gravação." }, "update_all": { "type": "boolean", "default": false, "description": "Aplica a todas as entidades da aplicação (com escopo definido pelos parâmetros filter_* quando presentes)." }, "filter_search": { "type": "string" }, "filter_status": { "type": "array", "items": { "type": "string" } }, "filter_country": { "type": "string" }, "filter_date_from": { "type": "string", "format": "date" }, "filter_date_to": { "type": "string", "format": "date" }, "session_numbers": { "type": "array", "items": { "type": "string" }, "description": "Números das sessões de empresas a alternar. Obrigatório, a menos que update_all (ou o alias legado toggle_all) seja true." }, "toggle_all": { "type": "boolean", "default": false, "description": "Alias legado de update_all." }, "filter_workflow_id": { "type": "string" } } }, "example": { "is_enabled": true, "session_numbers": [ "1001", "1002" ] } } } }, "responses": { "200": { "description": "Estimativa (quando estimate_only) ou o job concluído, para lotes pequenos processados de forma síncrona.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringToggleResult" } } } }, "202": { "description": "Lotes maiores são processados de forma assíncrona; consulte periodicamente o endpoint do job com o job_id retornado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "403": { "description": "Privilégio write:sessions ausente, ou saldo insuficiente para ativar (a estimativa é incluída no corpo do erro)." } }, "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": "Obter um job de monitoramento AML contínuo", "description": "Progresso e contadores por resultado de um job de ativação ou desativação do monitoramento. Consulte a cada poucos segundos enquanto o status for PENDING ou 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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID do job de monitoramento retornado pelo endpoint de ativação." } ], "responses": { "200": { "description": "A tarefa.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OngoingMonitoringJob" } } } }, "404": { "description": "Job desconhecido para esta aplicação." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.businesses.retrieve_session_ongoing_monitoring_job(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.businesses.retrieveSessionOngoingMonitoringJob(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.RetrieveSessionOngoingMonitoringJob(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.businesses().retrieveSessionOngoingMonitoringJob(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->retrieveSessionOngoingMonitoringJob('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.businesses.retrieve_session_ongoing_monitoring_job(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.RetrieveSessionOngoingMonitoringJobAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/": { "get": { "summary": "Listar casos", "description": "Lista os casos da aplicação, do mais recente para o mais antigo. Aceita filtragem, busca e ordenação; consulte os parâmetros de consulta. Paginado com `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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Tamanho da página. O padrão é 50." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Deslocamento, a partir de zero, do primeiro registro." }, { "name": "status__in", "in": "query", "schema": { "type": "string" }, "description": "Status a incluir, separados por vírgula, por exemplo, OPEN,AWAITING_USER." }, { "name": "priority", "in": "query", "schema": { "type": "string" }, "description": "Prioridades a incluir, separadas por vírgula." }, { "name": "source__in", "in": "query", "schema": { "type": "string" }, "description": "Origens a incluir, separadas por vírgula." }, { "name": "blueprint", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Filtra os casos deste blueprint." }, { "name": "assigned_to", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Filtra os casos atribuídos a este usuário." }, { "name": "unassigned", "in": "query", "schema": { "type": "boolean" }, "description": "true para casos não atribuídos, false para casos atribuídos." }, { "name": "tag", "in": "query", "schema": { "type": "string" }, "description": "Filtra os casos que têm exatamente esta tag." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Corresponde a title, case_number, tag, nome/UUID/ID externo do titular, UUID da sessão vinculada ou UUID da transação vinculada." }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Limite inferior da data de criação (inclusivo)." }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Limite superior da data de criação (inclusivo)." }, { "name": "due_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limite superior de due_at." }, { "name": "overdue", "in": "query", "schema": { "type": "boolean" }, "description": "true para retornar apenas casos open/awaiting-user em atraso." }, { "name": "ordering", "in": "query", "schema": { "type": "string", "enum": [ "created_at", "-created_at", "due_at", "-due_at" ], "default": "-created_at" }, "description": "Ordem de classificação. due_at coloca os valores nulos por último." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/?status__in=OPEN,AWAITING_USER&ordering=-due_at' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.ListAutoPaging(ctx, didit.CasesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Lista paginada de casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número de linhas correspondentes. Exato até 100 e limitado a 100 acima disso, por desempenho. Considere `next` nulo para detectar a última página." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta da próxima página, ou null." }, "previous": { "type": "string", "nullable": true, "description": "URL absoluta da página anterior, ou null." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseListItem" } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Criar caso", "description": "Cria um caso vinculado a exatamente um titular (um usuário ou uma empresa), diretamente ou derivando o titular de um vínculo com uma sessão ou transação anexada. A origem é sempre `MANUAL` para casos criados pela 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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." } ], "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 do CaseBlueprint. Omita para não usar nenhum modelo de caso." }, "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": "Obrigatório, a menos que links seja informado; o único sujeito do caso.", "properties": { "type": { "type": "string", "enum": [ "user", "business" ] }, "uuid": { "type": "string", "format": "uuid" } } }, "links": { "type": "array", "description": "Sessões/sessões de empresa/transações a vincular na criação, por exemplo [{\"entity_type\": \"transaction\", \"entity_uuid\": \"...\"}]. Quando subject é omitido, o subject é derivado do proprietário do primeiro vínculo.", "items": { "type": "object" } }, "assigned_to": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID do usuário a ser atribuído imediatamente." }, "review_duplicates": { "type": "boolean", "default": false, "description": "Verifica novamente as investigações existentes antes de criar o caso. Quando true, um titular com casos existentes exige um separate_incident_reason não vazio. O console sempre ativa essa proteção. Omiti-lo preserva o comportamento atual da API." }, "separate_incident_reason": { "type": "string", "maxLength": 1000 }, "source_context": { "$ref": "#/components/schemas/CaseDuplicateCaseFraudSourceContextRequest" } } }, "example": { "title": "Manual - Jane Doe", "blueprint": "b1de0000-0000-4000-8000-000000000002", "priority": "HIGH", "subject": { "type": "user", "uuid": "5b9a0000-0000-4000-8000-00000000f00d" }, "tags": [ "review" ] } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"title\": \"Manual - Jane Doe\", \"blueprint\": \"b1de0000-0000-4000-8000-000000000002\", \"priority\": \"HIGH\", \"subject\": {\"type\": \"user\", \"uuid\": \"5b9a0000-0000-4000-8000-00000000f00d\"}, \"tags\": [\"review\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.create(\n title=\"Manual - Jane Doe\",\n blueprint=\"b1de0000-0000-4000-8000-000000000002\",\n priority=\"HIGH\",\n tags=[\"review\"],\n subject={\n \"type\": \"user\",\n \"uuid\": \"5b9a0000-0000-4000-8000-00000000f00d\",\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.create({\n title: \"Manual - Jane Doe\",\n blueprint: \"b1de0000-0000-4000-8000-000000000002\",\n priority: \"HIGH\",\n tags: [\"review\"],\n subject: {\n type: \"user\",\n uuid: \"5b9a0000-0000-4000-8000-00000000f00d\",\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Create(ctx, didit.CasesCreateParams{\n\tTitle: \"Manual - Jane Doe\",\n\tBlueprint: didit.String(\"b1de0000-0000-4000-8000-000000000002\"),\n\tPriority: didit.Some(didit.CasesCreateParamsPriority(\"HIGH\")),\n\tTags: didit.Some([]string{\"review\"}),\n\tSubject: didit.Some(didit.CasesCreateParamsSubject{\n\t\tType: didit.Some(didit.CasesCreateParamsSubjectType(\"user\")),\n\t\tUUID: didit.String(\"5b9a0000-0000-4000-8000-00000000f00d\"),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CasesCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().create(CasesCreateParams.builder()\n .title(\"Manual - Jane Doe\")\n .blueprint(\"b1de0000-0000-4000-8000-000000000002\")\n .priority(CasesCreateParams.Priority.of(\"HIGH\"))\n .tags(List.of(\"review\"))\n .subject(CasesCreateParams.Subject.builder()\n .type(CasesCreateParams.Subject.Type.of(\"user\"))\n .uuid(\"5b9a0000-0000-4000-8000-00000000f00d\")\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->create([\n 'title' => 'Manual - Jane Doe',\n 'blueprint' => 'b1de0000-0000-4000-8000-000000000002',\n 'priority' => 'HIGH',\n 'tags' => ['review'],\n 'subject' => [\n 'type' => 'user',\n 'uuid' => '5b9a0000-0000-4000-8000-00000000f00d',\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.create(\n title: \"Manual - Jane Doe\",\n blueprint: \"b1de0000-0000-4000-8000-000000000002\",\n priority: \"HIGH\",\n tags: [\"review\"],\n subject: {\n type: \"user\",\n uuid: \"5b9a0000-0000-4000-8000-00000000f00d\",\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.CreateAsync(new CasesCreateParams\n{\n Title = \"Manual - Jane Doe\",\n Blueprint = \"b1de0000-0000-4000-8000-000000000002\",\n Priority = new CasesCreateParamsPriority(\"HIGH\"),\n Tags = new string[] { \"review\" },\n Subject = new CasesCreateParamsSubject\n {\n Type = new CasesCreateParamsSubjectType(\"user\"),\n Uuid = \"5b9a0000-0000-4000-8000-00000000f00d\",\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Caso criado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "400": { "description": "Nem subject nem links foram informados, ou o subject/blueprint/responsável não foi encontrado.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "A revisão de duplicados está ativada e foi encontrado um caso existente sem um motivo de incidente separado. Nenhum caso foi criado." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/": { "get": { "summary": "Obter caso", "description": "Obtenha um caso com seu titular, blueprint, notas, eventos, vínculos e checklist.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.retrieve(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.retrieve(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Retrieve(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().retrieve(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->retrieve('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.retrieve(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RetrieveAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Detalhes do caso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "404": { "description": "Caso (ou recurso aninhado) não encontrado nesta aplicação.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Atualizar caso", "description": "Atualize o título, a prioridade, a data de vencimento, as tags ou a equipe de revisão responsável pelo caso. Envie apenas os campos que deseja alterar; os campos omitidos mantêm o valor atual. `tags` substitui a lista inteira de tags. `team` recebe o uuid de uma equipe de revisão ativa desta aplicação (liste-as com `GET .../cases/teams/`), ou null para remover a equipe. Requer uma chave de API com acesso total, ou `write:cases` para um membro do console: uma chave com acesso restrito recebe 403. Registra os eventos PRIORITY_CHANGED, DUE_DATE_CHANGED, TAG_ADDED, TAG_REMOVED e TEAM_CHANGED, conforme aplicável; uma alteração de título é salva sem evento na linha do tempo. Retorna o caso atualizado.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 255, "description": "Novo título do caso." }, "priority": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "due_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Novo prazo. Envie null para removê-lo." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "A lista completa de tags. Ela substitui as tags atuais." }, "team": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID da equipe de revisão responsável pelo caso. Deve ser uma equipe ativa desta aplicação. Envie null para remover a equipe." } } }, "examples": { "Change priority and deadline": { "value": { "priority": "HIGH", "due_at": "2026-11-01T00:00:00Z" } }, "Move the case to a team": { "value": { "team": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "Clear the team": { "value": { "team": null } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"priority\": \"HIGH\", \"due_at\": \"2026-08-01T00:00:00Z\"}'" }, { "lang": "curl", "label": "curl (change team)", "source": "curl -X PATCH 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"team\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.update(\n \"c1a5e000-0000-4000-8000-000000000001\",\n priority=\"HIGH\",\n due_at=\"2026-11-01T00:00:00Z\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.update(\"c1a5e000-0000-4000-8000-000000000001\", {\n priority: \"HIGH\",\n due_at: \"2026-11-01T00:00:00Z\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Update(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesUpdateParams{\n\tPriority: didit.Some(didit.CasesUpdateParamsPriority(\"HIGH\")),\n\tDueAt: didit.Time(time.Date(2026, 11, 1, 0, 0, 0, 0, time.UTC)),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.OffsetDateTime;\nimport me.didit.Didit;\nimport me.didit.types.CasesUpdateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().update(\"c1a5e000-0000-4000-8000-000000000001\", CasesUpdateParams.builder()\n .priority(CasesUpdateParams.Priority.of(\"HIGH\"))\n .dueAt(OffsetDateTime.parse(\"2026-11-01T00:00:00Z\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->update('c1a5e000-0000-4000-8000-000000000001', [\n 'priority' => 'HIGH',\n 'due_at' => '2026-11-01T00:00:00Z',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.update(\n \"c1a5e000-0000-4000-8000-000000000001\",\n priority: \"HIGH\",\n due_at: \"2026-11-01T00:00:00Z\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.UpdateAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesUpdateParams\n{\n Priority = new CasesUpdateParamsPriority(\"HIGH\"),\n DueAt = DateTimeOffset.Parse(\"2026-11-01T00:00:00Z\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Caso atualizado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "400": { "description": "Um campo falhou na validação. O corpo é indexado pelo nome do campo. `team` é rejeitado quando não é uma equipe de revisão ativa desta aplicação.", "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": "A chave de API pertence a outra aplicação ou é uma chave com acesso restrito: os endpoints de casos exigem uma chave com acesso total. Um token de membro do console precisa de `write:cases`.", "content": { "application/json": { "examples": { "Restricted API Key": { "summary": "Chave de API com acesso restrito", "value": { "detail": "This API key has no access to this endpoint." } }, "Missing Privilege": { "summary": "Membro do console sem write:cases, ou uma chave de outra aplicação", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Caso não encontrado nesta aplicação.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No Case matches the given query." } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Excluir caso", "description": "Exclua um caso permanentemente. Os relatórios regulatórios em rascunho são excluídos junto com ele. Verificações, pessoas, empresas e transações vinculadas não são excluídas. Não existe endpoint para desfazer a exclusão.\n\nSe o caso tiver um relatório regulatório finalizado, toda a requisição é recusada com `409` e nada é excluído. O corpo usa `code: in_filed_report` e identifica cada relatório com `uuid`, `report_number`, `report_type` e `case_uuid`. Exclua os relatórios e repita a requisição.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.cases.delete(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.cases.delete(\"c1a5e000-0000-4000-8000-000000000001\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nif err := client.Cases.Delete(ctx, \"c1a5e000-0000-4000-8000-000000000001\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.cases().delete(\"c1a5e000-0000-4000-8000-000000000001\");" }, { "lang": "php", "label": "PHP", "source": "cases->delete('c1a5e000-0000-4000-8000-000000000001');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.delete(\"c1a5e000-0000-4000-8000-000000000001\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.Cases.DeleteAsync(\"c1a5e000-0000-4000-8000-000000000001\");" } ], "responses": { "204": { "description": "Caso excluído." }, "403": { "description": "A chave não pode excluir casos. É necessária uma chave de acesso total com `write:cases`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "404": { "description": "O caso não existe nesta aplicação ou já foi excluído.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "409": { "description": "O caso tem um relatório regulatório finalizado. Nada é excluído.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InFiledReportError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/assign/": { "post": { "summary": "Atribuir ou remover a atribuição do caso", "description": "Atribua o caso a um usuário ou remova a atribuição enviando assignee_user_id: null. assignee_email/assignee_name criam automaticamente uma linha de User quando o responsável ainda não existe.", "operationId": "assign_case", "x-didit-sdk": { "resource": "cases", "method": "assign", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "assignee_user_id" ], "properties": { "assignee_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "null para remover a atribuição." }, "assignee_email": { "type": "string", "format": "email", "nullable": true }, "assignee_name": { "type": "string", "nullable": true } } }, "example": { "assignee_user_id": "9a000000-0000-4000-8000-0000000000aa" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/assign/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"assignee_user_id\": \"9a000000-0000-4000-8000-0000000000aa\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.assign(\n \"c1a5e000-0000-4000-8000-000000000001\",\n assignee_user_id=\"9a000000-0000-4000-8000-0000000000aa\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.assign(\"c1a5e000-0000-4000-8000-000000000001\", {\n assignee_user_id: \"9a000000-0000-4000-8000-0000000000aa\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Assign(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesAssignParams{\n\tAssigneeUserID: didit.String(\"9a000000-0000-4000-8000-0000000000aa\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesAssignParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().assign(\"c1a5e000-0000-4000-8000-000000000001\", CasesAssignParams.builder()\n .assigneeUserId(\"9a000000-0000-4000-8000-0000000000aa\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->assign('c1a5e000-0000-4000-8000-000000000001', [\n 'assignee_user_id' => '9a000000-0000-4000-8000-0000000000aa',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.assign(\n \"c1a5e000-0000-4000-8000-000000000001\",\n assignee_user_id: \"9a000000-0000-4000-8000-0000000000aa\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.AssignAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesAssignParams\n{\n AssigneeUserId = \"9a000000-0000-4000-8000-0000000000aa\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Caso atribuído ou com atribuição removida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/resolve/": { "post": { "summary": "Resolver caso", "description": "Resolva o caso com uma de cinco resoluções: FALSE_POSITIVE (nenhuma suspeita encontrada), VALID_THREAT (suspeita confirmada), INCONCLUSIVE, REQUIREMENTS_NOT_MET ou REQUIREMENTS_SATISFIED. A ação é bloqueada com 400 se o checklist do blueprint não for opcional e ainda houver itens incompletos, ou se o blueprint exigir uma nota de resolução e nenhuma for informada. Quando o blueprint do caso tem uma etapa de verificação por quatro olhos (four_eyes_checker_blueprint), a resolução fica pendente (case.pending_resolution) e o caso passa para o blueprint de verificação em vez de ser resolvido imediatamente; outro responsável deve chamar approve ou reject-approval. Envie uma resolução de quatro olhos como membro do console: uma resolução enviada por uma chave de API não tem autor registrado, então approve e reject-approval retornam 403 para qualquer chamador. Em um blueprint de quatro olhos, você pode indicar com `checker` o membro que deve aprovar: nesse caso, somente esse membro pode aprovar ou rejeitar a resolução, e o `checker` da resposta o identifica. Sem `checker`, a resolução aguarda na fila do blueprint de verificação. Enviar `checker` para um blueprint sem etapa de verificação retorna 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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "resolution" ], "properties": { "resolution": { "type": "string", "enum": [ "FALSE_POSITIVE", "VALID_THREAT", "INCONCLUSIVE", "REQUIREMENTS_NOT_MET", "REQUIREMENTS_SATISFIED" ] }, "note": { "type": "string", "nullable": true, "description": "Obrigatório quando o blueprint define require_resolution_note." }, "checker": { "type": "string", "format": "uuid", "nullable": true, "description": "Apenas para blueprints com princípio dos quatro olhos. O uuid do usuário do membro que deve aprovar esta resolução (o mesmo id de `assigned_to.uuid` em um caso, ou de `members[].user_id` em uma equipe de revisão). O membro deve ter acesso a casos desta aplicação e não pode ser o responsável que envia a resolução. Omita-o ou envie null para deixar a resolução para a fila de verificadores." } } }, "examples": { "Resolve": { "value": { "resolution": "FALSE_POSITIVE", "note": "Confirmed legitimate activity after reviewing documents." } }, "Four-eyes blueprint with a named checker": { "value": { "resolution": "VALID_THREAT", "note": "Document tampering confirmed.", "checker": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/resolve/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"resolution\": \"FALSE_POSITIVE\", \"note\": \"Confirmed legitimate activity after reviewing documents.\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.resolve(\n \"c1a5e000-0000-4000-8000-000000000001\",\n resolution=\"FALSE_POSITIVE\",\n note=\"Confirmed legitimate activity after reviewing documents.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.resolve(\"c1a5e000-0000-4000-8000-000000000001\", {\n resolution: \"FALSE_POSITIVE\",\n note: \"Confirmed legitimate activity after reviewing documents.\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Resolve(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesResolveParams{\n\tResolution: \"FALSE_POSITIVE\",\n\tNote: didit.String(\"Confirmed legitimate activity after reviewing documents.\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesResolveParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().resolve(\"c1a5e000-0000-4000-8000-000000000001\", CasesResolveParams.builder()\n .resolution(CasesResolveParams.Resolution.of(\"FALSE_POSITIVE\"))\n .note(\"Confirmed legitimate activity after reviewing documents.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->resolve('c1a5e000-0000-4000-8000-000000000001', [\n 'resolution' => 'FALSE_POSITIVE',\n 'note' => 'Confirmed legitimate activity after reviewing documents.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.resolve(\n \"c1a5e000-0000-4000-8000-000000000001\",\n resolution: \"FALSE_POSITIVE\",\n note: \"Confirmed legitimate activity after reviewing documents.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ResolveAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesResolveParams\n{\n Resolution = \"FALSE_POSITIVE\",\n Note = \"Confirmed legitimate activity after reviewing documents.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Resolvido ou pendente de aprovação por quatro olhos.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "400": { "description": "A resolução foi recusada. Erros que não são de campo vêm como uma lista de strings: um checklist incompleto, uma nota obrigatória ausente, ou um `checker` que não pôde ser verificado ou que não é um revisor ativo com acesso a casos desta aplicação. Erros de `checker` vêm indexados pelo campo: o membro indicado é o responsável que está enviando a resolução, ou o blueprint do caso não tem etapa de checker.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } ] }, "examples": { "Incomplete checklist": { "value": [ "Case has incomplete checklist items: Verify source of funds" ] }, "Resolution note required": { "value": [ "A resolution note is required to resolve this case." ] }, "Reviewer access could not be verified": { "value": [ "Reviewer access could not be verified. Try again." ] }, "Checker is not an active reviewer": { "value": [ "Choose an active reviewer with case access to this application." ] }, "Checker is the submitting officer": { "value": { "checker": [ "The officer who submitted the resolution cannot be its checker." ] } }, "Policy has no checker step": { "value": { "checker": [ "This review policy has no checker step, so the case resolves directly." ] } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/reopen/": { "post": { "summary": "Reabrir caso", "description": "Retorna para aberto um caso aguardando o usuário ou resolvido, limpando resolution, resolution_notes, resolved_at e 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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/reopen/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.reopen(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.reopen(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Reopen(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().reopen(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->reopen('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.reopen(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ReopenAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Reabre o caso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/request-info/": { "post": { "summary": "Solicitar informações (aguardando o usuário)", "description": "Move um caso aberto para awaiting_user enquanto mais informações são coletadas do usuário verificado. Falha com 400 se houver uma resolução pendente de aprovação 4-eyes no momento.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/request-info/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.request_info(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.requestInfo(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RequestInfo(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().requestInfo(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->requestInfo('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.request_info(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RequestInfoAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Solicitar informações (aguardando o usuário).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/escalate/": { "post": { "summary": "Escalar caso", "description": "Move o caso para o escalation_blueprint configurado no blueprint dele. Exige que o blueprint atual tenha escalation_enabled e um escalation_blueprint definido; caso contrário, 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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/escalate/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.escalate(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.escalate(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Escalate(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().escalate(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->escalate('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.escalate(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.EscalateAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Escalar caso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/transfer/": { "post": { "summary": "Transferir caso", "description": "Move o caso para outro blueprint ativo da mesma aplicação. Exige que o blueprint atual tenha transfer_enabled; caso contrário, 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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "target_blueprint" ], "properties": { "target_blueprint": { "type": "string", "format": "uuid" } } }, "example": { "target_blueprint": "b1de0000-0000-4000-8000-000000000002" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/transfer/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"target_blueprint\": \"b1de0000-0000-4000-8000-000000000002\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.transfer(\n \"c1a5e000-0000-4000-8000-000000000001\",\n target_blueprint=\"b1de0000-0000-4000-8000-000000000002\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.transfer(\"c1a5e000-0000-4000-8000-000000000001\", {\n target_blueprint: \"b1de0000-0000-4000-8000-000000000002\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Transfer(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesTransferParams{\n\tTargetBlueprint: \"b1de0000-0000-4000-8000-000000000002\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesTransferParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().transfer(\"c1a5e000-0000-4000-8000-000000000001\", CasesTransferParams.builder()\n .targetBlueprint(\"b1de0000-0000-4000-8000-000000000002\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->transfer('c1a5e000-0000-4000-8000-000000000001', [\n 'target_blueprint' => 'b1de0000-0000-4000-8000-000000000002',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.transfer(\n \"c1a5e000-0000-4000-8000-000000000001\",\n target_blueprint: \"b1de0000-0000-4000-8000-000000000002\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.TransferAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesTransferParams\n{\n TargetBlueprint = \"b1de0000-0000-4000-8000-000000000002\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Caso transferido.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/approve/": { "post": { "summary": "Aprovar resolução preparada (quatro olhos)", "description": "Aplica uma resolução preparada por resolve em um blueprint de quatro olhos. Quem faz a chamada deve ser um responsável diferente daquele que a enviou; caso contrário, recebe 403. Quando a resolução indica um verificador (o `checker` do caso), somente esse membro pode aprová-la: qualquer outro chamador, inclusive uma chave de API, recebe 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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/approve/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.approve_resolution(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.approveResolution(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.ApproveResolution(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().approveResolution(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->approveResolution('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.approve_resolution(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ApproveResolutionAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Resolução aplicada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "409": { "description": "O caso não tem nenhuma resolução pendente de aprovação.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "403": { "description": "O chamador não pode aprovar esta resolução: foi ele quem a enviou, o caso não tem um autor registrado ou a resolução indica um aprovador diferente. Uma chave de API sempre recebe este 403 quando um aprovador é indicado.", "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": "Rejeitar resolução preparada (princípio dos quatro olhos)", "description": "Rejeita uma resolução preparada por resolve e devolve o caso ao blueprint de quem a elaborou. Quem faz a chamada deve ser um responsável diferente daquele que a enviou; caso contrário, retorna 403. Quando a resolução indica um revisor (o `checker` do caso), apenas esse membro pode rejeitá-la: qualquer outro chamador, incluindo uma chave de API, recebe 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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string", "nullable": true } } }, "example": { "notes": "Needs a clearer rationale before this can be approved." } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/reject-approval/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"notes\": \"Needs a clearer rationale before this can be approved.\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.reject_resolution(\n \"c1a5e000-0000-4000-8000-000000000001\",\n notes=\"Needs a clearer rationale before this can be approved.\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.rejectResolution(\"c1a5e000-0000-4000-8000-000000000001\", {\n notes: \"Needs a clearer rationale before this can be approved.\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RejectResolution(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesRejectResolutionParams{\n\tNotes: didit.String(\"Needs a clearer rationale before this can be approved.\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesRejectResolutionParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().rejectResolution(\"c1a5e000-0000-4000-8000-000000000001\", CasesRejectResolutionParams.builder()\n .notes(\"Needs a clearer rationale before this can be approved.\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->rejectResolution('c1a5e000-0000-4000-8000-000000000001', [\n 'notes' => 'Needs a clearer rationale before this can be approved.',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.reject_resolution(\n \"c1a5e000-0000-4000-8000-000000000001\",\n notes: \"Needs a clearer rationale before this can be approved.\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RejectResolutionAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesRejectResolutionParams\n{\n Notes = \"Needs a clearer rationale before this can be approved.\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Resolução rejeitada, caso devolvido ao blueprint do executor (maker).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDetail" } } } }, "409": { "description": "O caso não tem nenhuma resolução pendente de aprovação.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "403": { "description": "O chamador não pode rejeitar esta resolução: foi ele quem a enviou, o caso não tem um autor registrado ou a resolução indica um aprovador diferente. Uma chave de API sempre recebe este 403 quando um aprovador é indicado.", "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": "A referência pertence a um payload de ação diferente." } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Aplica uma ação explícita ao titular do caso. Informe um client_reference único para obter um recibo da ação e tornar as novas tentativas idempotentes. Reutilizar essa referência com um payload diferente retorna 409. Com uma referência, verifique receipt.status mesmo quando o status HTTP for 200: FAILED significa que nenhuma ação foi aplicada. Repetir uma requisição que falhou não a executa novamente, a menos que retry seja true. Omitir client_reference preserva a resposta legada.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.apply_entity_action(\n \"11111111-2222-3333-4444-555555555555\",\n client_reference=\"e1a00000-0000-4000-8000-000000000001\",\n action=\"add_tags\",\n tags=[\"source-of-funds-reviewed\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.applyEntityAction(\"11111111-2222-3333-4444-555555555555\", {\n client_reference: \"e1a00000-0000-4000-8000-000000000001\",\n action: \"add_tags\",\n tags: [\"source-of-funds-reviewed\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.ApplyEntityAction(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CaseActionCaseEntityActionRequest{\n\tClientReference: didit.String(\"e1a00000-0000-4000-8000-000000000001\"),\n\tAction: didit.CaseActionActionEnum(\"add_tags\"),\n\tTags: didit.Some([]string{\"source-of-funds-reviewed\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CaseActionActionEnum;\nimport me.didit.types.CaseActionCaseEntityActionRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().applyEntityAction(\"11111111-2222-3333-4444-555555555555\", CaseActionCaseEntityActionRequest.builder()\n .clientReference(\"e1a00000-0000-4000-8000-000000000001\")\n .action(CaseActionActionEnum.of(\"add_tags\"))\n .tags(List.of(\"source-of-funds-reviewed\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->applyEntityAction('11111111-2222-3333-4444-555555555555', [\n 'client_reference' => 'e1a00000-0000-4000-8000-000000000001',\n 'action' => 'add_tags',\n 'tags' => ['source-of-funds-reviewed'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.apply_entity_action(\n \"11111111-2222-3333-4444-555555555555\",\n client_reference: \"e1a00000-0000-4000-8000-000000000001\",\n action: \"add_tags\",\n tags: [\"source-of-funds-reviewed\"]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ApplyEntityActionAsync(\"11111111-2222-3333-4444-555555555555\", new CaseActionCaseEntityActionRequest\n{\n ClientReference = \"e1a00000-0000-4000-8000-000000000001\",\n Action = \"add_tags\",\n Tags = new string[] { \"source-of-funds-reviewed\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/print/": { "get": { "summary": "Imprimir caso (PDF)", "description": "Renderiza o caso completo (resumo, sujeito, estado do checklist, notas, sessões/transações anexadas, eventos, lista de relatórios para a FIU) como PDF e retorna uma URL de download pré-assinada.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/print/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.print(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.print(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Print(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().print(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->print('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.print(\"c1a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.PrintAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "URL pré-assinada do 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": "Qual campo usar para ordenar os resultados.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Número de resultados a retornar por página.", "schema": { "type": "integer" } }, { "name": "offset", "required": false, "in": "query", "description": "O índice inicial a partir do qual os resultados são retornados.", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseCollaborationPaginatedCaseNoteList" } } }, "description": "" }, "403": { "description": "O chamador não tem a permissão de casos necessária." }, "404": { "description": "O caso ou a nota não está disponível para este chamador." } }, "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": "O chamador não tem a permissão de casos necessária." }, "404": { "description": "O caso ou a nota não está disponível para este chamador." }, "409": { "description": "Esta referência do cliente já foi usada para outra nota ou para uma nota que foi excluída." } }, "tags": [ "Case Management" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Adiciona uma nota com escopo de caso. Um client_reference opcional faz com que uma nova tentativa inalterada retorne a mesma nota, sem atividade ou notificações duplicadas. reply_to deve identificar uma nota ativa neste caso. A resposta inclui um trecho limitado da nota original, sem copiar esse trecho na nota de resposta salva.", "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": "O chamador não tem a permissão de casos necessária." }, "404": { "description": "O caso ou a nota não está disponível para este chamador." } }, "tags": [ "Case Management" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Fixa ou desafixa uma nota existente. Notas fixadas aparecem primeiro. As alterações de fixação são registradas na atividade do caso e não alteram as evidências nem as decisões de origem.", "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": "A nota é excluída permanentemente. As respostas permanecem, sem o trecho da nota principal excluída. Os anexos são excluídos, a menos que outra nota ainda os use." }, "403": { "description": "O chamador não tem a permissão de casos necessária." }, "404": { "description": "O caso ou a nota não está disponível para este chamador." } }, "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": "Enviar anexo de nota", "description": "Envie um arquivo (JPEG, PNG, WebP, PDF, texto simples ou CSV; máx. 5 MB) para anexar a uma nota. Retorna o s3_key a ser passado no array attachments da 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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/notes/presign/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'file=@evidence.pdf'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.notes.create_attachment_upload(\n \"c1a5e000-0000-4000-8000-000000000001\",\n file=open(\"document.pdf\", \"rb\"),\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.notes.createAttachmentUpload(\"c1a5e000-0000-4000-8000-000000000001\", {\n file: await fileFromPath(\"document.pdf\"),\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Notes.CreateAttachmentUpload(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesNotesCreateAttachmentUploadParams{\n\tFile: didit.FileFromPath(\"document.pdf\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.types.CasesNotesCreateAttachmentUploadParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().notes().createAttachmentUpload(\"c1a5e000-0000-4000-8000-000000000001\", CasesNotesCreateAttachmentUploadParams.builder()\n .file(Path.of(\"document.pdf\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->notes->createAttachmentUpload('c1a5e000-0000-4000-8000-000000000001', [\n 'file' => File::fromPath('document.pdf'),\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.notes.create_attachment_upload(\n \"c1a5e000-0000-4000-8000-000000000001\",\n file: Pathname(\"document.pdf\")\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Notes.CreateAttachmentUploadAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesNotesCreateAttachmentUploadParams\n{\n File = FileUpload.FromPath(\"document.pdf\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Arquivo enviado.", "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": "Nenhum arquivo, tipo de conteúdo não suportado ou arquivo com mais de 5 MB.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "get": { "summary": "Obter a URL do anexo da nota", "description": "Gera uma nova URL de download pré-assinada para um anexo já armazenado em uma das notas do caso.", "operationId": "get_case_note_attachment_url", "x-didit-sdk": { "resource": "cases.notes", "method": "retrieve_attachment_url", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." }, { "name": "s3_key", "in": "query", "schema": { "type": "string" }, "description": "O s3_key do anexo, conforme retornado pelo upload ou listado na 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 pré-assinada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "s3_key": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "filename": { "type": "string" } } } } } }, "404": { "description": "s3_key ausente ou não pertence a este caso.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/links/": { "get": { "summary": "Listar vínculos do caso", "description": "Lista as sessões, as sessões de empresa e as transações vinculadas ao caso.", "operationId": "list_case_links", "x-didit-sdk": { "resource": "cases.links", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/links/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.links.list(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.links.list(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Links.List(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().links().list(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->links->list('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.links.list(\"c1a5e000-0000-4000-8000-000000000001\").each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Links.ListAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Links do caso.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseLink" } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Adicionar vínculo de caso", "description": "Anexe uma sessão, sessão de empresa ou transação ao caso. Rejeitado com 400 se a entidade pertencer a um titular diferente do titular do caso.", "operationId": "create_case_link", "x-didit-sdk": { "resource": "cases.links", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "entity_type", "entity_uuid" ], "properties": { "entity_type": { "type": "string", "enum": [ "session", "business_session", "transaction" ] }, "entity_uuid": { "type": "string", "format": "uuid" } } }, "example": { "entity_type": "transaction", "entity_uuid": "77000000-0000-4000-8000-000000000077" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/links/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"entity_type\": \"transaction\", \"entity_uuid\": \"77000000-0000-4000-8000-000000000077\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.links.create(\n \"c1a5e000-0000-4000-8000-000000000001\",\n entity_type=\"transaction\",\n entity_uuid=\"77000000-0000-4000-8000-000000000077\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.links.create(\"c1a5e000-0000-4000-8000-000000000001\", {\n entity_type: \"transaction\",\n entity_uuid: \"77000000-0000-4000-8000-000000000077\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Links.Create(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesLinksCreateParams{\n\tEntityType: \"transaction\",\n\tEntityUUID: \"77000000-0000-4000-8000-000000000077\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesLinksCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().links().create(\"c1a5e000-0000-4000-8000-000000000001\", CasesLinksCreateParams.builder()\n .entityType(CasesLinksCreateParams.EntityType.of(\"transaction\"))\n .entityUuid(\"77000000-0000-4000-8000-000000000077\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->links->create('c1a5e000-0000-4000-8000-000000000001', [\n 'entity_type' => 'transaction',\n 'entity_uuid' => '77000000-0000-4000-8000-000000000077',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.links.create(\n \"c1a5e000-0000-4000-8000-000000000001\",\n entity_type: \"transaction\",\n entity_uuid: \"77000000-0000-4000-8000-000000000077\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Links.CreateAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesLinksCreateParams\n{\n EntityType = \"transaction\",\n EntityUuid = \"77000000-0000-4000-8000-000000000077\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Vínculo criado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseLink" } } } }, "400": { "description": "A entidade pertence a um perfil diferente do titular do caso.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/links/{link_uuid}/": { "delete": { "summary": "Remover vínculo de caso", "description": "Desvincula do caso uma sessão, sessão de empresa ou transação vinculada.", "operationId": "delete_case_link", "x-didit-sdk": { "resource": "cases.links", "method": "delete", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." }, { "name": "link_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "11000000-0000-4000-8000-000000000004" }, "description": "UUID do vínculo." } ], "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": "Vínculo removido." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/events/": { "get": { "summary": "Listar eventos do caso", "description": "Linha do tempo de auditoria somente leitura do caso (criação, mudanças de status, atribuição, resolução, escalonamento, transferências, mudanças de tag/prioridade/prazo, ações sobre entidades e mais).", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Tamanho da página." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Deslocamento a partir de 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": "Eventos paginados, dos mais recentes para os mais antigos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número de linhas correspondentes. Exato até 100 e limitado a 100 acima disso, por desempenho. Considere `next` nulo para detectar a última página." }, "next": { "type": "string", "nullable": true, "description": "URL absoluta da próxima página, ou null." }, "previous": { "type": "string", "nullable": true, "description": "URL absoluta da página anterior, ou null." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseEvent" } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/checklist/": { "get": { "summary": "Listar checklist do caso", "description": "Lista os itens da checklist do caso, copiados de content_config.checklist.items do blueprint no momento da criação, em ordem.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/checklist/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.checklist.list(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.checklist.list(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Checklist.List(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().checklist().list(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->checklist->list('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.checklist.list(\"c1a5e000-0000-4000-8000-000000000001\").each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Checklist.ListAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Itens da checklist.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaseChecklistItem" } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/checklist/{item_uuid}/": { "patch": { "summary": "Marcar ou desmarcar item da lista de verificação", "description": "Marca um item da checklist como concluído ou não concluído. A resolução fica bloqueada enquanto houver algum item não concluído, a menos que o blueprint defina a checklist como opcional.", "operationId": "toggle_case_checklist_item", "x-didit-sdk": { "resource": "cases.checklist", "method": "toggle_item", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." }, { "name": "item_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c4ec0000-0000-4000-8000-000000000005" }, "description": "UUID do item da checklist." } ], "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": "Item da checklist atualizado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseChecklistItem" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/aml/": { "get": { "summary": "Listar ocorrências AML do caso", "description": "Lista as ocorrências da análise AML do titular do caso. Mesmo formato das ocorrências retornadas por 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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/aml/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.list_aml_hits(\n \"c1a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.listAmlHits(\"c1a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.ListAMLHits(ctx, \"c1a5e000-0000-4000-8000-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().listAmlHits(\"c1a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->listAmlHits('c1a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.list_aml_hits(\"c1a5e000-0000-4000-8000-000000000001\").each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ListAmlHitsAsync(\"c1a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Ocorrências 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": "Análises de casos", "description": "Análises agregadas de casos para o intervalo de datas (padrão: últimos 30 dias; máximo de 731 dias). Gráficos, tabelas, totais, eventos de atribuição e contagens atuais da fila usam os mesmos filtros com escopo da aplicação. Os filtros usam os valores atuais dos casos. As datas se aplicam a cada evento de métrica, portanto casos mais antigos atribuídos ou resolvidos durante o período continuam incluídos. A profundidade da fila independe do intervalo de datas. Filtros inválidos retornam 400; um blueprint ou responsável desconhecido retorna um resultado vazio.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Início do intervalo (inclusivo). O padrão é 30 dias atrás." }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Fim do intervalo (inclusivo). O padrão é hoje." }, { "name": "blueprint", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Filtra pelo UUID do blueprint atual." }, { "name": "assigned_to", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Filtra pelo UUID do usuário revisor atualmente atribuído." }, { "name": "priority", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "description": "Filtrar pela prioridade atual do caso." }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "MANUAL", "AML_SCREENING", "TRANSACTION_RULE", "WORKFLOW_BUILDER" ] }, "description": "Filtrar pela origem de criação do caso." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ] }, "description": "Filtrar pelo status atual do caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/statistics/?date_from=2026-06-01&date_to=2026-06-30' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.retrieve_statistics()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.retrieveStatistics();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RetrieveStatistics(ctx, didit.CasesRetrieveStatisticsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().retrieveStatistics();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->retrieveStatistics();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.retrieve_statistics\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RetrieveStatisticsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Payload de análise.", "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 da dimensão: e-mail do responsável, \"blueprint_name:uuid\", origem ou status. \"unassigned\"/\"none\" para dimensões ausentes." }, "created": { "type": "integer" }, "assigned": { "type": "integer" }, "resolved": { "type": "integer" }, "threat_rate": { "type": "number", "format": "float" }, "false_positive_rate": { "type": "number", "format": "float" }, "unresolved": { "type": "integer" }, "reassignment_rate": { "type": "number", "format": "float" }, "escalation_rate": { "type": "number", "format": "float" }, "avg_assign_hours": { "type": "number", "format": "float" }, "avg_resolve_hours": { "type": "number", "format": "float" }, "avg_handling_hours": { "type": "number", "format": "float" } } } }, "blueprint": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Valor da dimensão: e-mail do responsável, \"blueprint_name:uuid\", origem ou status. \"unassigned\"/\"none\" para dimensões ausentes." }, "created": { "type": "integer" }, "assigned": { "type": "integer" }, "resolved": { "type": "integer" }, "threat_rate": { "type": "number", "format": "float" }, "false_positive_rate": { "type": "number", "format": "float" }, "unresolved": { "type": "integer" }, "reassignment_rate": { "type": "number", "format": "float" }, "escalation_rate": { "type": "number", "format": "float" }, "avg_assign_hours": { "type": "number", "format": "float" }, "avg_resolve_hours": { "type": "number", "format": "float" }, "avg_handling_hours": { "type": "number", "format": "float" } } } }, "source": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Valor da dimensão: e-mail do responsável, \"blueprint_name:uuid\", origem ou status. \"unassigned\"/\"none\" para dimensões ausentes." }, "created": { "type": "integer" }, "assigned": { "type": "integer" }, "resolved": { "type": "integer" }, "threat_rate": { "type": "number", "format": "float" }, "false_positive_rate": { "type": "number", "format": "float" }, "unresolved": { "type": "integer" }, "reassignment_rate": { "type": "number", "format": "float" }, "escalation_rate": { "type": "number", "format": "float" }, "avg_assign_hours": { "type": "number", "format": "float" }, "avg_resolve_hours": { "type": "number", "format": "float" }, "avg_handling_hours": { "type": "number", "format": "float" } } } }, "status": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Valor da dimensão: e-mail do responsável, \"blueprint_name:uuid\", origem ou status. \"unassigned\"/\"none\" para dimensões ausentes." }, "created": { "type": "integer" }, "assigned": { "type": "integer" }, "resolved": { "type": "integer" }, "threat_rate": { "type": "number", "format": "float" }, "false_positive_rate": { "type": "number", "format": "float" }, "unresolved": { "type": "integer" }, "reassignment_rate": { "type": "number", "format": "float" }, "escalation_rate": { "type": "number", "format": "float" }, "avg_assign_hours": { "type": "number", "format": "float" }, "avg_resolve_hours": { "type": "number", "format": "float" }, "avg_handling_hours": { "type": "number", "format": "float" } } } } } }, "totals": { "type": "object", "properties": { "created": { "type": "integer" }, "assigned": { "type": "integer" }, "resolved": { "type": "integer" }, "threat_rate": { "type": "number", "format": "float" }, "false_positive_rate": { "type": "number", "format": "float" }, "unresolved": { "type": "integer" }, "reassignment_rate": { "type": "number", "format": "float" }, "escalation_rate": { "type": "number", "format": "float" }, "avg_assign_hours": { "type": "number", "format": "float" }, "avg_resolve_hours": { "type": "number", "format": "float" }, "avg_handling_hours": { "type": "number", "format": "float" } } }, "queue": { "type": "object", "description": "Instantâneo em tempo real, não restrito ao intervalo de datas.", "properties": { "open": { "type": "integer" }, "overdue": { "type": "integer" } } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/bulk/status/": { "post": { "summary": "Atualizar em massa o status de casos", "description": "Aplica a mesma transição de status a vários casos em uma única chamada: OPEN reabre, AWAITING_USER solicita informações, RESOLVED resolve (resolução obrigatória). Cada caso é avaliado de forma independente; falhas de validação (checklist incompleto, nota obrigatória ausente) são informadas por caso, sem interromper o lote.", "operationId": "bulk_update_case_status", "x-didit-sdk": { "resource": "cases", "method": "bulk_update_status", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." } ], "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": "Obrigatório quando o status for RESOLVED." }, "note": { "type": "string", "nullable": true } } }, "example": { "case_uuids": [ "c1a5e000-0000-4000-8000-000000000001" ], "status": "RESOLVED", "resolution": "FALSE_POSITIVE" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/bulk/status/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"case_uuids\": [\"c1a5e000-0000-4000-8000-000000000001\"], \"status\": \"RESOLVED\", \"resolution\": \"FALSE_POSITIVE\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.bulk_update_status(\n case_uuids=[\"c1a5e000-0000-4000-8000-000000000001\"],\n status=\"RESOLVED\",\n resolution=\"FALSE_POSITIVE\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.bulkUpdateStatus({\n case_uuids: [\"c1a5e000-0000-4000-8000-000000000001\"],\n status: \"RESOLVED\",\n resolution: \"FALSE_POSITIVE\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.BulkUpdateStatus(ctx, didit.CasesBulkUpdateStatusParams{\n\tCaseUUIDs: []string{\"c1a5e000-0000-4000-8000-000000000001\"},\n\tStatus: \"RESOLVED\",\n\tResolution: didit.Some(didit.CasesBulkUpdateStatusParamsResolution(\"FALSE_POSITIVE\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CasesBulkUpdateStatusParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().bulkUpdateStatus(CasesBulkUpdateStatusParams.builder()\n .caseUuids(List.of(\"c1a5e000-0000-4000-8000-000000000001\"))\n .status(CasesBulkUpdateStatusParams.Status.of(\"RESOLVED\"))\n .resolution(CasesBulkUpdateStatusParams.Resolution.of(\"FALSE_POSITIVE\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->bulkUpdateStatus([\n 'case_uuids' => ['c1a5e000-0000-4000-8000-000000000001'],\n 'status' => 'RESOLVED',\n 'resolution' => 'FALSE_POSITIVE',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.bulk_update_status(\n case_uuids: [\"c1a5e000-0000-4000-8000-000000000001\"],\n status: \"RESOLVED\",\n resolution: \"FALSE_POSITIVE\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.BulkUpdateStatusAsync(new CasesBulkUpdateStatusParams\n{\n CaseUuids = new string[] { \"c1a5e000-0000-4000-8000-000000000001\" },\n Status = \"RESOLVED\",\n Resolution = new CasesBulkUpdateStatusParamsResolution(\"FALSE_POSITIVE\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Resultados por caso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBulkUpdateResult" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/bulk/assign/": { "post": { "summary": "Atribuir casos em massa", "description": "Atribua vários casos de uma vez (ou remova a atribuição deles, com assignee_user_id: null). Todos os casos devem compartilhar o mesmo blueprint; as divergências são informadas por caso, sem interromper o lote.", "operationId": "bulk_assign_cases", "x-didit-sdk": { "resource": "cases", "method": "bulk_assign", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Cases" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "case_uuids", "assignee_user_id" ], "properties": { "case_uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1 }, "assignee_user_id": { "type": "string", "format": "uuid", "nullable": true }, "assignee_email": { "type": "string", "format": "email", "nullable": true }, "assignee_name": { "type": "string", "nullable": true } } }, "example": { "case_uuids": [ "c1a5e000-0000-4000-8000-000000000001" ], "assignee_user_id": "9a000000-0000-4000-8000-0000000000aa" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/bulk/assign/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"case_uuids\": [\"c1a5e000-0000-4000-8000-000000000001\"], \"assignee_user_id\": \"9a000000-0000-4000-8000-0000000000aa\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.bulk_assign(\n case_uuids=[\"c1a5e000-0000-4000-8000-000000000001\"],\n assignee_user_id=\"9a000000-0000-4000-8000-0000000000aa\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.bulkAssign({\n case_uuids: [\"c1a5e000-0000-4000-8000-000000000001\"],\n assignee_user_id: \"9a000000-0000-4000-8000-0000000000aa\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.BulkAssign(ctx, didit.CasesBulkAssignParams{\n\tCaseUUIDs: []string{\"c1a5e000-0000-4000-8000-000000000001\"},\n\tAssigneeUserID: didit.String(\"9a000000-0000-4000-8000-0000000000aa\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CasesBulkAssignParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().bulkAssign(CasesBulkAssignParams.builder()\n .caseUuids(List.of(\"c1a5e000-0000-4000-8000-000000000001\"))\n .assigneeUserId(\"9a000000-0000-4000-8000-0000000000aa\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->bulkAssign([\n 'case_uuids' => ['c1a5e000-0000-4000-8000-000000000001'],\n 'assignee_user_id' => '9a000000-0000-4000-8000-0000000000aa',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.bulk_assign(\n case_uuids: [\"c1a5e000-0000-4000-8000-000000000001\"],\n assignee_user_id: \"9a000000-0000-4000-8000-0000000000aa\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.BulkAssignAsync(new CasesBulkAssignParams\n{\n CaseUuids = new string[] { \"c1a5e000-0000-4000-8000-000000000001\" },\n AssigneeUserId = \"9a000000-0000-4000-8000-0000000000aa\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Resultados por caso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBulkUpdateResult" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/": { "get": { "summary": "Listar blueprints", "description": "Lista os blueprints de casos da aplicação.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Tamanho da página." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Deslocamento a partir de 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": "Lista paginada de blueprints.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número de linhas correspondentes, limitado a 100 por desempenho." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseBlueprintListItem" } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Criar blueprint", "description": "Cria um blueprint de caso: configurações gerais (atribuição, escalonamento, transferência, pareamento de quatro olhos) mais content_config, as seis seções que compõem a página do caso. Defina publish=false para criar um rascunho não publicado; Publicar cria sua primeira versão ativa. Descartar um rascunho nunca publicado o exclui.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "assignee_pool" ], "properties": { "name": { "type": "string", "maxLength": 24, "description": "Máximo de 24 caracteres, por exemplo, \"Investigação AML\"." }, "description": { "type": "string", "nullable": true }, "assignee_pool": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "description": "Lista de UUIDs de usuários. Arrays vazios são rejeitados com \"Pick at least one assignee\"." }, "assignment_method": { "type": "string", "enum": [ "MANUAL", "AUTOMATIC" ], "default": "MANUAL" }, "max_active_cases": { "type": "integer", "nullable": true, "minimum": 1, "description": "Limiar do modo automático: \"menos de N casos deste blueprint atribuídos\"." }, "escalation_enabled": { "type": "boolean", "default": false }, "escalation_blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID do blueprint de destino. Não é validado no momento de salvar, mas a ação de escalonamento falha com 400 até que escalation_enabled e escalation_blueprint estejam definidos." }, "transfer_enabled": { "type": "boolean", "default": false }, "four_eyes_checker_blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "Definir este valor ativa a revisão por quatro olhos (4-eyes): as resoluções neste blueprint ficam pendentes na fila do blueprint verificador." }, "require_resolution_note": { "type": "boolean", "default": false }, "content_config": { "$ref": "#/components/schemas/CaseContentConfig" }, "is_active": { "type": "boolean", "default": true }, "default_deadline_hours": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 8760, "description": "Prazo padrão para casos recém-abertos. Os prazos de casos existentes não mudam." }, "publish": { "type": "boolean", "writeOnly": true, "default": true, "description": "Defina como false para salvar um rascunho nunca publicado. O registro permanece inativo na versão 0 até que o rascunho seja publicado explicitamente. Omitir este campo mantém a criação imediata para as integrações existentes." } } }, "example": { "name": "AML investigation", "assignee_pool": [ "9a000000-0000-4000-8000-0000000000aa" ], "assignment_method": "AUTOMATIC", "max_active_cases": 15, "require_resolution_note": true, "content_config": { "aml_control": { "enabled": true, "financial": true, "identity": false } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"name\": \"AML investigation\", \"assignee_pool\": [\"9a000000-0000-4000-8000-0000000000aa\"], \"assignment_method\": \"AUTOMATIC\", \"max_active_cases\": 15, \"require_resolution_note\": true, \"content_config\": {\"aml_control\": {\"enabled\": true, \"financial\": true, \"identity\": false}}}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.create(\n name=\"AML investigation\",\n assignee_pool=[\"9a000000-0000-4000-8000-0000000000aa\"],\n assignment_method=\"AUTOMATIC\",\n max_active_cases=15,\n require_resolution_note=True,\n content_config={\n \"aml_control\": {\n \"enabled\": True,\n \"financial\": True,\n \"identity\": False,\n },\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.create({\n name: \"AML investigation\",\n assignee_pool: [\"9a000000-0000-4000-8000-0000000000aa\"],\n assignment_method: \"AUTOMATIC\",\n max_active_cases: 15,\n require_resolution_note: true,\n content_config: {\n aml_control: {\n enabled: true,\n financial: true,\n identity: false,\n },\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.Create(ctx, didit.CasesBlueprintsCreateParams{\n\tName: \"AML investigation\",\n\tAssigneePool: []string{\"9a000000-0000-4000-8000-0000000000aa\"},\n\tAssignmentMethod: didit.Some(didit.CasesBlueprintsCreateParamsAssignmentMethod(\"AUTOMATIC\")),\n\tMaxActiveCases: didit.Int(15),\n\tRequireResolutionNote: didit.Bool(true),\n\tContentConfig: didit.Some(didit.CaseContentConfigParam{\n\t\tAMLControl: didit.Some(didit.CaseContentConfigParamAMLControl{\n\t\t\tEnabled: didit.Bool(true),\n\t\t\tFinancial: didit.Bool(true),\n\t\t\tIdentity: didit.Bool(false),\n\t\t}),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CaseContentConfig;\nimport me.didit.types.CasesBlueprintsCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().create(CasesBlueprintsCreateParams.builder()\n .name(\"AML investigation\")\n .assigneePool(List.of(\"9a000000-0000-4000-8000-0000000000aa\"))\n .assignmentMethod(CasesBlueprintsCreateParams.AssignmentMethod.of(\"AUTOMATIC\"))\n .maxActiveCases(15L)\n .requireResolutionNote(true)\n .contentConfig(CaseContentConfig.builder()\n .amlControl(CaseContentConfig.AmlControl.builder()\n .enabled(true)\n .financial(true)\n .identity(false)\n .build())\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->create([\n 'name' => 'AML investigation',\n 'assignee_pool' => ['9a000000-0000-4000-8000-0000000000aa'],\n 'assignment_method' => 'AUTOMATIC',\n 'max_active_cases' => 15,\n 'require_resolution_note' => true,\n 'content_config' => [\n 'aml_control' => [\n 'enabled' => true,\n 'financial' => true,\n 'identity' => false,\n ],\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.create(\n name: \"AML investigation\",\n assignee_pool: [\"9a000000-0000-4000-8000-0000000000aa\"],\n assignment_method: \"AUTOMATIC\",\n max_active_cases: 15,\n require_resolution_note: true,\n content_config: {\n aml_control: {\n enabled: true,\n financial: true,\n identity: false,\n },\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.CreateAsync(new CasesBlueprintsCreateParams\n{\n Name = \"AML investigation\",\n AssigneePool = new string[] { \"9a000000-0000-4000-8000-0000000000aa\" },\n AssignmentMethod = new CasesBlueprintsCreateParamsAssignmentMethod(\"AUTOMATIC\"),\n MaxActiveCases = 15,\n RequireResolutionNote = true,\n ContentConfig = new CaseContentConfig\n {\n AmlControl = new CaseContentConfigAmlControl\n {\n Enabled = true,\n Financial = true,\n Identity = false,\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Blueprint criado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintDetail" } } } }, "400": { "description": "Nome com mais de 24 caracteres, assignee_pool vazio ou um blueprint referenciado (escalonamento/verificador) não encontrado.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/": { "get": { "summary": "Obter blueprint", "description": "Obtenha um blueprint, incluindo suas origens de criação conectadas (configuração AML, regras de transação, nós do fluxo) e quais blueprints escalam para ele.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "blueprint_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "b1de0000-0000-4000-8000-000000000002" }, "description": "UUID do 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": "Detalhes do blueprint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Atualizar blueprint", "description": "Atualiza parcialmente as configurações gerais ou o content_config de um 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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "blueprint_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "b1de0000-0000-4000-8000-000000000002" }, "description": "UUID do blueprint." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 24, "description": "Máximo de 24 caracteres, por exemplo, \"Investigação AML\"." }, "description": { "type": "string", "nullable": true }, "assignee_pool": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "description": "Lista de UUIDs de usuários. Arrays vazios são rejeitados com \"Pick at least one assignee\"." }, "assignment_method": { "type": "string", "enum": [ "MANUAL", "AUTOMATIC" ] }, "max_active_cases": { "type": "integer", "nullable": true, "minimum": 1, "description": "Limiar do modo automático: \"menos de N casos deste blueprint atribuídos\"." }, "escalation_enabled": { "type": "boolean" }, "escalation_blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID do blueprint de destino. Não é validado no momento de salvar, mas a ação de escalonamento falha com 400 até que escalation_enabled e escalation_blueprint estejam definidos." }, "transfer_enabled": { "type": "boolean" }, "four_eyes_checker_blueprint": { "type": "string", "format": "uuid", "nullable": true, "description": "Definir este valor ativa a revisão por quatro olhos (4-eyes): as resoluções neste blueprint ficam pendentes na fila do blueprint verificador." }, "require_resolution_note": { "type": "boolean" }, "content_config": { "$ref": "#/components/schemas/CaseContentConfig" }, "is_active": { "type": "boolean" }, "default_deadline_hours": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 8760, "description": "Prazo padrão para casos recém-abertos. Os prazos de casos existentes não mudam." }, "expected_version": { "type": "integer", "minimum": 1, "description": "A versão aberta pelo editor. Uma versão desatualizada retorna 409 sem alterar a política de revisão." } } }, "example": { "transfer_enabled": true } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/b1de0000-0000-4000-8000-000000000002/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"transfer_enabled\": true}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.update(\n \"b1de0000-0000-4000-8000-000000000002\",\n transfer_enabled=True,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.update(\"b1de0000-0000-4000-8000-000000000002\", {\n transfer_enabled: true,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.Update(ctx, \"b1de0000-0000-4000-8000-000000000002\", didit.CasesBlueprintsUpdateParams{\n\tTransferEnabled: didit.Bool(true),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesBlueprintsUpdateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().update(\"b1de0000-0000-4000-8000-000000000002\", CasesBlueprintsUpdateParams.builder()\n .transferEnabled(true)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->update('b1de0000-0000-4000-8000-000000000002', [\n 'transfer_enabled' => true,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.update(\n \"b1de0000-0000-4000-8000-000000000002\",\n transfer_enabled: true\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.UpdateAsync(\"b1de0000-0000-4000-8000-000000000002\", new CasesBlueprintsUpdateParams\n{\n TransferEnabled = true,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Blueprint atualizado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintDetail" } } } }, "409": { "description": "A política de revisão mudou desde expected_version. Revise a versão mais recente antes de tentar novamente." } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Excluir blueprint", "description": "Exclua um blueprint. A exclusão sempre é concluída e não afeta os casos do blueprint: os casos existentes mantêm a referência ao blueprint, e as configurações dele continuam valendo para eles. Um blueprint excluído não aparece mais nas listas de blueprints e não pode mais ser escolhido como destino de transferência; se um blueprint maker for excluído enquanto uma resolução aguarda aprovação por quatro olhos, uma resolução rejeitada deixa o caso no blueprint checker.", "operationId": "delete_case_blueprint", "x-didit-sdk": { "resource": "cases.blueprints", "method": "delete", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Blueprints" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "blueprint_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "b1de0000-0000-4000-8000-000000000002" }, "description": "UUID do 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 excluído." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/presets/": { "get": { "summary": "Listar presets de blueprint", "description": "Lista os quatro presets integrados (Screening hit, AML investigation, Suspicious activity, KYC review) com o respectivo content_config e indica se cada um já está instalado nesta aplicação.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/presets/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.list_presets()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.listPresets();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.ListPresets(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().listPresets();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->listPresets();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.list_presets\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.ListPresetsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Catálogo de predefinições.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "preset_key": { "type": "string", "enum": [ "screening_hit", "aml_investigation", "suspicious_activity", "kyc" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "content_config": { "$ref": "#/components/schemas/CaseContentConfig" }, "installed": { "type": "boolean" } } } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/presets/install/": { "post": { "summary": "Instalar predefinições de blueprint", "description": "Copie um ou mais presets para a aplicação como blueprints editáveis. Idempotente por preset_key; omita preset_keys para instalar todos os presets ainda não instalados.", "operationId": "install_case_blueprint_presets", "x-didit-sdk": { "resource": "cases.blueprints", "method": "install_presets", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Blueprints" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "preset_keys": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Subconjunto de screening_hit, aml_investigation, suspicious_activity, kyc. Omita para instalar todos." } } }, "example": { "preset_keys": [ "aml_investigation", "kyc" ] } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/blueprints/presets/install/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"preset_keys\": [\"aml_investigation\", \"kyc\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.blueprints.install_presets(\n preset_keys=[\"aml_investigation\", \"kyc\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.blueprints.installPresets({\n preset_keys: [\"aml_investigation\", \"kyc\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Blueprints.InstallPresets(ctx, didit.CasesBlueprintsInstallPresetsParams{\n\tPresetKeys: didit.Some([]string{\"aml_investigation\", \"kyc\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CasesBlueprintsInstallPresetsParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().blueprints().installPresets(CasesBlueprintsInstallPresetsParams.builder()\n .presetKeys(List.of(\"aml_investigation\", \"kyc\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->blueprints->installPresets([\n 'preset_keys' => ['aml_investigation', 'kyc'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.blueprints.install_presets(preset_keys: [\"aml_investigation\", \"kyc\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Blueprints.InstallPresetsAsync(new CasesBlueprintsInstallPresetsParams\n{\n PresetKeys = new string[] { \"aml_investigation\", \"kyc\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Um ou mais presets instalados.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintPresetInstallResult" } } } }, "200": { "description": "Nenhum preset novo para instalar (todos os presets solicitados já existem).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseBlueprintPresetInstallResult" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/report-templates/": { "get": { "summary": "Listar modelos de relatório", "description": "Lista os modelos de relatório da FIU da aplicação.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Tamanho da página." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Deslocamento a partir de 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": "Modelos paginados.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número de linhas correspondentes, limitado a 100 por desempenho." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTemplateDetail" } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Criar modelo de relatório", "description": "Cria um modelo de cabeçalho goAML reutilizável por jurisdição e por tipo de relatório. É rejeitado com 400 se algum dos campos obrigatórios no nível do modelo (rentity_id, submission_code, currency_code_local) estiver ausente de field_config; um modelo inválido não pode ser salvo nem usado para criar um relatório. Os campos de cabeçalho de cada envio (action, submission_date, transactions) são exigidos no momento de validar ou finalizar o relatório.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "jurisdiction", "report_type" ], "properties": { "name": { "type": "string" }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Código de país ISO 3166-1 alpha-2, convertido para maiúsculas ao salvar." }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "field_config": { "type": "object", "description": "Padrões reutilizáveis de cabeçalho do goAML. Campos obrigatórios no nível do modelo: rentity_id, submission_code e currency_code_local (3 letras). Opcionais: enabled_fields (quais blocos opcionais do relatório incluir), além dos padrões de reporting_person, location, reason e action. Os campos de cabeçalho por envio (action, submission_date, transactions, jurisdiction) são exigidos quando o relatório é validado ou finalizado, não no modelo." } } }, "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": "Modelo criado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTemplateDetail" } } } }, "400": { "description": "Jurisdição não reconhecida, ou field_config não passa na validação de campos obrigatórios.", "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": "Obter modelo de relatório", "description": "Obtenha um modelo de relatório.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "template_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "7ec00000-0000-4000-8000-000000000006" }, "description": "UUID do modelo de relatório." } ], "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": "Detalhes do modelo.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTemplateDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Atualizar modelo de relatório", "description": "Atualiza parcialmente um modelo de relatório. Revalida os campos obrigatórios do goAML ao salvar.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "template_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "7ec00000-0000-4000-8000-000000000006" }, "description": "UUID do modelo de relatório." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Código de país ISO 3166-1 alpha-2, convertido para maiúsculas ao salvar." }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "field_config": { "type": "object", "description": "Padrões reutilizáveis de cabeçalho do goAML. Campos obrigatórios no nível do modelo: rentity_id, submission_code e currency_code_local (3 letras). Opcionais: enabled_fields (quais blocos opcionais do relatório incluir), além dos padrões de reporting_person, location, reason e action. Os campos de cabeçalho por envio (action, submission_date, transactions, jurisdiction) são exigidos quando o relatório é validado ou finalizado, não no modelo." } } }, "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": "Modelo atualizado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTemplateDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Excluir modelo de relatório", "description": "Exclua um modelo de relatório. Os relatórios já criados a partir dele não são afetados.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "template_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "7ec00000-0000-4000-8000-000000000006" }, "description": "UUID do modelo de relatório." } ], "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": "Modelo excluído." } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/": { "get": { "summary": "Listar relatórios do caso", "description": "Lista os relatórios da FIU gerados para o caso.", "operationId": "list_case_regulatory_reports", "x-didit-sdk": { "resource": "cases.regulatory_reports", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Tamanho da página." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Deslocamento a partir de 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": "Relatórios paginados do caso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportList" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Criar relatório a partir de um caso", "description": "Cria um rascunho de relatório para a FIU do caso: status DRAFT, preenchido automaticamente a partir do modelo opcional mais o titular do caso, as transações vinculadas e a narrativa. Valide e depois finalize para gerar o XML goAML e o 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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "case_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "c1a5e000-0000-4000-8000-000000000001" }, "description": "UUID do caso." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ], "description": "Obrigatório, a menos que um modelo seja informado; caso contrário, é usado o report_type do modelo." }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Obrigatório, a menos que um modelo seja informado." }, "template": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID do modelo de relatório; o field_config dele preenche o rascunho inicial antes de os dados derivados do caso serem mesclados." }, "transactions": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true, "description": "Transações a anexar; por padrão, as transações vinculadas ao caso." }, "rentity_id": { "type": "string", "nullable": true }, "rentity_branch": { "type": "string", "nullable": true }, "submission_code": { "type": "string", "enum": [ "E", "M" ], "default": "E" }, "entity_reference": { "type": "string", "nullable": true }, "fiu_ref_number": { "type": "string", "nullable": true }, "currency_code_local": { "type": "string", "minLength": 3, "maxLength": 3, "nullable": true }, "submission_date": { "type": "string", "format": "date-time", "nullable": true }, "reporting_person": { "type": "object" }, "location": { "type": "object" }, "reason": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "activity": { "type": "string", "nullable": true }, "narrative": { "type": "object", "properties": { "who": { "type": "string" }, "what": { "type": "string" }, "when": { "type": "string" }, "where": { "type": "string" }, "why": { "type": "string" }, "how": { "type": "string" } } }, "report_indicators": { "type": "array", "items": { "type": "string" } }, "included_fields": { "type": "array", "items": { "type": "string" } } } }, "example": { "template": "7ec00000-0000-4000-8000-000000000006" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/regulatory-reports/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"template\": \"7ec00000-0000-4000-8000-000000000006\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.regulatory_reports.create(\n \"c1a5e000-0000-4000-8000-000000000001\",\n template=\"7ec00000-0000-4000-8000-000000000006\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.regulatoryReports.create(\"c1a5e000-0000-4000-8000-000000000001\", {\n template: \"7ec00000-0000-4000-8000-000000000006\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RegulatoryReports.Create(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesRegulatoryReportsCreateParams{\n\tTemplate: didit.String(\"7ec00000-0000-4000-8000-000000000006\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CasesRegulatoryReportsCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().regulatoryReports().create(\"c1a5e000-0000-4000-8000-000000000001\", CasesRegulatoryReportsCreateParams.builder()\n .template(\"7ec00000-0000-4000-8000-000000000006\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->regulatoryReports->create('c1a5e000-0000-4000-8000-000000000001', [\n 'template' => '7ec00000-0000-4000-8000-000000000006',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.regulatory_reports.create(\n \"c1a5e000-0000-4000-8000-000000000001\",\n template: \"7ec00000-0000-4000-8000-000000000006\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RegulatoryReports.CreateAsync(\"c1a5e000-0000-4000-8000-000000000001\", new CasesRegulatoryReportsCreateParams\n{\n Template = \"7ec00000-0000-4000-8000-000000000006\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Rascunho de relatório criado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "400": { "description": "O modelo referenciado não foi encontrado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/": { "get": { "summary": "Listar relatórios", "description": "Lista de relatórios para a FIU de toda a aplicação, com filtro opcional por status, report_type ou caso.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50, "minimum": 1 }, "description": "Tamanho da página." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Deslocamento a partir de zero." }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "DRAFT", "VALIDATED", "FINALIZED" ] }, "description": "Filtra por status." }, { "name": "report_type", "in": "query", "schema": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "description": "Filtrar por tipo de relatório." }, { "name": "case", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Filtra os relatórios deste caso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.regulatory_reports.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.regulatoryReports.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.RegulatoryReports.ListAutoPaging(ctx, didit.RegulatoryReportsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.regulatoryReports().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.regulatory_reports.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.RegulatoryReports.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Relatórios paginados de toda a aplicação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportList" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Criar relatório avulso", "description": "Cria um rascunho de relatório para a FIU a partir da página independente de Relatórios: tanto o caso quanto o modelo são obrigatórios (diferentemente da criação no escopo do caso, que pode omitir o modelo).", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." } ], "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": "Obrigatório, a menos que um modelo seja informado; caso contrário, é usado o report_type do modelo." }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Obrigatório, a menos que um modelo seja informado." }, "transactions": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true, "description": "Transações a anexar; por padrão, as transações vinculadas ao caso." }, "rentity_id": { "type": "string", "nullable": true }, "rentity_branch": { "type": "string", "nullable": true }, "submission_code": { "type": "string", "enum": [ "E", "M" ], "default": "E" }, "entity_reference": { "type": "string", "nullable": true }, "fiu_ref_number": { "type": "string", "nullable": true }, "currency_code_local": { "type": "string", "minLength": 3, "maxLength": 3, "nullable": true }, "submission_date": { "type": "string", "format": "date-time", "nullable": true }, "reporting_person": { "type": "object" }, "location": { "type": "object" }, "reason": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "activity": { "type": "string", "nullable": true }, "narrative": { "type": "object", "properties": { "who": { "type": "string" }, "what": { "type": "string" }, "when": { "type": "string" }, "where": { "type": "string" }, "why": { "type": "string" }, "how": { "type": "string" } } }, "report_indicators": { "type": "array", "items": { "type": "string" } }, "included_fields": { "type": "array", "items": { "type": "string" } } } }, "example": { "case": "c1a5e000-0000-4000-8000-000000000001", "template": "7ec00000-0000-4000-8000-000000000006" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"case\": \"c1a5e000-0000-4000-8000-000000000001\", \"template\": \"7ec00000-0000-4000-8000-000000000006\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.regulatory_reports.create(\n case=\"c1a5e000-0000-4000-8000-000000000001\",\n template=\"7ec00000-0000-4000-8000-000000000006\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.regulatoryReports.create({\n case: \"c1a5e000-0000-4000-8000-000000000001\",\n template: \"7ec00000-0000-4000-8000-000000000006\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.RegulatoryReports.Create(ctx, didit.RegulatoryReportsCreateParams{\n\tCase: \"c1a5e000-0000-4000-8000-000000000001\",\n\tTemplate: \"7ec00000-0000-4000-8000-000000000006\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.RegulatoryReportsCreateParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.regulatoryReports().create(RegulatoryReportsCreateParams.builder()\n .case_(\"c1a5e000-0000-4000-8000-000000000001\")\n .template(\"7ec00000-0000-4000-8000-000000000006\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->create([\n 'case' => 'c1a5e000-0000-4000-8000-000000000001',\n 'template' => '7ec00000-0000-4000-8000-000000000006',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.regulatory_reports.create(\n case: \"c1a5e000-0000-4000-8000-000000000001\",\n template: \"7ec00000-0000-4000-8000-000000000006\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.RegulatoryReports.CreateAsync(new RegulatoryReportsCreateParams\n{\n Case = \"c1a5e000-0000-4000-8000-000000000001\",\n Template = \"7ec00000-0000-4000-8000-000000000006\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "Rascunho de relatório criado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "400": { "description": "O modelo referenciado não foi encontrado.", "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": "Obter relatório", "description": "Obtenha um relatório regulatório.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID do relatório." } ], "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": "Detalhes do relatório.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Atualizar relatório", "description": "Edita os campos de um relatório em rascunho ou validado. Relatórios finalizados não podem ser editados (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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID do relatório." } ], "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": "Relatório atualizado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "409": { "description": "O relatório já está finalizado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Excluir relatório", "description": "Exclua um relatório regulatório permanentemente. O relatório, a narrativa e os motivos copiados, os vínculos com transações e os arquivos XML do goAML e PDF gerados são apagados, incluindo todas as versões armazenadas desses arquivos. O relatório desaparece das listas e as URLs de download deixam de funcionar. Outros registros, incluindo o caso, as transações, as pessoas e as empresas, não são excluídos. Não é possível desfazer.\n\nUm relatório em rascunho ou validado pode ser excluído sem corpo da requisição. Excluir um relatório finalizado exige `confirm_delete: true` no corpo da requisição. Se o relatório não existir, a requisição retorna `404`; se um relatório finalizado for enviado sem confirmação, ela retorna `400` e nada é excluído.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID do relatório." } ], "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": "Relatório excluído, incluindo seus arquivos gerados." }, "400": { "description": "Um relatório finalizado foi enviado sem `confirm_delete: true`. Nada é excluído.", "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": "A chave de API não pode excluir relatórios. O endpoint exige `write:cases`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "404": { "description": "Relatório não encontrado nesta aplicação.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "409": { "description": "O relatório já está sendo excluído. Repita a requisição para concluir a remoção dos arquivos.", "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": "Os arquivos do relatório não puderam ser apagados agora. O relatório continua existindo. Repita a requisição.", "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": "Obrigatório somente para um relatório finalizado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "confirm_delete": { "type": "boolean", "description": "Defina como true para confirmar que um relatório finalizado e os arquivos gerados a partir dele são excluídos permanentemente." } }, "example": { "confirm_delete": true } }, "example": { "confirm_delete": true } } } } } }, "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/validate/": { "post": { "summary": "Validar relatório", "description": "Valida o relatório em relação aos campos de cabeçalho obrigatórios do goAML (ID da entidade declarante, código de envio, moeda local, ação tomada, data de envio), além de exigir pelo menos uma transação anexada e uma jurisdição de 2 letras, sem gerar nenhum arquivo. Também armazena o resultado no relatório: validation_errors e validated_at são atualizados, e o status de um relatório não finalizado passa para VALIDATED (sem erros) ou volta para DRAFT (com erros).", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID do relatório." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/regulatory-reports/5ec00000-0000-4000-8000-000000000007/validate/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.regulatory_reports.validate(\n \"5ec00000-0000-4000-8000-000000000007\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.regulatoryReports.validate(\"5ec00000-0000-4000-8000-000000000007\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.RegulatoryReports.Validate(ctx, \"5ec00000-0000-4000-8000-000000000007\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.regulatoryReports().validate(\"5ec00000-0000-4000-8000-000000000007\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "regulatoryReports->validate('5ec00000-0000-4000-8000-000000000007');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.regulatory_reports.validate(\"5ec00000-0000-4000-8000-000000000007\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.RegulatoryReports.ValidateAsync(\"5ec00000-0000-4000-8000-000000000007\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Resultado da validação.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "DRAFT", "VALIDATED", "FINALIZED" ] }, "is_valid": { "type": "boolean" }, "errors": { "type": "array", "description": "Vazio quando válido.", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/finalize/": { "post": { "summary": "Finalizar relatório", "description": "Revalida e, em seguida, gera o XML e o PDF do goAML e envia ambos para o S3. Em relatórios SAR/STR/TFR, isso também move os alertas de transação do caso de SAR pendente para SAR enviado.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID do relatório." } ], "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": "Relatório finalizado; xml_s3_key e pdf_s3_key estão definidos.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryReportDetail" } } } }, "400": { "description": "O relatório falhou na validação.", "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": "O relatório não está em um estado que permita finalizá-lo.", "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": "Obter a URL de download do relatório", "description": "Gera uma URL pré-assinada para o XML goAML ou o PDF de um relatório finalizado.", "operationId": "get_regulatory_report_download_url", "x-didit-sdk": { "resource": "regulatory_reports", "method": "retrieve_download_url", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Regulatory Reports" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "report_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5ec00000-0000-4000-8000-000000000007" }, "description": "UUID do relatório." }, { "name": "file", "in": "query", "schema": { "type": "string", "enum": [ "pdf", "xml" ], "default": "pdf" }, "description": "Qual arquivo baixar." } ], "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 download pré-assinada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "download_url": { "type": "string", "format": "uri" }, "file": { "type": "string", "enum": [ "pdf", "xml" ] } } } } } }, "409": { "description": "O relatório ainda não está finalizado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "status": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/transactions/rules/": { "get": { "summary": "Listar regras", "description": "Lista as regras de monitoramento de transações da aplicação: suas regras personalizadas e os presets da biblioteca que você instalou. Filtre por origem, categoria, modo, pacote ou busca em texto livre; ordene com `ordering` (run_count, approved_pct, reviewed_pct, declined_pct, latest_triggered_at, title, created_at, source, cada um com um prefixo `-` 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 ou CUSTOM" }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filtrar por categoria de regra" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "TEST" ] }, "description": "ACTIVE, DISABLED ou TEST" }, { "name": "bundle", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filtrar presets por pacote" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Correspondência sem distinção entre maiúsculas e minúsculas no título e na descrição" }, { "name": "ordering", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Campos de ordenação separados por vírgula; padrão: source,-run_count" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tamanho da página" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Deslocamento da página" } ], "responses": { "200": { "description": "Regras paginadas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleDetail" } } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/rules/?source=CUSTOM&ordering=-run_count' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.transactions.rules.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.transactions.rules.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Transactions.Rules.ListAutoPaging(ctx, didit.TransactionsRulesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.transactions().rules().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.rules.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Transactions.Rules.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "summary": "Criar regra", "description": "Cria uma regra CUSTOM de monitoramento de transações. Os títulos são únicos por aplicação (duplicado -> 400). Uma ação `change_status` com destino `AWAITING_USER` deve incluir `workflow_id`. Regras criadas no modo ACTIVE se aplicam imediatamente a novas transações - o fluxo recomendado é criar no modo TEST, fazer o backtest e então mudar o modo para ACTIVE.", "operationId": "createTransactionRule", "x-didit-sdk": { "resource": "transactions.rules", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleCreateRequest" }, "example": { "title": "Structuring - inbound (custom)", "description": "20+ inbound EUR transfers, all under 10,000 EUR, 30 days", "category": "finance", "mode": "TEST", "evaluation_mode": "ALL", "scope": { "transaction_types": [ "finance" ], "directions": [ "INBOUND" ] }, "conditions": [ { "field": "currency", "operator": "eq", "value": "EUR" }, { "field": "amount", "operator": "lt", "value": 10000 } ], "aggregation": [ { "metric": "count", "operator": "gte", "value": 20, "window": "30d", "filters": { "direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR" } }, { "metric": "max", "field": "amount", "operator": "lt", "value": 10000, "window": "30d", "filters": { "direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR" } } ], "actions": [ { "type": "add_score", "value": 35 } ] } } } }, "responses": { "201": { "description": "A regra criada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleDetail" } } } }, "400": { "description": "Erro de validação: título duplicado, operador/métrica desconhecido, janela malformada, direção de escopo inválida ou AWAITING_USER sem 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": "O uuid da regra, obtido na listagem ou na criação." } ], "get": { "summary": "Obter regra", "description": "Obtenha uma regra com a sua configuração completa e os contadores de execução.", "operationId": "getTransactionRule", "x-didit-sdk": { "resource": "transactions.rules", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "A regra.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleDetail" } } } }, "404": { "description": "Regra não encontrada nesta aplicação.", "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": "Atualizar regra", "description": "Atualiza parcialmente uma regra. Regras personalizadas aceitam todos os campos de configuração. Regras da biblioteca (PRESET) aceitam apenas `mode` - use-o para ativar, desativar ou mudar uma regra predefinida para TEST; qualquer outro campo retorna 400. Uma cópia instalada de uma regra da biblioteca retida fica desligada: definir seu `mode` como qualquer valor diferente de `DISABLED` retorna 400 (\"This library rule cannot run yet: its conditions read data the rules engine cannot evaluate.\").", "operationId": "updateTransactionRule", "x-didit-sdk": { "resource": "transactions.rules", "method": "update", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleUpdateRequest" }, "example": { "mode": "ACTIVE" } } } }, "responses": { "200": { "description": "A regra atualizada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleDetail" } } } }, "400": { "description": "Erro de validação: um campo diferente de mode em uma regra da biblioteca, ou um mode diferente de DISABLED em uma regra da biblioteca retida.", "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": "Excluir regra", "description": "Exclua uma regra CUSTOM. A exclusão é imediata e permanente: a regra deixa de ser avaliada para novas transações e desaparece das listagens, enquanto as execuções anteriores da regra em transações já avaliadas mantêm os resultados registrados. Regras da biblioteca não podem ser excluídas; em vez disso, desinstale-as pelo endpoint de instalação (elas sempre podem ser reinstaladas a partir da biblioteca).", "operationId": "deleteTransactionRule", "x-didit-sdk": { "resource": "transactions.rules", "method": "delete", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "204": { "description": "Excluído." }, "400": { "description": "A regra é um preset da biblioteca - desinstale-a em vez disso.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "detail": "Library rules cannot be deleted. Uninstall them via the rules install endpoint instead." } } } }, "404": { "description": "Regra não encontrada nesta aplicação.", "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": "Configuração da regra de backtest", "description": "Avalie uma configuração de regra hipotética com base nas suas transações recentes (das mais recentes para as mais antigas, até o limite do backtest) sem criar uma regra nem alterar nenhuma transação. Use antes de ativar uma regra para ver com que frequência ela teria correspondido e quantos sujeitos ela teria afetado.", "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": "Estatísticas do backtest.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleBacktestResult" }, "example": { "evaluated": 4820, "matched": 12, "affected_entities": 4, "period_days": 90 } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/transactions/rules/backtest/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"conditions\": [{\"field\": \"currency\", \"operator\": \"eq\", \"value\": \"EUR\"}, {\"field\": \"amount\", \"operator\": \"lt\", \"value\": 10000}], \"aggregation\": [{\"metric\": \"count\", \"operator\": \"gte\", \"value\": 20, \"window\": \"30d\", \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}}, {\"metric\": \"max\", \"field\": \"amount\", \"operator\": \"lt\", \"value\": 10000, \"window\": \"30d\", \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}}], \"evaluation_mode\": \"ALL\", \"scope\": {\"transaction_types\": [\"finance\"], \"directions\": [\"INBOUND\"]}, \"period_days\": 90}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.rules.backtest(\n conditions=[{\n \"field\": \"currency\",\n \"operator\": \"eq\",\n \"value\": \"EUR\",\n }, {\n \"field\": \"amount\",\n \"operator\": \"lt\",\n \"value\": 10000,\n }],\n aggregation=[{\n \"metric\": \"count\",\n \"operator\": \"gte\",\n \"value\": 20.0,\n \"window\": \"30d\",\n \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"},\n }, {\n \"metric\": \"max\",\n \"field\": \"amount\",\n \"operator\": \"lt\",\n \"value\": 10000.0,\n \"window\": \"30d\",\n \"filters\": {\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"},\n }],\n evaluation_mode=\"ALL\",\n scope={\n \"transaction_types\": [\"finance\"],\n \"directions\": [\"INBOUND\"],\n },\n period_days=90,\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.rules.backtest({\n conditions: [{\n field: \"currency\",\n operator: \"eq\",\n value: \"EUR\",\n }, {\n field: \"amount\",\n operator: \"lt\",\n value: 10000,\n }],\n aggregation: [{\n metric: \"count\",\n operator: \"gte\",\n value: 20.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }, {\n metric: \"max\",\n field: \"amount\",\n operator: \"lt\",\n value: 10000.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }],\n evaluation_mode: \"ALL\",\n scope: {\n transaction_types: [\"finance\"],\n directions: [\"INBOUND\"],\n },\n period_days: 90,\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.Backtest(ctx, didit.TransactionRuleBacktestRequest{\n\tConditions: didit.Some([]didit.TransactionRuleConditionParam{{\n\t\tField: \"currency\",\n\t\tOperator: \"eq\",\n\t\tValue: didit.Some[any](\"EUR\"),\n\t}, {\n\t\tField: \"amount\",\n\t\tOperator: \"lt\",\n\t\tValue: didit.Some[any](10000),\n\t}}),\n\tAggregation: didit.Some([]didit.TransactionRuleAggregationParam{{\n\t\tMetric: didit.Some(didit.TransactionRuleAggregationMetric(\"count\")),\n\t\tOperator: didit.Some(didit.TransactionRuleAggregationOperator(\"gte\")),\n\t\tValue: 20.0,\n\t\tWindow: didit.String(\"30d\"),\n\t\tFilters: didit.Some(map[string]any{\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}),\n\t}, {\n\t\tMetric: didit.Some(didit.TransactionRuleAggregationMetric(\"max\")),\n\t\tField: didit.String(\"amount\"),\n\t\tOperator: didit.Some(didit.TransactionRuleAggregationOperator(\"lt\")),\n\t\tValue: 10000.0,\n\t\tWindow: didit.String(\"30d\"),\n\t\tFilters: didit.Some(map[string]any{\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}),\n\t}}),\n\tEvaluationMode: didit.Some(didit.TransactionRuleBacktestRequestEvaluationMode(\"ALL\")),\n\tScope: didit.Some(didit.TransactionRuleScopeParam{\n\t\tTransactionTypes: didit.Some([]string{\"finance\"}),\n\t\tDirections: didit.Some([]didit.TransactionRuleScopeDirections{\"INBOUND\"}),\n\t}),\n\tPeriodDays: didit.Int(90),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.TransactionRuleAggregation;\nimport me.didit.types.TransactionRuleBacktestRequest;\nimport me.didit.types.TransactionRuleCondition;\nimport me.didit.types.TransactionRuleScope;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().rules().backtest(TransactionRuleBacktestRequest.builder()\n .conditions(List.of(\n TransactionRuleCondition.builder()\n .field(\"currency\")\n .operator(TransactionRuleCondition.Operator.of(\"eq\"))\n .value(\"EUR\")\n .build(),\n TransactionRuleCondition.builder()\n .field(\"amount\")\n .operator(TransactionRuleCondition.Operator.of(\"lt\"))\n .value(10000)\n .build()))\n .aggregation(List.of(\n TransactionRuleAggregation.builder()\n .metric(TransactionRuleAggregation.Metric.of(\"count\"))\n .operator(TransactionRuleAggregation.Operator.of(\"gte\"))\n .value(20.0)\n .window(\"30d\")\n .filters(Map.of(\"direction\", \"INBOUND\", \"transaction_type\", \"finance\", \"subject_vendor_data\", \"__current__\", \"currency\", \"EUR\"))\n .build(),\n TransactionRuleAggregation.builder()\n .metric(TransactionRuleAggregation.Metric.of(\"max\"))\n .field(\"amount\")\n .operator(TransactionRuleAggregation.Operator.of(\"lt\"))\n .value(10000.0)\n .window(\"30d\")\n .filters(Map.of(\"direction\", \"INBOUND\", \"transaction_type\", \"finance\", \"subject_vendor_data\", \"__current__\", \"currency\", \"EUR\"))\n .build()))\n .evaluationMode(TransactionRuleBacktestRequest.EvaluationMode.of(\"ALL\"))\n .scope(TransactionRuleScope.builder()\n .transactionTypes(List.of(\"finance\"))\n .directions(List.of(TransactionRuleScope.Directions.of(\"INBOUND\")))\n .build())\n .periodDays(90L)\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->backtest([\n 'conditions' => [[\n 'field' => 'currency',\n 'operator' => 'eq',\n 'value' => 'EUR',\n ], [\n 'field' => 'amount',\n 'operator' => 'lt',\n 'value' => 10000,\n ]],\n 'aggregation' => [[\n 'metric' => 'count',\n 'operator' => 'gte',\n 'value' => 20.0,\n 'window' => '30d',\n 'filters' => ['direction' => 'INBOUND', 'transaction_type' => 'finance', 'subject_vendor_data' => '__current__', 'currency' => 'EUR'],\n ], [\n 'metric' => 'max',\n 'field' => 'amount',\n 'operator' => 'lt',\n 'value' => 10000.0,\n 'window' => '30d',\n 'filters' => ['direction' => 'INBOUND', 'transaction_type' => 'finance', 'subject_vendor_data' => '__current__', 'currency' => 'EUR'],\n ]],\n 'evaluation_mode' => 'ALL',\n 'scope' => [\n 'transaction_types' => ['finance'],\n 'directions' => ['INBOUND'],\n ],\n 'period_days' => 90,\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.rules.backtest(\n conditions: [{\n field: \"currency\",\n operator: \"eq\",\n value: \"EUR\",\n }, {\n field: \"amount\",\n operator: \"lt\",\n value: 10000,\n }],\n aggregation: [{\n metric: \"count\",\n operator: \"gte\",\n value: 20.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }, {\n metric: \"max\",\n field: \"amount\",\n operator: \"lt\",\n value: 10000.0,\n window: \"30d\",\n filters: { direction: \"INBOUND\", transaction_type: \"finance\", subject_vendor_data: \"__current__\", currency: \"EUR\" },\n }],\n evaluation_mode: \"ALL\",\n scope: {\n transaction_types: [\"finance\"],\n directions: [\"INBOUND\"],\n },\n period_days: 90\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Rules.BacktestAsync(new TransactionRuleBacktestRequest\n{\n Conditions = new TransactionRuleCondition[]\n {\n new()\n {\n Field = \"currency\",\n Operator = \"eq\",\n Value = \"EUR\",\n },\n new()\n {\n Field = \"amount\",\n Operator = \"lt\",\n Value = 10000,\n },\n },\n Aggregation = new TransactionRuleAggregation[]\n {\n new()\n {\n Metric = new TransactionRuleAggregationMetric(\"count\"),\n Operator = new TransactionRuleAggregationOperator(\"gte\"),\n Value = 20.0,\n Window = \"30d\",\n Filters = new Dictionary { [\"direction\"] = \"INBOUND\", [\"transaction_type\"] = \"finance\", [\"subject_vendor_data\"] = \"__current__\", [\"currency\"] = \"EUR\" },\n },\n new()\n {\n Metric = new TransactionRuleAggregationMetric(\"max\"),\n Field = \"amount\",\n Operator = new TransactionRuleAggregationOperator(\"lt\"),\n Value = 10000.0,\n Window = \"30d\",\n Filters = new Dictionary { [\"direction\"] = \"INBOUND\", [\"transaction_type\"] = \"finance\", [\"subject_vendor_data\"] = \"__current__\", [\"currency\"] = \"EUR\" },\n },\n },\n EvaluationMode = new TransactionRuleBacktestRequestEvaluationMode(\"ALL\"),\n Scope = new TransactionRuleScope\n {\n TransactionTypes = new string[] { \"finance\" },\n Directions = new TransactionRuleScopeDirections[] { \"INBOUND\" },\n },\n PeriodDays = 90,\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/transactions/rules/library/": { "get": { "summary": "Listar a biblioteca de regras", "description": "Navegue pela biblioteca completa de regras predefinidas (150+ regras), com a configuração completa de cada entrada e um indicador `is_installed` para esta aplicação. Filtre por pacote, categoria ou busca por texto livre. Uma regra da biblioteca cujas condições leem dados que o motor de regras ainda não consegue avaliar fica retida até que possa ser executada. Regras retidas não são listadas.", "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": "Filtrar por pacote, por exemplo, finance, aml_ctf, crypto_monitoring, travel_rule" }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filtrar por categoria" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Correspondência sem distinção entre maiúsculas e minúsculas no título e na descrição" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tamanho da página" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Deslocamento da página" } ], "responses": { "200": { "description": "Entradas da biblioteca paginadas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionRuleLibraryEntry" } } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/transactions/rules/library/?bundle=finance' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.transactions.rules.list_library():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.transactions.rules.listLibrary()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Transactions.Rules.ListLibraryAutoPaging(ctx, didit.TransactionsRulesListLibraryParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.transactions().rules().listLibrary()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->listLibrary() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.transactions.rules.list_library.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Transactions.Rules.ListLibraryAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/transactions/rules/install/": { "post": { "summary": "Instalar regras da biblioteca", "description": "Instale uma ou mais predefinições na aplicação, por `library_keys` ou por um `bundle` inteiro. Uma predefinição instalada fica ativa imediatamente enquanto o monitoramento de transações estiver ligado e, caso contrário, fica desabilitada; chaves já instaladas são ignoradas. Uma regra da biblioteca cujas condições leem dados que o mecanismo de regras ainda não consegue avaliar fica retida até poder ser executada. Uma requisição que inclua uma dessas regras em `library_keys` responde 400 e não instala nada (\"These library rules cannot run yet: their conditions read data the rules engine cannot evaluate.\" seguido das chaves), e uma instalação por `bundle` a ignora. Uma regra retida volta automaticamente assim que suas condições puderem ser avaliadas. Uma entrada de `library_keys` que não existe na biblioteca é ignorada, não recusada.", "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": "O que foi instalado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleInstallResult" }, "example": { "installed_library_keys": [ "structuring-inbound", "structuring-outbound" ], "installed_count": 2 } } } }, "400": { "description": "Nem library_keys nem bundle foram informados, `library_keys` não é uma lista ou uma entrada de `library_keys` está retida. Uma entrada desconhecida é ignorada e a resposta é 200 sem ela.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/transactions/rules/install/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"library_keys\": [\"structuring-inbound\", \"structuring-outbound\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.rules.install_library(\n library_keys=[\"structuring-inbound\", \"structuring-outbound\"],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.rules.installLibrary({\n library_keys: [\"structuring-inbound\", \"structuring-outbound\"],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.InstallLibrary(ctx, didit.TransactionRuleInstallRequest{\n\tLibraryKeys: didit.Some([]string{\"structuring-inbound\", \"structuring-outbound\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.TransactionRuleInstallRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().rules().installLibrary(TransactionRuleInstallRequest.builder()\n .libraryKeys(List.of(\"structuring-inbound\", \"structuring-outbound\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->installLibrary([\n 'library_keys' => ['structuring-inbound', 'structuring-outbound'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.rules.install_library(library_keys: [\"structuring-inbound\", \"structuring-outbound\"])\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Rules.InstallLibraryAsync(new TransactionRuleInstallRequest\n{\n LibraryKeys = new string[] { \"structuring-inbound\", \"structuring-outbound\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "delete": { "summary": "Desinstalar regras da biblioteca", "description": "Remove presets instalados da aplicação, por `library_keys` ou por um `bundle` inteiro. Os presets desinstalados deixam de ser avaliados imediatamente e podem ser reinstalados a partir da biblioteca a qualquer momento.", "operationId": "uninstallTransactionRuleLibrary", "x-didit-sdk": { "resource": "transactions.rules", "method": "uninstall_library", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleInstallRequest" }, "example": { "bundle": "responsible_gaming" } } } }, "responses": { "200": { "description": "Quantas predefinições foram removidas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionRuleInstallResult" }, "example": { "uninstalled_count": 5 } } } }, "400": { "description": "Nem library_keys nem bundle foram informados.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/transactions/rules/install/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"bundle\": \"responsible_gaming\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.transactions.rules.uninstall_library(\n bundle=\"responsible_gaming\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.transactions.rules.uninstallLibrary({\n bundle: \"responsible_gaming\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.UninstallLibrary(ctx, didit.TransactionRuleInstallRequest{\n\tBundle: didit.String(\"responsible_gaming\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TransactionRuleInstallRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.transactions().rules().uninstallLibrary(TransactionRuleInstallRequest.builder()\n .bundle(\"responsible_gaming\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->rules->uninstallLibrary([\n 'bundle' => 'responsible_gaming',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.transactions.rules.uninstall_library(bundle: \"responsible_gaming\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.Rules.UninstallLibraryAsync(new TransactionRuleInstallRequest\n{\n Bundle = \"responsible_gaming\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/": { "get": { "summary": "Listar redes", "description": "Lista as redes de fraude detectadas na organização desta aplicação, com as de maior risco primeiro por padrão. Por padrão, as redes descartadas são excluídas; passe status para incluí-las. Aplicações de sandbox nunca têm redes: o agrupamento exclui totalmente os dados de sandbox. Toda resposta traz o `sharing_mode` da organização e informa se os sinais entre organizações se aplicam a ela (`cross_org_available`, `cross_org_unavailable_reason`). `kpis` agregam as redes que correspondem aos seus filtros e `counts` agregam todas as redes que a aplicação pode ver; passe `summary=false` para omitir ambos quando você precisar apenas da página. Requer uma chave de API com acesso total, ou `list:networks` para um membro do console.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "status", "in": "query", "schema": { "type": "string" }, "description": "Status a incluir, separados por vírgula: active,in_review,resolved,dismissed. Omita para excluir dismissed." }, { "name": "scope", "in": "query", "schema": { "type": "string", "enum": [ "identity", "transactions" ] }, "description": "`transactions` mantém as redes cujos membros são todos partes de transações; `identity` mantém todas as outras redes. Omita para obter ambas. Também restringe `counts.views` e `counts.facets`. Qualquer outro valor retorna 400." }, { "name": "signal_type", "in": "query", "schema": { "type": "string" }, "description": "Tipos de sinal separados por vírgula: ip_address,device,face,document_number,phone,email,address." }, { "name": "pattern_type", "in": "query", "schema": { "type": "string" }, "description": "Tipos de padrão separados por vírgula, por exemplo, exact_same_device,same_email." }, { "name": "risk_band", "in": "query", "schema": { "type": "string" }, "description": "Faixas separadas por vírgula: low,medium,high." }, { "name": "min_size", "in": "query", "schema": { "type": "integer" }, "description": "Quantidade mínima de membros." }, { "name": "max_size", "in": "query", "schema": { "type": "integer" }, "description": "Número máximo de membros." }, { "name": "assignee", "in": "query", "schema": { "type": "string" }, "description": "Responsáveis separados por vírgula: `unassigned`, e-mails de membros (comparados sem diferenciar maiúsculas de minúsculas) ou `me` para o membro do console que faz a chamada. Uma rede corresponde a qualquer valor. `me` exige um token de membro do console: uma chave de API recebe 400 `{\"assignee\": [\"\\\"me\\\" needs a user token; an API key has no assignee identity.\"]}`." }, { "name": "priority", "in": "query", "schema": { "type": "string" }, "description": "Prioridades separadas por vírgula: `low`, `medium`, `high` ou `none` para redes sem prioridade. Qualquer outro valor retorna 400 `{\"priority\": \"Unknown priority: .\"}`." }, { "name": "risk_min", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 100 }, "description": "Pontuação de risco mínima, um número inteiro de 0 a 100. Um valor que não seja um número inteiro retorna 400 `{\"risk_min\": \"Use a whole number from 0 to 100.\"}`." }, { "name": "has_case", "in": "query", "schema": { "type": "boolean" }, "description": "`true` mantém as redes para as quais sua aplicação abriu um caso, e `false`, as demais. Qualquer outro valor é ignorado." }, { "name": "date_from", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Limite inferior de last_activity_at (data ou data e hora ISO 8601)." }, { "name": "date_to", "in": "query", "schema": { "type": "string", "format": "date" }, "description": "Limite superior de first_activity_at (data ou data e hora ISO 8601)." }, { "name": "q", "in": "query", "schema": { "type": "string" }, "description": "Busca em texto livre por nome da rede, nomes dos membros, network_id (N-0001) e tokens exatos de pattern_type." }, { "name": "ordering", "in": "query", "schema": { "type": "string" }, "description": "Um entre risk_score, -risk_score, last_activity_at, -last_activity_at, first_activity_at, -first_activity_at, network_number, -network_number. O padrão é -risk_score,-last_activity_at." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 100, "minimum": 1, "maximum": 500 }, "description": "Tamanho da página, de 1 a 500. O padrão é 100." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "description": "Deslocamento, a partir de zero, do primeiro registro." }, { "name": "summary", "in": "query", "schema": { "type": "boolean", "default": true }, "description": "`false` retorna a página e seu `count` apenas, sem `kpis` e `counts`. O padrão é `true`. Qualquer valor diferente de `true` ou `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": "Lista paginada de redes, com o modo de compartilhamento da organização e a disponibilidade entre organizações, além de `kpis` e `counts`, exceto quando `summary=false`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "integer", "nullable": true, "description": "Offset da próxima página, ou null na última página." }, "previous": { "type": "integer", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkListItem" } }, "kpis": { "type": "object", "description": "Cada chave é {value, delta} sobre os resultados que correspondem aos filtros atuais. Omitido quando `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": "O modo de compartilhamento entre organizações da organização. Somente `global` compara redes entre organizações; `private` e `off` as restringem ao histórico da própria organização.", "example": "global" }, "cross_org_available": { "type": "boolean", "description": "Indica se os sinais entre organizações se aplicam a esta organização. Eles exigem tanto o plano Enterprise quanto o modo de compartilhamento `global`.", "example": true }, "cross_org_unavailable_reason": { "type": "string", "enum": [ "plan", "sharing_mode" ], "nullable": true, "description": "Por que os sinais entre organizações não se aplicam, verificados nesta ordem. `plan`: o plano da organização não inclui a rede antifraude entre organizações (ela exige o plano Enterprise), qualquer que seja o modo de compartilhamento. `sharing_mode`: o plano a inclui, mas o modo de compartilhamento é `private` ou `off`. Nulo quando `cross_org_available` é `true`.", "example": null } }, "required": [ "count", "next", "previous", "results", "sharing_mode", "cross_org_available", "cross_org_unavailable_reason" ] } } } }, "400": { "description": "Um valor inválido de filtro, ordenação, paginação ou `summary`.", "content": { "application/json": { "examples": { "Invalid summary": { "summary": "Resumo inválido", "value": { "summary": [ "Must be \"true\" or \"false\"." ] } }, "Invalid scope": { "summary": "Escopo inválido", "value": { "scope": [ "Use identity or transactions." ] } }, "Unsupported ordering": { "summary": "Ordenação não suportada", "value": [ "Unsupported ordering." ] } } } } }, "401": { "description": "Credenciais ausentes ou inválidas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente em erros com código, por exemplo `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Credenciais ausentes ou inválidas", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "A chave de API pertence a outra aplicação ou é uma chave com acesso restrito: os endpoints de Networks exigem uma chave com acesso total. Um token de membro do console precisa de `list:networks`. Também é retornado com `code: networks_not_entitled` quando o Networks não está habilitado para a organização.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente em erros com código, por exemplo `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Redes não habilitadas", "value": { "detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled" } }, "Restricted API key": { "summary": "Chave de API restrita", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Sem permissão", "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": "Obter rede", "description": "Obtenha o detalhe completo de uma única rede: estatísticas, tags de fraude e sinais de risco, além do `sharing_mode` da organização e da disponibilidade entre organizações, as `tags` da sua aplicação na rede, os `outcomes` dos membros e as pontuações de padrões (`patterns`). Requer uma chave de API com acesso total, ou `read:networks` para um membro do console.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID da rede." } ], "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": "Detalhes da rede.", "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": "Rede não encontrada (ou não visível para esta aplicação).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "401": { "description": "Credenciais ausentes ou inválidas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente em erros com código, por exemplo `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Credenciais ausentes ou inválidas", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "A chave de API pertence a outra aplicação ou é uma chave com acesso restrito: os endpoints de Networks exigem uma chave com acesso total. Um token de membro do console precisa de `read:networks`. Também é retornado com `code: networks_not_entitled` quando o Networks não está habilitado para a organização.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente em erros com código, por exemplo `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Redes não habilitadas", "value": { "detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled" } }, "Restricted API key": { "summary": "Chave de API restrita", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Sem permissão", "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": "Obter o grafo da rede", "description": "Recupera a rede como um grafo de nós de sujeitos (usuários do fornecedor, empresas do fornecedor, partes de transações) e nós de sinais (os valores compartilhados de dispositivo/IP/rosto/documento/telefone/e-mail/endereço que os conectam), com arestas que representam vínculos.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID da rede." }, { "name": "depth", "in": "query", "schema": { "type": "string", "enum": [ "1", "2", "3", "all" ] }, "description": "Número de saltos a partir do sujeito em foco a incluir. O padrão é todos (sem limite)." }, { "name": "focus_kind", "in": "query", "schema": { "type": "string", "enum": [ "vendor_user", "vendor_business", "transaction_party" ] }, "description": "Tipo do sujeito no qual centralizar o grafo. Deve ser informado junto com focus_id; quando a profundidade é limitada e nenhum dos dois é informado, o padrão é um membro arbitrário." }, { "name": "focus_id", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "UUID do sujeito no qual centralizar o grafo." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/n3a5e000-0000-4000-8000-000000000001/graph/?depth=2' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.retrieve_graph(\n \"n3a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.retrieveGraph(\"n3a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.RetrieveGraph(ctx, \"n3a5e000-0000-4000-8000-000000000001\", didit.NetworksRetrieveGraphParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().retrieveGraph(\"n3a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->retrieveGraph('n3a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.retrieve_graph(\"n3a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.RetrieveGraphAsync(\"n3a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Grafo da rede.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkGraph" } } } }, "404": { "description": "Rede não encontrada (ou não visível para esta aplicação).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/members/": { "get": { "summary": "Listar membros da rede", "description": "Lista os sujeitos que pertencem a esta rede: usuários do fornecedor, empresas do fornecedor ou partes de transação.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID da rede." } ], "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": "Membros da rede. Sem paginação.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkMember" } } } } } } }, "404": { "description": "Rede não encontrada (ou não visível para esta aplicação).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/signals/": { "get": { "summary": "Listar sinais da rede", "description": "Lista os sinais que conectam os membros desta rede: valores compartilhados de dispositivo, IP, rosto, número de documento, telefone, e-mail ou endereço.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID da rede." } ], "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": "Sinais da rede. Sem paginação.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkSignal" } } } } } } }, "404": { "description": "Rede não encontrada (ou não visível para esta aplicação).", "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": "Obter a linha do tempo da rede", "description": "Sem `contract`: os eventos da própria rede (detecção, a observação mais recente de cada sinal e a revisão correspondente), do mais antigo ao mais recente e sem paginação. `limit`, `cursor` e `event_type` são ignorados. Com `contract=2`: a linha do tempo tipada, do mais recente ao mais antigo e paginada por cursor. Ela inclui o que as contas membro fizeram (tentativas de verificação, transações, logins que você envia pela API de eventos e as regras ativas que eles acionaram) e os casos abertos para a rede. Eventos `note_added` são retornados apenas para membros do console, nunca para uma chave de API. Requer uma chave de API com acesso total, ou `read:networks` para um membro do console.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID da rede." }, { "name": "contract", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2" ] }, "description": "`2` retorna a linha do tempo tipada. Omita-o para obter a linha do tempo padrão. Qualquer outro valor retorna 400." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 }, "description": "Somente para a linha do tempo tipada. Eventos por página, de 1 a 500. O padrão é 100." }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Somente para a linha do tempo tipada. O `next_cursor` da página anterior. Um cursor inválido ou vazio 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": "Somente para a linha do tempo tipada. Tipos de evento a manter, repetidos ou separados por vírgula, com no máximo 20 valores. O padrão é todos os tipos." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/n3a5e000-0000-4000-8000-000000000001/timeline/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "curl", "label": "curl (typed timeline)", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/3fa85f64-5717-4562-b3fc-2c963f66afa6/timeline/?contract=2&limit=50&event_type=verification_attempt,login' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.networks.retrieve_timeline(\n \"n3a5e000-0000-4000-8000-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.networks.retrieveTimeline(\"n3a5e000-0000-4000-8000-000000000001\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Networks.RetrieveTimeline(ctx, \"n3a5e000-0000-4000-8000-000000000001\", didit.NetworksRetrieveTimelineParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.networks().retrieveTimeline(\"n3a5e000-0000-4000-8000-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "networks->retrieveTimeline('n3a5e000-0000-4000-8000-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.networks.retrieve_timeline(\"n3a5e000-0000-4000-8000-000000000001\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Networks.RetrieveTimelineAsync(\"n3a5e000-0000-4000-8000-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Sem `contract`: `{results}`, do mais antigo para o mais recente, sem paginação. Com `contract=2`: `{results, next_cursor}`, do mais recente para o mais antigo.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/NetworkTimeline" }, { "$ref": "#/components/schemas/NetworkTimelinePage" } ] }, "examples": { "Default timeline": { "summary": "Sem 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": "Com 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": "Com `contract` presente: um valor inválido de `contract`, `limit`, `cursor` ou `event_type`.", "content": { "application/json": { "examples": { "Unsupported contract": { "summary": "Contrato não suportado", "value": { "contract": [ "\"3\" is not a valid choice." ] } }, "Invalid cursor": { "summary": "Cursor inválido", "value": { "cursor": [ "This cursor is not valid. Reload the feed." ] } }, "Limit too large": { "summary": "Limite muito grande", "value": { "limit": [ "Ensure this value is less than or equal to 500." ] } }, "Unknown event type": { "summary": "Tipo de evento desconhecido", "value": { "event_type": { "0": [ "\"logout\" is not a valid choice." ] } } } } } } }, "401": { "description": "Credenciais ausentes ou inválidas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente em erros com código, por exemplo `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Credenciais ausentes ou inválidas", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "A chave de API pertence a outra aplicação ou é uma chave com acesso restrito: os endpoints de Networks exigem uma chave com acesso total. Um token de membro do console precisa de `read:networks`. Também é retornado com `code: networks_not_entitled` quando o Networks não está habilitado para a organização.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente em erros com código, por exemplo `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Redes não habilitadas", "value": { "detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled" } }, "Restricted API key": { "summary": "Chave de API restrita", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Sem permissão", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Rede não encontrada (ou não visível para esta aplicação).", "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": "Obter o mapa da rede", "description": "Pontos geográficos onde convergem os endereços/localizações dos membros desta rede, obtidos das sessões, sessões de empresa e transações que sustentam suas associações.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "n3a5e000-0000-4000-8000-000000000001" }, "description": "UUID da rede." } ], "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 da rede.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkMap" } } } }, "404": { "description": "Rede não encontrada (ou não visível para esta aplicação).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/sessions/{session_id}/networks/": { "get": { "summary": "Listar redes de uma sessão", "description": "Lista as redes às quais pertence o usuário (vendor user) da sessão. A resolução é feita pelo usuário vinculado ao vendor_data da sessão.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da sessão." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/sessions/aaaaaaaa-0000-4000-8000-000000000001/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.sessions.list_networks(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.sessions.listNetworks(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ListNetworks(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.sessions().listNetworks(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->listNetworks('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.sessions.list_networks(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ListNetworksAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Redes às quais esta entidade pertence. Sem paginação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "Entidade não encontrada nesta aplicação ou sem titular vinculado para consulta.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/business-sessions/{business_session_id}/networks/": { "get": { "summary": "Listar redes de uma sessão de empresa", "description": "Lista as redes às quais pertence a empresa (vendor business) da sessão de empresa.", "operationId": "list_business_session_network_memberships", "x-didit-sdk": { "resource": "business_sessions", "method": "list_networks", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "business_session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da sessão de empresa." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/business-sessions/aaaaaaaa-0000-4000-8000-000000000002/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.business_sessions.list_networks(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.businessSessions.listNetworks(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.BusinessSessions.ListNetworks(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.businessSessions().listNetworks(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businessSessions->listNetworks('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.business_sessions.list_networks(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.BusinessSessions.ListNetworksAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Redes às quais esta entidade pertence. Sem paginação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "Entidade não encontrada nesta aplicação ou sem titular vinculado para consulta.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/users/{vendor_user_uuid}/networks/": { "get": { "summary": "Listar redes de um usuário", "description": "Lista as redes às quais um usuário (vendor user) pertence.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "vendor_user_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID do usuário do fornecedor." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/users/aaaaaaaa-0000-4000-8000-000000000003/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.users.list_networks(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.users.listNetworks(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Users.ListNetworks(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.users().listNetworks(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "users->listNetworks('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.users.list_networks(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Users.ListNetworksAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Redes às quais esta entidade pertence. Sem paginação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "Entidade não encontrada nesta aplicação ou sem titular vinculado para consulta.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/businesses/{vendor_business_uuid}/networks/": { "get": { "summary": "Listar redes de uma empresa", "description": "Lista as redes às quais uma empresa (vendor business) pertence.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "vendor_business_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da empresa do fornecedor." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/businesses/aaaaaaaa-0000-4000-8000-000000000004/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.businesses.list_networks(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.businesses.listNetworks(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.ListNetworks(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.businesses().listNetworks(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "businesses->listNetworks('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.businesses.list_networks(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Businesses.ListNetworksAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Redes às quais esta entidade pertence. Sem paginação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "Entidade não encontrada nesta aplicação ou sem titular vinculado para consulta.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/networks/": { "get": { "summary": "Listar redes de uma transação", "description": "Lista as redes às quais pertence o titular de KYC/KYB que dá suporte à transação (resolvido pela sessão ou pela sessão de empresa da transação).", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "transaction_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da transação." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/transactions/aaaaaaaa-0000-4000-8000-000000000005/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.transactions.list_networks(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.transactions.listNetworks(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.ListNetworks(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.transactions().listNetworks(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->listNetworks('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.transactions.list_networks(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.ListNetworksAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Redes às quais esta entidade pertence. Sem paginação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "Entidade não encontrada nesta aplicação ou sem titular vinculado para consulta.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/parties/{transaction_party_uuid}/networks/": { "get": { "summary": "Listar redes de uma parte da transação", "description": "Lista as redes às quais uma parte da transação (remetente, beneficiário ou contraparte) pertence, resolvidas pela própria parte, e não pela sessão que dá suporte à transação.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "transaction_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da transação." }, { "name": "transaction_party_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da parte da transação." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/transactions/aaaaaaaa-0000-4000-8000-000000000005/parties/bbbbbbbb-0000-4000-8000-000000000006/networks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.transactions.list_party_networks(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.transactions.listPartyNetworks(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.ListPartyNetworks(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.transactions().listPartyNetworks(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "transactions->listPartyNetworks('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.transactions.list_party_networks(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Transactions.ListPartyNetworksAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Redes às quais esta entidade pertence. Sem paginação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityNetworkMembershipList" } } } }, "404": { "description": "Entidade não encontrada nesta aplicação ou sem titular vinculado para consulta.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/biometric-templates/": { "get": { "summary": "Listar templates biométricos retidos", "description": "Uma aplicação que ativou esse recurso mantém um template biométrico facial, sem imagens e gerenciado separadamente, vinculado ao usuário quando uma sessão é excluída (veja `DELETE /v3/session/{sessionId}/delete/`). Os templates são dados biométricos com um `expires_at` finito; eles nunca contêm imagens, dados de sessão nem campos de identidade, e são expurgados na exclusão do usuário, no apagamento por privacidade, na expiração ou em um expurgo explícito. Estes endpoints aceitam apenas chaves de API da aplicação (`x-api-key`); tokens de usuário do Business Console são rejeitados com `403`.\n\nRetorna uma lista paginada dos templates que a aplicação mantém atualmente. Templates expurgados não são listados.", "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": "Correspondência de substring sem distinção entre maiúsculas e minúsculas no `vendor_data` atual do User proprietário.", "schema": { "type": "string" } }, { "in": "query", "name": "vendor_user_uuid", "required": false, "description": "Correspondência exata no usuário proprietário.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "status", "required": false, "description": "Status do ciclo de vida. Modelos expurgados nunca são listados.", "schema": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed" ] } }, { "in": "query", "name": "source_type", "required": false, "description": "Como o modelo foi criado.", "schema": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ] } }, { "in": "query", "name": "retained_from", "required": false, "description": "Templates retidos neste momento ou depois dele.", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "retained_to", "required": false, "description": "Templates retidos neste momento ou antes dele. Não pode ser anterior a `retained_from` (`400`).", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "ordering", "required": false, "description": "Ordem de classificação.", "schema": { "type": "string", "enum": [ "retained_at", "-retained_at", "expires_at", "-expires_at" ], "default": "-retained_at" } }, { "in": "query", "name": "limit", "required": false, "description": "Tamanho da página.", "schema": { "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "description": "Deslocamento (offset) da paginação.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Modelos paginados.", "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 do template. Gerado aleatoriamente; não é derivado da sessão excluída nem do rosto dela." }, "vendor_user_uuid": { "type": "string", "format": "uuid", "description": "O usuário proprietário." }, "vendor_data": { "type": "string", "nullable": true, "description": "O `vendor_data` atual do usuário, resolvido quando você lê o modelo (nunca copiado)." }, "source_type": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ], "description": "Como o modelo foi criado: uma exclusão de sessão (API ou Console), a janela automática de retenção de dados da aplicação ou um preenchimento retroativo (backfill) operado pela Didit sob sua instrução." }, "provenance_reference": { "type": "string", "format": "uuid", "description": "Referência opaca que vincula o modelo à sua trilha de auditoria. Não é o id da sessão excluída e não pode ser resolvida para ele." }, "retention_policy": { "type": "string", "enum": [ "delete_with_session", "retain_until_user_deleted" ], "description": "A política da aplicação no momento da retenção." }, "retention_override": { "type": "boolean", "nullable": true, "description": "O valor de `retain_face_embeddings` enviado na exclusão, ou `null` quando a política foi aplicada." }, "retained_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time", "description": "Quando o template expira e é eliminado automaticamente. Sempre definido." }, "retained_by": { "type": "string", "nullable": true, "description": "Principal que deu a instrução: o id da aplicação para chaves de API, o id do membro do Console para ações no Console, ou um identificador `service:` para retenção automática. Nunca um endereço de e-mail." }, "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": "O `instruction_id` enviado na exclusão, ou um id gerado pela Didit." }, "held_out_of_use": { "type": "boolean", "description": "`true` apenas enquanto houver uma retenção legal. Um template retido é excluído de toda correspondência." }, "status": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed", "purged" ], "description": "Somente modelos `active` que não estão retidos, que não ultrapassaram `expires_at` e cujo User ainda existe participam da correspondê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 filtro inválido, ou `retained_to` anterior a `retained_from`. Erros de validação indexados por campo.", "content": { "application/json": { "examples": { "Bad range": { "value": { "retained_to": [ "Must be on or after retained_from." ] } } } } } }, "403": { "description": "Token de usuário do console, ou a chave de API não é permitida. Estes endpoints aceitam apenas chaves de API de aplicação.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/biometric-templates/?vendor_data=user-42&status=active' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.biometric_templates.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.biometricTemplates.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.BiometricTemplates.ListAutoPaging(ctx, didit.BiometricTemplatesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.biometricTemplates().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "biometricTemplates->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.biometric_templates.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.BiometricTemplates.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/biometric-templates/count/": { "get": { "summary": "Contar templates biométricos retidos", "description": "Uma aplicação que optou por esse recurso mantém um template biométrico facial sem imagens, gerenciado separadamente e vinculado ao Usuário, quando uma sessão é excluída (veja `DELETE /v3/session/{sessionId}/delete/`). Templates são dados biométricos com um `expires_at` finito. Eles nunca contêm imagens, dados da sessão nem campos de identidade, e são expurgados quando o Usuário é excluído, em um apagamento por privacidade, na expiração ou em um expurgo explícito. Estes endpoints aceitam apenas chaves de API da aplicação (`x-api-key`). Tokens de usuário do Business Console são rejeitados com `403`.\n\nRetorna o número de templates que correspondem aos mesmos filtros do endpoint de listagem. Use-o para verificar o que um expurgo em massa filtrado com `delete_all: true` atingiria.", "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": "Correspondência de substring sem distinção entre maiúsculas e minúsculas no `vendor_data` atual do User proprietário.", "schema": { "type": "string" } }, { "in": "query", "name": "vendor_user_uuid", "required": false, "description": "Correspondência exata no usuário proprietário.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "status", "required": false, "description": "Status do ciclo de vida. Modelos expurgados nunca são listados.", "schema": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed" ] } }, { "in": "query", "name": "source_type", "required": false, "description": "Como o modelo foi criado.", "schema": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ] } }, { "in": "query", "name": "retained_from", "required": false, "description": "Templates retidos neste momento ou depois dele.", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "retained_to", "required": false, "description": "Templates retidos neste momento ou antes dele. Não pode ser anterior a `retained_from` (`400`).", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Contagem.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0 } } }, "examples": { "Count": { "value": { "count": 128 } } } } } }, "400": { "description": "Valor de filtro inválido, ou `retained_to` anterior a `retained_from`. Erros de validação indexados por campo.", "content": { "application/json": { "examples": { "Bad range": { "value": { "retained_to": [ "Must be on or after retained_from." ] } } } } } }, "403": { "description": "Token de usuário do console, ou a chave de API não é permitida. Estes endpoints aceitam apenas chaves de API de aplicação.", "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": "Obter um template biométrico retido", "description": "Uma aplicação que ativou esse recurso mantém um template biométrico facial, sem imagens e gerenciado separadamente, vinculado ao usuário quando uma sessão é excluída (veja `DELETE /v3/session/{sessionId}/delete/`). Os templates são dados biométricos com um `expires_at` finito; eles nunca contêm imagens, dados de sessão nem campos de identidade, e são expurgados na exclusão do usuário, no apagamento por privacidade, na expiração ou em um expurgo explícito. Estes endpoints aceitam apenas chaves de API da aplicação (`x-api-key`); tokens de usuário do Business Console são rejeitados com `403`.\n\nRetorna um template. A resposta nunca inclui uma imagem, um vetor, o id da sessão excluída nem dados de identidade.", "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 do template, conforme retornado em `biometric_template_uuid` pelos endpoints de exclusão de sessão, em `biometric_template_id` em uma correspondência da Busca facial ou pelo endpoint de listagem.", "schema": { "type": "string", "format": "uuid", "example": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b" } } ], "responses": { "200": { "description": "O modelo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID do template. Gerado aleatoriamente; não é derivado da sessão excluída nem do rosto dela." }, "vendor_user_uuid": { "type": "string", "format": "uuid", "description": "O usuário proprietário." }, "vendor_data": { "type": "string", "nullable": true, "description": "O `vendor_data` atual do usuário, resolvido quando você lê o modelo (nunca copiado)." }, "source_type": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ], "description": "Como o modelo foi criado: uma exclusão de sessão (API ou Console), a janela automática de retenção de dados da aplicação ou um preenchimento retroativo (backfill) operado pela Didit sob sua instrução." }, "provenance_reference": { "type": "string", "format": "uuid", "description": "Referência opaca que vincula o modelo à sua trilha de auditoria. Não é o id da sessão excluída e não pode ser resolvida para ele." }, "retention_policy": { "type": "string", "enum": [ "delete_with_session", "retain_until_user_deleted" ], "description": "A política da aplicação no momento da retenção." }, "retention_override": { "type": "boolean", "nullable": true, "description": "O valor de `retain_face_embeddings` enviado na exclusão, ou `null` quando a política foi aplicada." }, "retained_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time", "description": "Quando o template expira e é eliminado automaticamente. Sempre definido." }, "retained_by": { "type": "string", "nullable": true, "description": "Principal que deu a instrução: o id da aplicação para chaves de API, o id do membro do Console para ações no Console, ou um identificador `service:` para retenção automática. Nunca um endereço de e-mail." }, "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": "O `instruction_id` enviado na exclusão, ou um id gerado pela Didit." }, "held_out_of_use": { "type": "boolean", "description": "`true` apenas enquanto houver uma retenção legal. Um template retido é excluído de toda correspondência." }, "status": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed", "purged" ], "description": "Somente modelos `active` que não estão retidos, que não ultrapassaram `expires_at` e cujo User ainda existe participam da correspondê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 de usuário do console, ou a chave de API não é permitida. Estes endpoints aceitam apenas chaves de API de aplicação.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Modelo desconhecido, um modelo de outra aplicação ou (no `GET`) um modelo removido definitivamente.", "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": "Expurgar um template biométrico retido", "description": "Uma aplicação que ativou esse recurso mantém um template biométrico facial, sem imagens e gerenciado separadamente, vinculado ao usuário quando uma sessão é excluída (veja `DELETE /v3/session/{sessionId}/delete/`). Os templates são dados biométricos com um `expires_at` finito; eles nunca contêm imagens, dados de sessão nem campos de identidade, e são expurgados na exclusão do usuário, no apagamento por privacidade, na expiração ou em um expurgo explícito. Estes endpoints aceitam apenas chaves de API da aplicação (`x-api-key`); tokens de usuário do Business Console são rejeitados com `403`.\n\nExpurga um template: ele é removido de todo tipo de correspondência e o template armazenado é excluído. A operação é irreversível e fica registrada no registro de auditoria com o principal que a executou.\n\n**Semântica de nova tentativa:** a Didit exclui primeiro o template armazenado e só depois marca o template como expurgado. Se um armazenamento biométrico estiver indisponível, a chamada retorna `503`, o template passa para `status: purge_failed` e já fica excluído da correspondência; repita a mesma chamada para concluir. Repetir o expurgo de um template já expurgado retorna `already_purged`.\n\nOs templates também são expurgados por `POST /v3/users/delete/` para o usuário proprietário, por qualquer exclusão das sessões desse usuário com `deletion_instruction: privacy_erasure` e automaticamente em `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 do template, conforme retornado em `biometric_template_uuid` pelos endpoints de exclusão de sessão, em `biometric_template_id` em uma correspondência da Busca facial ou pelo endpoint de listagem.", "schema": { "type": "string", "format": "uuid", "example": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b" } } ], "responses": { "200": { "description": "Resultado do expurgo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "outcome": { "type": "string", "enum": [ "purged", "already_purged" ] } } }, "examples": { "Purged": { "value": { "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "outcome": "purged" } }, "Already purged": { "value": { "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "outcome": "already_purged" } } } } } }, "403": { "description": "Token de usuário do console, ou a chave de API não é permitida. Estes endpoints aceitam apenas chaves de API de aplicação.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Modelo desconhecido, um modelo de outra aplicação ou (no `GET`) um modelo removido definitivamente.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "Biometric template not found." } } } } } }, "503": { "description": "Um armazenamento biométrico ficou indisponível durante a retenção ou a exclusão de um template biométrico. Nada é excluído; repita a mesma requisição. As novas tentativas são idempotentes e convergem para um único template.", "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": "Expurgar em massa templates biométricos retidos", "description": "Uma aplicação que ativou esse recurso mantém um template biométrico facial, sem imagens e gerenciado separadamente, vinculado ao usuário quando uma sessão é excluída (veja `DELETE /v3/session/{sessionId}/delete/`). Os templates são dados biométricos com um `expires_at` finito; eles nunca contêm imagens, dados de sessão nem campos de identidade, e são expurgados na exclusão do usuário, no apagamento por privacidade, na expiração ou em um expurgo explícito. Estes endpoints aceitam apenas chaves de API da aplicação (`x-api-key`); tokens de usuário do Business Console são rejeitados com `403`.\n\nExpurga vários templates em uma única chamada, por uma lista explícita de ids ou com `delete_all: true`, opcionalmente restrito pelos mesmos filtros do endpoint de listagem. Os templates são expurgados um a um e cada resultado informa `purged` ou `already_purged`. Se um armazenamento biométrico estiver indisponível, a chamada retorna `503` no primeiro template que falhar: os templates expurgados antes nessa requisição continuam expurgados, o que falhou passa para `purge_failed` (já excluído da correspondência) e repetir a requisição conclui o trabalho.\n\n**`delete_all: true` sem filtros expurga todos os templates biométricos da aplicação e não pode ser desfeito.** Execute antes o endpoint de contagem com os mesmos filtros.", "operationId": "bulk_purge_biometric_templates", "x-didit-sdk": { "resource": "biometric_templates", "method": "batch_delete", "auth": "api_key", "server": true }, "tags": [ "Biometric Templates" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "template_uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "description": "Templates a expurgar. Obrigatório, a menos que `delete_all` seja `true`. IDs já expurgados são informados como `already_purged`." }, "delete_all": { "type": "boolean", "default": false, "description": "Quando `true`, elimina definitivamente todos os modelos que correspondem aos filtros abaixo (todos os modelos da aplicação quando nenhum filtro é informado). `template_uuids` é ignorado. Irreversível." }, "vendor_data": { "type": "string", "description": "Somente com `delete_all`: correspondência de substring, sem diferenciar maiúsculas de minúsculas, no `vendor_data` do User proprietário." }, "vendor_user_uuid": { "type": "string", "format": "uuid", "description": "Somente com `delete_all`: correspondência exata com o usuário proprietário." }, "status": { "type": "string", "enum": [ "pending", "active", "expired", "held_out_of_use", "purge_pending", "purge_failed" ], "description": "Somente com `delete_all`." }, "source_type": { "type": "string", "enum": [ "session_delete", "automatic_retention", "backfill" ], "description": "Somente com `delete_all`." }, "retained_from": { "type": "string", "format": "date-time", "description": "Somente com `delete_all`." }, "retained_to": { "type": "string", "format": "date-time", "description": "Somente com `delete_all`. Não pode ser anterior a `retained_from`." } } }, "examples": { "By id": { "value": { "template_uuids": [ "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d" ] } }, "Every template of one User": { "value": { "delete_all": true, "vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f" } }, "Every template in the application": { "value": { "delete_all": true } } } } } }, "responses": { "200": { "description": "Resultados da exclusão definitiva por modelo.", "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": "Erro de validação: nada é removido definitivamente.", "content": { "application/json": { "examples": { "Missing selector": { "value": { "template_uuids": [ "This field is required unless delete_all is true." ] } }, "Bad range": { "value": { "retained_to": [ "Must be on or after retained_from." ] } } } } } }, "403": { "description": "Token de usuário do console, ou a chave de API não é permitida. Estes endpoints aceitam apenas chaves de API de aplicação.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } }, "503": { "description": "Um armazenamento biométrico ficou indisponível durante a retenção ou a exclusão de um template biométrico. Nada é excluído; repita a mesma requisição. As novas tentativas são idempotentes e convergem para um único template.", "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 no registro KYB com acionistas (avulsa)", "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": "Obtenha o perfil Lite **e os acionistas diretos** (pessoas físicas e pessoas jurídicas, com suas faixas de propriedade) de um candidato retornado por `POST /v3/kyb/search/`.\n\n**Uso com a busca.** Envie o `kyb_response_id` do candidato exatamente como foi retornado por uma busca da mesma aplicação. Faça a busca no nível que você pretende comprar (`tier` em `POST /v3/kyb/search/`), porque a busca é executada na cadeia de registros que atende a esse nível, e uma busca Lite sem resultados não prova que o registro não tenha a empresa. Quando os dados de propriedade do país estão em outro registro, a Didit localiza a empresa novamente nesse registro pelo número de registro, sem custo adicional.\n\n**Faturamento.** Cobrado pelo preço Shareholders do país; consulte [Preços de registros KYB](/pt-br/getting-started/kyb-registry-pricing). Quando o registro não tem nenhum dado de acionistas da empresa (ou o país não oferece nenhum dado de propriedade), o perfil Lite é entregue e cobrado em seu lugar: consulte `registry_tier_delivered` e `registry_ownership_status`. O saldo é verificado em relação ao preço Shareholders antes de qualquer chamada ao registro (`403` quando insuficiente).\n\n**Disponibilidade.** Somente v3. Cada chamada cria uma sessão de empresa (seu id é o `request_id`).\n\n**Relatórios pendentes.** Quando um relatório ainda está sendo preparado, ou a seção de propriedade ainda não foi obtida do registro, o endpoint retorna 202 Accepted, kyb_registry.fetch_status=pending, kyb_registry.registry_ownership_status=pending e registry_tier_delivered=null. Guarde o request_id e consulte GET /v3/session/{request_id}/decision/ até que registry_checks[0].company.fetch_status seja resolvido. A Didit conclui o relatório automaticamente e cobra o nível entregue quando ele estiver pronto. Não repita a compra enquanto ela estiver pendente; cada novo POST cria uma requisição separada.", "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": "Relatório da empresa retornado e faturado no nível entregue. Relatórios de propriedade ainda em preparação podem retornar 202; guarde o request_id para recuperar a decisão salva.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Id da sessão de empresa criada para esta consulta. O registro armazenado (visível no console) continua sendo atualizado se o registro de empresas responder depois da resposta." }, "registry_tier_requested": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "O nível que este endpoint vende: `basic` (Lite) para países selecionados, `shareholders`, `ubo`." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo", null ], "description": "O nível efetivamente entregue e faturado. Inferior ao solicitado quando os registros do país não contêm dados de propriedade ou quando o registro não possui informações de propriedade desta empresa.", "nullable": true }, "kyb_registry": { "type": "object", "description": "Perfil completo da empresa no registro.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID da Didit para este registro de empresa." }, "node_id": { "type": "string", "example": "feature_kyb_registry" }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review" ], "description": "Avaliação da Didit sobre a verificação no registro de empresas (por exemplo, `In Review` quando a empresa não está ativa no registro ou quando não foi possível derivar os dados de propriedade)." }, "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": "Status normalizado da empresa conforme informado pelo registro." }, "data_resolved": { "type": "boolean", "description": "`true` quando o registro retornou o perfil completo. `false` quando o registro ainda estava processando após a consulta periódica; o registro armazenado é completado automaticamente assim que o registro resolve." }, "company_name": { "type": "string", "example": "Tesco PLC" }, "registration_number": { "type": "string", "nullable": true, "example": "00445790" }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2.", "example": "GB" }, "region": { "type": "string", "nullable": true, "description": "Código da subdivisão quando o registro é regional (por exemplo `CA` para `US-CA`); vazio caso contrário." }, "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": "Nível de risco informado pelo registro, quando disponível." }, "verification_status": { "type": "string", "nullable": true, "description": "Status de verificação do registro, quando disponível." }, "is_from_registry": { "type": "boolean", "description": "Sempre `true` para este endpoint: o perfil foi obtido de um registro oficial." }, "fetch_status": { "type": "string", "enum": [ "pending", "resolved" ], "description": "Ciclo de vida da consulta ao registro. Refletido por `data_resolved`." }, "alternative_names": { "type": "string", "nullable": true, "description": "Nomes alternativos, comerciais, anteriores ou no idioma original da empresa, em texto, quando informados." }, "nature_of_business": { "type": "string", "nullable": true, "description": "Descrição da atividade ou código de classificação, quando informado." }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "nullable": true, "description": "Valor decimal como string, quando informado." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Código ISO 4217, quando informado." }, "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, quando informado." }, "location_of_registration": { "type": "string", "nullable": true, "description": "Registro/jurisdição em que a empresa está registrada, quando informado." }, "vat_number": { "type": "string", "nullable": true, "description": "Número de IVA da UE (EU VAT), quando coletado durante a etapa de registro no fluxo hospedado ou editado posteriormente. No momento da seleção, normalmente ainda não está definido: a validação de IVA e de identificação fiscal é executada quando o usuário final envia a etapa de registro no fluxo hospedado." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Resultado da validação do número de VAT ou, quando não houver, do `tax_number`, no envio ao registro. `valid` / `invalid`: decidido pelo registro oficial do país (EU VIES, Noruega, Suíça, Brasil, Colômbia, Costa Rica, Equador, Paraguai; a Polônia também pelo seu registro nacional de VAT). `format_valid` / `invalid_format`: decidido pelas regras de formato e dígito verificador do país quando nenhum registro pode ser consultado. `could_not_validate`: o registro estava indisponível. `not_applicable`: nenhum número, um país sem registro nem regras, ou uma sessão de sandbox." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "O número que foi verificado, como a fonte o conhece (por exemplo, o número de IVA derivado de um SIREN francês ou de um RSIN holandês). `null` quando nenhuma verificação foi executada." }, "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": "A fonte que determinou `vat_validation_status`: um registro oficial ou `format_rules`. `null` quando nenhuma verificação foi executada." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Nome registrado na fonte que validou o número, quando ela o informa. Preenchido apenas quando o status é `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Endereço registrado na fonte que validou o número, quando ela o informa. Definido apenas quando o status é `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data e hora da verificação. `null` quando nenhuma verificação foi executada." }, "financial_summary": { "type": "object", "nullable": true, "description": "Detalhes de ações/capital informados pelo registro (moeda, total de ações, classes de ações), quando disponíveis." }, "officers": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "example": "MELISSA BETHELL" }, "designation": { "type": "string", "nullable": true, "description": "Designação bruta do registro (por exemplo, `Director`, `Secretary`)." }, "role": { "type": "string", "description": "Função normalizada derivada do cargo. Conjunto completo de 17 valores do modelo; a análise do registro neste endpoint normalmente retorna director, non_executive_director, secretary, chairman ou 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` quando o registro marca a nomeação como encerrada por renúncia." }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending", null ], "description": "Status de uma sessão de KYC associada, quando uma foi iniciada para este administrador. `null` caso contrário." }, "kyc_session_url": { "type": "string", "nullable": true, "description": "URL de verificação da sessão de KYC associada, quando existir." }, "first_name": { "type": "string", "nullable": true, "description": "Nome próprio, quando informado explicitamente pelo registro; não é inferido a partir do nome completo." }, "last_name": { "type": "string", "nullable": true, "description": "Sobrenome, quando informado explicitamente pelo registro." }, "address": { "type": "string", "nullable": true, "description": "Endereço do administrador informado pelo registro de empresas." }, "appointment_date": { "type": "string", "nullable": true, "description": "Data em que o administrador foi nomeado.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Data em que o cargo terminou, quando informada.", "format": "date" }, "date_of_birth": { "type": "string", "nullable": true, "description": "Data de nascimento completa informada pelo registro. Nula quando apenas o ano ou o mês de nascimento é conhecido.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Ano de nascimento informado pelo registro, inclusive quando a data completa não está disponível." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Mês de nascimento informado pelo registro. Nulo quando apenas o ano é conhecido." } } }, "description": "Diretores, secretários e outros administradores extraídos do registro." }, "beneficial_owners": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Se o proprietário é uma pessoa física ou uma pessoa jurídica." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Funções normalizadas (por exemplo, `ubo`, `shareholder`)." }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Limite inferior da faixa de propriedade informada pelo registro (por exemplo, `25%`)." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Limite superior da faixa de propriedade informada pelo registro." }, "is_active": { "type": "boolean" }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending", null ] }, "kyc_session_url": { "type": "string", "nullable": true }, "effective_ownership_percent": { "type": "number", "nullable": true, "description": "Percentual de propriedade interpretado (limite máximo, recorrendo ao limite mínimo)." }, "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 nascimento completa, quando informada.", "format": "date" }, "appointment_date": { "type": "string", "nullable": true, "description": "Data de nomeação, quando informada.", "format": "date" }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } } }, "description": "Beneficiários finais / pessoas com controle significativo extraídos do registro. Pode estar vazio quando o registro não expõe a propriedade." }, "addresses": { "type": "array", "nullable": true, "description": "Todos os endereços que o registro informa, em um único formato canônico. Nulo quando não informa nenhum.", "items": { "$ref": "#/components/schemas/KYBRegistryAddress" } }, "industries": { "type": "array", "nullable": true, "description": "As atividades em que o registro classifica a empresa, em um único formato canônico. Null quando ele não informa nenhuma.", "items": { "$ref": "#/components/schemas/KYBRegistryIndustry" } }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Datas de arquivamento no registro, quando disponíveis. Declarações anuais e assembleias gerais usam last_annual_return_date e last_agm_date; elas são distintas das demonstrações financeiras." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "nullable": true, "description": "Sempre `null` neste endpoint (usado pelo fluxo KYB hospedado quando usuários finais editam dados do registro)." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Sempre `null` neste endpoint." }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Preenchido quando um revisor do console edita o registro posteriormente." }, "is_editable": { "type": "boolean", "description": "Se os dados obtidos do registro ainda podem ser editados no fluxo hospedado/console." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo", null ], "description": "Igual ao `registry_tier_delivered` de nível superior.", "nullable": true }, "registry_ownership_status": { "type": "string", "nullable": true, "enum": [ "not_requested", "delivered", "not_held", "unavailable", "pending", null ], "description": "`delivered` quando os dados de propriedade foram retornados, `not_held` quando o registro de propriedade respondeu e não lista esta empresa (consulte `registry_data.ownership_error`), `unavailable` quando um nível com propriedade foi solicitado, mas o registro não tinha esses dados para esta empresa ou não pôde ser consultado (consulte `registry_data.ownership_error`), `pending` quando a seção de propriedade ainda não foi obtida do registro e a Didit ainda está concluindo essa etapa, `not_requested` no nível Lite." }, "ownership": { "$ref": "#/components/schemas/KYBRegistryOwnership" }, "registry_tier": { "type": "string", "nullable": true, "description": "O nível de registro solicitado pelo fluxo: `basic`, `shareholders` ou `ubo`. Também em `ownership.tier_requested`." }, "registry_monitoring": { "type": "object", "nullable": true, "description": "O monitor de registro mais recente da empresa, ou `null` quando não existe nenhum.", "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": "Os campos da empresa que o monitor acompanha." } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco dos `vendor_data` que você enviou." }, "metadata": { "type": "object", "nullable": true, "description": "Eco do `metadata` que você enviou." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Resolved company": { "summary": "Perfil completo do registro (lista de administradores truncada por brevidade)", "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": "Erro de validação. Problemas no nível de campo usam o envelope padrão do DRF.", "content": { "application/json": { "examples": { "Missing kyb_response_id": { "summary": "`kyb_response_id` é obrigatório", "value": { "kyb_response_id": [ "This field is required." ] } }, "save_api_request=false rejected": { "summary": "As seleções são sempre persistidas", "value": { "save_api_request": [ "KYB registry select must be saved so billing and retrieval can be tracked." ] } } } } } }, "403": { "description": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente e também quando o saldo da organização que faz a chamada não cobre a chamada; uma chave incorreta, revogada ou expirada retorna `401`. Uma chave ausente retorna `403` com `{\"detail\": ...}`; uma chave incorreta, revogada ou expirada retorna `401`. Créditos insuficientes retornam `403` com `{\"error\": ...}` antes de qualquer análise ou chamada a provedores.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "O saldo da organização não cobre a chamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Limite de requisições excedido. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API. A resposta inclui os cabeçalhos `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Mais de 300 requisições de escrita no minuto atual", "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": "Relatório aceito e ainda em processamento. Quando um relatório ainda está sendo preparado, o endpoint retorna 202 Accepted, kyb_registry.fetch_status=pending e registry_tier_delivered=null. Guarde o request_id e consulte GET /v3/session/{request_id}/decision/ até que registry_checks[0].company.fetch_status seja resolvido. A Didit conclui o relatório automaticamente e cobra o nível entregue assim que ele estiver pronto. Não repita a compra enquanto ela estiver pendente; cada novo POST cria uma requisição separada.", "content": { "application/json": { "schema": { "$ref": "#/paths/~1v3~1kyb~1shareholders~1/post/responses/200/content/application~1json/schema" }, "examples": { "Pending (registry still resolving)": { "summary": "O relatório de propriedade ainda está em processamento; recupere a decisão salva", "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 no registro KYB com beneficiários finais (avulsa)", "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": "Obtenha o perfil Lite, os acionistas diretos **e os beneficiários finais** identificados por meio da cadeia de propriedade (`registry_data.ubo_resolution` contém a cadeia de controladoras corporativas) de um candidato retornado por `POST /v3/kyb/search/`.\n\n**Uso com a busca.** Envie o `kyb_response_id` do candidato exatamente como foi retornado por uma busca da mesma aplicação. Faça a busca no nível que você pretende comprar (`tier` em `POST /v3/kyb/search/`), porque a busca é executada na cadeia de registros que atende a esse nível, e uma busca Lite sem resultados não prova que o registro não tenha a empresa. Quando os dados de propriedade do país estão em outro registro, a Didit localiza a empresa novamente nesse registro pelo número de registro, sem custo adicional.\n\n**Faturamento.** Cobrado pelo preço UBO do país; consulte [Preços de registros KYB](/pt-br/getting-started/kyb-registry-pricing). O nível entregue é o mais alto que o país e o registro conseguem atender: Shareholders quando o relatório resolvido não indica nenhuma pessoa física como beneficiário final, Lite quando não há nenhum dado de propriedade; `registry_tier_delivered` indica o que foi cobrado. O saldo é verificado em relação ao preço UBO antes de qualquer chamada ao registro (`403` quando insuficiente).\n\n**Disponibilidade.** Somente v3. Cada chamada cria uma sessão de empresa (seu id é o `request_id`).\n\n**Relatórios pendentes.** Quando um relatório ainda está sendo preparado, ou a seção de propriedade ainda não foi obtida do registro, o endpoint retorna 202 Accepted, kyb_registry.fetch_status=pending, kyb_registry.registry_ownership_status=pending e registry_tier_delivered=null. Guarde o request_id e consulte GET /v3/session/{request_id}/decision/ até que registry_checks[0].company.fetch_status seja resolvido. A Didit conclui o relatório automaticamente e cobra o nível entregue quando ele estiver pronto. Não repita a compra enquanto ela estiver pendente; cada novo POST cria uma requisição separada.", "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": "Relatório da empresa retornado e faturado no nível entregue. Relatórios de propriedade ainda em preparação podem retornar 202; guarde o request_id para recuperar a decisão salva.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Id da sessão de empresa criada para esta consulta. O registro armazenado (visível no console) continua sendo atualizado se o registro de empresas responder depois da resposta." }, "registry_tier_requested": { "type": "string", "enum": [ "basic", "shareholders", "ubo" ], "description": "O nível que este endpoint vende: `basic` (Lite) para países selecionados, `shareholders`, `ubo`." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo", null ], "description": "O nível efetivamente entregue e faturado. Inferior ao solicitado quando os registros do país não contêm dados de propriedade, quando o registro não possui informações de propriedade desta empresa ou quando o relatório resolvido de uma requisição `ubo` não indica nenhuma pessoa física como beneficiário final.", "nullable": true }, "kyb_registry": { "type": "object", "description": "Perfil completo da empresa no registro.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID da Didit para este registro de empresa." }, "node_id": { "type": "string", "example": "feature_kyb_registry" }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review" ], "description": "Avaliação da Didit sobre a verificação no registro de empresas (por exemplo, `In Review` quando a empresa não está ativa no registro ou quando não foi possível derivar os dados de propriedade)." }, "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": "Status normalizado da empresa conforme informado pelo registro." }, "data_resolved": { "type": "boolean", "description": "`true` quando o registro retornou o perfil completo. `false` quando o registro ainda estava processando após a consulta periódica; o registro armazenado é completado automaticamente assim que o registro resolve." }, "company_name": { "type": "string", "example": "Tesco PLC" }, "registration_number": { "type": "string", "nullable": true, "example": "00445790" }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2.", "example": "GB" }, "region": { "type": "string", "nullable": true, "description": "Código da subdivisão quando o registro é regional (por exemplo `CA` para `US-CA`); vazio caso contrário." }, "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": "Nível de risco informado pelo registro, quando disponível." }, "verification_status": { "type": "string", "nullable": true, "description": "Status de verificação do registro, quando disponível." }, "is_from_registry": { "type": "boolean", "description": "Sempre `true` para este endpoint: o perfil foi obtido de um registro oficial." }, "fetch_status": { "type": "string", "enum": [ "pending", "resolved" ], "description": "Ciclo de vida da consulta ao registro. Refletido por `data_resolved`." }, "alternative_names": { "type": "string", "nullable": true, "description": "Nomes alternativos, comerciais, anteriores ou no idioma original da empresa, em texto, quando informados." }, "nature_of_business": { "type": "string", "nullable": true, "description": "Descrição da atividade ou código de classificação, quando informado." }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "nullable": true, "description": "Valor decimal como string, quando informado." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Código ISO 4217, quando informado." }, "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, quando informado." }, "location_of_registration": { "type": "string", "nullable": true, "description": "Registro/jurisdição em que a empresa está registrada, quando informado." }, "vat_number": { "type": "string", "nullable": true, "description": "Número de IVA da UE (EU VAT), quando coletado durante a etapa de registro no fluxo hospedado ou editado posteriormente. No momento da seleção, normalmente ainda não está definido: a validação de IVA e de identificação fiscal é executada quando o usuário final envia a etapa de registro no fluxo hospedado." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Resultado da validação do número de VAT ou, quando não houver, do `tax_number`, no envio ao registro. `valid` / `invalid`: decidido pelo registro oficial do país (EU VIES, Noruega, Suíça, Brasil, Colômbia, Costa Rica, Equador, Paraguai; a Polônia também pelo seu registro nacional de VAT). `format_valid` / `invalid_format`: decidido pelas regras de formato e dígito verificador do país quando nenhum registro pode ser consultado. `could_not_validate`: o registro estava indisponível. `not_applicable`: nenhum número, um país sem registro nem regras, ou uma sessão de sandbox." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "O número que foi verificado, como a fonte o conhece (por exemplo, o número de IVA derivado de um SIREN francês ou de um RSIN holandês). `null` quando nenhuma verificação foi executada." }, "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": "A fonte que determinou `vat_validation_status`: um registro oficial ou `format_rules`. `null` quando nenhuma verificação foi executada." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Nome registrado na fonte que validou o número, quando ela o informa. Preenchido apenas quando o status é `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Endereço registrado na fonte que validou o número, quando ela o informa. Definido apenas quando o status é `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data e hora da verificação. `null` quando nenhuma verificação foi executada." }, "financial_summary": { "type": "object", "nullable": true, "description": "Detalhes de ações/capital informados pelo registro (moeda, total de ações, classes de ações), quando disponíveis." }, "officers": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "example": "MELISSA BETHELL" }, "designation": { "type": "string", "nullable": true, "description": "Designação bruta do registro (por exemplo, `Director`, `Secretary`)." }, "role": { "type": "string", "description": "Função normalizada derivada do cargo. Conjunto completo de 17 valores do modelo; a análise do registro neste endpoint normalmente retorna director, non_executive_director, secretary, chairman ou 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` quando o registro marca a nomeação como encerrada por renúncia." }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending", null ], "description": "Status de uma sessão de KYC associada, quando uma foi iniciada para este administrador. `null` caso contrário." }, "kyc_session_url": { "type": "string", "nullable": true, "description": "URL de verificação da sessão de KYC associada, quando existir." }, "first_name": { "type": "string", "nullable": true, "description": "Nome próprio, quando informado explicitamente pelo registro; não é inferido a partir do nome completo." }, "last_name": { "type": "string", "nullable": true, "description": "Sobrenome, quando informado explicitamente pelo registro." }, "address": { "type": "string", "nullable": true, "description": "Endereço do administrador informado pelo registro de empresas." }, "appointment_date": { "type": "string", "nullable": true, "description": "Data em que o administrador foi nomeado.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Data em que o cargo terminou, quando informada.", "format": "date" }, "date_of_birth": { "type": "string", "nullable": true, "description": "Data de nascimento completa informada pelo registro. Nula quando apenas o ano ou o mês de nascimento é conhecido.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Ano de nascimento informado pelo registro, inclusive quando a data completa não está disponível." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Mês de nascimento informado pelo registro. Nulo quando apenas o ano é conhecido." } } }, "description": "Diretores, secretários e outros administradores extraídos do registro." }, "beneficial_owners": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Se o proprietário é uma pessoa física ou uma pessoa jurídica." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Funções normalizadas (por exemplo, `ubo`, `shareholder`)." }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Limite inferior da faixa de propriedade informada pelo registro (por exemplo, `25%`)." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Limite superior da faixa de propriedade informada pelo registro." }, "is_active": { "type": "boolean" }, "kyc_status": { "type": "string", "nullable": true, "enum": [ "Approved", "Declined", "Pending", null ] }, "kyc_session_url": { "type": "string", "nullable": true }, "effective_ownership_percent": { "type": "number", "nullable": true, "description": "Percentual de propriedade interpretado (limite máximo, recorrendo ao limite mínimo)." }, "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 nascimento completa, quando informada.", "format": "date" }, "appointment_date": { "type": "string", "nullable": true, "description": "Data de nomeação, quando informada.", "format": "date" }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } } }, "description": "Beneficiários finais / pessoas com controle significativo extraídos do registro. Pode estar vazio quando o registro não expõe a propriedade." }, "addresses": { "type": "array", "nullable": true, "description": "Todos os endereços que o registro informa, em um único formato canônico. Nulo quando não informa nenhum.", "items": { "$ref": "#/components/schemas/KYBRegistryAddress" } }, "industries": { "type": "array", "nullable": true, "description": "As atividades em que o registro classifica a empresa, em um único formato canônico. Null quando ele não informa nenhuma.", "items": { "$ref": "#/components/schemas/KYBRegistryIndustry" } }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Datas de arquivamento no registro, quando disponíveis. Declarações anuais e assembleias gerais usam last_annual_return_date e last_agm_date; elas são distintas das demonstrações financeiras." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "nullable": true, "description": "Sempre `null` neste endpoint (usado pelo fluxo KYB hospedado quando usuários finais editam dados do registro)." }, "confirmed_by_user_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Sempre `null` neste endpoint." }, "last_console_edit_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Preenchido quando um revisor do console edita o registro posteriormente." }, "is_editable": { "type": "boolean", "description": "Se os dados obtidos do registro ainda podem ser editados no fluxo hospedado/console." }, "registry_tier_delivered": { "type": "string", "enum": [ "basic", "shareholders", "ubo", null ], "description": "Igual ao `registry_tier_delivered` de nível superior.", "nullable": true }, "registry_ownership_status": { "type": "string", "nullable": true, "enum": [ "not_requested", "delivered", "not_held", "unavailable", "pending", null ], "description": "`delivered` quando os dados de propriedade foram retornados, `not_held` quando o registro de propriedade respondeu e não lista esta empresa (consulte `registry_data.ownership_error`), `unavailable` quando um nível com propriedade foi solicitado, mas o registro não tinha esses dados para esta empresa ou não pôde ser consultado (consulte `registry_data.ownership_error`), `pending` quando a seção de propriedade ainda não foi obtida do registro e a Didit ainda está concluindo essa etapa, `not_requested` no nível Lite." }, "ownership": { "$ref": "#/components/schemas/KYBRegistryOwnership" }, "registry_tier": { "type": "string", "nullable": true, "description": "O nível de registro solicitado pelo fluxo: `basic`, `shareholders` ou `ubo`. Também em `ownership.tier_requested`." }, "registry_monitoring": { "type": "object", "nullable": true, "description": "O monitor de registro mais recente da empresa, ou `null` quando não existe nenhum.", "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": "Os campos da empresa que o monitor acompanha." } } } } }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco dos `vendor_data` que você enviou." }, "metadata": { "type": "object", "nullable": true, "description": "Eco do `metadata` que você enviou." }, "created_at": { "type": "string", "format": "date-time" } } }, "examples": { "Resolved company": { "summary": "Perfil completo do registro (lista de administradores truncada por brevidade)", "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": "Erro de validação. Problemas no nível de campo usam o envelope padrão do DRF.", "content": { "application/json": { "examples": { "Missing kyb_response_id": { "summary": "`kyb_response_id` é obrigatório", "value": { "kyb_response_id": [ "This field is required." ] } }, "save_api_request=false rejected": { "summary": "As seleções são sempre persistidas", "value": { "save_api_request": [ "KYB registry select must be saved so billing and retrieval can be tracked." ] } } } } } }, "403": { "description": "Permissão negada. Retornado quando o cabeçalho `x-api-key` está ausente e também quando o saldo da organização que faz a chamada não cobre a chamada; uma chave incorreta, revogada ou expirada retorna `401`. Uma chave ausente retorna `403` com `{\"detail\": ...}`; uma chave incorreta, revogada ou expirada retorna `401`. Créditos insuficientes retornam `403` com `{\"error\": ...}` antes de qualquer análise ou chamada a provedores.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida/revogada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "O saldo da organização não cobre a chamada", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "429": { "description": "Limite de requisições excedido. Todos os endpoints POST/PATCH/DELETE compartilham uma cota de 300 requisições de escrita por minuto por chave de API. A resposta inclui os cabeçalhos `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` e `Retry-After`.", "content": { "application/json": { "examples": { "Write rate limit exceeded": { "summary": "Mais de 300 requisições de escrita no minuto atual", "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": "Relatório aceito e ainda em processamento. Quando um relatório ainda está sendo preparado, o endpoint retorna 202 Accepted, kyb_registry.fetch_status=pending e registry_tier_delivered=null. Guarde o request_id e consulte GET /v3/session/{request_id}/decision/ até que registry_checks[0].company.fetch_status seja resolvido. A Didit conclui o relatório automaticamente e cobra o nível entregue assim que ele estiver pronto. Não repita a compra enquanto ela estiver pendente; cada novo POST cria uma requisição separada.", "content": { "application/json": { "schema": { "$ref": "#/paths/~1v3~1kyb~1ubo~1/post/responses/200/content/application~1json/schema" }, "examples": { "Pending (registry still resolving)": { "summary": "O relatório de propriedade ainda está em processamento; recupere a decisão salva", "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": "Cada carteira de Digital ID com seu endpoint de início, países, campos obrigatórios e se esta aplicação pode iniciá-la neste ambiente agora. Estar listada não significa estar disponível em produção.", "summary": "Listar carteiras de Digital ID", "tags": [ "Digital ID wallets" ], "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletCatalogResponse" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiClientCredentialsForbiddenErrorMessage" } } }, "description": "Credenciais ausentes (x-api-key ou 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": "Status e resultado de uma verificação de carteira: a identidade normalizada e os atributos da própria carteira após a verificação, o código de erro após a recusa e a próxima ação enquanto estiver pendente. Uma verificação que ultrapassou expires_at recebe a decisão timeout.", "summary": "Obter uma verificação de carteira", "parameters": [ { "in": "path", "name": "request_id", "schema": { "type": "string", "format": "uuid" }, "description": "O request_id retornado pelo endpoint de início.", "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": "Credenciais ausentes (x-api-key ou Authorization: Bearer)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro not_found: nenhuma verificação de carteira desta aplicação tem este request_id." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request GET \\\n --url https://verification.didit.me/v3/id-verification/wallets/verifications/REQUEST_ID/ \\\n --header 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.retrieve_verification(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.retrieveVerification(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.RetrieveVerification(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().retrieveVerification(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->retrieveVerification('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.retrieve_verification(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.RetrieveVerificationAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/id-verification/wallets/verifications/{request_id}/poll/": { "post": { "operationId": "poll_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "poll_verification", "auth": "api_key", "server": true }, "description": "Smart-ID e Mobile-ID: consulta o provedor para saber se o usuário confirmou, recusou ou deixou a solicitação expirar, e verifica a identidade assinada quando ele confirmou. As carteiras com redirecionamento são concluídas pelo navegador do usuário, então, para elas, isto apenas lê a verificação de volta. Responde com a verificação no estado em que ela fica depois.", "summary": "Consultar o status de uma verificação de carteira", "parameters": [ { "in": "path", "name": "request_id", "schema": { "type": "string", "format": "uuid" }, "description": "O request_id retornado pelo endpoint de início.", "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": "Credenciais ausentes (x-api-key ou Authorization: Bearer)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro not_found: nenhuma verificação de carteira desta aplicação tem este request_id." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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 uma verificação pendente: ela é recusada como cancelada e nunca é cobrada. Uma verificação já decidida é retornada sem alterações. Smart-ID e Mobile-ID: um cancelamento que chega enquanto uma consulta está verificando o login aguarda alguns segundos por essa consulta e, em seguida, recusa a verificação, ou a retorna como verificada se o usuário já tiver confirmado. Uma verificação que o usuário está concluindo neste momento não pode ser cancelada (409 verification_in_progress com Retry-After): tente novamente após esse número de segundos para ler o resultado.", "summary": "Cancelar uma verificação de carteira", "parameters": [ { "in": "path", "name": "request_id", "schema": { "type": "string", "format": "uuid" }, "description": "O request_id retornado pelo endpoint de início.", "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": "Credenciais ausentes (x-api-key ou Authorization: Bearer)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro not_found: nenhuma verificação de carteira desta aplicação tem este request_id." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro verification_in_progress: o usuário está concluindo este login neste momento. O cabeçalho Retry-After indica quando tentar novamente; a nova tentativa retorna a verificação já decidida." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/verifications/REQUEST_ID/cancel/ \\\n --header 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.cancel_verification(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.cancelVerification(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.CancelVerification(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().cancelVerification(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->cancelVerification('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.cancel_verification(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.CancelVerificationAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/id-verification/wallets/mitid/": { "post": { "operationId": "start_mitid_wallet_verification", "x-didit-sdk": { "resource": "id_wallets", "method": "start_mitid", "auth": "api_key", "server": true }, "description": "Inicie um login com MitID (Danish Agency for Digital Government; DNK) sem nenhum fluxo. A cobrança é feita uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual você deve enviar o navegador do usuário; o usuário retorna à return_url com request_id e result adicionados. Consulte o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca entra em contato com o provedor.", "summary": "Iniciar verificação com MitID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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 um login com BankID (SWE) (Finansiell ID-Teknik / consórcio bancário; SWE) sem nenhum fluxo. Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com BankID (SWE)", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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 um login com BankID (NOR) (BankID BankAxept AS; NOR) sem nenhum fluxo. Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com BankID (NOR)", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com Vipps (Vipps MobilePay / BankID NO; NOR) sem nenhum fluxo de verificação (workflow). Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações em sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com Vipps", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com Buypass ID (Buypass AS; NOR) sem nenhum fluxo de verificação (workflow). Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com Buypass ID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com itsme (Belgian Mobile ID; BEL, LUX, NLD) sem nenhum fluxo. A cobrança ocorre uma única vez, apenas quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para onde o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com itsme", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com iDIN (bancos holandeses (Currence iDIN); NLD) sem nenhum fluxo de verificação (workflow). Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações em sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com iDIN", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com Finnish Trust Network (bancos e operadoras móveis finlandeses (FTN); FIN) sem nenhum fluxo de verificação (workflow). Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com Finnish Trust Network", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com Personalausweis (Bundesministerium des Innern (eID); DEU) sem nenhum fluxo de verificação (workflow). Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações em sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com Personalausweis", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com Freja eID (Freja eID Group; SWE) sem nenhum fluxo. A cobrança é feita uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual você deve enviar o navegador do usuário; o usuário retorna à return_url com request_id e result adicionados. Consulte o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca entra em contato com o provedor.", "summary": "Iniciar verificação com Freja eID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com UAE PASS (UAE Digital Government Authority; ARE) sem nenhum fluxo de verificação (workflow). Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações em sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com UAE PASS", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com gov.br (Governo Federal do Brasil; BRA) sem nenhum fluxo de verificação (workflow). Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações em sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com gov.br", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com OneID (OneID (identidade verificada por banco no Reino Unido); GBR) sem nenhum fluxo. A cobrança é feita uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual você deve enviar o navegador do usuário; o usuário retorna à return_url com request_id e result adicionados. Consulte o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca entra em contato com o provedor.", "summary": "Iniciar verificação com OneID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com GOV.UK Wallet (UK Government Digital Service; GBR) sem nenhum fluxo. A cobrança é feita uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual você deve enviar o navegador do usuário; o usuário retorna à return_url com request_id e result adicionados. Consulte o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca entra em contato com o provedor.", "summary": "Iniciar verificação com GOV.UK Wallet", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com Smart-ID (SK ID Solutions; EST, LVA, LTU, BEL) sem nenhum fluxo de verificação (workflow). Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=confirm_in_app com o código de comparação a ser exibido ao usuário; o usuário confirma o código e digita o PIN no aplicativo (nunca colete o PIN). Consulte POST /v3/id-verification/wallets/verifications/{request_id}/poll/ a cada poll_interval_seconds ou conte com o webhook: a Didit também faz a consulta em segundo plano. Aplicações em sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com Smart-ID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com Mobile-ID (SK ID Solutions com as operadoras móveis nacionais; EST, LTU) sem nenhum fluxo. A cobrança é feita uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=confirm_in_app com o código de comparação a ser exibido ao usuário; o usuário o confirma e digita o PIN no aplicativo (nunca colete o PIN). Consulte POST /v3/id-verification/wallets/verifications/{request_id}/poll/ a cada poll_interval_seconds ou conte com o webhook: a Didit também faz a consulta em segundo plano. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca entra em contato com o provedor.", "summary": "Iniciar verificação com Mobile-ID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com o cartão de identidade estoniano (Police and Border Guard Board (Estonia); EST) sem nenhum fluxo de verificação (workflow). Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com cartão de identidade estoniano", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com eParaksts mobile (LVRTC (Latvian State Radio and Television Centre); LVA) sem nenhum fluxo de verificação (workflow). Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações em sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação móvel com eParaksts", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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 um login com Bank iD (Bankovní identita, a.s.; CZE) sem nenhum fluxo. Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com Bank iD", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com MojeID (CZ.NIC; CZE) sem nenhum fluxo. A cobrança é feita uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual você deve enviar o navegador do usuário; o usuário retorna à return_url com request_id e result adicionados. Consulte o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca entra em contato com o provedor.", "summary": "Iniciar verificação com MojeID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com Diia (Ministry of Digital Transformation of Ukraine; UKR) sem nenhum fluxo de verificação (workflow). Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com Diia", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com FranceConnect (DINUM (Estado francês); FRA) sem nenhum fluxo de verificação (workflow). Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com FranceConnect", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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 um login com Auðkenni (Auðkenni (identidade eletrônica islandesa); ISL) sem nenhum fluxo. Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com Auðkenni", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com ConnectID (Australian Payments Plus; AUS) sem nenhum fluxo de verificação (workflow). Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com ConnectID", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Inicie um login com EUDI Wallet (o próprio Estado-membro do usuário; o emissor varia conforme o 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) sem nenhum fluxo de verificação (workflow). Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor.", "summary": "Iniciar verificação com EUDI Wallet", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", "source": "curl --request POST \\\n --url https://verification.didit.me/v3/id-verification/wallets/eudi/ \\\n --header 'x-api-key: YOUR_API_KEY' \\\n --header 'Idempotency-Key: your-unique-attempt-key' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"country\": \"AUT\",\n \"vendor_data\": \"your-customer-reference\",\n \"metadata\": {\n \"reference\": \"example\"\n },\n \"return_url\": \"https://app.example.com/identity/complete\"\n}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.id_wallets.start_eudi(\n vendor_data=\"your-customer-reference\",\n metadata={\"reference\": \"example\"},\n country=\"AUT\",\n return_url=\"https://app.example.com/identity/complete\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.idWallets.startEudi({\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"AUT\",\n return_url: \"https://app.example.com/identity/complete\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartEudi(ctx, didit.IDWalletsStartEudiParams{\n\tBody: didit.DigitalIDWalletAPIEudiWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata: didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry: didit.DigitalIDWalletAPIEudiWalletVerificationStartCountryEnum(\"AUT\"),\n\t\tReturnURL: \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.DigitalIdWalletApiEudiWalletVerificationStartCountryEnum;\nimport me.didit.types.DigitalIdWalletApiEudiWalletVerificationStartRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.idWallets().startEudi(DigitalIdWalletApiEudiWalletVerificationStartRequest.builder()\n .vendorData(\"your-customer-reference\")\n .metadata(Map.of(\"reference\", \"example\"))\n .country(DigitalIdWalletApiEudiWalletVerificationStartCountryEnum.of(\"AUT\"))\n .returnUrl(\"https://app.example.com/identity/complete\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "idWallets->startEudi([\n 'vendor_data' => 'your-customer-reference',\n 'metadata' => ['reference' => 'example'],\n 'country' => 'AUT',\n 'return_url' => 'https://app.example.com/identity/complete',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.id_wallets.start_eudi(\n vendor_data: \"your-customer-reference\",\n metadata: { reference: \"example\" },\n country: \"AUT\",\n return_url: \"https://app.example.com/identity/complete\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.IdWallets.StartEudiAsync(new DigitalIdWalletApiEudiWalletVerificationStartRequest\n{\n VendorData = \"your-customer-reference\",\n Metadata = new Dictionary { [\"reference\"] = \"example\" },\n Country = \"AUT\",\n ReturnUrl = \"https://app.example.com/identity/complete\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-wallet-id": "eudi" } }, "/v3/organization/{organization_id}/application/{application_id}/cases/teams/": { "get": { "summary": "Listar equipes de revisão", "description": "Requer `list:cases` para a aplicação solicitada.", "operationId": "list_case_teams", "x-didit-sdk": { "resource": "cases.teams", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "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": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseReviewTeam" } }, "count": { "type": "integer", "description": "Contagem de correspondências, limitada a 100. Siga next para continuar além do limite." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true } } } } } }, "400": { "description": "Entrada inválida." }, "403": { "description": "Permissão insuficiente." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.teams.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.teams.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.Teams.ListAutoPaging(ctx, didit.CasesTeamsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().teams().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->teams->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.teams.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.Teams.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "summary": "Criar equipe de revisão", "description": "Requer `write:cases` para a aplicação solicitada.", "operationId": "create_case_teams", "x-didit-sdk": { "resource": "cases.teams", "method": "create", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." } ], "responses": { "201": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeam" } } } }, "400": { "description": "Entrada inválida." }, "403": { "description": "Permissão insuficiente." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeamCreate" }, "example": { "name": "AML analysts", "members": [ { "user_id": "9a000000-0000-4000-8000-0000000000aa", "capacity": 10 } ] } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.teams.create(\n name=\"AML analysts\",\n members=[{\n \"user_id\": \"9a000000-0000-4000-8000-0000000000aa\",\n \"capacity\": 10,\n }],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.teams.create({\n name: \"AML analysts\",\n members: [{\n user_id: \"9a000000-0000-4000-8000-0000000000aa\",\n capacity: 10,\n }],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Teams.Create(ctx, didit.CaseReviewTeamCreate{\n\tName: \"AML analysts\",\n\tMembers: []didit.CaseReviewTeamMemberParam{{\n\t\tUserID: \"9a000000-0000-4000-8000-0000000000aa\",\n\t\tCapacity: didit.Int(10),\n\t}},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CaseReviewTeamCreate;\nimport me.didit.types.CaseReviewTeamMember;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().teams().create(CaseReviewTeamCreate.builder()\n .name(\"AML analysts\")\n .members(List.of(CaseReviewTeamMember.builder()\n .userId(\"9a000000-0000-4000-8000-0000000000aa\")\n .capacity(10L)\n .build()))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->teams->create([\n 'name' => 'AML analysts',\n 'members' => [[\n 'user_id' => '9a000000-0000-4000-8000-0000000000aa',\n 'capacity' => 10,\n ]],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.teams.create(\n name: \"AML analysts\",\n members: [{\n user_id: \"9a000000-0000-4000-8000-0000000000aa\",\n capacity: 10,\n }]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Teams.CreateAsync(new CaseReviewTeamCreate\n{\n Name = \"AML analysts\",\n Members = new CaseReviewTeamMember[]\n {\n new()\n {\n UserId = \"9a000000-0000-4000-8000-0000000000aa\",\n Capacity = 10,\n },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/fraud/checks/{check_id}/": { "get": { "operationId": "root_retrieve", "x-didit-sdk": { "resource": "fraud_checks", "method": "retrieve", "auth": "api_key", "server": true }, "description": "Obtenha uma verificação criada anteriormente pelo seu `check_id`.", "summary": "Obter uma verificação de fraude", "parameters": [ { "in": "path", "name": "check_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudCheckResponse" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudClientCredentialsErrorMessage" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudClientCredentialsForbiddenErrorMessage" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Fraud Check" ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.fraud_checks.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.fraudChecks.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.FraudChecks.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.fraudChecks().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "fraudChecks->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.fraud_checks.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.FraudChecks.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/": { "get": { "operationId": "organization_application_cases_requests_list", "x-didit-sdk": { "resource": "cases.requests", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "name": "ordering", "required": false, "in": "query", "description": "Qual campo usar para ordenar os resultados.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Número de resultados a retornar por página.", "schema": { "type": "integer" } }, { "name": "offset", "required": false, "in": "query", "description": "O índice inicial a partir do qual os resultados são retornados.", "schema": { "type": "integer" } } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingPaginatedCaseRequestList" } } }, "description": "" }, "404": { "description": "A requisição ou o caso não está disponível para este solicitante." }, "403": { "description": "O chamador não tem a permissão de casos necessária." } }, "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": "A requisição ou o caso não está disponível para este solicitante." }, "403": { "description": "O chamador não tem a permissão de casos necessária." }, "400": { "description": "Entradas inválidas, finalidade não suportada, contato verificado indisponível ou uma resposta imutável já existente." }, "409": { "description": "A prévia mudou ou expirou. Gere a prévia novamente antes de confirmar." }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequest" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Confirme a prévia assinada exata em até 15 minutos. Só são aceitos modelos fixos e um contato verificado por OTP que pertença ao titular do caso. O ID da requisição torna as novas tentativas idempotentes. A entrega é enfileirada; SENT, SIMULATED e UNKNOWN são resultados distintos. Uma requisição que exige ação define o caso como Awaiting user. Uma atualização de revisão mantém o status inalterado.", "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": "Envie um ou mais identificadores tipados e receba, em uma única resposta, normalização, enriquecimento atualizado, validação em fonte oficial quando o país e o tipo de identificador são cobertos, dimensões de risco independentes e uma recomendação.\n\nEstes perfis aceitam verificações de identificadores. A vinculação de identidade baseada em selfie (`biometric_identity`) exige a versão de perfil `2026-09-14.2` e um CPF brasileiro; ela só é executada com o consentimento do usuário e quando sua organização tem direito a ela. Versões anteriores a reportam como `not_available_in_profile_version`. Módulos que não podem ser executados são reportados como ignorados, com um motivo determinístico; uma fonte que não conseguiu responder nunca é reportada como divergência de identidade.", "summary": "Executar uma verificação de fraude", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" }, "example": { "client_reference": "review-attempt-001", "subject": { "identifiers": [ { "type": "email", "value": "applicant@example.com" } ], "attributes": { "first_name": "Alex", "last_name": "Example" } }, "checks": { "include": [ "networks_same_org", "networks_cross_org", "email_risk" ] } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudCheckResponse" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudClientCredentialsErrorMessage" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudClientCredentialsForbiddenErrorMessage" } } }, "description": "" }, "409": { "description": "Conflito, retornado sem cobrança: o `client_reference` já foi usado com um corpo de requisição diferente; uma verificação com o mesmo `client_reference` ainda está em execução (tente novamente após `Retry-After` segundos com a mesma referência); ou a verificação na qual esta checagem é registrada foi excluída antes de a checagem ser concluída.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] }, "examples": { "different_body": { "summary": "Referência reutilizada com um corpo diferente", "value": { "error": "client_reference has already been used with a different request body." } }, "still_running": { "summary": "Uma verificação com esta referência ainda está em execução", "value": { "error": "A check with this client_reference is already running. Retry with the same reference later." } }, "verification_deleted": { "summary": "A verificação foi excluída antes da conclusão da checagem", "value": { "error": "This verification was deleted before the check completed." } } } } }, "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente, enviado quando uma verificação com o mesmo `client_reference` ainda está em execução.", "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": "A requisição ou o caso não está disponível para este solicitante." }, "403": { "description": "O chamador não tem a permissão de casos necessária." }, "400": { "description": "Entradas inválidas, finalidade não suportada, contato verificado indisponível ou uma resposta imutável já existente." }, "409": { "description": "A prévia mudou ou expirou. Gere a prévia novamente antes de confirmar." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.requests.cancel(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.requests.cancel(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Requests.Cancel(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().requests().cancel(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->requests->cancel('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.requests.cancel(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Requests.CancelAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/options/": { "get": { "operationId": "organization_application_cases_requests_options_retrieve", "x-didit-sdk": { "resource": "cases.requests", "method": "retrieve_options", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestOptions" } } }, "description": "" }, "404": { "description": "A requisição ou o caso não está disponível para este solicitante." }, "403": { "description": "O chamador não tem a permissão de casos necessária." } }, "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": "A requisição ou o caso não está disponível para este solicitante." }, "403": { "description": "O chamador não tem a permissão de casos necessária." } }, "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": "Qual campo usar para ordenar os resultados.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Número de resultados a retornar por página.", "schema": { "type": "integer" } }, { "name": "offset", "required": false, "in": "query", "description": "O índice inicial a partir do qual os resultados são retornados.", "schema": { "type": "integer" } } ], "tags": [ "Case Assignment" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPaginatedPolicyRevisionList" } } }, "description": "" }, "403": { "description": "É necessário ter acesso a casos." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.routing_rules.list_history(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.routingRules.listHistory(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.RoutingRules.ListHistoryAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CasesRoutingRulesListHistoryParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().routingRules().listHistory(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->listHistory('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.routing_rules.list_history(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.RoutingRules.ListHistoryAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/session/{sessionId}/resubmission-preview/": { "post": { "summary": "Pré-visualizar um e-mail de reenvio", "description": "Gera o e-mail que acompanharia um reenvio de KYC ou KYB sem alterar a sessão, redefinir verificações, estender sua validade, executar verificações ou enviar e-mails. Exige o privilégio `write:sessions` (uma chave de API com escopo precisa de acesso de escrita a decisões) e uma sessão com status `Approved`, `Declined`, `In Review`, `Kyc Expired` ou `Abandoned`. O servidor valida as etapas do fluxo selecionadas e gera seu modelo fixo traduzido com o remetente verificado e a identidade visual de marca própria aplicáveis. A requisição não pode definir assunto, corpo da mensagem nem URL de ação.\n\n`email_address` é opcional. Sem ele, o e-mail vai para o endereço da própria pessoa: o que ela verificou em uma etapa de verificação de e-mail do fluxo ou, se não houver, o informado em `contact_details` quando a sessão foi criada. Um endereço que você informar tem prioridade (`recipient_source: request`). Quando nenhum endereço é conhecido e você não informa nenhum, `recipient` e `preview_token` são strings vazias e nenhum e-mail pode ser enviado.\n\nA resposta inclui o destinatário e a origem dele, o remetente, o assunto, o HTML, o idioma, as etapas resolvidas, se a confirmação envia o e-mail (`will_be_sent`, `not_sent_reason`) e um `preview_token` assinado. `requires_user_action` é `false` quando todas as etapas selecionadas são executadas sem a pessoa: nesse caso, o reenvio é concluído sozinho e nenhum e-mail é enviado (`not_sent_reason: no_user_action`).\n\nEsta pré-visualização não reserva o estado da sessão nem autoriza a entrega. Depois de revisá-la, chame [Update Session Status](/pt-br/sessions-api/update-status) com `new_status: Resubmitted`, os mesmos `nodes_to_resubmit` e `email_language` que você pré-visualizou, `send_email: true`, `email_address` definido como `recipient` e `email_preview_token` definido como `preview_token`. O comprovante expira após 15 minutos. Quando um comprovante é fornecido, alterações nas entradas, no conteúdo da mensagem, no remetente ou no estado da sessão retornam `409` antes de qualquer alteração ou envio. Integrações existentes podem omitir o comprovante. Gere a pré-visualização novamente após um conflito. Trate a resposta como conteúdo de verificação sensível; as respostas usam `Cache-Control: no-store`. Renderize o HTML em um frame isolado (sandbox), nunca diretamente no DOM da sua aplicação.", "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 da sessão de verificação a ser atualizada. Aceita IDs de sessão tanto de usuário (KYC) quanto de empresa (KYB): o serviço resolve o ID entre os dois tipos de sessão.", "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": "Etapas a pré-visualizar, usando a mesma validação, seleção e ordem do fluxo de um reenvio. Omita para selecionar automaticamente as tentativas registradas que precisam de reenvio.", "items": { "type": "object", "required": [ "node_id", "feature" ], "properties": { "node_id": { "type": "string", "description": "Identificador do nó conforme aparece na definição do fluxo de verificação (workflow) da sessão (por exemplo, `feature_ocr`, `feature_liveness`).", "example": "feature_ocr" }, "feature": { "type": "string", "description": "Tipo de recurso do nó. Os aliases `ID_VERIFICATION`, `POA`, `PHONE` e `EMAIL` são normalizados no servidor para `OCR`, `PROOF_OF_ADDRESS`, `PHONE_VERIFICATION` e `EMAIL_VERIFICATION`. `KYB_REGISTRY`, `KYB_KEY_PEOPLE` e `KYB` passam na validação do schema, mas são sempre rejeitados com o `400` de regra de negócio mostrado nos exemplos.", "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 o e-mail para este endereço em vez do endereço da própria pessoa. Sem ele, o destinatário é o endereço que a pessoa verificou no fluxo ou, na ausência dele, o informado em `contact_details`. Nenhum e-mail é enviado por esta chamada.", "example": "user@example.com" }, "email_language": { "type": "string", "description": "Idioma do e-mail de notificação. Aceita qualquer string no nível do schema; códigos não suportados passam a usar inglês (`en`) sem aviso.", "default": "en", "example": "en" } } }, "examples": { "Person's Own Address": { "summary": "Pré-visualizar um reenvio de comprovante de endereço para o próprio endereço da pessoa", "value": { "nodes_to_resubmit": [ { "node_id": "feature_poa_1", "feature": "POA" } ], "email_language": "en" } }, "Named Recipient": { "summary": "Pré-visualizar o e-mail para um endereço que você informar", "value": { "nodes_to_resubmit": [ { "node_id": "feature_ocr", "feature": "OCR" } ], "email_address": "person@example.com", "email_language": "en" } } } } } }, "responses": { "200": { "description": "Somente pré-visualização. A sessão não é alterada e nenhum e-mail é enviado.", "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": "O endereço para o qual o e-mail vai. Uma string vazia quando nenhum endereço da pessoa é conhecido. Nesse caso, nenhum e-mail pode ser enviado e `preview_token` também fica vazio. Envie-o como `email_address` ao confirmar.", "example": "person@example.com" }, "recipient_source": { "type": "string", "enum": [ "email_verification", "contact_details", "request", "" ], "description": "A origem de `recipient`. `request`: o `email_address` que você enviou. `email_verification`: o endereço que a pessoa verificou em uma etapa de verificação de e-mail do fluxo. `contact_details`: o endereço informado em `contact_details` quando a sessão foi criada. Uma string vazia quando não há endereço.", "example": "email_verification" }, "sender": { "type": "string", "description": "O cabeçalho `From` com o qual o e-mail é enviado.", "example": "Example App " }, "sender_name": { "type": "string", "description": "A parte do nome de exibição de `sender`.", "example": "Example App" }, "sender_email": { "type": "string", "format": "email", "description": "A parte de endereço de `sender`.", "example": "no-reply@mail.example.com" }, "sender_kind": { "type": "string", "enum": [ "customer", "didit" ], "description": "`customer`: o e-mail é enviado a partir do domínio de remetente verificado da sua aplicação (marca própria). `didit`: ele é enviado a partir do remetente da própria Didit.", "example": "customer" }, "subject": { "type": "string", "description": "A linha de assunto exatamente como é enviada.", "example": "Action Required: Complete your verification in Example App" }, "html": { "type": "string", "description": "O HTML do e-mail exatamente como é enviado, com o logotipo incorporado como data URL. Renderize-o em um frame isolado (sandbox), nunca diretamente no DOM da sua aplicação.", "example": "..." }, "text": { "type": "string", "description": "O texto do e-mail em texto simples, como a conversa de Mensagens da pessoa o mantém, para uma pré-visualização compacta (o HTML continua sendo o e-mail que a pessoa recebe).", "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": "O idioma em que o e-mail está escrito. Inglês (`en`) quando o `email_language` solicitado não é oferecido.", "example": "en" }, "will_be_sent": { "type": "boolean", "description": "Indica se confirmar a alteração com `send_email: true` envia este e-mail. `false` quando `not_sent_reason` está definido.", "example": true }, "not_sent_reason": { "type": "string", "nullable": true, "enum": [ "no_user_action", "no_recipient", "sandbox", null ], "description": "Por que a confirmação não enviaria nenhum e-mail, ou `null` quando ele será enviado. `no_user_action`: todas as etapas selecionadas são executadas sem a pessoa, então o reenvio é concluído sozinho e nenhum e-mail é enviado. `no_recipient`: nenhum endereço é conhecido para a pessoa e você não informou nenhum. `sandbox`: uma sessão sandbox cujo destinatário não ativou a entrega de e-mails no sandbox, então o envio é apenas simulado.", "example": null }, "nodes_to_resubmit": { "type": "array", "items": { "type": "object", "required": [ "node_id", "feature" ], "properties": { "node_id": { "type": "string", "description": "Identificador do nó conforme aparece na definição do fluxo de verificação (workflow) da sessão (por exemplo, `feature_ocr`, `feature_liveness`).", "example": "feature_ocr" }, "feature": { "type": "string", "description": "Tipo de recurso do nó. Os aliases `ID_VERIFICATION`, `POA`, `PHONE` e `EMAIL` são normalizados no servidor para `OCR`, `PROOF_OF_ADDRESS`, `PHONE_VERIFICATION` e `EMAIL_VERIFICATION`. `KYB_REGISTRY`, `KYB_KEY_PEOPLE` e `KYB` passam na validação do schema, mas são sempre rejeitados com o `400` de regra de negócio mostrado nos exemplos.", "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 se pelo menos uma verificação selecionada exige interação do usuário. Isso não prevê o resultado final do fluxo." }, "preview_token": { "type": "string", "description": "Recibo assinado para este e-mail exato, válido por 15 minutos. Passe-o como `email_preview_token` para [Atualizar status da sessão](/pt-br/sessions-api/update-status). Uma string vazia quando não há destinatário.", "example": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } } }, "examples": { "Will Be Sent": { "summary": "Destinatário padrão: o endereço verificado no fluxo", "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": "Somente etapas de backend são selecionadas, então nenhum e-mail é enviado", "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`: a pré-visualização contém conteúdo da verificação e não deve ser armazenada em cache.", "schema": { "type": "string", "example": "no-store" } } } }, "400": { "description": "A sessão não está em um status aceito por este endpoint, já está como `Resubmitted`, as etapas selecionadas não podem ser reenviadas ou um campo é inválido.", "content": { "application/json": { "examples": { "Wrong Current Status": { "summary": "A sessão não está em um status aceito por este endpoint", "value": { "detail": "Only sessions with status Approved, Declined, In Review, Kyc Expired, Abandoned, Resubmitted can be updated. Current status: In Progress" } }, "Already Resubmitted": { "summary": "A sessão já está como Resubmitted", "value": [ "The new status is the same as the current status." ] }, "Nothing To Resubmit": { "summary": "A seleção automática não encontrou nenhuma etapa que precise de reenvio", "value": { "nodes_to_resubmit": "No features found that need resubmission. All features are already approved." } }, "Invalid Email": { "summary": "email_address não é um endereço de e-mail", "value": { "email_address": [ "Enter a valid email address." ] } } } } } }, "401": { "description": "A chave de API com escopo expirou.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Chave de API com escopo após a data de validade", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Credenciais ausentes, um chamador sem o privilégio `write:sessions`, uma chave de API com escopo sem o acesso de que este endpoint precisa, ou um `session_id` que pertence a outra aplicação.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente ou inválido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "O chamador não tem write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Chave de API com escopo sem este acesso", "value": { "detail": "This API key has no write access to decisions." } } } } } }, "404": { "description": "Não existe nenhuma sessão de KYC ou KYB com este `session_id`.", "content": { "application/json": { "examples": { "Not Found": { "summary": "session_id desconhecido", "value": { "detail": "Not found." } } } } } }, "429": { "description": "As etapas a reenviar são todas apenas de backend (AML, DATABASE_VALIDATION, IP_ANALYSIS), e a sessão já foi reenviada para etapas apenas de backend nos últimos 30 segundos, então Update Session Status recusaria o reenvio. Tente novamente após o intervalo indicado em `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": "Obter regra de roteamento", "description": "Requer `read:cases` para a aplicação solicitada.", "operationId": "retrieve_case_routing_rules", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "record_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRule" } } } }, "400": { "description": "Entrada inválida." }, "403": { "description": "Permissão insuficiente." }, "404": { "description": "Registro não encontrado nesta aplicação." } }, "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": "Atualizar regra de roteamento", "description": "Requer `write:cases` para a aplicação solicitada.", "operationId": "update_case_routing_rules", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "update", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "record_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRule" } } } }, "400": { "description": "Entrada inválida." }, "403": { "description": "Permissão insuficiente." }, "404": { "description": "Registro não encontrado nesta aplicação." }, "409": { "description": "A regra de roteamento mudou desde expected_version. Revise a regra mais recente antes de tentar novamente." } }, "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": "A requisição ou o caso não está disponível para este solicitante." } }, "security": [ { "CaseRequestToken": [] } ], "description": "Acesse uma solicitação do cliente usando o token específico dessa solicitação. Nenhuma constatação privada do caso, dado de identidade original ou endereço do destinatário é retornado. Solicitações acionáveis expiram após sete dias. O cancelamento ou a resolução do caso invalida o link. As respostas são imutáveis e permanecem como evidência para a avaliação do revisor; elas nunca aprovam nem atualizam uma verificação de origem." }, "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": "A requisição ou o caso não está disponível para este solicitante." }, "400": { "description": "Entradas inválidas, finalidade não suportada, contato verificado indisponível ou uma resposta imutável já existente." }, "409": { "description": "A prévia mudou ou expirou. Gere a prévia novamente antes de confirmar." } }, "security": [ { "CaseRequestToken": [] } ], "description": "Acesse uma solicitação do cliente usando o token específico dessa solicitação. Nenhuma constatação privada do caso, dado de identidade original ou endereço do destinatário é retornado. Solicitações acionáveis expiram após sete dias. O cancelamento ou a resolução do caso invalida o link. As respostas são imutáveis e permanecem como evidência para a avaliação do revisor; elas nunca aprovam nem atualizam uma verificação de origem." } }, "/v3/fraud/checks/plan/": { "post": { "operationId": "plan_create", "x-didit-sdk": { "resource": "fraud_checks", "method": "plan", "auth": "api_key", "server": true }, "description": "Valide as verificações selecionadas e estime o preço delas sem executá-las, sem criar uma sessão e sem gerar faturamento.", "summary": "Planejar uma verificação de fraude", "tags": [ "Fraud Check" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" }, "example": { "client_reference": "review-attempt-001", "subject": { "identifiers": [ { "type": "email", "value": "applicant@example.com" } ], "attributes": { "first_name": "Alex", "last_name": "Example" } }, "checks": { "include": [ "networks_same_org", "networks_cross_org", "email_risk" ] } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/FraudCheckRequestRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudCheckPlan" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FraudBadRequestErrorMessage" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.fraud_checks.plan(\n client_reference=\"review-attempt-001\",\n subject={\n \"identifiers\": [{\n \"type\": \"email\",\n \"value\": \"applicant@example.com\",\n }],\n \"attributes\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Example\",\n },\n },\n checks={\n \"include\": [\"networks_same_org\", \"networks_cross_org\", \"email_risk\"],\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.fraudChecks.plan({\n client_reference: \"review-attempt-001\",\n subject: {\n identifiers: [{\n type: \"email\",\n value: \"applicant@example.com\",\n }],\n attributes: {\n first_name: \"Alex\",\n last_name: \"Example\",\n },\n },\n checks: {\n include: [\"networks_same_org\", \"networks_cross_org\", \"email_risk\"],\n },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.FraudChecks.Plan(ctx, didit.FraudCheckRequestRequest{\n\tClientReference: didit.String(\"review-attempt-001\"),\n\tSubject: didit.FraudCheckSubjectRequest{\n\t\tIdentifiers: []didit.FraudCheckIdentifierRequest{{\n\t\t\tType: didit.FraudTypeEnum(\"email\"),\n\t\t\tValue: \"applicant@example.com\",\n\t\t}},\n\t\tAttributes: didit.Some(didit.FraudCheckAttributesRequest{\n\t\t\tFirstName: didit.String(\"Alex\"),\n\t\t\tLastName: didit.String(\"Example\"),\n\t\t}),\n\t},\n\tChecks: didit.Some(didit.FraudCheckModuleSelectionRequest{\n\t\tInclude: didit.Some([]didit.FraudExcludeEnum{didit.FraudExcludeEnum(\"networks_same_org\"), didit.FraudExcludeEnum(\"networks_cross_org\"), didit.FraudExcludeEnum(\"email_risk\")}),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.FraudCheckAttributesRequest;\nimport me.didit.types.FraudCheckIdentifierRequest;\nimport me.didit.types.FraudCheckModuleSelectionRequest;\nimport me.didit.types.FraudCheckRequestRequest;\nimport me.didit.types.FraudCheckSubjectRequest;\nimport me.didit.types.FraudExcludeEnum;\nimport me.didit.types.FraudTypeEnum;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.fraudChecks().plan(FraudCheckRequestRequest.builder()\n .clientReference(\"review-attempt-001\")\n .subject(FraudCheckSubjectRequest.builder()\n .identifiers(List.of(FraudCheckIdentifierRequest.builder()\n .type(FraudTypeEnum.of(\"email\"))\n .value(\"applicant@example.com\")\n .build()))\n .attributes(FraudCheckAttributesRequest.builder()\n .firstName(\"Alex\")\n .lastName(\"Example\")\n .build())\n .build())\n .checks(FraudCheckModuleSelectionRequest.builder()\n .include(List.of(FraudExcludeEnum.of(\"networks_same_org\"), FraudExcludeEnum.of(\"networks_cross_org\"), FraudExcludeEnum.of(\"email_risk\")))\n .build())\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "fraudChecks->plan([\n 'client_reference' => 'review-attempt-001',\n 'subject' => [\n 'identifiers' => [[\n 'type' => 'email',\n 'value' => 'applicant@example.com',\n ]],\n 'attributes' => [\n 'first_name' => 'Alex',\n 'last_name' => 'Example',\n ],\n ],\n 'checks' => [\n 'include' => ['networks_same_org', 'networks_cross_org', 'email_risk'],\n ],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.fraud_checks.plan(\n client_reference: \"review-attempt-001\",\n subject: {\n identifiers: [{\n type: \"email\",\n value: \"applicant@example.com\",\n }],\n attributes: {\n first_name: \"Alex\",\n last_name: \"Example\",\n },\n },\n checks: {\n include: [\"networks_same_org\", \"networks_cross_org\", \"email_risk\"],\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.FraudChecks.PlanAsync(new FraudCheckRequestRequest\n{\n ClientReference = \"review-attempt-001\",\n Subject = new()\n {\n Identifiers = new FraudCheckIdentifierRequest[]\n {\n new()\n {\n Type = \"email\",\n Value = \"applicant@example.com\",\n },\n },\n Attributes = new FraudCheckAttributesRequest\n {\n FirstName = \"Alex\",\n LastName = \"Example\",\n },\n },\n Checks = new FraudCheckModuleSelectionRequest\n {\n Include = new FraudExcludeEnum[] { \"networks_same_org\", \"networks_cross_org\", \"email_risk\" },\n },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/": { "get": { "summary": "Listar regras de roteamento", "description": "Requer `list:cases` para a aplicação solicitada.", "operationId": "list_case_routing_rules", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "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": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseRoutingRule" } }, "count": { "type": "integer", "description": "Contagem de correspondências, limitada a 100. Siga next para continuar além do limite." }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true } } } } } }, "400": { "description": "Entrada inválida." }, "403": { "description": "Permissão insuficiente." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nfor item in client.cases.routing_rules.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nfor await (const item of didit.cases.routingRules.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Cases.RoutingRules.ListAutoPaging(ctx, didit.CasesRoutingRulesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nfor (var item : client.cases().routingRules().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.cases.routing_rules.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Cases.RoutingRules.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] }, "post": { "summary": "Criar regra de roteamento", "description": "Requer `write:cases` para a aplicação solicitada. Defina publish=false para criar um rascunho não publicado; a publicação cria sua primeira versão ativa. Descartar um rascunho que nunca foi publicado o exclui.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." } ], "responses": { "201": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRule" } } } }, "400": { "description": "Entrada inválida." }, "403": { "description": "Permissão insuficiente." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingRuleCreate" }, "example": { "name": "AML screening alerts", "conditions": [ { "field": "source", "operator": "equals", "value": "AML_SCREENING" } ], "blueprint": "b1de0000-0000-4000-8000-000000000002" } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.create(\n name=\"AML screening alerts\",\n conditions=[{\n \"field\": \"source\",\n \"operator\": \"equals\",\n \"value\": \"AML_SCREENING\",\n }],\n blueprint=\"b1de0000-0000-4000-8000-000000000002\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.create({\n name: \"AML screening alerts\",\n conditions: [{\n field: \"source\",\n operator: \"equals\",\n value: \"AML_SCREENING\",\n }],\n blueprint: \"b1de0000-0000-4000-8000-000000000002\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.Create(ctx, didit.CaseRoutingRuleCreate{\n\tName: \"AML screening alerts\",\n\tConditions: []didit.CaseRoutingConditionParam{{\n\t\tField: \"source\",\n\t\tOperator: \"equals\",\n\t\tValue: \"AML_SCREENING\",\n\t}},\n\tBlueprint: \"b1de0000-0000-4000-8000-000000000002\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.CaseRoutingCondition;\nimport me.didit.types.CaseRoutingRuleCreate;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().create(CaseRoutingRuleCreate.builder()\n .name(\"AML screening alerts\")\n .conditions(List.of(CaseRoutingCondition.builder()\n .field(CaseRoutingCondition.Field.of(\"source\"))\n .operator(CaseRoutingCondition.Operator.of(\"equals\"))\n .value(CaseRoutingCondition.Value.ofString(\"AML_SCREENING\"))\n .build()))\n .blueprint(\"b1de0000-0000-4000-8000-000000000002\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->create([\n 'name' => 'AML screening alerts',\n 'conditions' => [[\n 'field' => 'source',\n 'operator' => 'equals',\n 'value' => 'AML_SCREENING',\n ]],\n 'blueprint' => 'b1de0000-0000-4000-8000-000000000002',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.create(\n name: \"AML screening alerts\",\n conditions: [{\n field: \"source\",\n operator: \"equals\",\n value: \"AML_SCREENING\",\n }],\n blueprint: \"b1de0000-0000-4000-8000-000000000002\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.CreateAsync(new CaseRoutingRuleCreate\n{\n Name = \"AML screening alerts\",\n Conditions = new CaseRoutingCondition[]\n {\n new()\n {\n Field = \"source\",\n Operator = \"equals\",\n Value = \"AML_SCREENING\",\n },\n },\n Blueprint = \"b1de0000-0000-4000-8000-000000000002\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/publish/": { "post": { "operationId": "publish_case_routing_rule", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "publish", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "record_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Assignment" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftPreconditionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftPreconditionRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftPreconditionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationCaseRoutingRule" } } }, "description": "" }, "403": { "description": "É necessário ter acesso a casos." }, "409": { "description": "A versão publicada ou a revisão do rascunho mudou. Recarregue antes de tentar novamente." } }, "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": "A versão publicada ou a revisão de rascunho salva foi alterada. Recarregue antes de tentar novamente." }, "403": { "description": "Falta a permissão de caso necessária." } }, "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": "A requisição ou o caso não está disponível para este solicitante." }, "403": { "description": "O chamador não tem a permissão de casos necessária." }, "400": { "description": "Entradas inválidas, finalidade não suportada, contato verificado indisponível ou uma resposta imutável já existente." }, "409": { "description": "A prévia mudou ou expirou. Gere a prévia novamente antes de confirmar." } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Renderiza o e-mail de produção sem enviá-lo nem alterar o caso. Retorna exatamente o destinatário, o remetente, o assunto, o corpo e um preview_token assinado. Envie os mesmos contact_id, purpose, language, request_id, expires_at e preview_token para confirmar em até 15 minutos.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.requests.preview(\n \"11111111-2222-3333-4444-555555555555\",\n contact_id=\"11111111-2222-3333-4444-555555555555\",\n purpose=\"identity_document\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.requests.preview(\"11111111-2222-3333-4444-555555555555\", {\n contact_id: \"11111111-2222-3333-4444-555555555555\",\n purpose: \"identity_document\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Requests.Preview(ctx, \"11111111-2222-3333-4444-555555555555\", didit.CustomerMessagingCaseRequestPreviewRequest{\n\tContactID: \"11111111-2222-3333-4444-555555555555\",\n\tPurpose: didit.CustomerMessagingPurposeEnum(\"identity_document\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CustomerMessagingCaseRequestPreviewRequest;\nimport me.didit.types.CustomerMessagingPurposeEnum;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().requests().preview(\"11111111-2222-3333-4444-555555555555\", CustomerMessagingCaseRequestPreviewRequest.builder()\n .contactId(\"11111111-2222-3333-4444-555555555555\")\n .purpose(CustomerMessagingPurposeEnum.of(\"identity_document\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->requests->preview('11111111-2222-3333-4444-555555555555', [\n 'contact_id' => '11111111-2222-3333-4444-555555555555',\n 'purpose' => 'identity_document',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.requests.preview(\n \"11111111-2222-3333-4444-555555555555\",\n contact_id: \"11111111-2222-3333-4444-555555555555\",\n purpose: \"identity_document\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Requests.PreviewAsync(\"11111111-2222-3333-4444-555555555555\", new CustomerMessagingCaseRequestPreviewRequest\n{\n ContactId = \"11111111-2222-3333-4444-555555555555\",\n Purpose = \"identity_document\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/action-receipts/": { "get": { "operationId": "action_receipts_retrieve", "x-didit-sdk": { "resource": "cases", "method": "list_action_receipts", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "offset", "schema": { "type": "integer", "maximum": 1000000, "minimum": 0, "default": 0 } } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseActionCaseActionReceiptPage" } } }, "description": "" } }, "security": [ { "ApiKeyAuth": [] } ], "description": "Lista os recibos de ações sobre o titular, dos mais recentes para os mais antigos, com no máximo 20 resultados por página. Use next_offset para obter a próxima página. O texto da nota enviada não é exposto no histórico.", "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": "Excluir sua nota de rede", "description": "Requer write:networks e que o usuário autenticado seja o autor da nota. A exclusão é irreversível. Os dados de contas e verificações conectados não são afetados.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da rede." }, { "name": "note_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Token de acesso de usuário do console no formato Bearer ." } ], "responses": { "204": { "description": "Nota excluída." }, "401": { "description": "A autenticação é obrigatória." }, "403": { "description": "Permissão ou acesso a Networks ausente." }, "404": { "description": "A rede ou a nota não está visível para esta aplicação." } }, "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": "Tenta novamente apenas esta ação de sujeito que falhou, usando as entradas salvas. A permissão de escrita atual é verificada. Ações já aplicadas retornam seu comprovante sem serem executadas novamente. O encerramento do caso é independente.", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.retry_action_receipt(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.retryActionReceipt(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RetryActionReceipt(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().retryActionReceipt(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->retryActionReceipt('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.retry_action_receipt(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RetryActionReceiptAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/draft/": { "get": { "operationId": "get_case_blueprint_draft", "x-didit-sdk": { "resource": "cases.blueprints", "method": "retrieve_draft", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "blueprint_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationPolicyDraftResponse" } } }, "description": "" }, "403": { "description": "Falta a permissão de caso necessária." } }, "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": "A versão publicada ou a revisão de rascunho salva foi alterada. Recarregue antes de tentar novamente." }, "403": { "description": "Falta a permissão de caso necessária." } }, "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": "Sem corpo de resposta" }, "409": { "description": "A versão publicada ou a revisão de rascunho salva foi alterada. Recarregue antes de tentar novamente." }, "403": { "description": "Falta a permissão de caso necessária." } }, "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": "Obter equipe de revisão", "description": "Requer `read:cases` para a aplicação solicitada.", "operationId": "retrieve_case_teams", "x-didit-sdk": { "resource": "cases.teams", "method": "retrieve", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "record_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeam" } } } }, "400": { "description": "Entrada inválida." }, "403": { "description": "Permissão insuficiente." }, "404": { "description": "Registro não encontrado nesta aplicação." } }, "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": "Atualizar equipe de revisão", "description": "Requer `write:cases` para a aplicação solicitada.", "operationId": "update_case_teams", "x-didit-sdk": { "resource": "cases.teams", "method": "update", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "record_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseReviewTeam" } } } }, "400": { "description": "Entrada inválida." }, "403": { "description": "Permissão insuficiente." }, "404": { "description": "Registro não encontrado nesta aplicação." } }, "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": "Baixar um relatório de evidências da rede", "description": "Baixe um PDF da rede atual da organização, com suas conexões de contas observadas, referências de sinais e status de revisão. Requer read:networks. A inteligência global e as notas privadas de analistas não são incluídas. Cada lista de contas e de sinais é limitada a 500 entradas, e o relatório informa quando está incompleto. A requisição não altera o status da rede. Os erros são retornados como JSON.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da rede." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Token de acesso de usuário do console no formato Bearer ." } ], "responses": { "200": { "description": "Relatório de evidências da rede. Cache-Control: no-store.", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "A autenticação é obrigatória." }, "403": { "description": "Permissão ou acesso a Networks ausente." }, "404": { "description": "A rede ou a nota não está visível para esta aplicação." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\nclient = Didit()\n\ncontent = client.networks.download_report(\n \"11111111-2222-3333-4444-555555555555\",\n extra_headers={\"Authorization\": \"Bearer YOUR_CONSOLE_USER_TOKEN\"},\n)\nwith open(\"download.pdf\", \"wb\") as file:\n file.write(content)" }, { "lang": "javascript", "label": "Node.js", "source": "import { writeFile } from \"node:fs/promises\";\nimport Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nconst didit = new Didit({\n fetch: (url, init) => {\n const headers = new Headers(init?.headers);\n headers.set(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\");\n return fetch(url, { ...init, headers });\n },\n});\n\nconst content = await didit.networks.downloadReport(\"11111111-2222-3333-4444-555555555555\");\nawait writeFile(\"download.pdf\", Buffer.from(await content.arrayBuffer()));" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nclient := didit.NewClient()\n\nresp, err := client.Networks.DownloadReport(ctx, \"11111111-2222-3333-4444-555555555555\", didit.NetworksDownloadReportParams{\n\tAuthorization: \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.core.RequestOptions;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nDidit client = new Didit();\n\nclient.networks().downloadReport(\"11111111-2222-3333-4444-555555555555\", RequestOptions.builder()\n .header(\"Authorization\", \"Bearer YOUR_CONSOLE_USER_TOKEN\")\n .build())\n .writeTo(Path.of(\"download.pdf\"));" }, { "lang": "php", "label": "PHP", "source": "networks->downloadReport('11111111-2222-3333-4444-555555555555', [\n 'authorization' => 'Bearer YOUR_CONSOLE_USER_TOKEN',\n]);\n$content->saveTo('download.pdf');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\n# Also needs a console user's access token.\ndidit = Didit::Client.new\n\ncontent = didit.networks.download_report(\n \"11111111-2222-3333-4444-555555555555\",\n request_options: { extra_headers: { \"Authorization\" => \"Bearer YOUR_CONSOLE_USER_TOKEN\" } }\n)\nFile.binwrite(\"download.pdf\", content)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\n// Also needs a console user's access token.\nusing var client = new DiditClient();\n\nvar content = await client.Networks.DownloadReportAsync(\"11111111-2222-3333-4444-555555555555\", requestOptions: new RequestOptions\n{\n Headers = new Dictionary\n {\n [\"Authorization\"] = \"Bearer YOUR_CONSOLE_USER_TOKEN\",\n },\n});\nawait content.SaveToAsync(\"download.pdf\");" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/notes/": { "get": { "operationId": "list_network_notes", "x-didit-sdk": { "resource": "networks.notes", "method": "list", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Networks" ], "summary": "Listar notas privadas da rede", "description": "Usuários do console com read:networks podem ler as notas de uma rede visível para a aplicação. As notas permanecem dentro da organização e não são compartilhadas com a inteligência coletiva. As notas mais recentes aparecem primeiro.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da rede." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Token de acesso de usuário do console no formato Bearer ." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 30 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 1000000, "default": 0 } } ], "responses": { "200": { "description": "Uma página de notas. A contagem é limitada a 100; use next para continuar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkNote" } } } } } } }, "401": { "description": "A autenticação é obrigatória." }, "403": { "description": "Permissão ou acesso a Networks ausente." }, "404": { "description": "A rede ou a nota não está visível para esta aplicação." } }, "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": "Adicionar uma nota privada à rede", "description": "Requer um usuário do console com write:networks. O autor é atribuído a partir do usuário autenticado. Forneça um novo client_reference UUID aleatório para cada nota; após uma resposta incerta, tente novamente com o mesmo corpo e a mesma referência para evitar duplicatas. Reutilizar uma referência com outro corpo, autor ou rede retorna 409. Quando redes são mescladas, as notas acompanham a investigação que permanece.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da rede." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Token de acesso de usuário do console no formato Bearer ." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "comment", "client_reference" ], "properties": { "comment": { "type": "string", "minLength": 1, "maxLength": 10000 }, "client_reference": { "type": "string", "format": "uuid" } } } } } }, "responses": { "201": { "description": "Nota privada salva.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkNote" } } } }, "200": { "description": "Nota privada salva.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkNote" } } } }, "400": { "description": "Nota inválida ou em branco." }, "409": { "description": "A referência já foi usada para outra nota." }, "401": { "description": "A autenticação é obrigatória." }, "403": { "description": "Permissão ou acesso a Networks ausente." }, "404": { "description": "A rede ou a nota não está visível para esta aplicação." } }, "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": "É necessário ter acesso a casos." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.retrieve_draft(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.retrieveDraft(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.RetrieveDraft(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().retrieveDraft(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->retrieveDraft('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.retrieve_draft(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.RetrieveDraftAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] }, "put": { "operationId": "save_case_routing_rule_draft", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "save_draft", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "record_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "Case Assignment" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftWriteRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftWriteRequest" }, "example": { "expected_version": 1, "expected_revision": "4e5f0000-0000-4000-8000-000000000003", "changes": { "priority": 10 } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraftWriteRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPublicationPolicyDraft" } } }, "description": "" }, "403": { "description": "É necessário ter acesso a casos." }, "409": { "description": "A versão publicada ou a revisão do rascunho mudou. Recarregue antes de tentar novamente." } }, "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": "Sem corpo de resposta" }, "403": { "description": "É necessário ter acesso a casos." }, "409": { "description": "A versão publicada ou a revisão do rascunho mudou. Recarregue antes de tentar novamente." } }, "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": "Revise os casos existentes de um titular ou de um registro de origem próprio antes de criar um caso manualmente. São retornadas tanto as investigações abertas quanto as resolvidas. Cada página contém no máximo 20 casos; use next_offset para solicitar outra 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": "Testar o roteamento de casos", "description": "Requer `read:cases` para a aplicação solicitada. Avalia as regras atuais ou um rascunho fornecido com base no acesso, na disponibilidade, nas habilidades e na capacidade atuais dos revisores. Não salva o rascunho nem reserva capacidade dos revisores.", "operationId": "preview_case_routing", "x-didit-sdk": { "resource": "cases.routing_rules", "method": "preview", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingPreview" } } } }, "400": { "description": "Entrada inválida." }, "403": { "description": "Permissão insuficiente." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRoutingPreviewRequest" } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.routing_rules.preview(\n source=\"MANUAL\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.routingRules.preview({\n source: \"MANUAL\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RoutingRules.Preview(ctx, didit.CaseRoutingPreviewRequest{\n\tSource: \"MANUAL\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.CaseRoutingPreviewRequest;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().routingRules().preview(CaseRoutingPreviewRequest.builder()\n .source(CaseRoutingPreviewRequest.Source.of(\"MANUAL\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->routingRules->preview([\n 'source' => 'MANUAL',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.routing_rules.preview(source: \"MANUAL\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.RoutingRules.PreviewAsync(new CaseRoutingPreviewRequest\n{\n Source = \"MANUAL\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/reviewers/": { "get": { "summary": "Listar revisores elegíveis para o caso", "description": "Requer `list:cases` para a aplicação solicitada.", "operationId": "list_case_reviewers", "x-didit-sdk": { "resource": "cases", "method": "list_reviewers", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Case Assignment" ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." } ], "responses": { "200": { "description": "Sucesso", "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 inválida." }, "403": { "description": "Permissão insuficiente." }, "503": { "description": "Não foi possível verificar o acesso do revisor. Tente novamente mais tarde." } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.list_reviewers()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.listReviewers();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.ListReviewers(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().listReviewers();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->listReviewers();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.list_reviewers\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.ListReviewersAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/history/": { "get": { "operationId": "list_case_blueprint_history", "x-didit-sdk": { "resource": "cases.blueprints", "method": "list_history", "auth": "api_key", "server": true, "scope": "application" }, "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "path", "name": "blueprint_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "name": "ordering", "required": false, "in": "query", "description": "Qual campo usar para ordenar os resultados.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Número de resultados a retornar por página.", "schema": { "type": "integer" } }, { "name": "offset", "required": false, "in": "query", "description": "O índice inicial a partir do qual os resultados são retornados.", "schema": { "type": "integer" } } ], "tags": [ "Case Management" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CasePublicationPaginatedPolicyRevisionList" } } }, "description": "" }, "403": { "description": "Falta a permissão de caso necessária." } }, "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": "Baixar um documento assinado", "description": "Baixe o PDF assinado de um documento de uma etapa de Assinatura eletrônica. Use o caminho `signed_file` de `signatures[].documents[]` na decisão. O PDF contém o documento exibido ao signatário, com os valores dos campos dele aplicados, e a página de evidências (a menos que `signature_evidence_page` esteja desativado). Um PDF Advanced (AES) também traz a assinatura PAdES com seu carimbo de data/hora; um PDF Simple não tem assinatura digital, selo nem carimbo de data/hora. A Didit confere o arquivo com `sha256_signed` antes de retorná-lo.\n\nFunciona para sessões de Verificação de usuários (KYC) e Verificação de empresas (KYB). Requer `read:sessions`; sua chave de API funciona. Consulte o [relatório de Assinatura eletrônica](/pt-br/core-technology/electronic-signature/report-electronic-signature#baixar-os-documentos-assinados).", "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": "A sessão de Verificação de usuários (KYC) ou de Verificação de empresas (KYB).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "nodeId", "in": "path", "required": true, "description": "A etapa de Assinatura eletrônica: `node_id` do item em `signatures[]`.", "schema": { "type": "string", "example": "feature_signature" } }, { "name": "documentId", "in": "path", "required": true, "description": "`id` do documento em `signatures[].documents[]`.", "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "O PDF assinado.", "headers": { "Content-Disposition": { "description": "Anexo com o nome do arquivo.", "schema": { "type": "string", "example": "attachment; filename=\"agreement-signed.pdf\"" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Credenciais ausentes, ou uma credencial que não pode ler esta sessão. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada 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": "Nenhum documento assinado corresponde: a sessão, a etapa ou o documento não existe, foi excluído ou ainda não foi assinado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Not signed yet": { "summary": "O signatário não assinou", "value": { "code": "signature_not_signed", "detail": "signature_not_signed" } }, "Unknown document": { "summary": "Documento não encontrado nesta etapa", "value": { "code": "signature_not_found", "detail": "signature_not_found" } } } } } }, "409": { "description": "O arquivo armazenado não corresponde mais ao SHA-256 registrado. Nada é retornado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Changed file": { "summary": "O arquivo armazenado não corresponde ao 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": "Baixar a evidência da assinatura", "description": "Baixe o PDF de evidências de um signatário: o nível e o formato, o signatário, o endereço IP, cada documento com seu SHA-256 original e os valores dos campos e o SHA-256 de cada arquivo assinado, além de, para uma assinatura Advanced (AES), a sessão de identidade verificada, a confirmação do código, o certificado e o carimbo de data/hora. Use o caminho `evidence_file` do item do signatário em `signatures[]`.\n\nSempre informe `signature_id` quando uma etapa de Verificação de empresas tiver vários signatários: sem ele, a rota escolhe um dos signatários da etapa. Requer `read:sessions`; sua chave de 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": "A sessão de Verificação de usuários (KYC) ou de Verificação de empresas (KYB).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "nodeId", "in": "path", "required": true, "description": "A etapa de Assinatura eletrônica: `node_id` do item em `signatures[]`.", "schema": { "type": "string", "example": "feature_signature" } }, { "name": "signature_id", "in": "query", "required": false, "description": "`id` do item do signatário em `signatures[]`.", "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "O PDF de evidências.", "headers": { "Content-Disposition": { "description": "Anexo com o nome do arquivo.", "schema": { "type": "string", "example": "attachment; filename=\"signature-evidence.pdf\"" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Credenciais ausentes, ou uma credencial que não pode ler esta sessão. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada 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": "Nenhuma evidência corresponde: a sessão, a etapa ou o signatário não existe, foi excluído ou ainda não assinou.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Not signed yet": { "summary": "O signatário não assinou", "value": { "code": "signature_not_signed", "detail": "signature_not_signed" } }, "Unknown signer": { "summary": "Assinatura não encontrada nesta etapa", "value": { "code": "signature_not_found", "detail": "signature_not_found" } } } } } }, "409": { "description": "O arquivo armazenado não corresponde mais ao SHA-256 registrado. Nada é retornado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Changed file": { "summary": "O arquivo armazenado não corresponde ao 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": "Baixar a imagem de uma assinatura", "description": "Baixe, em PNG, a assinatura ou as iniciais que um signatário aplicou a um campo. Use o `image_url` do campo em `signatures[].documents[].fields[]`. Requer `read:sessions`; sua chave de 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": "A sessão de Verificação de usuários (KYC) ou de Verificação de empresas (KYB).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "nodeId", "in": "path", "required": true, "description": "A etapa de Assinatura eletrônica: `node_id` do item em `signatures[]`.", "schema": { "type": "string", "example": "feature_signature" } }, { "name": "fieldId", "in": "path", "required": true, "description": "O campo na cópia deste signatário, como no `image_url` do campo.", "schema": { "type": "string", "format": "uuid" } } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "A imagem.", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "A imagem armazenada não corresponde mais ao SHA-256 registrado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "example": { "code": "signature_document_changed", "detail": "signature_document_changed" } } } }, "403": { "description": "Credenciais ausentes, ou uma credencial que não pode ler esta sessão. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada 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": "Nenhuma imagem corresponde: a sessão, a etapa ou o campo não existe, foi excluído ou não tem assinatura ou rubrica aplicada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Unknown field": { "summary": "Campo não encontrado", "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": "Validar assinaturas novamente", "description": "Verifica novamente os documentos assinados de uma etapa de Assinatura eletrônica. A Didit relê cada PDF assinado, confere o SHA-256 e, no caso de uma assinatura Avançada (AES), valida a assinatura PAdES, o certificado, os dados de revogação e o carimbo de tempo (uma assinatura Simples não tem assinatura digital, então apenas a integridade do arquivo é verificada). Em seguida, salva o resultado no `validation` de cada signatário e retorna os itens atualizados. Nada é assinado novamente. Envie `signature_id` para verificar um único signatário; sem ele, todos os signatários da etapa são verificados, e a chamada falha se algum deles não tiver assinado.\n\nRequer `write:sessions`; sua chave de API funciona. No console, corresponde ao botão **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": "A sessão de Verificação de usuários (KYC) ou de Verificação de empresas (KYB).", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "nodeId", "in": "path", "required": true, "description": "A etapa de Assinatura eletrônica: `node_id` do item em `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` do item de um signatário em `signatures[]`." } } }, "example": { "signature_id": "0e6c2a8e-6c2f-4b8e-9a51-3f2f6a7d9b10" } } } }, "responses": { "200": { "description": "Os signatários verificados, com sua `validation` atualizada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "signatures": { "type": "array", "items": { "$ref": "#/components/schemas/SignatureResult" } } } } } } }, "400": { "description": "Um PDF assinado armazenado não corresponde mais ao SHA-256 registrado quando ele foi assinado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Document changed": { "summary": "Um arquivo assinado não corresponde mais ao seu hash", "value": { "code": "signature_document_changed", "detail": "signature_document_changed" } } } } } }, "403": { "description": "Credenciais ausentes, ou uma credencial que não pode ler esta sessão. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada 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": "Nenhuma assinatura corresponde: a sessão, a etapa ou o signatário não existe ou foi excluído.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Unknown signer": { "summary": "Assinatura não encontrada nesta etapa", "value": { "code": "signature_not_found", "detail": "signature_not_found" } } } } } }, "409": { "description": "Um signatário da etapa não assinou, então não há nada para validar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "examples": { "Not signed": { "summary": "Um signatário ainda não assinou", "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": "Atualizar um documento do Document AI", "description": "Corrija os campos que o Document AI extraiu de um documento enviado, defina seu status de revisão, ou ambos, em uma sessão de KYC ou KYB. `extracted_data` deve ser um objeto JSON e é mesclado chave por chave: uma chave que você envia substitui o valor armazenado (uma chave enviada como `null` é armazenada como `null`) e as chaves que você omite mantêm seus valores. O status do documento alimenta o resultado do Document AI do nó correspondente do fluxo na decisão da sessão; o status da sessão em si não é recalculado. Toda chamada bem-sucedida, inclusive uma que não altera nada, envia um [webhook](https://docs.didit.me/pt-br/integration/webhooks) `data.updated` com o gatilho `manual_review`. Uma chave de API com escopo precisa de `decisions: write`; consulte [Document AI](https://docs.didit.me/pt-br/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 da sessão de verificação (o `session_id` retornado por `POST /v3/session/`). Aceita IDs de sessão tanto de Verificação de usuários (KYC) quanto de Verificação de empresas (KYB): o servidor resolve o ID entre os dois tipos de sessão. Deve ser um UUID bem formado; um valor malformado não corresponde à rota e retorna um `404` em HTML.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "documentUuid", "in": "path", "required": true, "description": "UUID do documento do Document AI (`document_ai_documents[].items[].uuid` em `GET /v3/session/{sessionId}/decision/`). Ele deve pertencer à sessão indicada no caminho.", "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": "Chaves de campo (as chaves que você configurou para o documento) e seus valores corrigidos. Deve ser um objeto JSON; mesclado chave por chave nos dados armazenados. Omita-o em vez de enviar `null`, que retorna `400`.", "example": { "invoice_number": "INV-2026-0042" } }, "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Not Finished" ], "description": "Novo status de revisão do documento.", "example": "Approved" } } }, "example": { "extracted_data": { "invoice_number": "INV-2026-0042" }, "status": "Approved" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/document-ai/11111111-2222-3333-4444-555555555555/documents/44444444-5555-6666-7777-888888888888/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"extracted_data\": {\"invoice_number\": \"INV-2026-0042\"}, \"status\": \"Approved\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_document_ai_data(\n \"11111111-2222-3333-4444-555555555555\",\n \"44444444-5555-6666-7777-888888888888\",\n extracted_data={\"invoice_number\": \"INV-2026-0042\"},\n status=\"Approved\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateDocumentAiData(\n \"11111111-2222-3333-4444-555555555555\",\n \"44444444-5555-6666-7777-888888888888\",\n {\n extracted_data: { invoice_number: \"INV-2026-0042\" },\n status: \"Approved\",\n },\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateDocumentAiData(ctx, \"11111111-2222-3333-4444-555555555555\", \"44444444-5555-6666-7777-888888888888\", didit.SessionsUpdateDocumentAiDataParams{\n\tExtractedData: didit.Some(map[string]any{\"invoice_number\": \"INV-2026-0042\"}),\n\tStatus: didit.Some(didit.SessionsUpdateDocumentAiDataParamsStatus(\"Approved\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SessionsUpdateDocumentAiDataParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateDocumentAiData(\"11111111-2222-3333-4444-555555555555\", \"44444444-5555-6666-7777-888888888888\", SessionsUpdateDocumentAiDataParams.builder()\n .extractedData(Map.of(\"invoice_number\", \"INV-2026-0042\"))\n .status(SessionsUpdateDocumentAiDataParams.Status.of(\"Approved\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateDocumentAiData('11111111-2222-3333-4444-555555555555', '44444444-5555-6666-7777-888888888888', [\n 'extracted_data' => ['invoice_number' => 'INV-2026-0042'],\n 'status' => 'Approved',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_document_ai_data(\n \"11111111-2222-3333-4444-555555555555\",\n \"44444444-5555-6666-7777-888888888888\",\n extracted_data: { invoice_number: \"INV-2026-0042\" },\n status: \"Approved\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateDocumentAiDataAsync(\"11111111-2222-3333-4444-555555555555\", \"44444444-5555-6666-7777-888888888888\", new SessionsUpdateDocumentAiDataParams\n{\n ExtractedData = new Dictionary { [\"invoice_number\"] = \"INV-2026-0042\" },\n Status = new SessionsUpdateDocumentAiDataParamsStatus(\"Approved\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Documento atualizado. Retorna o documento após a mesclagem.", "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 do documento." }, "document_key": { "type": "string", "description": "O documento configurado ao qual este upload corresponde." }, "original_filename": { "type": "string", "nullable": true, "description": "Nome do arquivo com o qual o documento foi enviado." }, "file_url": { "type": "string", "nullable": true, "description": "Caminho de armazenamento do arquivo enviado. Não é um link de download: leia o `file_url` pré-assinado na decisão da sessão para baixar o arquivo." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Status de revisão do documento." }, "extracted_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Todos os campos extraídos após a mesclagem, indexados pela chave do campo." } } }, "example": { "uuid": "44444444-5555-6666-7777-888888888888", "document_key": "invoice", "original_filename": "invoice-2026-09.pdf", "file_url": "document_ai/11111111-2222-3333-4444-555555555555-66666666-7777-8888-9999-000000000000.pdf", "status": "Approved", "extracted_data": { "invoice_number": "INV-2026-0042", "total_amount": 1250.0, "issue_date": "2026-09-01" } } } } }, "400": { "description": "Erro de validação, verificado antes da busca do documento: `status` não é um dos valores permitidos, ou `extracted_data` foi enviado como `null`.", "content": { "application/json": { "examples": { "Invalid status": { "summary": "status não está no enum", "value": { "status": [ "\"Rejected\" is not a valid choice." ] } }, "Null extracted_data": { "summary": "extracted_data é null", "value": { "extracted_data": [ "This field may not be null." ] } } } } } }, "401": { "description": "A chave de API com escopo expirou. Este é o único caso que retorna `401`: uma chave ausente, inválida ou revogada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "summary": "A data de validade da chave já passou", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falha de autenticação ou autorização. Uma chave ausente retorna `403`, assim como uma chave de outra aplicação, uma chave com escopo sem a permissão exigida por este endpoint e uma requisição de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada retorna `401`. Diferencie-as pelo `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Missing or invalid credentials": { "summary": "Cabeçalho x-api-key ausente, ou a chave falhou na validação", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Uma chave válida que pertence a uma aplicação diferente da aplicação da sessão", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "Chave com escopo sem decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Requisição de fora da lista de IPs permitidos da chave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "A sessão não existe, foi excluída ou está fora dos limites de uma chave com escopo, ou nenhum documento atual com este UUID pertence a ela. A busca da sessão é feita antes da verificação da credencial, então um `sessionId` desconhecido retorna `404` mesmo sem uma chave válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Unknown session": { "summary": "Não existe nenhuma sessão com este ID, ou ela foi excluída", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "A sessão está fora dos limites de uma chave com escopo (também retornado para uma sessão excluída há instantes)", "value": { "detail": "Session not found." } }, "Unknown document": { "summary": "documentUuid não pertence à sessão", "value": { "detail": "Document AI document not found." } } } } } }, "429": { "description": "Limite de requisições excedido: 300 requisições de escrita (POST, PATCH, DELETE) por minuto por chave de API. Aguarde `Retry-After` segundos antes de tentar novamente; os cabeçalhos `X-RateLimit-*` mostram a cota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Rate limited": { "summary": "Orçamento do minuto atual esgotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/aml/dataset-freshness/": { "get": { "summary": "Obter a atualização do conjunto de dados AML", "description": "Informa o quão atualizados estão os conjuntos de dados por trás da Análise AML, por família de fontes (`sanctions`, `pep`, `warnings`, `adverse_media`), como evidência de auditoria para o [monitoramento AML contínuo](https://docs.didit.me/pt-br/core-technology/aml-screening/continuous-monitoring-aml-screening#comprovando-que-o-monitoramento-rodou). A resposta vale para toda a plataforma: nenhuma sessão no caminho, nenhum dado de cliente no corpo, a mesma resposta para todas as aplicações.\n\nSempre `200` para uma chave aceita. Verifique `availability` primeiro: quando não for `available`, `dataset_freshness` é `null`. As datas nunca são estimadas: uma família cujos conjuntos de dados não informaram nenhuma data fica ausente de `sources`, e uma família em que apenas alguns conjuntos de dados informaram uma data tem `oldest_updated_at: null`. As leituras são feitas enquanto o monitoramento contínuo é executado, não a cada chamada; `captured_at` indica quando.\n\nUma chave de API com escopo precisa de `sessions: read`; uma chave limitada a alguns fluxos ou a sessões aprovadas não pode chamar este endpoint. Nada é cobrado.", "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": "A leitura mais recente de atualização do conjunto de dados, ou `null` com o motivo.", "content": { "application/json": { "schema": { "type": "object", "required": [ "dataset_freshness", "availability" ], "properties": { "dataset_freshness": { "allOf": [ { "$ref": "#/components/schemas/AMLDatasetFreshness" } ], "nullable": true, "description": "A leitura mais recente, ou `null` quando `availability` não é `available`." }, "availability": { "type": "string", "enum": [ "available", "not_configured", "not_yet_collected" ], "description": "`available` quando existe uma leitura; `not_configured` quando as datas dos conjuntos de dados não são coletadas neste ambiente; `not_yet_collected` quando a coleta está configurada, mas ainda não existe nenhuma leitura." } } }, "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": "A chave de API expirou. Somente uma chave criada com data de validade pode expirar; após essa data, toda requisição feita com ela responde `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida. Uma chave ausente recebe a mensagem genérica; uma chave incorreta, revogada ou expirada recebe `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": "Mais de 600 requisições GET por minuto com esta chave de API. Aguarde o número de segundos indicado em `Retry-After` e tente novamente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos até a janela atual de um minuto ser reiniciada.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas por minuto nesta cota.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Horário Unix em que a janela é reiniciada.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/lists/": { "get": { "summary": "Listar listas", "description": "Retorna as listas da aplicação, da mais recente para a mais antiga: as listas do sistema que a Didit provisiona (uma lista de bloqueio por tipo de entrada, a lista personalizada **High Risk Countries** e qualquer lista de permissões do sistema) e as listas de permissões e listas personalizadas que você criou. Filtre com `list_type` e `entry_type`; listas excluídas nunca aparecem. Os resultados são paginados com `limit` e `offset`. Uma chave de API com escopo precisa de `workflows: read`. Consulte [Listas](https://docs.didit.me/pt-br/management-api/lists/overview) para saber o que cada tipo de lista faz.", "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": "Somente listas deste tipo.", "schema": { "type": "string", "enum": [ "blocklist", "allowlist", "custom" ] } }, { "name": "entry_type", "in": "query", "required": false, "description": "Somente listas deste tipo de entrada.", "schema": { "type": "string", "enum": [ "face", "document", "phone", "email", "ip_address", "device_fingerprint", "wallet_address", "bank_account", "country", "user", "business", "key" ] } }, { "name": "ordering", "in": "query", "required": false, "description": "Ordem de classificação: `-created_at` (mais recentes primeiro, o padrão) ou `created_at` (mais antigos primeiro).", "schema": { "type": "string", "enum": [ "-created_at", "created_at" ], "default": "-created_at" } }, { "name": "limit", "in": "query", "required": false, "description": "Tamanho da página. O padrão é 50. Um valor acima de 1000000 retorna `400`; zero, um valor negativo ou não numérico volta para 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 } }, { "name": "offset", "in": "query", "required": false, "description": "Índice, a partir de zero, do primeiro item a retornar. Prefira seguir `next`. Um valor acima de 1000000 retorna `400`; um valor negativo ou não numérico passa a ser 0.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/lists/?list_type=blocklist' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.lists.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.lists.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Lists.ListAutoPaging(ctx, didit.ListsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.lists().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "lists->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.lists.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Lists.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Uma página de listas.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "minimum": 0, "description": "Número total de listas que correspondem aos filtros." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta da próxima página, ou `null` na última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta da página anterior, ou `null` na primeira 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": "Um parâmetro de consulta é inválido.", "content": { "application/json": { "examples": { "Unknown list type": { "value": { "list_type": [ "\"denylist\" is not a valid choice." ] } }, "Unsupported ordering": { "value": { "ordering": [ "\"name\" is not a valid choice." ] } }, "Limit too large": { "value": [ "limit must not exceed 1000000." ] } } } } }, "401": { "description": "A chave de API com escopo expirou. Outras falhas de autenticação retornam `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "O cabeçalho `x-api-key` está ausente (uma chave incorreta, revogada ou expirada recebe `401`), ou uma chave de API com escopo não tem `workflows: read` ou é usada a partir de um endereço IP fora da sua lista de permissões.", "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": "O limite compartilhado de leitura de 600 requisições por minuto por chave de API foi excedido. Respeite `Retry-After` antes de tentar novamente.", "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": "Criar uma lista", "description": "Cria uma lista de permissões ou uma lista personalizada na aplicação à qual a chave de API pertence. Não é possível criar listas de bloqueio: a Didit provisiona uma lista de bloqueio do sistema por tipo de entrada, e você adiciona itens a ela com [Criar uma entrada de lista](https://docs.didit.me/pt-br/management-api/lists/create-entry). O `entry_type` não pode ser alterado após a criação e determina como os valores das entradas são validados e correspondidos. As entradas da lista de permissões marcam os itens correspondentes como confiáveis (por exemplo, uma lista de permissões de rostos ignora a ação de rosto duplicado) e nunca se sobrepõem a uma correspondência na lista de bloqueio; referencie qualquer lista em uma condição de regra de fluxo ou de transação com `value_type: \"list\"`. Uma chave de API com escopo precisa de `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": "Nome da lista. Deve ser diferente do nome de todas as outras listas da aplicação, incluindo as listas do sistema." }, "description": { "type": "string", "default": "", "description": "Descrição opcional em texto livre." }, "list_type": { "type": "string", "enum": [ "allowlist", "custom" ], "description": "`allowlist` ou `custom`. `blocklist` é recusado com `400`." }, "entry_type": { "type": "string", "enum": [ "face", "document", "phone", "email", "ip_address", "device_fingerprint", "wallet_address", "bank_account", "country", "user", "business", "key" ], "description": "O que a lista contém: `face`, `document` (número do documento), `phone`, `email`, `ip_address` (endereço IP ou intervalo CIDR), `device_fingerprint`, `wallet_address`, `bank_account`, `country` (ISO 3166-1 alpha-3), `user` ou `business` (seu `vendor_data`), ou `key` (qualquer string). Define como os valores das entradas são validados e comparados. Não pode ser alterado depois." } } }, "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": "A lista foi criada.", "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": "O corpo é inválido.", "content": { "application/json": { "examples": { "Blocklist refused": { "value": { "list_type": [ "Cannot create additional blocklist lists. System blocklists are auto-created for each application." ] } }, "Duplicate name": { "value": { "name": [ "A list with this name already exists for this application." ] } }, "Missing fields": { "value": { "name": [ "This field is required." ], "list_type": [ "This field is required." ], "entry_type": [ "This field is required." ] } }, "Unknown entry type": { "value": { "entry_type": [ "\"iban\" is not a valid choice." ] } }, "Name too long": { "value": { "name": [ "Ensure this field has no more than 255 characters." ] } } } } } }, "401": { "description": "A chave de API com escopo expirou. Outras falhas de autenticação retornam `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "O cabeçalho `x-api-key` está ausente (uma chave incorreta, revogada ou expirada recebe `401`), ou uma chave de API com escopo não tem `workflows: write` ou é usada a partir de um endereço IP fora da sua lista de permissões.", "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": "Obter uma lista", "description": "Retorna uma lista da aplicação com a contagem de entradas e o momento em que a entrada mais recente foi adicionada. Uma lista de outra aplicação, ou uma lista que foi excluída, retorna `404`. Este endpoint retorna apenas a lista: leia os valores dela com [Listar entradas da lista](https://docs.didit.me/pt-br/management-api/lists/list-entries). Uma chave de API com escopo precisa de `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 da lista, conforme retornado por Listar listas ou Criar uma lista.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.lists.retrieve(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.lists.retrieve(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.lists().retrieve(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "lists->retrieve('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.lists.retrieve(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Lists.RetrieveAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "A lista.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceList" }, "examples": { "System face blocklist": { "value": { "uuid": "11111111-2222-3333-4444-555555555555", "name": "Face Blocklist", "description": "Blocked biometric faces. When a face matching an entry in this list is detected during liveness verification, the session will be automatically declined.", "list_type": "blocklist", "entry_type": "face", "is_system": true, "entry_count": 12, "last_entry_added_at": "2026-10-09T16:42:03.118204Z", "created_at": "2026-01-14T10:02:11.402917Z", "updated_at": "2026-01-14T10:02:11.402917Z" } } } } } }, "401": { "description": "A chave de API com escopo expirou. Outras falhas de autenticação retornam `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "O cabeçalho `x-api-key` está ausente (uma chave incorreta, revogada ou expirada recebe `401`), ou uma chave de API com escopo não tem `workflows: read` ou é usada a partir de um endereço IP fora da sua lista de permissões.", "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": "Não existe nenhuma lista com este UUID na aplicação da chave de API, ou ela foi excluída.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No List matches the given query." } } } } } }, "429": { "description": "O limite compartilhado de leitura de 600 requisições por minuto por chave de API foi excedido. Respeite `Retry-After` antes de tentar novamente.", "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": "Atualizar uma lista", "description": "Renomeia uma lista ou altera sua descrição. Apenas `name` e `description` são lidos; qualquer outro campo é ignorado, portanto `list_type` e `entry_type` mantêm os valores com que foram criados. Listas do sistema não podem ser modificadas e retornam `400`. A resposta contém apenas `name` e `description`: chame [Obter uma lista](https://docs.didit.me/pt-br/management-api/lists/get) para obter a lista completa. Uma chave de API com escopo precisa de `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 da lista, conforme retornado por Listar listas ou Criar uma lista.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Novo nome. Deve ser diferente do nome de todas as outras listas da aplicação." }, "description": { "type": "string", "description": "Nova descrição. Envie uma string vazia para removê-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": "A lista foi atualizada. Apenas os campos editáveis são retornados.", "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "description" ], "properties": { "name": { "type": "string", "description": "O nome da lista após a atualização." }, "description": { "type": "string", "description": "A descrição da lista após a atualização." } } }, "examples": { "Renamed": { "value": { "name": "Trusted office and VPN IPs", "description": "Office egress ranges" } } } } } }, "400": { "description": "A lista é uma lista do sistema, ou o corpo é inválido.", "content": { "application/json": { "examples": { "System list": { "value": { "non_field_errors": [ "System lists cannot be modified." ] } }, "Duplicate name": { "value": { "name": [ "A list with this name already exists for this application." ] } }, "Blank name": { "value": { "name": [ "This field may not be blank." ] } } } } } }, "401": { "description": "A chave de API com escopo expirou. Outras falhas de autenticação retornam `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "O cabeçalho `x-api-key` está ausente (uma chave incorreta, revogada ou expirada recebe `401`), ou uma chave de API com escopo não tem `workflows: write` ou é usada a partir de um endereço IP fora da sua lista de permissões.", "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": "Não existe nenhuma lista com este UUID na aplicação da chave de API, ou ela foi excluída.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No List matches the given query." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "summary": "Excluir uma lista", "description": "Exclui uma lista de permissões ou lista personalizada junto com suas entradas. A exclusão é irreversível: a lista e suas entradas deixam de aparecer em qualquer leitura, e as condições de regras de fluxos e de transações que fazem referência à lista passam a avaliá-la como uma lista vazia. Sessões e transações já avaliadas mantêm seus resultados, e o nome pode ser reutilizado em uma nova lista. Listas do sistema não podem ser excluídas e retornam `400`; para esvaziar uma delas, [exclua suas entradas](https://docs.didit.me/pt-br/management-api/lists/delete-entry). Uma chave de API com escopo precisa de `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 da lista, conforme retornado por Listar listas ou Criar uma lista.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.lists.delete(\n \"11111111-2222-3333-4444-555555555555\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.lists.delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Lists.Delete(ctx, \"11111111-2222-3333-4444-555555555555\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.lists().delete(\"11111111-2222-3333-4444-555555555555\");" }, { "lang": "php", "label": "PHP", "source": "lists->delete('11111111-2222-3333-4444-555555555555');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.lists.delete(\"11111111-2222-3333-4444-555555555555\")" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Lists.DeleteAsync(\"11111111-2222-3333-4444-555555555555\");" } ], "responses": { "204": { "description": "A lista e suas entradas foram excluídas. Sem corpo." }, "400": { "description": "A lista é uma lista do sistema.", "content": { "application/json": { "examples": { "System list": { "value": { "detail": "System lists cannot be deleted." } } } } } }, "401": { "description": "A chave de API com escopo expirou. Outras falhas de autenticação retornam `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "O cabeçalho `x-api-key` está ausente (uma chave incorreta, revogada ou expirada recebe `401`), ou uma chave de API com escopo não tem `workflows: write` ou é usada a partir de um endereço IP fora da sua lista de permissões.", "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": "Não existe nenhuma lista com este UUID na aplicação da chave de API, ou ela já foi excluída.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No List matches the given query." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/lists/{list_uuid}/entries/": { "get": { "summary": "Listar entradas da lista", "description": "Retorna as entradas atuais de uma lista, da mais recente para a mais antiga. `search` corresponde a parte do `value` ou do `display_label` de uma entrada, sem diferenciar maiúsculas de minúsculas, e `reference_session_id` restringe os resultados às entradas obtidas de uma sessão de verificação de pessoa. As URLs de imagem em `metadata` são URLs assinadas de curta duração, emitidas novamente a cada chamada; uma chave de API com escopo sem `media: read` recebe `null` no lugar delas. Uma chave de API com escopo precisa de `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 da lista, conforme retornado por Listar listas ou Criar uma lista.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "search", "in": "query", "required": false, "description": "Texto, sem distinção entre maiúsculas e minúsculas, que o `value` ou o `display_label` da entrada deve conter.", "schema": { "type": "string" } }, { "name": "reference_session_id", "in": "query", "required": false, "description": "Somente as entradas extraídas desta sessão de verificação de pessoa, por exemplo para ver quais de seus rostos já estão listados.", "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "description": "Tamanho da página. O padrão é 50. Um valor acima de 1000000 retorna `400`; zero, um valor negativo ou não numérico volta para 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 } }, { "name": "offset", "in": "query", "required": false, "description": "Índice, a partir de zero, do primeiro item a retornar. Prefira seguir `next`. Um valor acima de 1000000 retorna `400`; um valor negativo ou não numérico passa a ser 0.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/?search=example.com' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.lists.entries.list(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.lists.entries.list(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Lists.Entries.ListAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.lists().entries().list(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "lists->entries->list('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.lists.entries.list(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Lists.Entries.ListAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Uma página de entradas, da mais recente para a mais antiga.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "minimum": 0, "description": "Número total de entradas que correspondem aos filtros." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta da próxima página, ou `null` na última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta da página anterior, ou `null` na primeira 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": "Um parâmetro de consulta é inválido.", "content": { "application/json": { "examples": { "Invalid session id": { "value": { "reference_session_id": [ "Must be a valid UUID." ] } }, "Limit too large": { "value": [ "limit must not exceed 1000000." ] } } } } }, "401": { "description": "A chave de API com escopo expirou. Outras falhas de autenticação retornam `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "O cabeçalho `x-api-key` está ausente (uma chave incorreta, revogada ou expirada recebe `401`), ou uma chave de API com escopo não tem `workflows: read` ou é usada a partir de um endereço IP fora da sua lista de permissões.", "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": "Não existe nenhuma lista com este UUID na aplicação da chave de API, ou ela foi excluída.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "List not found." } } } } } }, "429": { "description": "O limite compartilhado de leitura de 600 requisições por minuto por chave de API foi excedido. Respeite `Retry-After` antes de tentar novamente.", "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": "Criar uma entrada de lista", "description": "Adiciona uma entrada a uma lista, de uma de três formas: por `value`; a partir de uma sessão de verificação com `reference_session_id`, em que a Didit lê o valor do registro mais recente da sessão para o tipo de entrada da lista e vincula a entrada a ele; ou por `value` com um `reference_object_uuid` e `metadata.reference_type` apontando de volta para uma transação, um usuário ou uma empresa. Nas listas de bloqueio do sistema de rostos, documentos, telefones e e-mails, o registro lido da sessão também é marcado como bloqueado, de modo que novas sessões correspondentes são recusadas; nas listas de bloqueio do sistema de usuários e empresas, os usuários ou empresas correspondentes passam para `BLOCKED`. Sessões e transações já concluídas não são alteradas. Uma chave de API com escopo precisa de `workflows: write`. Consulte [Criar uma entrada de lista](https://docs.didit.me/pt-br/management-api/lists/create-entry) para cada modo.", "operationId": "create_list_entry", "x-didit-sdk": { "resource": "lists.entries", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_uuid", "in": "path", "required": true, "description": "UUID da lista à qual adicionar. Para um rosto que você tem apenas como imagem, use Enviar um rosto para uma lista.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Envie `value`, `reference_session_id` ou ambos. Os campos aplicáveis dependem do `entry_type` da lista.", "properties": { "value": { "type": "string", "description": "O valor a ser incluído na lista, validado conforme o `entry_type` da lista: `email`, um endereço de e-mail válido; `phone`, um número internacional válido, armazenado em E.164; `ip_address`, um endereço IP ou intervalo CIDR (por exemplo, `10.0.0.0/8`); `device_fingerprint`, pelo menos 8 caracteres entre letras, dígitos, `-`, `_`, `:` e `.` (uma lista de bloqueio recusa uma impressão digital que vários dispositivos distintos informaram); `country`, um código ISO 3166-1 alfa-2 ou alfa-3, armazenado como alfa-3; `user` e `business`, o `vendor_data`; qualquer outro tipo, uma string não vazia. Armazenado em letras minúsculas, exceto números de telefone e códigos de país, e uma lista contém cada valor uma única vez (sem diferenciar maiúsculas de minúsculas). Obrigatório, a menos que `reference_session_id` seja enviado; deve ficar vazio com um `face_image_source` de captura de documento." }, "reference_session_id": { "type": "string", "format": "uuid", "description": "Uma sessão de verificação de pessoa ou de empresa da sua aplicação da qual o valor será obtido. A Didit lê o registro mais recente da sessão do tipo de entrada da lista (`face`, `document`, `phone`, `email`, `ip_address` ou `device_fingerprint`), vincula a entrada à sessão e a esse registro e preenche `display_label` e `metadata` para documentos. Para uma lista de bloqueio `device_fingerprint`, uma sessão que tenha apenas uma impressão digital de classe de dispositivo, ou que tenha sido concluída em mais de um dispositivo, é recusada: envie a impressão digital exata como `value`. Para outros tipos de entrada, ou quando a sessão não tiver esse registro, envie também `value`; nesse caso, o seu `value` é armazenado e a entrada continua vinculada à sessão." }, "reference_object_uuid": { "type": "string", "format": "uuid", "description": "UUID do registro que a entrada representa quando ela não vem de uma sessão: um UUID de transação, ou o `didit_internal_id` de um usuário ou de uma empresa. Use-o junto com `metadata.reference_type`. É substituído pelo registro da sessão quando `reference_session_id` fornece um." }, "face_image_source": { "type": "string", "enum": [ "liveness", "front_image_camera_front", "back_image_camera_front" ], "default": "liveness", "description": "Em listas de rostos com `reference_session_id`: de qual imagem da sessão o rosto é extraído. `liveness` (padrão) é a selfie de prova de vida. `front_image_camera_front` e `back_image_camera_front` são as selfies que a câmera frontal tirou enquanto o usuário fotografava a frente ou o verso do documento: aceitas apenas na lista de bloqueio facial do sistema, com `reference_session_id` e um `value` vazio. Cada selfie pode ser adicionada uma única vez e deve mostrar um rosto nítido." }, "reference_node_id": { "type": "string", "nullable": true, "maxLength": 100, "description": "Com um `face_image_source` de captura de documento: o nó de verificação de identidade cuja selfie deve ser usada, para fluxos com mais de um. O padrão é a verificação de identidade mais recente que tenha essa imagem. Recusado com `liveness`." }, "display_label": { "type": "string", "maxLength": 512, "description": "Rótulo legível. Quando vazio, a Didit deriva um a partir da sessão, quando possível (por exemplo, o nome do titular e o número do documento)." }, "comment": { "type": "string", "description": "Nota em texto livre, como o motivo da inclusão na lista." }, "metadata": { "type": "object", "additionalProperties": true, "description": "JSON livre armazenado com a entrada e retornado como foi armazenado. Use `reference_type` e `reference_id` para que o console faça o link de volta à origem. `reference_image_url` e `front_image_url` são definidos apenas pela Didit e descartados se você os enviar. Para uma entrada lida de uma sessão, as chaves da Didit são mescladas com as suas.", "properties": { "reference_type": { "type": "string", "enum": [ "transaction", "vendor_user", "vendor_business" ], "description": "Para o que `reference_object_uuid` aponta." }, "reference_id": { "type": "string", "description": "Identificador do registro de origem." } } } } }, "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": "A entrada foi criada.", "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": "O corpo é inválido, o valor já está na lista ou a sessão não pode fornecer o 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": "A chave de API com escopo expirou. Outras falhas de autenticação retornam `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "O cabeçalho `x-api-key` está ausente (uma chave incorreta, revogada ou expirada recebe `401`), ou uma chave de API com escopo não tem `workflows: write` ou é usada a partir de um endereço IP fora da sua lista de permissões.", "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": "Não existe nenhuma lista com este UUID na aplicação da chave de API, ou ela foi excluída.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "List not found." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" }, "503": { "description": "A análise facial de uma selfie de captura de documento está temporariamente indisponível. Nada foi adicionado; tente novamente mais tarde.", "content": { "application/json": { "examples": { "Unavailable": { "value": { "detail": "Service temporarily unavailable. Please try again later." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/lists/{list_uuid}/entries/{entry_uuid}/": { "delete": { "summary": "Excluir uma entrada de lista", "description": "Exclui uma entrada de uma lista, incluindo listas do sistema. A entrada deixa de gerar correspondências imediatamente, e a exclusão é irreversível: para listar o valor novamente, crie uma nova entrada. Em uma lista de bloqueio do sistema de rostos, documentos, telefones ou e-mails, o registro que a entrada representa deixa de ser sinalizado como bloqueado; na lista de bloqueio do sistema de usuários ou de empresas, os usuários ou empresas da aplicação cujo `vendor_data` seja igual ao valor da entrada (ou cujo `didit_internal_id` seja igual ao seu `reference_object_uuid`) e que estejam `BLOCKED` voltam a `ACTIVE`. Sessões e transações já concluídas mantêm seu status. Uma chave de API com escopo precisa de `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 da lista que contém a entrada.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "entry_uuid", "in": "path", "required": true, "description": "UUID da entrada, conforme retornado por Listar entradas da lista ou Criar uma entrada na lista.", "schema": { "type": "string", "format": "uuid" }, "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X DELETE 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.lists.entries.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.lists.entries.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Lists.Entries.Delete(ctx, \"11111111-2222-3333-4444-555555555555\", \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.lists().entries().delete(\"11111111-2222-3333-4444-555555555555\", \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\");" }, { "lang": "php", "label": "PHP", "source": "lists->entries->delete('11111111-2222-3333-4444-555555555555', 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.lists.entries.delete(\n \"11111111-2222-3333-4444-555555555555\",\n \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Lists.Entries.DeleteAsync(\"11111111-2222-3333-4444-555555555555\", \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\");" } ], "responses": { "204": { "description": "A entrada foi excluída. Sem corpo." }, "401": { "description": "A chave de API com escopo expirou. Outras falhas de autenticação retornam `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "O cabeçalho `x-api-key` está ausente (uma chave incorreta, revogada ou expirada recebe `401`), ou uma chave de API com escopo não tem `workflows: write` ou é usada a partir de um endereço IP fora da sua lista de permissões.", "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": "Não existe nenhuma entrada com este UUID nesta lista, a lista não está na aplicação da chave de API ou foi excluída, ou a entrada já foi excluída.", "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": "Enviar um rosto para uma lista", "description": "Adiciona um rosto a uma lista de bloqueio de rostos ou a uma lista de permissão de rostos a partir de uma imagem JPEG ou PNG codificada em base64, para quando você não tem uma sessão de verificação para referenciar. A Didit detecta os rostos na imagem, usa o maior e cria uma entrada cujos `value` e `reference_object_uuid` são o UUID do novo rosto. Um rosto na lista de bloqueio recusa novas sessões cujo rosto corresponda; um rosto na lista de permissão ignora a ação de rosto duplicado e nunca se sobrepõe a uma correspondência na lista de bloqueio. Em uma aplicação de sandbox, a imagem não é analisada e a entrada não corresponde a nada. Uma chave de API com escopo precisa de `workflows: write`. Para incluir na lista um rosto de uma sessão existente, use [Criar uma entrada de lista](https://docs.didit.me/pt-br/management-api/lists/create-entry) com `reference_session_id`.", "operationId": "upload_list_entry_face", "x-didit-sdk": { "resource": "lists.entries", "method": "upload_face", "auth": "api_key", "server": true }, "tags": [ "Lists" ], "parameters": [ { "name": "list_uuid", "in": "path", "required": true, "description": "UUID de uma lista com `entry_type: face` e `list_type: blocklist` ou `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 ou PNG codificado em Base64, com no máximo 2 MB após a decodificação, mostrando um rosto claramente visível. Envie a string base64 pura, sem o prefixo `data:image/...;base64,`." }, "comment": { "type": "string", "default": "", "description": "Nota opcional em texto livre, como o motivo da inclusão na lista." } } }, "examples": { "Face image": { "value": { "image": "/9j/4AAQSkZJRgABAQAAAQABAAD...", "comment": "Known fraud attempt" } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/face-upload/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d \"{\\\"image\\\": \\\"$(base64 < face.jpg | tr -d '\\n')\\\", \\\"comment\\\": \\\"Known fraud attempt\\\"}\"" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.lists.entries.upload_face(\n \"11111111-2222-3333-4444-555555555555\",\n image=\"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n comment=\"Known fraud attempt\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.lists.entries.uploadFace(\"11111111-2222-3333-4444-555555555555\", {\n image: \"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n comment: \"Known fraud attempt\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Entries.UploadFace(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesUploadFaceParams{\n\tImage: \"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n\tComment: didit.String(\"Known fraud attempt\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.ListsEntriesUploadFaceParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.lists().entries().uploadFace(\"11111111-2222-3333-4444-555555555555\", ListsEntriesUploadFaceParams.builder()\n .image(\"/9j/4AAQSkZJRgABAQAAAQABAAD...\")\n .comment(\"Known fraud attempt\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "lists->entries->uploadFace('11111111-2222-3333-4444-555555555555', [\n 'image' => '/9j/4AAQSkZJRgABAQAAAQABAAD...',\n 'comment' => 'Known fraud attempt',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.lists.entries.upload_face(\n \"11111111-2222-3333-4444-555555555555\",\n image: \"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n comment: \"Known fraud attempt\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Lists.Entries.UploadFaceAsync(\"11111111-2222-3333-4444-555555555555\", new ListsEntriesUploadFaceParams\n{\n Image = \"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n Comment = \"Known fraud attempt\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "201": { "description": "A entrada de rosto foi criada.", "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": "A lista não aceita envio de rostos, ou a imagem está ausente, é inválida, grande demais ou não mostra um rosto utilizável. Nenhuma entrada foi criada.", "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": "A chave de API com escopo expirou. Outras falhas de autenticação retornam `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "O cabeçalho `x-api-key` está ausente (uma chave incorreta, revogada ou expirada recebe `401`), ou uma chave de API com escopo não tem `workflows: write` ou é usada a partir de um endereço IP fora da sua lista de permissões.", "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": "Não existe nenhuma lista com este UUID na aplicação da chave de API, ou ela foi excluída.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "List not found." } } } } } }, "429": { "$ref": "#/components/responses/RateLimitedWrite" }, "503": { "description": "A análise facial está temporariamente indisponível. Nenhuma entrada foi criada; tente novamente mais tarde.", "content": { "application/json": { "examples": { "Unavailable": { "value": { "detail": "Service temporarily unavailable. Please try again later." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/blocklist/": { "get": { "summary": "Listar itens da lista de bloqueio", "description": "Retorna um único feed paginado com os rostos, documentos de identidade, números de telefone e endereços de e-mail das sessões de verificação da aplicação que estão atualmente na lista de bloqueio, do `blocklisted_at` mais recente para o mais antigo; filtre com `item_type`. Itens de sessões excluídas não são incluídos. O feed abrange registros bloqueados a partir de uma sessão (com [Adicionar itens da sessão à lista de bloqueio](https://docs.didit.me/pt-br/management-api/blocklist/add), pelo console ou por uma entrada de lista criada a partir de uma sessão); valores adicionados manualmente a uma lista, rostos enviados por upload, rostos de uma selfie da captura de documento e os demais tipos de entrada são lidos com [Listar entradas de lista](https://docs.didit.me/pt-br/management-api/lists/list-entries). `face_image` e `front_image` são URLs assinadas de curta duração, e uma chave de API com escopo sem `media: read` recebe `null`. Uma chave de API com escopo precisa de `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": "Somente itens deste tipo. Quando omitido, todos os tipos são retornados.", "schema": { "type": "string", "enum": [ "face", "document", "phone", "email" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Tamanho da página. O padrão é 50. Um valor acima de 1000000 retorna `400`; zero, um valor negativo ou não numérico volta para 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 } }, { "name": "offset", "in": "query", "required": false, "description": "Índice, a partir de zero, do primeiro item a retornar. Prefira seguir `next`. Um valor acima de 1000000 retorna `400`; um valor negativo ou não numérico passa a ser 0.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/blocklist/?item_type=document' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.blocklist.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.blocklist.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Blocklist.ListAutoPaging(ctx, didit.BlocklistListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.blocklist().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "blocklist->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.blocklist.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Blocklist.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Uma página de itens da lista de bloqueio, do mais recente para o mais antigo.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "minimum": 0, "description": "Número total de itens da lista de bloqueio que correspondem aos filtros." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta da próxima página, ou `null` na última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta da página anterior, ou `null` na primeira 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": "Um parâmetro de consulta é inválido.", "content": { "application/json": { "examples": { "Unknown item type": { "value": { "item_type": [ "\"wallet\" is not a valid choice." ] } }, "Limit too large": { "value": [ "limit must not exceed 1000000." ] } } } } }, "401": { "description": "A chave de API com escopo expirou. Outras falhas de autenticação retornam `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "O cabeçalho `x-api-key` está ausente (uma chave incorreta, revogada ou expirada recebe `401`), ou uma chave de API com escopo não tem `workflows: read` ou é usada a partir de um endereço IP fora da sua lista de permissões.", "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": "O limite compartilhado de leitura de 600 requisições por minuto por chave de API foi excedido. Respeite `Retry-After` antes de tentar novamente.", "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": "Adicionar itens da sessão à lista de bloqueio", "description": "Adiciona à lista de bloqueio o rosto, o documento de identidade, o número de telefone ou o endereço de e-mail de uma sessão de verificação de pessoa da aplicação. Para cada tipo selecionado, a Didit usa o registro mais recente da sessão, marca-o como bloqueado e adiciona uma entrada vinculada à sessão na lista de bloqueio do sistema correspondente (`added_by: \"api\"`), de modo que novas sessões com rosto, número de documento, número de telefone ou endereço de e-mail correspondentes sejam recusadas. Todos os itens selecionados são verificados primeiro; portanto, se algum estiver faltando, nada é adicionado à lista de bloqueio. Repetir a chamada para um item já listado mantém sua entrada única e atualiza `blocklisted_at`. A própria sessão e as sessões já concluídas não são alteradas. Uma chave de API com escopo precisa de `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": "Pelo menos uma flag `blocklist_*` deve ser `true`.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Uma sessão de verificação de pessoa da sua aplicação. Sessões excluídas são recusadas." }, "blocklist_face": { "type": "boolean", "default": false, "description": "Adicionar o rosto da sessão à lista de bloqueio." }, "blocklist_document": { "type": "boolean", "default": false, "description": "Adicionar o documento de identidade da sessão à lista de bloqueio. O documento precisa ter o estado emissor, o tipo de documento, o número do documento e o nome completo." }, "blocklist_phone": { "type": "boolean", "default": false, "description": "Adicionar o número de telefone da sessão à lista de bloqueio." }, "blocklist_email": { "type": "boolean", "default": false, "description": "Adicionar o endereço de e-mail da sessão à lista de bloqueio." } } }, "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": "Os itens selecionados foram adicionados à lista de bloqueio.", "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": "O corpo é inválido, a sessão não é uma sessão de verificação desta aplicação ou não tem registro de um tipo selecionado. Nada foi adicionado à lista de bloqueio.", "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": "A chave de API com escopo expirou. Outras falhas de autenticação retornam `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "O cabeçalho `x-api-key` está ausente (uma chave incorreta, revogada ou expirada recebe `401`), ou uma chave de API com escopo não tem `workflows: write` ou é usada a partir de um endereço IP fora da sua lista de permissões.", "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": "Remover itens de sessão da lista de bloqueio", "description": "Remove o bloqueio do rosto, do documento de identidade, do número de telefone ou do endereço de e-mail de uma sessão de verificação de pessoa da aplicação. Para cada tipo selecionado, a Didit pega o registro mais recente da sessão, limpa a marcação de lista de bloqueio dele e exclui as entradas de lista de bloqueio do sistema criadas a partir desse registro, de modo que ele deixe de recusar novas sessões. Entradas adicionadas a uma lista por valor não são afetadas: encontre-as com [List list entries](https://docs.didit.me/pt-br/management-api/lists/list-entries) e exclua-as com [Delete a list entry](https://docs.didit.me/pt-br/management-api/lists/delete-entry). Desbloquear um registro que não está na lista de bloqueio funciona e não altera nada, e sessões que já foram concluídas não são alteradas. Uma chave de API com escopo precisa de `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": "Pelo menos uma flag `unblock_*` deve ser `true`.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Uma sessão de verificação de pessoa da sua aplicação. Sessões excluídas são recusadas." }, "unblock_face": { "type": "boolean", "default": false, "description": "Remove o bloqueio do rosto da sessão." }, "unblock_document": { "type": "boolean", "default": false, "description": "Remove o bloqueio do documento de identidade da sessão." }, "unblock_phone": { "type": "boolean", "default": false, "description": "Remove o bloqueio do número de telefone da sessão." }, "unblock_email": { "type": "boolean", "default": false, "description": "Remove o bloqueio do endereço de e-mail da sessão." } } }, "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": "O bloqueio dos itens selecionados foi removido.", "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": "O corpo é inválido, a sessão não é uma sessão de verificação desta aplicação ou não tem registro de um tipo selecionado. Nada foi alterado.", "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": "A chave de API com escopo expirou. Outras falhas de autenticação retornam `403`.", "content": { "application/json": { "examples": { "Expired API key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "O cabeçalho `x-api-key` está ausente (uma chave incorreta, revogada ou expirada recebe `401`), ou uma chave de API com escopo não tem `workflows: write` ou é usada a partir de um endereço IP fora da sua lista de permissões.", "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": "Obter a configuração de webhook", "description": "Retorna as configurações de webhook da aplicação em uma única chamada: cada [destino do webhook](https://docs.didit.me/pt-br/management-api/webhook/list-destinations) com seu segredo de assinatura, os tipos de evento que um destino pode assinar, a URL, a versão e o segredo do webhook no nível da aplicação (legado), a política de retenção de dados e de templates biométricos e os hosts de retorno da carteira Digital ID. A Didit entrega os webhooks aos destinos, cada um assinado com seu próprio `secret_shared_key`; os campos de nível superior `webhook_url`, `webhook_version` e `secret_shared_key` só são usados enquanto nenhum destino estiver habilitado e, nesse caso, apenas para `status.updated` e `data.updated`. A resposta contém segredos de assinatura, portanto mantenha-a fora de logs e de código no lado do cliente. Uma chave de API com escopo precisa de `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": "A configuração do 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": "A chave de API expirou: ela foi criada com uma data de validade que já passou. Uma chave incorreta ou revogada também recebe `401`; uma chave ausente recebe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida. Um `x-api-key` ausente, inválido ou revogado recebe `You do not have permission to perform this action.` Uma chave com escopo sem o acesso exigido por este endpoint recebe uma mensagem que indica o acesso ausente, e uma chave usada de fora da sua lista de IPs permitidos recebe `This API key can't be used from this IP address.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "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": "Limite de requisições excedido: mais de 600 requisições GET na janela atual de um minuto para esta chave de API. Aguarde `Retry-After` segundos antes de tentar novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas na janela de um minuto (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Horário Unix (segundos) em que a janela atual é reiniciada.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nome do orçamento que foi excedido.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "summary": "Atualizar configuração de webhook", "description": "Atualiza parcialmente as configurações no nível da aplicação: a URL, a versão e o segredo do webhook legado, a política de retenção de dados e de templates biométricos e os hosts de retorno da carteira Digital ID. Envie apenas os campos que deseja alterar; a resposta é a configuração completa, no mesmo formato de `GET /v3/webhook/`. Os destinos não são gerenciados aqui: crie, atualize e exclua destinos com os endpoints `/v3/webhook/destinations/` e não envie um campo `endpoints` para este endpoint. Uma alteração em `data_retention_months` também se aplica às sessões existentes, e as sessões que ela exclui não podem ser restauradas; leia [Retenção de dados](https://docs.didit.me/pt-br/console/data-retention) antes. Uma chave de API com escopo precisa de `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": "Envie apenas os campos a alterar. Os destinos não são gerenciados aqui.", "properties": { "webhook_url": { "type": "string", "format": "uri", "nullable": true, "maxLength": 2000, "description": "URL de webhook legada no nível da aplicação. A Didit a usa somente enquanto a aplicação não tem nenhum destino habilitado, e apenas para `status.updated` e `data.updated`. Ela não cria um destino, e a próxima criação, atualização ou exclusão de um destino a substitui. Para receber webhooks, crie um destino com `POST /v3/webhook/destinations/`." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Versão do payload do `webhook_url` legado." }, "rotate_secret_key": { "type": "boolean", "default": false, "description": "`true` substitui imediatamente o `secret_shared_key` da aplicação por um novo valor aleatório; o novo valor vem na resposta. Os segredos dos destinos não são alterados. Cada chamada com `true` gera um novo segredo, portanto ela não é idempotente." }, "capture_method": { "type": "string", "enum": [ "MOBILE", "MOBILE_AND_DESKTOP" ], "description": "Configuração legada da aplicação. O fluxo de verificação não a lê." }, "data_retention_months": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 120, "description": "Janela de exclusão automática em meses (um mês equivale a 30 dias), ou `null` para nenhuma exclusão automática. Uma alteração também se aplica às sessões existentes: toda sessão de verificação de usuário mais antiga que a nova janela é excluída automaticamente, e essa exclusão é irreversível." }, "face_retention_policy": { "type": "string", "enum": [ "delete_with_session", "retain_until_user_deleted" ], "description": "O que acontece com o embedding facial de uma sessão quando a sessão é excluída. `retain_until_user_deleted` exige `face_retention_days` na mesma requisição ou já definido. Uma alteração se aplica às exclusões de sessão a partir de então; ela não cria nem remove nenhum template biométrico existente." }, "face_retention_days": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 3650, "description": "Período de retenção, em dias, dos templates biométricos sob `retain_until_user_deleted`." }, "biometric_consent_mode": { "type": "string", "enum": [ "auto", "always", "never" ], "description": "Quando o fluxo hospedado e os SDKs nativos pedem à pessoa consentimento biométrico explícito antes de uma captura facial. `auto` (padrão) pede apenas quando um gatilho se aplica: um estado declarado, o IP da pessoa ou o emissor do documento de identidade está em Illinois, Texas ou Colorado, ou a pessoa parece estar nos EUA sem um estado conhecido. `always` pede a toda pessoa cujo fluxo captura um rosto. `never` nunca mostra a etapa, e você mesmo coleta o consentimento antes da selfie. Cada alteração é registrada no registro de auditoria. Veja [Consentimento biométrico](https://docs.didit.me/pt-br/getting-started/biometric-consent)." }, "allowed_return_hosts": { "type": "array", "maxItems": 20, "description": "Substitui toda a lista de hosts de retorno da carteira de Digital ID. Apenas nomes de host simples, como `shop.example.com`: sem esquema, porta, caminho ou curinga. Os valores são convertidos para minúsculas e as duplicatas são descartadas. Envie `[]` para limpar a lista.", "items": { "type": "string", "maxLength": 253 } }, "allowed_domains": { "type": "array", "maxItems": 50, "items": { "type": "string", "maxLength": 300 }, "description": "Substitui toda a lista de origens permitidas. Origens (por exemplo `https://app.example.com`; `http` apenas para `localhost`) nas quais o fluxo de verificação hospedado pode ser incorporado e para as quais pode enviar o usuário de volta com um callback de sessão. Chamadas servidor a servidor não são afetadas. Uma lista vazia significa nenhuma restrição. A Didit armazena cada origem em minúsculas e sem a porta padrão. Uma entrada inválida falha com `400` em `allowed_domains`. Envie `[]` para remover a restrição.", "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": "A configuração completa após a atualização, com o mesmo formato de `GET /v3/webhook/`. Se você rotacionou o segredo, armazene o novo `secret_shared_key` antes de descartar a 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": "Falha na validação: cada campo inválido é associado a uma lista de mensagens, e nada é alterado. Um corpo que não é um JSON válido retorna `{\"detail\": \"JSON parse error - ...\"}`.", "content": { "application/json": { "schema": { "type": "object", "description": "Cada campo inválido mapeado para uma lista de mensagens.", "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": "A chave de API expirou: ela foi criada com uma data de validade que já passou. Uma chave incorreta ou revogada também recebe `401`; uma chave ausente recebe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida. Um `x-api-key` ausente, inválido ou revogado recebe `You do not have permission to perform this action.` Uma chave com escopo sem o acesso exigido por este endpoint recebe uma mensagem que indica o acesso ausente, e uma chave usada de fora da sua lista de IPs permitidos recebe `This API key can't be used from this IP address.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "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": "Limite de requisições excedido: mais de 300 requisições de escrita (POST, PATCH, PUT, DELETE) na janela atual de um minuto para esta chave de API. Aguarde `Retry-After` segundos antes de tentar novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas na janela de um minuto (300).", "schema": { "type": "integer", "example": 300 } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Horário Unix (segundos) em que a janela atual é reiniciada.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nome do orçamento que foi excedido.", "schema": { "type": "string", "example": "generic-write" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "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": "Obter as análises do destino do webhook", "description": "Totais de entrega, taxa de falha e tempos de resposta de um destino do webhook, no intervalo completo (`summary`) e por dia UTC (`points`). Toda tentativa conta como uma entrega: o primeiro envio de um evento, cada [nova tentativa](https://docs.didit.me/pt-br/integration/webhooks#política-de-novas-tentativas) automática e cada reenvio. Uma entrega falha quando o status HTTP registrado é 400 ou superior, então timeouts (registrados como `504`) e falhas de conexão (`503`) contam como falhas; uma entrega que ainda está na fila conta apenas em `total_deliveries`. Os registros de entrega ficam disponíveis por cerca de 30 dias. Uma chave de API com escopo precisa de `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 do destino (o `uuid` retornado por `GET /v3/webhook/destinations/`).", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "date_from", "in": "query", "required": false, "description": "Primeiro dia UTC a incluir, no formato `YYYY-MM-DD` (inclusive). Omita para começar pela entrega mais antiga disponível. `dateFrom` é aceito como alias.", "schema": { "type": "string", "format": "date" }, "example": "2026-10-01" }, { "name": "date_to", "in": "query", "required": false, "description": "Último dia UTC a incluir, no formato `YYYY-MM-DD` (inclusivo). Não pode ser anterior a `date_from`. `dateTo` é aceito como alias.", "schema": { "type": "string", "format": "date" }, "example": "2026-10-16" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/analytics/?date_from=2026-10-01&date_to=2026-10-16' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.retrieve_analytics(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.retrieveAnalytics(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.RetrieveAnalytics(ctx, \"11111111-2222-3333-4444-555555555555\", didit.WebhooksDestinationsRetrieveAnalyticsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().retrieveAnalytics(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->retrieveAnalytics('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.destinations.retrieve_analytics(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.RetrieveAnalyticsAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Estatísticas de entrega do destino.", "content": { "application/json": { "schema": { "type": "object", "required": [ "summary", "points" ], "properties": { "summary": { "type": "object", "description": "Totais no intervalo solicitado.", "required": [ "total_deliveries", "failed_deliveries", "min_response_time_ms", "avg_response_time_ms", "max_response_time_ms", "error_rate_percentage" ], "properties": { "total_deliveries": { "type": "integer", "minimum": 0, "description": "Tentativas de entrega, incluindo as que estão na fila." }, "failed_deliveries": { "type": "integer", "minimum": 0, "description": "Tentativas cujo status HTTP registrado é 400 ou superior." }, "min_response_time_ms": { "type": "integer", "nullable": true, "description": "Tentativa mais rápida em milissegundos, ou `null` quando nenhuma tentativa tem tempo registrado." }, "avg_response_time_ms": { "type": "integer", "nullable": true, "description": "Tempo médio por tentativa em milissegundos, arredondado, ou `null` quando nenhuma tentativa tem tempo registrado." }, "max_response_time_ms": { "type": "integer", "nullable": true, "description": "Tentativa mais lenta em milissegundos, ou `null` quando nenhuma tentativa tem tempo registrado." }, "error_rate_percentage": { "type": "integer", "minimum": 0, "maximum": 100, "description": "`failed_deliveries` / `total_deliveries` x 100, arredondado para um número inteiro. `0` quando não há entregas." } } }, "points": { "type": "array", "description": "Uma entrada por dia UTC que teve entregas, da mais antiga para a mais recente. Os dias sem entregas são omitidos, então preencha as lacunas com zeros ao montar gráficos.", "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 em UTC, `YYYY-MM-DD`." }, "total_deliveries": { "type": "integer", "minimum": 0, "description": "Tentativas de entrega, incluindo as que estão na fila." }, "failed_deliveries": { "type": "integer", "minimum": 0, "description": "Tentativas cujo status HTTP registrado é 400 ou superior." }, "min_response_time_ms": { "type": "integer", "nullable": true, "description": "Tentativa mais rápida em milissegundos, ou `null` quando nenhuma tentativa tem tempo registrado." }, "avg_response_time_ms": { "type": "integer", "nullable": true, "description": "Tempo médio por tentativa em milissegundos, arredondado, ou `null` quando nenhuma tentativa tem tempo registrado." }, "max_response_time_ms": { "type": "integer", "nullable": true, "description": "Tentativa mais lenta em milissegundos, ou `null` quando nenhuma tentativa tem tempo registrado." } } } } } }, "examples": { "Three days of deliveries": { "value": { "summary": { "total_deliveries": 1250, "failed_deliveries": 12, "min_response_time_ms": 38, "avg_response_time_ms": 164, "max_response_time_ms": 5004, "error_rate_percentage": 1 }, "points": [ { "date": "2026-10-14", "total_deliveries": 410, "failed_deliveries": 0, "min_response_time_ms": 38, "avg_response_time_ms": 152, "max_response_time_ms": 911 }, { "date": "2026-10-15", "total_deliveries": 395, "failed_deliveries": 12, "min_response_time_ms": 41, "avg_response_time_ms": 190, "max_response_time_ms": 5004 }, { "date": "2026-10-16", "total_deliveries": 445, "failed_deliveries": 0, "min_response_time_ms": 40, "avg_response_time_ms": 151, "max_response_time_ms": 1220 } ] } }, "No deliveries in range": { "value": { "summary": { "total_deliveries": 0, "failed_deliveries": 0, "min_response_time_ms": null, "avg_response_time_ms": null, "max_response_time_ms": null, "error_rate_percentage": 0 }, "points": [] } } } } } }, "400": { "description": "`date_from` ou `date_to` não é uma data `YYYY-MM-DD`, ou `date_to` é anterior a `date_from`.", "content": { "application/json": { "schema": { "type": "object", "description": "Cada campo inválido mapeado para uma lista de mensagens.", "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": "A chave de API expirou: ela foi criada com uma data de validade que já passou. Uma chave incorreta ou revogada também recebe `401`; uma chave ausente recebe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida. Um `x-api-key` ausente, inválido ou revogado recebe `You do not have permission to perform this action.` Uma chave com escopo sem o acesso exigido por este endpoint recebe uma mensagem que indica o acesso ausente, e uma chave usada de fora da sua lista de IPs permitidos recebe `This API key can't be used from this IP address.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "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": "Não existe nenhum destino com este UUID para a aplicação, ou ele foi excluído.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Destination not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "Limite de requisições excedido: mais de 600 requisições GET na janela atual de um minuto para esta chave de API. Aguarde `Retry-After` segundos antes de tentar novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas na janela de um minuto (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Horário Unix (segundos) em que a janela atual é reiniciada.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nome do orçamento que foi excedido.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/webhook/destinations/{destination_uuid}/deliveries/": { "get": { "summary": "Listar entregas do destino do webhook", "description": "Percorra páginas com todas as tentativas de entrega para um destino do webhook, das mais recentes para as mais antigas. O primeiro envio de cada evento, cada [nova tentativa](https://docs.didit.me/pt-br/integration/webhooks#política-de-novas-tentativas) automática e cada reenvio são entradas separadas. As entradas trazem o status HTTP e o tempo de resposta, mas não o payload: consulte uma entrega para ler os cabeçalhos e o corpo. `count` é exato até 100 e mostra 100 acima disso, então siga `next` até que seja `null`. Os registros de entrega ficam disponíveis por cerca de 30 dias. Uma chave de API com escopo precisa de `webhooks: read` e `decisions: read`; uma chave limitada a alguns fluxos ou a sessões aprovadas não pode usar este endpoint.", "operationId": "list_webhook_destination_deliveries", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "list_deliveries", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID do destino (o `uuid` retornado por `GET /v3/webhook/destinations/`).", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "limit", "in": "query", "required": false, "description": "Número máximo de entregas por página. O padrão é 50. Um valor que não seja um inteiro positivo volta para 50; um valor acima de 1000000 retorna `400`.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "example": 50 }, { "name": "offset", "in": "query", "required": false, "description": "Número de entregas a pular. O padrão é 0. Prefira seguir as URLs `next` e `previous` da resposta.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "example": 0 }, { "name": "date_from", "in": "query", "required": false, "description": "Primeiro dia UTC a incluir, no formato `YYYY-MM-DD` (inclusive). Omita para começar pela entrega mais antiga disponível. `dateFrom` é aceito como alias.", "schema": { "type": "string", "format": "date" }, "example": "2026-10-01" }, { "name": "date_to", "in": "query", "required": false, "description": "Último dia UTC a incluir, no formato `YYYY-MM-DD` (inclusivo). Não pode ser anterior a `date_from`. `dateTo` é aceito como alias.", "schema": { "type": "string", "format": "date" }, "example": "2026-10-16" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/deliveries/?limit=50&date_from=2026-10-01' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.webhooks.destinations.list_deliveries(\n \"11111111-2222-3333-4444-555555555555\",\n):\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.webhooks.destinations.listDeliveries(\"11111111-2222-3333-4444-555555555555\")) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Webhooks.Destinations.ListDeliveriesAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.WebhooksDestinationsListDeliveriesParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.webhooks().destinations().listDeliveries(\"11111111-2222-3333-4444-555555555555\")) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->listDeliveries('11111111-2222-3333-4444-555555555555') as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.webhooks.destinations.list_deliveries(\"11111111-2222-3333-4444-555555555555\").auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.Webhooks.Destinations.ListDeliveriesAsync(\"11111111-2222-3333-4444-555555555555\"))\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ], "responses": { "200": { "description": "Uma página de entregas, das mais recentes para as mais antigas.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "minimum": 0, "description": "Entregas correspondentes, com contagem exata até 100 e limitada a 100 acima disso. Use `next` para saber se existem mais páginas." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta da próxima página, ou `null` na última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta da página anterior, ou `null` na primeira 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` ou `date_to` não é uma data `YYYY-MM-DD`, `date_to` é anterior a `date_from`, ou `limit` ou `offset` é maior que 1000000 (esse erro é um array JSON de mensagens).", "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": "A chave de API expirou: ela foi criada com uma data de validade que já passou. Uma chave incorreta ou revogada também recebe `401`; uma chave ausente recebe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida. Uma `x-api-key` ausente, inválida ou revogada recebe `You do not have permission to perform this action.` Uma chave com escopo sem o acesso exigido por este endpoint recebe uma mensagem que indica o acesso ausente, e uma chave usada fora da sua lista de IPs permitidos recebe `This API key can't be used from this IP address.` Uma chave limitada a alguns fluxos ou a sessões aprovadas recebe `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": "Mensagem de erro legível." } } }, "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": "Não existe nenhum destino com este UUID para a aplicação, ou ele foi excluído.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Destination not found": { "value": { "detail": "Webhook destination not found." } } } } } }, "429": { "description": "Limite de requisições excedido: mais de 600 requisições GET na janela atual de um minuto para esta chave de API. Aguarde `Retry-After` segundos antes de tentar novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas na janela de um minuto (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Horário Unix (segundos) em que a janela atual é reiniciada.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nome do orçamento que foi excedido.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "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": "Obter entrega do destino do webhook", "description": "Obtenha uma tentativa de entrega a um destino do webhook com os cabeçalhos exatos da requisição e o corpo JSON que a Didit enviou, o status HTTP que o seu endpoint retornou e o tempo de resposta. `request_header` e `request_body` são texto JSON: faça o parse deles para ler os cabeçalhos de assinatura e o payload, por exemplo para conferir a sua [verificação de assinatura](https://docs.didit.me/pt-br/integration/webhooks#verificação-de-assinatura) com o `secret_shared_key` do destino. Uma entrega nunca contém o segredo de assinatura, e a Didit não registra o corpo da resposta do seu endpoint. Uma chave de API com escopo precisa de `webhooks: read` e `decisions: read`; uma chave limitada a alguns fluxos ou a sessões aprovadas não pode usar este endpoint.", "operationId": "get_webhook_destination_delivery", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "retrieve_delivery", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID do destino para o qual a entrega foi enviada.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "delivery_uuid", "in": "path", "required": true, "description": "UUID da entrega: o `uuid` de um item retornado por `GET /v3/webhook/destinations/{destination_uuid}/deliveries/`.", "schema": { "type": "string", "format": "uuid" }, "example": "66666666-7777-8888-9999-000000000001" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/deliveries/66666666-7777-8888-9999-000000000001/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.retrieve_delivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.retrieveDelivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.RetrieveDelivery(ctx, \"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().retrieveDelivery(\"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->retrieveDelivery('11111111-2222-3333-4444-555555555555', '66666666-7777-8888-9999-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.destinations.retrieve_delivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.RetrieveDeliveryAsync(\"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "A entrega, com os cabeçalhos e o corpo da requisição.", "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": "A chave de API expirou: ela foi criada com uma data de validade que já passou. Uma chave incorreta ou revogada também recebe `401`; uma chave ausente recebe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida. Uma `x-api-key` ausente, inválida ou revogada recebe `You do not have permission to perform this action.` Uma chave com escopo sem o acesso exigido por este endpoint recebe uma mensagem que indica o acesso ausente, e uma chave usada fora da sua lista de IPs permitidos recebe `This API key can't be used from this IP address.` Uma chave limitada a alguns fluxos ou a sessões aprovadas recebe `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": "Mensagem de erro legível." } } }, "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": "O destino não existe para a aplicação ou foi excluído, ou a entrega não existe, pertence a outro destino ou não está mais disponível.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Destination not found": { "value": { "detail": "Webhook destination not found." } }, "Delivery not found": { "value": { "detail": "Webhook delivery not found." } } } } } }, "429": { "description": "Limite de requisições excedido: mais de 600 requisições GET na janela atual de um minuto para esta chave de API. Aguarde `Retry-After` segundos antes de tentar novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas na janela de um minuto (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Horário Unix (segundos) em que a janela atual é reiniciada.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nome do orçamento que foi excedido.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "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 entrega para o destino do webhook", "description": "Envie novamente uma entrega anterior, por exemplo depois que seu endpoint ficou fora do ar. A Didit pega o payload armazenado, define um novo `timestamp`, assina-o novamente com o `secret_shared_key` atual do destino (`X-Signature`, `X-Signature-V2`, `X-Signature-Simple` e `X-Timestamp`) e o envia para a `request_url` da entrega, mesmo que a URL do destino tenha mudado desde então ou que o destino esteja desativado. O `event_id` e o restante do payload não mudam, então faça a deduplicação pelo `event_id`. A chamada aguarda até 5 segundos pelo seu endpoint e retorna a nova entrega com `200`, independentemente da resposta do seu endpoint: leia `response_status`. Um reenvio não é repetido automaticamente, cada chamada envia novamente e cria uma nova entrega, e a requisição não tem corpo. Uma chave de API com escopo precisa de `webhooks: write` e `decisions: read`; uma chave limitada a alguns fluxos ou a sessões aprovadas não pode usar este endpoint.", "operationId": "resend_webhook_destination_delivery", "x-didit-sdk": { "resource": "webhooks.destinations", "method": "resend_delivery", "auth": "api_key", "server": true }, "tags": [ "Webhook" ], "parameters": [ { "name": "destination_uuid", "in": "path", "required": true, "description": "UUID do destino para o qual a entrega foi enviada.", "schema": { "type": "string", "format": "uuid" }, "example": "11111111-2222-3333-4444-555555555555" }, { "name": "delivery_uuid", "in": "path", "required": true, "description": "UUID da entrega a ser reenviada: o `uuid` de um item retornado por `GET /v3/webhook/destinations/{destination_uuid}/deliveries/`.", "schema": { "type": "string", "format": "uuid" }, "example": "66666666-7777-8888-9999-000000000001" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/deliveries/66666666-7777-8888-9999-000000000001/resend/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.webhooks.destinations.resend_delivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.webhooks.destinations.resendDelivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.ResendDelivery(ctx, \"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.webhooks().destinations().resendDelivery(\"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "webhooks->destinations->resendDelivery('11111111-2222-3333-4444-555555555555', '66666666-7777-8888-9999-000000000001');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.webhooks.destinations.resend_delivery(\n \"11111111-2222-3333-4444-555555555555\",\n \"66666666-7777-8888-9999-000000000001\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Webhooks.Destinations.ResendDeliveryAsync(\"11111111-2222-3333-4444-555555555555\", \"66666666-7777-8888-9999-000000000001\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "A nova entrega, já tentada. `response_status` é o que o seu endpoint respondeu desta vez (`504` tempo esgotado, `503` falha de conexão). A entrega original permanece inalterada.", "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": "A entrega armazenada não pôde ser assinada novamente. Nada é enviado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." }, "code": { "type": "string", "description": "Código de erro estável e legível por máquina. Use este código para ramificar a lógica, não o `detail`." } } }, "examples": { "Unsignable delivery": { "value": { "detail": "Invalid webhook data format", "code": "invalid_webhook_payload" } } } } } }, "401": { "description": "A chave de API expirou: ela foi criada com uma data de validade que já passou. Uma chave incorreta ou revogada também recebe `401`; uma chave ausente recebe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida. Uma `x-api-key` ausente, inválida ou revogada recebe `You do not have permission to perform this action.` Uma chave com escopo sem o acesso exigido por este endpoint recebe uma mensagem que indica o acesso ausente, e uma chave usada fora da sua lista de IPs permitidos recebe `This API key can't be used from this IP address.` Uma chave limitada a alguns fluxos ou a sessões aprovadas recebe `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": "Mensagem de erro legível." } } }, "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": "O destino não existe para a aplicação ou foi excluído, ou a entrega não existe, pertence a outro destino ou não está mais disponível.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Destination not found": { "value": { "detail": "Webhook destination not found." } }, "Delivery not found": { "value": { "detail": "Webhook delivery not found." } } } } } }, "429": { "description": "Limite de requisições excedido: mais de 300 requisições de escrita (POST, PATCH, PUT, DELETE) na janela atual de um minuto para esta chave de API. Aguarde `Retry-After` segundos antes de tentar novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas na janela de um minuto (300).", "schema": { "type": "integer", "example": 300 } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Horário Unix (segundos) em que a janela atual é reiniciada.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nome do orçamento que foi excedido.", "schema": { "type": "string", "example": "generic-write" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/": { "get": { "summary": "Listar eventos de monitoramento", "description": "Lista os eventos de monitoramento armazenados para sua aplicação, com o `occurred_at` mais recente primeiro, com filtros opcionais que se combinam com AND. Filtros de vários valores (`event_category`, `action_type`, `status`, `retention_class`) repetem o parâmetro e correspondem a qualquer um dos valores; os demais filtros exigem correspondência exata, e valores desconhecidos simplesmente não retornam eventos. Cada resultado é um resumo: chame `GET /v3/events/{event_uuid}/` para obter o payload, o contexto do dispositivo, o enriquecimento de IP e as evidências das regras, e prefira `GET /v3/events/subjects/{vendor_data}/` para o histórico de um único titular. As leituras funcionam com a ingestão de eventos ativada ou não. Uma chave de API com escopo precisa de `transactions: read`. Consulte [Ingestão de eventos](https://docs.didit.me/pt-br/transaction-monitoring/events).", "operationId": "list_monitoring_events", "x-didit-sdk": { "resource": "monitoring_events", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Número máximo de eventos por página. O padrão é 50. Valores acima de 1000000 retornam `400`; um valor não numérico, zero ou negativo volta para 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "example": 50 }, { "name": "offset", "in": "query", "required": false, "description": "Número de eventos a pular. O padrão é 0. Prefira seguir a URL `next` da resposta.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "example": 0 }, { "name": "event_category", "in": "query", "required": false, "description": "Somente eventos nestas categorias. Repita o parâmetro para vários valores (`?event_category=payment&event_category=dispute`); um evento que corresponda a qualquer um deles é retornado.", "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": "Somente eventos com estes tipos de ação (exatos, diferenciando maiúsculas de minúsculas). Repita para vários valores.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "deposit_completed", "chargeback_opened" ] }, { "name": "status", "in": "query", "required": false, "description": "Somente eventos com estes status. Repita para vários valores.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ] } }, "example": [ "IN_REVIEW", "DECLINED" ] }, { "name": "retention_class", "in": "query", "required": false, "description": "Somente eventos nestas classes de retenção. Repita para vários valores.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ] } }, "example": [ "risk_relevant" ] }, { "name": "subject_vendor_data", "in": "query", "required": false, "description": "Correspondência exata no `vendor_data` do titular. O mesmo id pode identificar uma pessoa física e uma empresa; adicione `subject_entity_type` para escolher uma delas ou use `GET /v3/events/subjects/{vendor_data}/`.", "schema": { "type": "string" }, "example": "user-42" }, { "name": "subject_entity_type", "in": "query", "required": false, "description": "`company` retorna apenas eventos de titulares do tipo empresa; qualquer outro valor não vazio (por exemplo, `individual`) retorna apenas eventos de pessoas físicas. Omita-o para retornar ambos.", "schema": { "type": "string", "enum": [ "individual", "company" ] }, "example": "individual" }, { "name": "business_vendor_data", "in": "query", "required": false, "description": "Correspondência exata no `business.vendor_data` enviado com o evento.", "schema": { "type": "string" }, "example": "merchant-7" }, { "name": "session_id", "in": "query", "required": false, "description": "Correspondência exata em `session.session_id`.", "schema": { "type": "string" }, "example": "web-session-abc" }, { "name": "device_fingerprint", "in": "query", "required": false, "description": "Correspondência exata em `device_context.fingerprint`.", "schema": { "type": "string" }, "example": "fp-a8c1" }, { "name": "ip_address", "in": "query", "required": false, "description": "Correspondência exata no endereço IP do evento.", "schema": { "type": "string" }, "example": "203.0.113.42" }, { "name": "game_id", "in": "query", "required": false, "description": "Correspondência exata no `game_id` promovido.", "schema": { "type": "string" }, "example": "poker-holdem-01" }, { "name": "round_id", "in": "query", "required": false, "description": "Correspondência exata no `round_id` promovido.", "schema": { "type": "string" }, "example": "round-88231" }, { "name": "affiliate_code", "in": "query", "required": false, "description": "Correspondência exata no `affiliate_code` promovido.", "schema": { "type": "string" }, "example": "aff-summer" }, { "name": "payment_reference_id", "in": "query", "required": false, "description": "Correspondência exata na referência de pagamento (de `transaction_context.payment_reference_id` ou `payload.payment_reference_id`).", "schema": { "type": "string" }, "example": "dep_735" }, { "name": "counterparty_vendor_data", "in": "query", "required": false, "description": "Correspondência exata no `counterparty_vendor_data` promovido.", "schema": { "type": "string" }, "example": "user-77" }, { "name": "matched_only", "in": "query", "required": false, "description": "`true` (também `1` ou `yes`, sem diferenciar maiúsculas de minúsculas) retorna apenas os eventos aos quais pelo menos uma regra correspondeu (`rules_matched_count` acima de 0). Qualquer outro valor é ignorado.", "schema": { "type": "boolean", "default": false }, "example": true }, { "name": "occurred_from", "in": "query", "required": false, "description": "Somente eventos com `occurred_at` neste instante ou depois dele (inclusive). Envie um valor ISO 8601: `2026-10-01T00:00:00Z`, um deslocamento explícito com o `+` codificado em percentual (`2026-10-01T02:00:00%2B02:00`; um `+` não codificado é decodificado como espaço e o valor deixa de ser interpretado) ou apenas uma data (`2026-10-01`), que significa 00:00:00 UTC desse dia. Um valor sem deslocamento é lido como UTC. Valores em qualquer outro formato não são aceitos.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-01T00:00:00Z" }, { "name": "occurred_to", "in": "query", "required": false, "description": "Somente eventos com `occurred_at` neste instante ou antes dele (inclusive). Apenas uma data significa o início desse dia, então `occurred_to=2026-10-15` exclui o restante de 15 de outubro; envie `2026-10-15T23:59:59Z` para incluí-lo. Envie um valor ISO 8601: `2026-10-01T00:00:00Z`, um deslocamento explícito com o `+` codificado em percentual (`2026-10-01T02:00:00%2B02:00`; um `+` não codificado é decodificado como espaço e o valor deixa de ser interpretado) ou apenas uma data (`2026-10-01`), que significa 00:00:00 UTC desse dia. Um valor sem deslocamento é lido como UTC. Valores em qualquer outro formato não são aceitos.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-17T23:59:59Z" }, { "name": "search", "in": "query", "required": false, "description": "Correspondência de substring sem distinção entre maiúsculas e minúsculas em `event_id`, `action_type`, `subject_vendor_data` ou `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": "Uma página de resumos de eventos.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringEventPage" }, "examples": { "Payment and dispute events": { "value": { "count": 2, "next": null, "previous": null, "results": [ { "event_uuid": "11111111-2222-3333-4444-555555555555", "event_id": "chargeback-2026-10-16-000318", "event_category": "dispute", "action_type": "chargeback_opened", "occurred_at": "2026-10-16T14:02:11Z", "received_at": "2026-10-16T14:02:12.418230Z", "status": "IN_REVIEW", "score": 60, "subject_vendor_data": "user-42", "subject_entity_type": "individual", "subject_uuid": "66666666-7777-8888-9999-000000000000", "counterparty_vendor_data": null, "session_id": null, "device_fingerprint": null, "ip_address": null, "ip_country": null, "amount": "250.000000000000000000", "currency": "EUR", "game_id": null, "round_id": null, "bonus_id": null, "affiliate_code": null, "payment_reference_id": "dep_735", "retention_class": "monetary_or_compliance", "rules_matched_count": 1, "correlation_pending": false, "is_droppable": false }, { "event_uuid": "22222222-3333-4444-5555-666666666666", "event_id": "login-2026-10-15-000912", "event_category": "auth", "action_type": "login", "occurred_at": "2026-10-15T08:30:00.120000Z", "received_at": "2026-10-15T08:30:00.734512Z", "status": "ACCEPTED", "score": 0, "subject_vendor_data": "user-42", "subject_entity_type": "individual", "subject_uuid": "66666666-7777-8888-9999-000000000000", "counterparty_vendor_data": null, "session_id": "web-session-abc", "device_fingerprint": "fp-a8c1", "ip_address": "203.0.113.42", "ip_country": "ES", "amount": null, "currency": null, "game_id": null, "round_id": null, "bonus_id": null, "affiliate_code": null, "payment_reference_id": null, "retention_class": "standard", "rules_matched_count": 0, "correlation_pending": false, "is_droppable": true } ] } } } } } }, "400": { "description": "`limit` ou `offset` é maior que 1000000. O corpo é um array JSON com uma mensagem. Um `limit` não numérico ou não positivo volta ao padrão de 50 em vez de falhar.", "content": { "application/json": { "examples": { "limit too large": { "summary": "limit acima de 1000000", "value": [ "limit must not exceed 1000000." ] }, "offset too large": { "summary": "offset acima de 1000000", "value": [ "offset must not exceed 1000000." ] } } } } }, "401": { "description": "A chave de API com escopo expirou. Somente uma chave expirada recebe `401`; uma chave ausente ou inválida recebe `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ausência de `x-api-key` (uma chave incorreta, revogada ou expirada recebe `401`), uma chave com escopo sem `transactions: read`, uma chave limitada a alguns fluxos ou a sessões aprovadas (essa chave nunca acessa dados de monitoramento de transações) ou uma requisição feita de fora da lista de IPs permitidos da chave.", "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": "Limite de requisições excedido: requisições `GET` compartilham uma cota de 600 requisições por minuto por chave de API. Aguarde `Retry-After` segundos e tente novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "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": "Criar evento de monitoramento", "description": "Envie um evento não monetário (login, sessão, jogabilidade, bônus, afiliado, pagamento, disputa, segurança, jogo responsável ou personalizado) a partir do seu backend. O evento é validado em relação ao contrato da sua categoria, armazenado, enriquecido com dados de IP uma vez por endereço público único e avaliado pelas suas regras de eventos em tempo real antes de a resposta ser retornada; as regras entre sujeitos e de janela longa são executadas de forma assíncrona (`correlation_pending: true`) e, em uma aplicação de sandbox, nenhuma regra é executada. `event_id` é a chave de idempotência: o mesmo `event_id` com os mesmos `event_category`, `action_type`, `occurred_at`, `subject.vendor_data` e `payload` retorna `200` com `idempotent_replay: true` e o resultado armazenado (os demais campos do envelope não são comparados), enquanto valores diferentes retornam `409`. A ingestão de eventos é opcional por aplicação: até ser ativada, este endpoint retorna `403` com `code: event_monitoring_disabled` e não armazena nada. Uma chave de API com escopo precisa de `transactions: write`. Consulte [Ingestão de eventos](https://docs.didit.me/pt-br/transaction-monitoring/events) e [Regras sobre eventos](https://docs.didit.me/pt-br/transaction-monitoring/event-rules); para enviar eventos a partir de um navegador ou app, use o [Envio de eventos pelo SDK](https://docs.didit.me/pt-br/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": "O evento foi armazenado e avaliado.", "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": "Reprodução idempotente: um evento com este `event_id` e o mesmo conteúdo já está armazenado. Nada foi armazenado nem avaliado novamente; o corpo descreve o evento armazenado.", "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": "Falha na validação. O corpo é indexado por campo; campos aninhados são objetos aninhados. Nada é armazenado.", "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": "A chave de API com escopo expirou. Somente uma chave expirada recebe `401`; uma chave ausente ou inválida recebe `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ausência de `x-api-key` (uma chave incorreta, revogada ou expirada recebe `401`), uma chave com escopo sem `transactions: write`, uma chave limitada a alguns fluxos ou a sessões aprovadas (essa chave nunca acessa dados de monitoramento de transações) ou uma requisição feita de fora da lista de IPs permitidos da chave. Também é retornado com `code: event_monitoring_disabled` enquanto a ingestão de eventos estiver desativada para a aplicação; nesse caso, nada é armazenado, e a verificação é executada antes da validação do corpo.", "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` já foi usado para um evento com conteúdo diferente (categoria, tipo de ação, `occurred_at`, `vendor_data` do sujeito ou payload). Envie o evento com um novo `event_id`.", "content": { "application/json": { "examples": { "event_id reused": { "value": { "event_id": "event_id 'login-2026-10-17-000001' already exists with a different payload." } } } } } }, "429": { "description": "Limite de requisições excedido: requisições de escrita (`POST`, `PATCH`, `DELETE`) compartilham uma cota de 300 requisições por minuto por chave de API. Aguarde `Retry-After` segundos e tente novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/batch/": { "post": { "summary": "Criar eventos de monitoramento em lote", "description": "Envie de 1 a 500 eventos em uma única requisição, cada um no mesmo envelope de `POST /v3/events/`. Cada item é validado, armazenado e avaliado individualmente e recebe seu próprio resultado (`accepted`, `replayed` ou `rejected`), de modo que um evento malformado nunca desfaz os outros: a resposta é `201` quando nenhum item foi rejeitado e `207` quando pelo menos um foi, e ambas significam que a requisição foi processada. Envie `{\"events\": [...]}`; um array JSON simples de eventos também é aceito. A ingestão de eventos precisa estar ativada para a aplicação; caso contrário, a requisição inteira retorna `403` com `code: event_monitoring_disabled` e nada é armazenado. Uma chave de API com escopo precisa de `transactions: write`. Consulte [Lotes](https://docs.didit.me/pt-br/transaction-monitoring/events#lotes).", "operationId": "create_monitoring_events_batch", "x-didit-sdk": { "resource": "monitoring_events", "method": "create_batch", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "events" ], "properties": { "events": { "type": "array", "minItems": 1, "maxItems": 500, "description": "De 1 a 500 eventos. Cada item segue `MonitoringEventCreateRequest`, incluindo a janela de 7 dias no passado e 5 minutos no futuro em `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": "Nenhum item foi rejeitado: todos os itens estão `accepted` ou `replayed`.", "content": { "application/json": { "schema": { "type": "object", "required": [ "accepted_count", "replayed_count", "rejected_count", "results" ], "properties": { "accepted_count": { "type": "integer", "minimum": 0, "description": "Itens armazenados e avaliados." }, "replayed_count": { "type": "integer", "minimum": 0, "description": "Itens já armazenados com o mesmo conteúdo." }, "rejected_count": { "type": "integer", "minimum": 0, "description": "Itens não armazenados." }, "results": { "type": "array", "description": "Uma entrada por item, na ordem da requisição.", "items": { "type": "object", "description": "Resultado de um item. Itens aceitos e repetidos também trazem todos os campos de `MonitoringEventIngestResult`; itens rejeitados trazem `event_id` e `errors` em vez disso.", "required": [ "index", "outcome" ], "properties": { "index": { "type": "integer", "minimum": 0, "description": "Posição do item no seu array `events`." }, "outcome": { "type": "string", "enum": [ "accepted", "replayed", "rejected" ], "description": "`accepted`: armazenado e avaliado. `replayed`: já armazenado com o mesmo conteúdo. `rejected`: não armazenado; veja `errors`." }, "event_id": { "type": "string", "nullable": true, "description": "Seu `event_id`. Nos itens rejeitados pela validação, ele é lido da chave `event_id` em snake_case do item, portanto é nulo quando o item o omitiu ou enviou o alias `eventId`." }, "errors": { "type": "object", "additionalProperties": true, "description": "Apenas itens rejeitados. Erros de validação indexados por campo, no mesmo formato do `400` de `POST /v3/events/`; um `event_id` reutilizado com conteúdo diferente é informado como string em `errors.event_id`." }, "event_uuid": { "type": "string", "format": "uuid", "description": "Somente itens aceitos e reprocessados." }, "status": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ], "description": "Somente itens aceitos e reprocessados." }, "score": { "type": "integer", "description": "Somente itens aceitos e reprocessados." }, "rules_evaluated_count": { "type": "integer", "description": "Somente itens aceitos e reprocessados." }, "rules_matched_count": { "type": "integer", "description": "Somente itens aceitos e reprocessados." }, "correlation_pending": { "type": "boolean", "description": "Somente itens aceitos e reprocessados." }, "retention_class": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ], "description": "Somente itens aceitos e reprocessados." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Somente itens aceitos e reprocessados." }, "idempotent_replay": { "type": "boolean", "description": "Somente itens aceitos e reprocessados." }, "rule_matches": { "type": "array", "description": "Somente itens aceitos e reprocessados.", "items": { "type": "object", "required": [ "rule_id", "library_key", "mode", "is_async" ], "properties": { "rule_id": { "type": "string", "format": "uuid", "description": "UUID da regra." }, "library_key": { "type": "string", "nullable": true, "description": "Chave da biblioteca quando a regra foi instalada a partir da biblioteca de regras; caso contrário, null." }, "mode": { "type": "string", "enum": [ "ACTIVE", "TEST" ], "description": "Regras `TEST` registram a correspondência, mas não aplicam nenhuma ação." }, "is_async": { "type": "boolean", "description": "`true` quando a correspondência veio da passagem assí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": "Pelo menos um item foi rejeitado. Os demais itens foram armazenados; corrija e reenvie apenas os rejeitados (reenviar um item aceito é seguro, ele retorna como `replayed`).", "content": { "application/json": { "schema": { "type": "object", "required": [ "accepted_count", "replayed_count", "rejected_count", "results" ], "properties": { "accepted_count": { "type": "integer", "minimum": 0, "description": "Itens armazenados e avaliados." }, "replayed_count": { "type": "integer", "minimum": 0, "description": "Itens já armazenados com o mesmo conteúdo." }, "rejected_count": { "type": "integer", "minimum": 0, "description": "Itens não armazenados." }, "results": { "type": "array", "description": "Uma entrada por item, na ordem da requisição.", "items": { "type": "object", "description": "Resultado de um item. Itens aceitos e repetidos também trazem todos os campos de `MonitoringEventIngestResult`; itens rejeitados trazem `event_id` e `errors` em vez disso.", "required": [ "index", "outcome" ], "properties": { "index": { "type": "integer", "minimum": 0, "description": "Posição do item no seu array `events`." }, "outcome": { "type": "string", "enum": [ "accepted", "replayed", "rejected" ], "description": "`accepted`: armazenado e avaliado. `replayed`: já armazenado com o mesmo conteúdo. `rejected`: não armazenado; veja `errors`." }, "event_id": { "type": "string", "nullable": true, "description": "Seu `event_id`. Nos itens rejeitados pela validação, ele é lido da chave `event_id` em snake_case do item, portanto é nulo quando o item o omitiu ou enviou o alias `eventId`." }, "errors": { "type": "object", "additionalProperties": true, "description": "Apenas itens rejeitados. Erros de validação indexados por campo, no mesmo formato do `400` de `POST /v3/events/`; um `event_id` reutilizado com conteúdo diferente é informado como string em `errors.event_id`." }, "event_uuid": { "type": "string", "format": "uuid", "description": "Somente itens aceitos e reprocessados." }, "status": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ], "description": "Somente itens aceitos e reprocessados." }, "score": { "type": "integer", "description": "Somente itens aceitos e reprocessados." }, "rules_evaluated_count": { "type": "integer", "description": "Somente itens aceitos e reprocessados." }, "rules_matched_count": { "type": "integer", "description": "Somente itens aceitos e reprocessados." }, "correlation_pending": { "type": "boolean", "description": "Somente itens aceitos e reprocessados." }, "retention_class": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ], "description": "Somente itens aceitos e reprocessados." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Somente itens aceitos e reprocessados." }, "idempotent_replay": { "type": "boolean", "description": "Somente itens aceitos e reprocessados." }, "rule_matches": { "type": "array", "description": "Somente itens aceitos e reprocessados.", "items": { "type": "object", "required": [ "rule_id", "library_key", "mode", "is_async" ], "properties": { "rule_id": { "type": "string", "format": "uuid", "description": "UUID da regra." }, "library_key": { "type": "string", "nullable": true, "description": "Chave da biblioteca quando a regra foi instalada a partir da biblioteca de regras; caso contrário, null." }, "mode": { "type": "string", "enum": [ "ACTIVE", "TEST" ], "description": "Regras `TEST` registram a correspondência, mas não aplicam nenhuma ação." }, "is_async": { "type": "boolean", "description": "`true` quando a correspondência veio da passagem assí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": "O próprio lote está malformado: `events` está ausente ou não é um array, está vazio ou tem mais de 500 itens. Nada é armazenado; divida lotes grandes.", "content": { "application/json": { "examples": { "Not a list": { "value": { "events": "Expected a list of events." } }, "Empty": { "value": { "events": "At least one event is required." } }, "Too many": { "value": { "events": "A batch accepts at most 500 events; received 612." } } } } } }, "401": { "description": "A chave de API com escopo expirou. Somente uma chave expirada recebe `401`; uma chave ausente ou inválida recebe `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ausência de `x-api-key` (uma chave incorreta, revogada ou expirada recebe `401`), uma chave com escopo sem `transactions: write`, uma chave limitada a alguns fluxos ou a sessões aprovadas (essa chave nunca acessa dados de monitoramento de transações) ou uma requisição feita de fora da lista de IPs permitidos da chave. Também é retornado com `code: event_monitoring_disabled` enquanto a ingestão de eventos estiver desativada para a aplicação; nesse caso, nada é armazenado, e a verificação é executada antes da validação do corpo.", "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": "Limite de requisições excedido: requisições de escrita (`POST`, `PATCH`, `DELETE`) compartilham uma cota de 300 requisições por minuto por chave de API. Aguarde `Retry-After` segundos e tente novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } }, "content": { "application/json": { "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/events/sdk-token/": { "post": { "summary": "Gerar token de SDK de monitoramento", "description": "Gere uma credencial de dispositivo de curta duração vinculada a um único titular, para que seu app web ou mobile envie os eventos desse usuário diretamente à Didit sem uma chave de API. O app envia o `monitoring_token` retornado no cabeçalho `X-Monitoring-Token` para o canal de dispositivo (`POST /v1/events/` e `POST /v1/events/batch/`), onde o titular é sempre sobrescrito com este `vendor_data`, eventos fora de `allowed_event_categories` são rejeitados, cada evento enviado consome um uso e uma requisição cujo `Origin` não seja igual a `bind_to_origin` é recusada. Chame este endpoint somente a partir do seu backend; a geração cria a credencial e nada mais (nenhum usuário é criado). A ingestão de eventos precisa estar ativada para a aplicação; caso contrário, este endpoint retorna `403` com `code: event_monitoring_disabled` em vez de gerar uma credencial que nunca poderia gravar. Uma chave de API com escopo precisa de `transactions: write`. Consulte [Envio de eventos pelo SDK](https://docs.didit.me/pt-br/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": "Aliases em camelCase são aceitos: `vendorData`, `entityType`, `allowedEventCategories`, `ttlSeconds`, `maxUses`, `bindToOrigin`.", "required": [ "vendor_data" ], "properties": { "vendor_data": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Seu ID do sujeito ao qual pertence cada evento enviado com esta credencial." }, "entity_type": { "type": "string", "maxLength": 32, "default": "individual", "description": "`company` vincula um titular do tipo empresa; qualquer outro valor (padrão `individual`) vincula uma pessoa física." }, "allowed_event_categories": { "type": "array", "items": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ] }, "description": "Categorias que a credencial pode enviar. Omita ou envie `[]` para permitir todas as categorias." }, "ttl_seconds": { "type": "integer", "minimum": 60, "maximum": 86400, "default": 900, "description": "Tempo de vida da credencial em segundos." }, "max_uses": { "type": "integer", "minimum": 1, "nullable": true, "default": 1000, "description": "Número de eventos que a credencial pode enviar (um lote consome um uso por evento). Envie `null` para não haver limite durante a validade." }, "bind_to_origin": { "type": "string", "maxLength": 255, "nullable": true, "description": "Quando definido, o cabeçalho `Origin` do navegador em toda requisição de dispositivo deve ser exatamente igual a este valor; uma requisição sem `Origin` é recusada." } } }, "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": "A credencial foi emitida. Entregue o `monitoring_token` ao app e trate-o como segredo até `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": "A credencial do dispositivo (um token seguro para URL de 43 caracteres). Envie-a no cabeçalho `X-Monitoring-Token`." }, "expires_at": { "type": "string", "format": "date-time", "description": "Quando a credencial deixa de ser aceita." }, "allowed_event_categories": { "type": "array", "items": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ] }, "description": "Categorias que a credencial pode enviar; `[]` significa todas as categorias." }, "max_uses": { "type": "integer", "nullable": true, "description": "Cota de eventos da credencial; null significa sem limite." }, "bind_to_origin": { "type": "string", "nullable": true, "description": "Origem à qual a credencial está vinculada, ou 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": "Falha na validação: `vendor_data` ausente, `ttl_seconds` fora do intervalo de 60 a 86400, `max_uses` menor que 1 ou uma categoria desconhecida (identificada pela sua posição no 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": "A chave de API com escopo expirou. Somente uma chave expirada recebe `401`; uma chave ausente ou inválida recebe `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ausência de `x-api-key` (uma chave incorreta, revogada ou expirada recebe `401`), uma chave com escopo sem `transactions: write`, uma chave limitada a alguns fluxos ou a sessões aprovadas (essa chave nunca acessa dados de monitoramento de transações) ou uma requisição feita de fora da lista de IPs permitidos da chave. Também é retornado com `code: event_monitoring_disabled` enquanto a ingestão de eventos estiver desativada para a aplicação; nesse caso, nada é armazenado, e a verificação é executada antes da validação do corpo.", "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": "Limite de requisições excedido: requisições de escrita (`POST`, `PATCH`, `DELETE`) compartilham uma cota de 300 requisições por minuto por chave de API. Aguarde `Retry-After` segundos e tente novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "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": "Obter evento de monitoramento", "description": "Obtenha um evento de monitoramento com tudo o que a lista retorna, além do payload, dos valores personalizados, do contexto do dispositivo, da origem dos campos (`field_sources`), dos campos de domínio promovidos, de `expires_at`, de cada execução de regra correspondente com a sua evidência, do enriquecimento de IP e das tags que as regras anexaram. Enquanto `correlation_pending` for `true`, uma regra assíncrona ainda precisa ser executada; leia o evento novamente alguns minutos depois para obter `status`, `score` e `rule_runs` finais. As leituras funcionam com a ingestão de eventos ativada ou não. Uma chave de API com escopo precisa de `transactions: read`. Consulte [Evidência](https://docs.didit.me/pt-br/transaction-monitoring/event-rules#evidências) e [Enriquecimento de IP](https://docs.didit.me/pt-br/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 da Didit para o evento (`event_uuid` da resposta de criação, lote, listagem ou linha do tempo), não o seu próprio `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": "O evento com suas evidências.", "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": "A chave de API com escopo expirou. Somente uma chave expirada recebe `401`; uma chave ausente ou inválida recebe `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ausência de `x-api-key` (uma chave incorreta, revogada ou expirada recebe `401`), uma chave com escopo sem `transactions: read`, uma chave limitada a alguns fluxos ou a sessões aprovadas (essa chave nunca acessa dados de monitoramento de transações) ou uma requisição feita de fora da lista de IPs permitidos da chave.", "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": "Não existe nenhum evento com este `event_uuid` na aplicação: ele nunca foi armazenado, foi excluído ou pertence a outra aplicação. Um segmento de caminho que não seja um UUID não corresponde à rota e também retorna `404`.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No MonitoringEvent matches the given query." } } } } } }, "429": { "description": "Limite de requisições excedido: requisições `GET` compartilham uma cota de 600 requisições por minuto por chave de API. Aguarde `Retry-After` segundos e tente novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "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": "Obter a linha do tempo de eventos do titular", "description": "Lista todos os eventos de monitoramento de um titular, do `occurred_at` mais recente para o mais antigo. Um `vendor_data` é único apenas dentro de um tipo de entidade, então o mesmo id pode identificar uma pessoa física e uma empresa: `entity_type` escolhe qual linha do tempo você recebe e o padrão é `individual`, então os eventos de uma empresa exigem `entity_type=company`. Os filtros de `GET /v3/events/` se aplicam por cima, e um `vendor_data` sem eventos retorna uma página vazia em vez de `404`. Uma chave de API com escopo precisa de `transactions: read`. Consulte [Ler os eventos de volta](https://docs.didit.me/pt-br/transaction-monitoring/events#consultando-eventos).", "operationId": "get_monitoring_event_subject_timeline", "x-didit-sdk": { "resource": "monitoring_events", "method": "retrieve_subject_timeline", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "parameters": [ { "name": "vendor_data", "in": "path", "required": true, "description": "Seu ID do sujeito (`subject.vendor_data` dos seus eventos). Codifique-o para URL; um valor que contenha `/` não pode ser endereçado por este endpoint.", "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "example": "user-42" }, { "name": "entity_type", "in": "query", "required": false, "description": "`company` retorna a empresa com este `vendor_data`; qualquer outro valor, ou nenhum, retorna a pessoa física. `subject_entity_type` é aceito como alias quando `entity_type` está ausente.", "schema": { "type": "string", "enum": [ "individual", "company" ], "default": "individual" }, "example": "individual" }, { "name": "limit", "in": "query", "required": false, "description": "Número máximo de eventos por página. O padrão é 50. Valores acima de 1000000 retornam `400`; um valor não numérico, zero ou negativo volta para 50.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "example": 50 }, { "name": "offset", "in": "query", "required": false, "description": "Número de eventos a pular. O padrão é 0. Prefira seguir a URL `next` da resposta.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "example": 0 }, { "name": "event_category", "in": "query", "required": false, "description": "Somente eventos nestas categorias. Repita o parâmetro para vários valores (`?event_category=payment&event_category=dispute`); um evento que corresponda a qualquer um deles é retornado.", "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": "Somente eventos com estes tipos de ação (exatos, diferenciando maiúsculas de minúsculas). Repita para vários valores.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "deposit_completed", "chargeback_opened" ] }, { "name": "status", "in": "query", "required": false, "description": "Somente eventos com estes status. Repita para vários valores.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ] } }, "example": [ "IN_REVIEW", "DECLINED" ] }, { "name": "retention_class", "in": "query", "required": false, "description": "Somente eventos nestas classes de retenção. Repita para vários valores.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ] } }, "example": [ "risk_relevant" ] }, { "name": "business_vendor_data", "in": "query", "required": false, "description": "Correspondência exata no `business.vendor_data` enviado com o evento.", "schema": { "type": "string" }, "example": "merchant-7" }, { "name": "session_id", "in": "query", "required": false, "description": "Correspondência exata em `session.session_id`.", "schema": { "type": "string" }, "example": "web-session-abc" }, { "name": "device_fingerprint", "in": "query", "required": false, "description": "Correspondência exata em `device_context.fingerprint`.", "schema": { "type": "string" }, "example": "fp-a8c1" }, { "name": "ip_address", "in": "query", "required": false, "description": "Correspondência exata no endereço IP do evento.", "schema": { "type": "string" }, "example": "203.0.113.42" }, { "name": "game_id", "in": "query", "required": false, "description": "Correspondência exata no `game_id` promovido.", "schema": { "type": "string" }, "example": "poker-holdem-01" }, { "name": "round_id", "in": "query", "required": false, "description": "Correspondência exata no `round_id` promovido.", "schema": { "type": "string" }, "example": "round-88231" }, { "name": "affiliate_code", "in": "query", "required": false, "description": "Correspondência exata no `affiliate_code` promovido.", "schema": { "type": "string" }, "example": "aff-summer" }, { "name": "payment_reference_id", "in": "query", "required": false, "description": "Correspondência exata na referência de pagamento (de `transaction_context.payment_reference_id` ou `payload.payment_reference_id`).", "schema": { "type": "string" }, "example": "dep_735" }, { "name": "counterparty_vendor_data", "in": "query", "required": false, "description": "Correspondência exata no `counterparty_vendor_data` promovido.", "schema": { "type": "string" }, "example": "user-77" }, { "name": "matched_only", "in": "query", "required": false, "description": "`true` (também `1` ou `yes`, sem diferenciar maiúsculas de minúsculas) retorna apenas os eventos aos quais pelo menos uma regra correspondeu (`rules_matched_count` acima de 0). Qualquer outro valor é ignorado.", "schema": { "type": "boolean", "default": false }, "example": true }, { "name": "occurred_from", "in": "query", "required": false, "description": "Somente eventos com `occurred_at` neste instante ou depois dele (inclusive). Envie um valor ISO 8601: `2026-10-01T00:00:00Z`, um deslocamento explícito com o `+` codificado em percentual (`2026-10-01T02:00:00%2B02:00`; um `+` não codificado é decodificado como espaço e o valor deixa de ser interpretado) ou apenas uma data (`2026-10-01`), que significa 00:00:00 UTC desse dia. Um valor sem deslocamento é lido como UTC. Valores em qualquer outro formato não são aceitos.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-01T00:00:00Z" }, { "name": "occurred_to", "in": "query", "required": false, "description": "Somente eventos com `occurred_at` neste instante ou antes dele (inclusive). Apenas uma data significa o início desse dia, então `occurred_to=2026-10-15` exclui o restante de 15 de outubro; envie `2026-10-15T23:59:59Z` para incluí-lo. Envie um valor ISO 8601: `2026-10-01T00:00:00Z`, um deslocamento explícito com o `+` codificado em percentual (`2026-10-01T02:00:00%2B02:00`; um `+` não codificado é decodificado como espaço e o valor deixa de ser interpretado) ou apenas uma data (`2026-10-01`), que significa 00:00:00 UTC desse dia. Um valor sem deslocamento é lido como UTC. Valores em qualquer outro formato não são aceitos.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-17T23:59:59Z" }, { "name": "search", "in": "query", "required": false, "description": "Correspondência de substring sem distinção entre maiúsculas e minúsculas em `event_id`, `action_type`, `subject_vendor_data` ou `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": "Uma página dos eventos do titular.", "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` ou `offset` é maior que 1000000. O corpo é um array JSON com uma mensagem. Um `limit` não numérico ou não positivo volta ao padrão de 50 em vez de falhar.", "content": { "application/json": { "examples": { "limit too large": { "summary": "limit acima de 1000000", "value": [ "limit must not exceed 1000000." ] }, "offset too large": { "summary": "offset acima de 1000000", "value": [ "offset must not exceed 1000000." ] } } } } }, "401": { "description": "A chave de API com escopo expirou. Somente uma chave expirada recebe `401`; uma chave ausente ou inválida recebe `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ausência de `x-api-key` (uma chave incorreta, revogada ou expirada recebe `401`), uma chave com escopo sem `transactions: read`, uma chave limitada a alguns fluxos ou a sessões aprovadas (essa chave nunca acessa dados de monitoramento de transações) ou uma requisição feita de fora da lista de IPs permitidos da chave.", "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": "Limite de requisições excedido: requisições `GET` compartilham uma cota de 600 requisições por minuto por chave de API. Aguarde `Retry-After` segundos e tente novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "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": "Obter as métricas de enriquecimento de eventos", "description": "Retorna os contadores de ingestão de eventos e de enriquecimento de IP da sua aplicação em um período, somados em todos os canais (servidor, lote e dispositivo), para que você acompanhe o volume de eventos e confirme que o enriquecimento é resolvido uma vez por endereço único, e não uma vez por evento. O período abrange o dia de hoje mais os `days` dias anteriores, contados por data de calendário em UTC. As três proporções são nulas quando o denominador é zero. Uma chave de API com escopo precisa de `transactions: read`. Consulte [Enriquecimento de IP](https://docs.didit.me/pt-br/transaction-monitoring/events#enriquecimento-de-ip).", "operationId": "get_monitoring_event_enrichment_metrics", "x-didit-sdk": { "resource": "monitoring_events", "method": "retrieve_enrichment_metrics", "auth": "api_key", "server": true }, "tags": [ "Monitoring Events" ], "parameters": [ { "name": "days", "in": "query", "required": false, "description": "Duração do período em dias. O padrão é 30; os valores são limitados ao intervalo de 1 a 365, e um valor não inteiro volta para 30. O valor aplicado é retornado como `period_days`.", "schema": { "type": "integer", "default": 30, "minimum": 1, "maximum": 365 }, "example": 30 } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/events/enrichment-metrics/?days=30' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.monitoring_events.retrieve_enrichment_metrics()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.monitoringEvents.retrieveEnrichmentMetrics();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.MonitoringEvents.RetrieveEnrichmentMetrics(ctx, didit.MonitoringEventsRetrieveEnrichmentMetricsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.monitoringEvents().retrieveEnrichmentMetrics();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "monitoringEvents->retrieveEnrichmentMetrics();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.monitoring_events.retrieve_enrichment_metrics\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.MonitoringEvents.RetrieveEnrichmentMetricsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Contadores e proporções do período.", "content": { "application/json": { "schema": { "type": "object", "required": [ "events_ingested", "events_rejected", "enrichment_lookups", "enrichment_cache_hits", "enrichment_provider_calls", "enrichment_skipped_low_value", "unique_ips_seen", "period_days", "cache_hit_rate", "unique_ip_ratio", "provider_calls_per_1k_events" ], "properties": { "events_ingested": { "type": "integer", "description": "Novos eventos armazenados. Repetições idempotentes não são contabilizadas." }, "events_rejected": { "type": "integer", "description": "Itens rejeitados dentro de requisições em lote (canais de servidor e de dispositivo). Uma requisição de evento único rejeitada não é contabilizada." }, "enrichment_lookups": { "type": "integer", "description": "Eventos cujo endereço IP público foi resolvido, a partir do cache ou de uma nova consulta." }, "enrichment_cache_hits": { "type": "integer", "description": "Consultas respondidas a partir do cache." }, "enrichment_provider_calls": { "type": "integer", "description": "Consultas que exigiram uma nova resolução do endereço." }, "enrichment_skipped_low_value": { "type": "integer", "description": "Eventos de telemetria de baixo valor cujo endereço ainda não era conhecido. Eles nunca acionam uma nova resolução por conta própria." }, "unique_ips_seen": { "type": "integer", "description": "Endereços que precisaram de uma nova resolução." }, "period_days": { "type": "integer", "description": "O valor de `days` aplicado após o ajuste aos limites permitidos." }, "cache_hit_rate": { "type": "number", "nullable": true, "description": "`enrichment_cache_hits / enrichment_lookups`, arredondado para 4 casas decimais. Nulo quando não houve consultas." }, "unique_ip_ratio": { "type": "number", "nullable": true, "description": "`unique_ips_seen / events_ingested`, arredondado para 4 casas decimais. Nulo quando nenhum evento foi ingerido." }, "provider_calls_per_1k_events": { "type": "number", "nullable": true, "description": "Novas resoluções a cada 1000 eventos ingeridos, arredondadas para 2 casas decimais. Null quando nenhum evento foi ingerido." } } }, "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": "A chave de API com escopo expirou. Somente uma chave expirada recebe `401`; uma chave ausente ou inválida recebe `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ausência de `x-api-key` (uma chave incorreta, revogada ou expirada recebe `401`), uma chave com escopo sem `transactions: read`, uma chave limitada a alguns fluxos ou a sessões aprovadas (essa chave nunca acessa dados de monitoramento de transações) ou uma requisição feita de fora da lista de IPs permitidos da chave.", "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": "Limite de requisições excedido: requisições `GET` compartilham uma cota de 600 requisições por minuto por chave de API. Aguarde `Retry-After` segundos e tente novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "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": "Excluir evento de monitoramento", "description": "Exclui permanentemente um evento de monitoramento junto com as suas execuções de regras, notas e vínculos de tags, por exemplo, um evento enviado por engano. Após o `204`, o evento desaparece de todas as leituras (a consulta retorna `404` e ele não aparece mais na listagem nem na linha do tempo do titular), a exclusão é irreversível e o seu `event_id` fica livre para ser usado em um novo evento. Não são afetados: o usuário ou a empresa ao qual o evento foi associado, os casos abertos por uma regra, as entradas de lista adicionadas por uma regra e as pontuações e status já aplicados a outros eventos. Para apagar tudo sobre uma pessoa ou uma empresa, exclua o usuário ou a empresa, o que também exclui os seus eventos. Uma chave de API com escopo precisa de `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 da Didit para o evento (`event_uuid` da resposta de criação, lote, listagem ou linha do tempo), não o seu próprio `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": "O evento foi excluído. Sem corpo." }, "401": { "description": "A chave de API com escopo expirou. Somente uma chave expirada recebe `401`; uma chave ausente ou inválida recebe `403`.", "content": { "application/json": { "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Ausência de `x-api-key` (uma chave incorreta, revogada ou expirada recebe `401`), uma chave com escopo sem `transactions: write`, uma chave limitada a alguns fluxos ou a sessões aprovadas (essa chave nunca acessa dados de monitoramento de transações) ou uma requisição feita de fora da lista de IPs permitidos da chave.", "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": "Não existe nenhum evento com este `event_uuid` na aplicação: ele nunca foi armazenado, foi excluído ou pertence a outra aplicação. Um segmento de caminho que não seja um UUID não corresponde à rota e também retorna `404`.", "content": { "application/json": { "examples": { "Not found": { "value": { "detail": "No MonitoringEvent matches the given query." } } } } } }, "429": { "description": "Limite de requisições excedido: requisições de escrita (`POST`, `PATCH`, `DELETE`) compartilham uma cota de 300 requisições por minuto por chave de API. Aguarde `Retry-After` segundos e tente novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "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": "Gerar novamente a sessão de KYC de uma parte de pessoas-chave", "description": "Gera uma nova sessão de KYC individual para uma parte de Pessoas-chave de uma sessão de Verificação de empresas (KYB) depois que a anterior foi excluída ou expirou antes de a pessoa iniciá-la, para que a verificação de Pessoas-chave possa ser concluída novamente; não envie corpo na requisição. Funciona quando a sessão de KYC da parte foi excluída (`kyc_session_deleted: true`) ou expirou antes de a pessoa iniciá-la (`Expired`, nunca iniciada). Uma sessão ainda em andamento ou que terminou em qualquer outro status (`Approved`, `Declined`, `In Review`, `Abandoned`, ...) retorna `409`, a menos que tenha sido excluída. Uma parte que nunca teve uma sessão ou uma parte que seja empresa sempre retorna `409`. A Didit cria uma nova sessão de KYC hospedada com o fluxo com que a parte foi verificada (sua versão publicada mais recente) ou, quando ele não é mais conhecido, com o fluxo que suas configurações de Pessoas-chave atribuem à função da parte, de modo que o link dura o tempo de expiração de sessão desse fluxo de KYC; ela envia o link por e-mail à parte quando há um e-mail registrado, limpa `is_skipped` e recalcula a verificação de Pessoas-chave e o status da sessão de empresa. Em seguida, envia um [webhook](https://docs.didit.me/pt-br/integration/webhooks) `data.updated` para a sessão de empresa com o gatilho `console_key_people_regenerate`; para isentar a parte em vez disso, use `PATCH /v3/session/{sessionId}/kyb/parties/{partyUuid}/`. Uma chave de API com escopo precisa de `decisions: write` e, sem `sessions: write`, recebe `kyc_session_url` como `null`. Sessões excluídas se qualificam mesmo que a pessoa já tenha iniciado ou concluído a verificação. Sessões importadas não se qualificam por expiração; elas precisam ter sido excluídas.", "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 da sessão principal de Verificação de empresas (KYB).", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "partyUuid", "in": "path", "required": true, "description": "UUID da parte de pessoas-chave (Key People) (`key_people_checks[].submitted.parties[].uuid` na decisão da sessão de empresa). Deve pertencer à sessão referenciada por `sessionId`.", "schema": { "type": "string", "format": "uuid", "example": "0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41" } } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/session/33333333-4444-5555-6666-777777777777/kyb/parties/0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41/regenerate/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.regenerate_kyb_party(\n \"33333333-4444-5555-6666-777777777777\",\n \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.regenerateKybParty(\n \"33333333-4444-5555-6666-777777777777\",\n \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.RegenerateKYBParty(ctx, \"33333333-4444-5555-6666-777777777777\", \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().regenerateKybParty(\"33333333-4444-5555-6666-777777777777\", \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->regenerateKybParty('33333333-4444-5555-6666-777777777777', '0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.regenerate_kyb_party(\n \"33333333-4444-5555-6666-777777777777\",\n \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.RegenerateKybPartyAsync(\"33333333-4444-5555-6666-777777777777\", \"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Nova sessão de KYC criada. Retorna a parte atualizada com sua nova sessão filha, que expira após o tempo de expiração de sessão do fluxo de verificação (workflow) de KYC correspondente.", "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": "A chave de API com escopo expirou. Este é o único caso que retorna `401`: uma chave ausente, inválida ou revogada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "summary": "A data de validade da chave já passou", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falha de autenticação ou autorização. Uma chave ausente retorna `403`, assim como uma chave de outra aplicação, uma chave com escopo sem a permissão exigida por este endpoint e uma requisição de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada retorna `401`. Diferencie-as pelo `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Missing or invalid credentials": { "summary": "Cabeçalho x-api-key ausente, ou a chave falhou na validação", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Uma chave válida que pertence a uma aplicação diferente da aplicação da sessão", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "Chave com escopo sem decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Requisição de fora da lista de IPs permitidos da chave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "A sessão não existe, foi excluída ou está fora dos limites de uma chave com escopo; nenhuma parte com este UUID existe na sua aplicação; ou a parte pertence a outra sessão. Cada caso tem seu próprio `detail`. A busca da sessão é feita antes da verificação da credencial, então um `sessionId` desconhecido retorna `404` mesmo sem uma chave válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Unknown session": { "summary": "Não existe nenhuma sessão com este ID, ou ela foi excluída", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "A sessão está fora dos limites de fluxo ou de somente aprovadas de uma chave com escopo", "value": { "detail": "Session not found." } }, "Unknown party": { "summary": "Nenhuma parte com este UUID na sua aplicação", "value": { "detail": "No BusinessParty matches the given query." } }, "Party of another session": { "summary": "partyUuid existe, mas pertence a outra sessão", "value": { "detail": "Party does not belong to the given session." } } } } } }, "409": { "description": "A parte não tem nenhuma sessão de KYC elegível para substituir. A menos que tenha sido excluída, uma sessão ainda em andamento ou que terminou em outro status (`Approved`, `Declined`, `In Review`, `Abandoned`, ...) não pode ser regenerada. Uma parte que nunca teve uma sessão ou uma parte que é empresa também retorna `409`. Uma sessão elegível foi excluída ou expirou antes de a pessoa iniciá-la. Sessões excluídas se qualificam mesmo que a pessoa já tenha iniciado ou concluído a verificação. Sessões importadas não se qualificam por expiração; elas precisam ter sido excluídas. Ramifique com base em `code`.", "content": { "application/json": { "schema": { "type": "object", "required": [ "detail", "code" ], "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." }, "code": { "type": "string", "enum": [ "kyb_party_kyc_session_not_deleted" ], "description": "Código de erro estável e legível por máquina." } } }, "example": { "detail": "This party's KYC session is still live (it has neither been deleted nor expired without starting), so it cannot be regenerated.", "code": "kyb_party_kyc_session_not_deleted" } } } }, "429": { "description": "Limite de requisições excedido: 300 requisições de escrita (POST, PATCH, DELETE) por minuto por chave de API. Aguarde `Retry-After` segundos antes de tentar novamente; os cabeçalhos `X-RateLimit-*` mostram a cota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Rate limited": { "summary": "Orçamento do minuto atual esgotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/transactions/{transaction_id}/notes/": { "get": { "summary": "Listar notas de transação", "description": "Lista as notas de uma transação monitorada, das mais recentes para as mais antigas (`created_at` em ordem decrescente): notas que você adiciona pela API, notas e mudanças de status que os revisores fazem no Console e notas que a Didit adiciona automaticamente (a ação `add_note` de uma regra ou um problema ao criar a sessão de verificação da ação do usuário), que trazem `actor_name` `Rule Engine`. `metadata` diferencia os tipos de nota.\n\nPaginada com `limit` e `offset`. `count` é exato até 100 e limitado a 100 acima disso; portanto, siga `next` até que seja `null` em vez de calcular as páginas a partir de `count`. Esta é uma leitura sem efeitos colaterais.\n\nUma chave de API com escopo precisa de `transactions: read`; uma chave limitada a alguns fluxos ou a sessões aprovadas não pode chamar este endpoint. Os revisores veem a mesma lista em **Notes** no [detalhe da transação](https://docs.didit.me/pt-br/transaction-monitoring/console#detalhes-da-transação).", "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 da transação na Didit: o `uuid` retornado por `POST /v3/transactions/` e `GET /v3/transactions/`. O seu próprio `txn_id` não é aceito.", "schema": { "type": "string", "format": "uuid" }, "example": "abcdef12-3456-7890-abcd-ef1234567890" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "description": "Número de notas por página. O padrão é 50. Um valor que não seja um inteiro positivo volta para 50; um valor acima de 1000000 retorna `400`." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Posição, a partir de zero, da primeira nota a retornar. Prefira seguir `next`. Um valor que não seja um número inteiro passa a ser 0; um valor acima de 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": "Uma página de notas, da mais recente para a mais antiga.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Número de notas na transação: exato até 100 e limitado a 100 acima disso. Siga `next` em vez de calcular páginas a partir dele." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta da próxima página, ou `null` na última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta da página anterior, ou `null` na primeira 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` ou `offset` é maior que 1000000. O corpo é um array JSON de mensagens, não um objeto.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "Limit too large": { "value": [ "limit must not exceed 1000000." ] }, "Offset too large": { "value": [ "offset must not exceed 1000000." ] } } } } }, "401": { "description": "A chave de API expirou. Somente uma chave criada com data de validade pode expirar; após essa data, toda requisição feita com ela responde `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida. Uma chave ausente recebe a mensagem genérica; uma chave incorreta, revogada ou expirada recebe `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": "Não existe nenhuma transação com este UUID na aplicação (nunca criada, excluída ou pertencente a outra aplicação). Um `transaction_id` que não seja um UUID não chega à API: ele retorna uma página HTML `404` em vez deste corpo JSON.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not found": { "value": { "detail": "No Transaction matches the given query." } } } } } }, "429": { "description": "Mais de 600 requisições GET por minuto com esta chave de API. Aguarde o número de segundos indicado em `Retry-After` e tente novamente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos até a janela atual de um minuto ser reiniciada.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas por minuto nesta cota.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Horário Unix em que a janela é reiniciada.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "post": { "summary": "Criar nota de transação", "description": "Adiciona uma nota em texto simples à linha do tempo de revisão de uma transação monitorada, onde os revisores do Console a veem. Uma nota é contexto, não uma decisão: o `status`, o `score` e os alertas da transação não mudam, nenhum webhook é enviado e nada é cobrado. As `activities` da transação ganham uma entrada `TRANSACTION_NOTE_ADDED`.\n\nNotas criadas com uma chave de API não têm autor: `actor_email` e `actor_name` são `null`, então inclua o autor no texto se precisar. Todo endereço em `mentioned_emails` deve pertencer a um membro da sua organização; caso contrário, a requisição inteira falha com `400`. As menções são armazenadas em letras minúsculas e sem duplicatas, e este endpoint não notifica os membros mencionados.\n\nCada chamada cria uma nova nota, então tentar novamente uma requisição que expirou pode adicioná-la duas vezes: liste as notas antes de tentar novamente. Não há endpoint de API para editar ou remover uma nota. Uma chave de API com escopo precisa de `transactions: write`; uma chave limitada a alguns fluxos ou a sessões aprovadas não pode chamar este endpoint.", "operationId": "create_transaction_note", "x-didit-sdk": { "resource": "transactions.notes", "method": "create", "auth": "api_key", "server": true }, "tags": [ "Transactions" ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "description": "UUID da transação na Didit: o `uuid` retornado por `POST /v3/transactions/` e `GET /v3/transactions/`. O seu próprio `txn_id` não é aceito.", "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 em texto simples. Espaços em branco no início e no fim são removidos, e uma nota vazia é rejeitada. Sem limite de tamanho." }, "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email" }, "default": [], "description": "E-mails dos membros da sua organização a mencionar. Cada um deve ser um e-mail válido de um membro da organização." } } }, "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": "A nota foi criada.", "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": "O corpo é inválido: `note` ausente, null ou em branco, um endereço inválido em `mentioned_emails` (erros indexados pela posição na lista) ou um endereço mencionado que não é membro da sua organização. Nada é criado.", "content": { "application/json": { "schema": { "type": "object", "description": "Erros de campo indexados pelo nome do campo.", "additionalProperties": {} }, "examples": { "Missing note": { "value": { "note": [ "This field is required." ] } }, "Blank note": { "value": { "note": [ "This field may not be blank." ] } }, "Invalid email": { "value": { "mentioned_emails": { "0": [ "Enter a valid email address." ] } } }, "Not an organization member": { "value": { "mentioned_emails": [ "Mentioned users must belong to this organization and have access to this application." ] } } } } } }, "401": { "description": "A chave de API expirou. Somente uma chave criada com data de validade pode expirar; após essa data, toda requisição feita com ela responde `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida. Uma chave ausente recebe a mensagem genérica; uma chave incorreta, revogada ou expirada recebe `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": "Não existe nenhuma transação com este UUID na aplicação (nunca criada, excluída ou pertencente a outra aplicação). Um `transaction_id` que não seja um UUID não chega à API: ele retorna uma página HTML `404` em vez deste corpo JSON.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not found": { "value": { "detail": "No Transaction matches the given query." } } } } } }, "429": { "description": "Mais de 300 requisições de escrita por minuto com esta chave de API. Aguarde o número de segundos indicado em `Retry-After` e tente novamente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos até a janela atual de um minuto ser reiniciada.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas por minuto nesta cota.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Horário Unix em que a janela é reiniciada.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/transactions/{transaction_id}/related/": { "get": { "summary": "Listar transações relacionadas", "description": "Lista as outras transações da sua aplicação que envolvem as mesmas pessoas ou empresas desta. Uma transação é considerada relacionada quando qualquer uma de suas partes, em qualquer função, tem o mesmo `vendor_data` que uma das partes desta transação. A própria transação nunca é retornada, e partes sem `vendor_data` são ignoradas: quando nenhuma das partes desta transação tem um, o resultado é sempre vazio.\n\nOs resultados usam o formato resumido de `GET /v3/transactions/`, dos mais recentes para os mais antigos (`txn_date`, depois `created_at`). A paginação usa `limit` e `offset`. `count` é exato até 100 e fica limitado a 100 acima disso, então siga `next` até que seja `null`.\n\nUma chave de API com escopo precisa de `transactions: read`. Uma chave limitada a alguns fluxos ou a sessões aprovadas não pode chamar este endpoint. Envie o mesmo `vendor_data` para a mesma pessoa ou empresa em toda [transação](https://docs.didit.me/pt-br/transaction-monitoring/transactions#titular-e-contraparte) para que esta lista fique 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 da transação na Didit: o `uuid` retornado por `POST /v3/transactions/` e `GET /v3/transactions/`. O seu próprio `txn_id` não é aceito.", "schema": { "type": "string", "format": "uuid" }, "example": "abcdef12-3456-7890-abcd-ef1234567890" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000 }, "description": "Número de transações por página. O padrão é 50. Um valor que não seja um inteiro positivo volta para 50; um valor acima de 1000000 retorna `400`." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000 }, "description": "Posição, a partir de zero, da primeira transação a retornar. Prefira seguir `next`. Um valor que não seja um número inteiro passa a ser 0; um valor acima de 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": "Uma página de transações relacionadas, da mais recente para a mais antiga.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Número de transações relacionadas: exato até 100 e limitado a 100 acima disso. Siga `next` em vez de calcular páginas a partir dele." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta da próxima página, ou `null` na última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL absoluta da página anterior, ou `null` na primeira 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` ou `offset` é maior que 1000000. O corpo é um array JSON de mensagens, não um objeto.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "Limit too large": { "value": [ "limit must not exceed 1000000." ] }, "Offset too large": { "value": [ "offset must not exceed 1000000." ] } } } } }, "401": { "description": "A chave de API expirou. Somente uma chave criada com data de validade pode expirar; após essa data, toda requisição feita com ela responde `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida. Uma chave ausente recebe a mensagem genérica; uma chave incorreta, revogada ou expirada recebe `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": "Não existe nenhuma transação com este UUID na aplicação (nunca criada, excluída ou pertencente a outra aplicação). Um `transaction_id` que não seja um UUID não chega à API: ele retorna uma página HTML `404` em vez deste corpo JSON.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not found": { "value": { "detail": "No Transaction matches the given query." } } } } } }, "429": { "description": "Mais de 600 requisições GET por minuto com esta chave de API. Aguarde o número de segundos indicado em `Retry-After` e tente novamente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos até a janela atual de um minuto ser reiniciada.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas por minuto nesta cota.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Horário Unix em que a janela é reiniciada.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/businesses/{business_session_id}/pdf/": { "get": { "summary": "Baixar o relatório em PDF de uma sessão de empresa", "description": "Gera o relatório em PDF de uma sessão de Verificação de empresas (KYB): dados do registro de empresas, pessoas-chave e beneficiários finais, documentos, resultados de AML e os demais recursos do fluxo, além das tags e da atividade de revisão da sessão. Com a personalização de marca própria ativada, o relatório traz o seu logotipo e a URL da sua política de privacidade. O corpo da resposta é o próprio PDF (`application/pdf`), não JSON.\n\nA sessão precisa estar com status `Approved`, `Declined` ou `In Review`; qualquer outro status retorna `403`, então aguarde primeiro o [webhook](https://docs.didit.me/pt-br/integration/webhooks) `status.updated`. O relatório é gerado a cada chamada e nada é cobrado, então armazene o arquivo em vez de buscá-lo repetidamente. `GET /v3/session/{sessionId}/generate-pdf/` gera o mesmo tipo de relatório apenas com o ID da sessão.\n\nUm relatório em PDF conta como mídia: uma chave de API com escopo precisa de `businesses: read` e `media: read`, e uma chave limitada a alguns fluxos ou a sessões aprovadas não pode chamá-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 da organização.", "example": "11111111-2222-3333-4444-555555555555" }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação. Deve ser a aplicação à qual a chave de API pertence: uma chave usada em qualquer outra aplicação recebe `403`.", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, { "name": "business_session_id", "in": "path", "required": true, "description": "`session_id` da sessão de Verificação de empresas (KYB), conforme retornado na criação da sessão. Uma sessão de outra aplicação 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": "O PDF renderizado, retornado diretamente como binário `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": "A chave de API expirou. Somente uma chave criada com data de validade pode expirar; após essa data, toda requisição feita com ela responde `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida ou a sessão não foi concluída. Leia `detail`: uma sessão que não está `Approved`, `Declined` ou `In Review`, uma chave de API ausente (uma chave incorreta, revogada ou expirada recebe `401`), um `application_id` que não é da aplicação da chave, uma chave com escopo sem `media: read` ou `businesses: read`, uma chave limitada a fluxos ou a sessões aprovadas, ou uma requisição de fora da lista de IPs da chave.", "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": "Não existe nenhuma sessão de empresa com este ID na aplicação (nunca foi criada, foi excluída ou pertence a outra aplicação). Um valor que não seja um UUID retorna uma página HTML `404` em vez deste corpo JSON.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not found": { "value": { "detail": "Business session not found." } } } } } }, "429": { "description": "Mais de 600 requisições GET por minuto com esta chave de API. Aguarde o número de segundos indicado em `Retry-After` e tente novamente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos até a janela atual de um minuto ser reiniciada.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas por minuto nesta cota.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Horário Unix em que a janela é reiniciada.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/pdf/": { "get": { "summary": "Baixar o relatório em PDF de uma transação", "description": "Gere um relatório em PDF de uma transação monitorada: visão geral e veredito, partes e métodos de pagamento, propriedades personalizadas, alertas e execuções de regras, resultados de triagem e de Travel Rule, o resumo da rede, o detalhamento de custos, até 50 transações relacionadas e as 20 entradas de atividade mais recentes. O corpo é o próprio PDF (`application/pdf`), não JSON.\n\nO relatório é gerado a partir dos dados atuais da transação a cada chamada, então solicite-o novamente após uma mudança de status. Nada é armazenado e nada é cobrado. A geração pode levar alguns segundos, então use um tempo limite generoso no cliente.\n\nEste endpoint fica em um caminho com escopo de aplicação: coloque na URL o ID da sua organização e o ID da aplicação à qual sua chave de API pertence ([encontre o ID da sua organização](https://docs.didit.me/pt-br/getting-started/api-authentication#como-encontrar-o-id-da-sua-organização)). Um relatório em PDF conta como mídia: uma chave de API com escopo precisa de `media: read` e `transactions: read`, e uma chave limitada a alguns fluxos de verificação (workflows) ou a sessões aprovadas não pode chamá-lo.", "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 da organização.", "example": "11111111-2222-3333-4444-555555555555" }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação. Deve ser a aplicação à qual a chave de API pertence: uma chave usada em qualquer outra aplicação recebe `403`.", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, { "name": "transaction_uuid", "in": "path", "required": true, "description": "UUID da transação na Didit: o `uuid` retornado por `POST /v3/transactions/` e `GET /v3/transactions/`. O seu próprio `txn_id` não é aceito.", "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": "O PDF renderizado, retornado diretamente como binário `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": "A chave de API expirou. Somente uma chave criada com data de validade pode expirar; após essa data, toda requisição feita com ela responde `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida. Leia `detail`: uma chave de API ausente (uma chave errada, revogada ou expirada recebe `401`), um `application_id` que não é a aplicação da chave, uma chave com escopo sem `media: read` ou `transactions: read`, uma chave limitada a fluxos ou a sessões aprovadas, ou uma requisição feita fora da lista de IPs da chave.", "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": "Não existe nenhuma transação com este UUID na aplicação (nunca criada, excluída ou pertencente a outra aplicação). Um `transaction_uuid` que não seja um UUID não chega à API: ele retorna uma página HTML `404` em vez deste corpo JSON.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Not found": { "value": { "detail": "No Transaction matches the given query." } } } } } }, "429": { "description": "Mais de 600 requisições GET por minuto com esta chave de API. Aguarde o número de segundos indicado em `Retry-After` e tente novamente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos até a janela atual de um minuto ser reiniciada.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas por minuto nesta cota.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Horário Unix em que a janela é reiniciada.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/analytics/": { "get": { "summary": "Obter as análises da aplicação", "description": "Leia os números por trás do [painel de análises](https://docs.didit.me/pt-br/console/analytics) do Business Console para um intervalo de datas. Sem `scope` e `widget_keys`, a resposta é o resumo de verificação de usuários (KYC) (`ApplicationAnalyticsSummary`): contagens diárias de sessões, totais por status, taxa de conversão, os mesmos números para o período anterior de igual duração, localizações, dados demográficos, dispositivos, funis por fluxo de verificação (workflow), tempo ativo de verificação, reenvios, avisos e séries temporais. Com `scope` ou `widget_keys`, a resposta são os widgets de uma aba do painel (`ApplicationAnalyticsWidgetResponse`): `kyc`, `kyb`, `transactions` ou `home`.\n\nAs contagens de sessões são feitas pela data de criação da sessão (UTC) e refletem o status atual de cada sessão. Elas vêm de consolidações diárias atualizadas em segundo plano, então a atividade mais recente pode levar um pouco para aparecer. IDs e versões de fluxo inválidos são ignorados em vez de rejeitados. Nada é cobrado.\n\nSomente uma chave de API com acesso total pode chamar este endpoint: toda chave com escopo recebe `403`, qualquer que seja o acesso que tenha, assim como uma chave de outra aplicação. Consulte [Chaves de API](https://docs.didit.me/pt-br/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 da organização.", "example": "11111111-2222-3333-4444-555555555555" }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação. Deve ser a aplicação à qual a chave de API pertence: uma chave usada em qualquer outra aplicação recebe `403`.", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2026-10-01" }, "description": "Primeiro dia do intervalo, `YYYY-MM-DD`, inclusive (UTC). Envie junto com `end_date`: quando um dos dois está ausente, ambos são ignorados e o intervalo vai de 30 dias antes de hoje até hoje." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2026-10-15" }, "description": "Último dia do intervalo, `YYYY-MM-DD`, inclusivo (UTC). Uma data futura conta como hoje. O intervalo não pode exceder 730 dias." }, { "name": "scope", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "home", "kyc", "kyb", "transactions" ] }, "description": "Aba do painel para a qual retornar widgets (sem diferenciar maiúsculas de minúsculas). Omita-a, junto com `widget_keys`, para obter o resumo de KYC. Enviar apenas `widget_keys` implica `kyc`. `home` aceita qualquer widget de KYC, KYB ou de transações e usa por padrão o layout inicial salvo da aplicação." }, { "name": "widget_keys", "in": "query", "required": false, "schema": { "type": "string", "example": "tx_count_total,tx_count_daily" }, "description": "Chaves de widget separadas por vírgula, respondidas nesta ordem. As chaves que o escopo não aceita são descartadas; quando não sobra nenhuma, você recebe os padrões do escopo. 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`. Transações: `tx_count_total`, `tx_count_daily`, `tx_volume_total_preferred_currency`, `tx_volume_daily_preferred_currency`, `tx_average_amount`, `tx_average_amount_daily`, `tx_transaction_category_breakdown`, `tx_action_type_breakdown`, `tx_status_volume_trend`, `tx_user_ip_or_country_distribution`, `tx_tag_breakdown`, `tx_top_rules_triggered`, `tx_team_member_performance`, `tx_score_histogram`." }, { "name": "workflow_ids", "in": "query", "required": false, "schema": { "type": "string", "example": "33333333-4444-5555-6666-777777777777" }, "description": "IDs de fluxo separados por vírgula. Limita o resumo de KYC e os widgets de KYC e KYB a esses fluxos. Valores que não são UUIDs são ignorados; quando nenhum é válido, o filtro é descartado. O resumo também aceita `workflow_id`." }, { "name": "versions", "in": "query", "required": false, "schema": { "type": "string", "example": "3,4" }, "description": "Números de versão do fluxo separados por vírgula. Aplica-se somente em conjunto com `workflow_ids`; valores que não são números inteiros são ignorados. `version` é aceito como alias." }, { "name": "branch_path_ids", "in": "query", "required": false, "schema": { "type": "string", "example": "default" }, "description": "IDs de caminhos de ramificação separados por vírgula. Só se aplica junto com `workflow_ids` e apenas aos números de KYC. Atualmente, os números são registrados apenas para `default` (todos os caminhos combinados), então qualquer outro valor retorna números vazios. `branch_path_id` é aceito como alias." }, { "name": "tag", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Somente widgets de transações: UUIDs ou nomes de tags separados por vírgula." }, { "name": "transaction_type", "in": "query", "required": false, "schema": { "type": "string", "example": "finance" }, "description": "Somente widgets de transações: categorias de transação separadas por vírgula." }, { "name": "action_type", "in": "query", "required": false, "schema": { "type": "string", "example": "withdrawal" }, "description": "Somente widgets de transações: tipos de ação separados por vírgula (sem distinção entre maiúsculas e minúsculas)." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/analytics/?start_date=2026-10-01&end_date=2026-10-15' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.analytics.retrieve()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.analytics.retrieve();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Analytics.Retrieve(ctx, didit.AnalyticsRetrieveParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.analytics().retrieve();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "analytics->retrieve();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.analytics.retrieve\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Analytics.RetrieveAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "O resumo de KYC, ou os widgets solicitados quando `scope` ou `widget_keys` é enviado.", "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": "Intervalo de datas ou escopo inválido. O corpo é um objeto indexado pelo parâmetro problemático, com uma mensagem em string.", "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": "A chave de API expirou. Somente uma chave criada com data de validade pode expirar; após essa data, toda requisição feita com ela responde `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida. Leia `detail`: uma chave de API ausente (uma chave errada, revogada ou expirada recebe `401`), uma chave de outra aplicação, qualquer chave com escopo ou uma requisição feita fora da lista de IPs da chave.", "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": "Mais de 600 requisições GET por minuto com esta chave de API. Aguarde o número de segundos indicado em `Retry-After` e tente novamente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos até a janela atual de um minuto ser reiniciada.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas por minuto nesta cota.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Horário Unix em que a janela é reiniciada.", "schema": { "type": "integer" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/organization/{organization_id}/application/{application_id}/analytics/today/": { "get": { "summary": "Obter as verificações de hoje por hora", "operationId": "get_application_analytics_today", "x-didit-sdk": { "resource": "analytics", "method": "retrieve_today", "auth": "api_key", "server": true, "scope": "application" }, "tags": [ "Analytics" ], "description": "Sessões de verificação de usuários (KYC) de hoje, a partir da meia-noite local em `tz`, contadas pela hora local em que foram criadas, ao lado das mesmas horas do mesmo dia da semana uma semana antes, e divididas pelo resultado que cada uma tem agora: aprovada, em revisão ou recusada. Este é o card de volume da página inicial do Business Console.\n\n`total` é o de hoje até o momento. `previous_total_so_far` conta o dia de comparação apenas até o mesmo horário local, de modo que uma variação entre eles compara a mesma parte de ambos os dias. As horas que ainda faltam hoje são `0`. Um dia em que os relógios mudam tem 23 ou 25 horas: a hora que falta fica em `0` e a hora repetida contém as duas.", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização.", "example": "11111111-2222-3333-4444-555555555555" }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação. Deve ser a aplicação à qual a chave de API pertence: uma chave usada em qualquer outra aplicação recebe `403`.", "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "default": "UTC", "example": "Europe/Madrid" }, "description": "Fuso horário IANA cuja meia-noite marca o início de hoje, por exemplo `Europe/Madrid` ou `America/Mexico_City`. Omita-o para usar UTC." } ], "responses": { "200": { "description": "Verificações de hoje por hora local, as do dia de comparação e os resultados de hoje.", "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": "Fuso horário desconhecido. O corpo é indexado pelo parâmetro, com uma lista de mensagens.", "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": "A chave de API expirou. Somente uma chave criada com data de validade pode expirar; após essa data, toda requisição feita com ela responde `401`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida. Leia `detail`: uma chave de API ausente ou inválida (nunca `401`), uma chave de outra aplicação, qualquer chave com escopo ou uma requisição feita fora da lista de IPs da chave.", "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": "Mais de 600 requisições GET por minuto com esta chave de API. Aguarde o número de segundos indicado em `Retry-After` e tente novamente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Throttled": { "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos até a janela atual de um minuto ser reiniciada.", "schema": { "type": "integer", "example": 23 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas por minuto nesta cota.", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Horário Unix em que a janela é reiniciada.", "schema": { "type": "integer" } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/analytics/today/?tz=Europe%2FMadrid' \\\n -H 'x-api-key: YOUR_API_KEY'" } ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/webhooks/": { "get": { "summary": "Listar entregas de webhook da sessão", "description": "Lista todas as entregas de webhook que a Didit registrou para uma sessão de verificação, um usuário (KYC) ou uma empresa (KYB), da mais recente para a mais antiga, como um array JSON simples (sem paginação). Cada entrada é uma tentativa para um destino: o primeiro envio, cada [nova tentativa](https://docs.didit.me/pt-br/integration/webhooks#política-de-novas-tentativas) automática e cada reenvio são entradas separadas, com seu próprio `uuid`, e as novas tentativas e os reenvios mantêm o `event_id` do payload. `request_header` e `request_body` são texto JSON; faça o parse deles para ler as assinaturas e o payload. Os registros de entrega ficam disponíveis por cerca de 30 dias, então um array vazio significa que nenhum webhook foi enviado para a sessão ainda ou que todas as entregas são mais antigas que isso. Uma chave de API com escopo precisa de `sessions: read` e `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 da sessão de verificação, de usuário (KYC) ou de empresa (KYB): o `session_id` retornado por `POST /v3/session/`. O servidor o resolve entre os dois tipos de sessão.\n\n**Deve ser um UUID válido.** A rota só corresponde a UUIDs bem formados, então um valor malformado é rejeitado pelo roteador de URLs antes que qualquer código da aplicação seja executado, e a resposta é uma página **HTML** `404` em vez do envelope JSON `{\"detail\": ...}` mostrado abaixo.", "schema": { "type": "string", "format": "uuid" }, "example": "22222222-3333-4444-5555-666666666666" } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET 'https://verification.didit.me/v3/session/22222222-3333-4444-5555-666666666666/webhooks/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.webhooks.list(\n \"22222222-3333-4444-5555-666666666666\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.webhooks.list(\"22222222-3333-4444-5555-666666666666\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Webhooks.List(ctx, \"22222222-3333-4444-5555-666666666666\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().webhooks().list(\"22222222-3333-4444-5555-666666666666\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->webhooks->list('22222222-3333-4444-5555-666666666666');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.sessions.webhooks.list(\"22222222-3333-4444-5555-666666666666\").each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Webhooks.ListAsync(\"22222222-3333-4444-5555-666666666666\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Todas as entregas registradas para a sessão, da mais recente para a mais antiga.", "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": "A chave de API expirou: ela foi criada com uma data de validade que já passou. Uma chave incorreta ou revogada também recebe `401`; uma chave ausente recebe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida. Sem `x-api-key`, ou com uma chave inválida ou revogada, a resposta é `Authentication credentials were not provided or are invalid.` Uma chave de outra aplicação recebe `You do not have permission to perform this action.` Uma chave com escopo sem o acesso exigido por este endpoint recebe uma mensagem que indica o acesso ausente, e uma chave usada fora da sua lista de IPs permitidos recebe `This API key can't be used from this IP address.` Um `sessionId` desconhecido retorna `404` antes de a credencial ser verificada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "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": "A sessão não existe ou foi excluída (`Not found.`, retornado antes de a credencial ser verificada), ou está fora dos limites de fluxo ou de status de uma chave com escopo (`Session not found.`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Unknown session": { "value": { "detail": "Not found." } }, "Outside the key's limits": { "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Limite de requisições excedido: mais de 600 requisições GET na janela atual de um minuto para esta chave de API. Aguarde `Retry-After` segundos antes de tentar novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas na janela de um minuto (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Horário Unix (segundos) em que a janela atual é reiniciada.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nome do orçamento que foi excedido.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "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": "Obter entrega de webhook da sessão", "description": "Obtenha uma entrega de webhook de uma sessão de verificação: a URL para a qual foi enviada, o status HTTP que o seu endpoint retornou e os cabeçalhos exatos e o corpo JSON que a Didit enviou. `request_header` e `request_body` são texto JSON; para conferir a sua [verificação de assinatura](https://docs.didit.me/pt-br/integration/webhooks#verificação-de-assinatura), recalcule `X-Signature-V2` a partir do corpo após o parse com o segredo do destino para o qual foi enviada (ou o segredo da aplicação, no caso de uma entrega para a URL de webhook legada). O caminho não tem barra final: com ela, retorna `404`. Uma chave de API com escopo precisa de `sessions: read` e `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 da sessão de verificação, de usuário (KYC) ou de empresa (KYB): o `session_id` retornado por `POST /v3/session/`. O servidor o resolve entre os dois tipos de sessão.\n\n**Deve ser um UUID válido.** A rota só corresponde a UUIDs bem formados, então um valor malformado é rejeitado pelo roteador de URLs antes que qualquer código da aplicação seja executado, e a resposta é uma página **HTML** `404` em vez do envelope JSON `{\"detail\": ...}` mostrado abaixo.", "schema": { "type": "string", "format": "uuid" }, "example": "22222222-3333-4444-5555-666666666666" }, { "name": "webhook_uuid", "in": "path", "required": true, "description": "UUID da entrega: o `uuid` de um item retornado por `GET /v3/session/{sessionId}/webhooks/`. Ela deve pertencer à sessão indicada no caminho.", "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": "A entrega, com os cabeçalhos e o corpo da requisição.", "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": "A chave de API expirou: ela foi criada com uma data de validade que já passou. Uma chave incorreta ou revogada também recebe `401`; uma chave ausente recebe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida. Sem `x-api-key`, ou com uma chave inválida ou revogada, a resposta é `Authentication credentials were not provided or are invalid.` Uma chave de outra aplicação recebe `You do not have permission to perform this action.` Uma chave com escopo sem o acesso exigido por este endpoint recebe uma mensagem que indica o acesso ausente, e uma chave usada fora da sua lista de IPs permitidos recebe `This API key can't be used from this IP address.` Um `sessionId` desconhecido retorna `404` antes de a credencial ser verificada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "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": "A sessão não existe ou foi excluída (`Not found.`, retornado antes de a credencial ser verificada), ou está fora dos limites de fluxo ou de status de uma chave com escopo (`Session not found.`). Uma entrega que não existe, pertence a outra sessão ou não está mais disponível retorna `No WebhookLog matches the given query.`", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "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": "Limite de requisições excedido: mais de 600 requisições GET na janela atual de um minuto para esta chave de API. Aguarde `Retry-After` segundos antes de tentar novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas na janela de um minuto (600).", "schema": { "type": "integer", "example": 600 } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Horário Unix (segundos) em que a janela atual é reiniciada.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nome do orçamento que foi excedido.", "schema": { "type": "string", "example": "generic-get" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "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 entrega de webhook da sessão", "description": "Envie novamente um webhook de sessão registrado para a URL à qual ele foi enviado originalmente, com o mesmo payload e `event_id` e com novos `timestamp`, cabeçalho `X-Timestamp` e assinaturas. A Didit o assina com o segredo atual do destino ao qual a entrega pertence (ou com o segredo da aplicação, no caso de uma entrega para a URL de webhook legada), aguarda até 5 segundos pelo seu endpoint, registra a tentativa como uma nova entrega e a retorna com `200`, independentemente da resposta do seu endpoint: leia `response_status`. Um reenvio não é repetido automaticamente e cada chamada envia novamente, então torne seu endpoint idempotente em relação ao `event_id`. O caminho não tem barra final e a requisição não tem corpo. Uma chave de API com escopo precisa de `webhooks: write` e `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 da sessão de verificação, de usuário (KYC) ou de empresa (KYB): o `session_id` retornado por `POST /v3/session/`. O servidor o resolve entre os dois tipos de sessão.\n\n**Deve ser um UUID válido.** A rota só corresponde a UUIDs bem formados, então um valor malformado é rejeitado pelo roteador de URLs antes que qualquer código da aplicação seja executado, e a resposta é uma página **HTML** `404` em vez do envelope JSON `{\"detail\": ...}` mostrado abaixo.", "schema": { "type": "string", "format": "uuid" }, "example": "22222222-3333-4444-5555-666666666666" }, { "name": "webhook_uuid", "in": "path", "required": true, "description": "UUID da entrega a ser reenviada: o `uuid` de um item retornado por `GET /v3/session/{sessionId}/webhooks/`. Ela deve pertencer à sessão indicada no caminho.", "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": "A nova entrega, já tentada. `response_status` é o que o seu endpoint respondeu desta vez. A entrega original permanece inalterada.", "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": "A entrega não pôde ser reenviada. Faça a ramificação pelo `code`: `webhook_url_missing` significa que a entrega não tem URL registrada e nada é enviado; `webhook_resend_error` significa que a entrega armazenada não pôde ser assinada novamente ou que a tentativa não pôde ser concluída. Após `webhook_resend_error`, `detail` começa com `Error processing webhook resend:` seguido de um texto de diagnóstico que pode mudar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." }, "code": { "type": "string", "description": "Código de erro estável e legível por máquina. Use este código para ramificar a lógica, não o `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": "A chave de API expirou: ela foi criada com uma data de validade que já passou. Uma chave incorreta ou revogada também recebe `401`; uma chave ausente recebe `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "A requisição não é permitida. Sem `x-api-key`, ou com uma chave inválida ou revogada, a resposta é `Authentication credentials were not provided or are invalid.` Uma chave de outra aplicação recebe `You do not have permission to perform this action.` Uma chave com escopo sem o acesso exigido por este endpoint recebe uma mensagem que indica o acesso ausente, e uma chave usada fora da sua lista de IPs permitidos recebe `This API key can't be used from this IP address.` Um `sessionId` desconhecido retorna `404` antes de a credencial ser verificada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "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": "A sessão não existe ou foi excluída (`Not found.`, retornado antes de a credencial ser verificada), ou está fora dos limites de fluxo ou de status de uma chave com escopo (`Session not found.`). Uma entrega que não existe, pertence a outra sessão ou não está mais disponível retorna `Webhook log not found`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "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": "Limite de requisições excedido: mais de 300 requisições de escrita (POST, PATCH, PUT, DELETE) na janela atual de um minuto para esta chave de API. Aguarde `Retry-After` segundos antes de tentar novamente.", "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } }, "X-RateLimit-Limit": { "description": "Requisições permitidas na janela de um minuto (300).", "schema": { "type": "integer", "example": 300 } }, "X-RateLimit-Remaining": { "description": "Requisições restantes na janela atual.", "schema": { "type": "integer", "example": 0 } }, "X-RateLimit-Reset": { "description": "Horário Unix (segundos) em que a janela atual é reiniciada.", "schema": { "type": "integer", "example": 1792056120 } }, "X-RateLimit-Scope": { "description": "Nome do orçamento que foi excedido.", "schema": { "type": "string", "example": "generic-write" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Throttled": { "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/events/": { "get": { "summary": "Listar eventos da sessão", "description": "Leia a linha do tempo de eventos de uma sessão de verificação, dos mais recentes para os mais antigos por `sent_at`: as telas que o usuário viu, botões e uploads, tentativas com falha, mudanças de status e de etapa de recurso, e o rastro de roteamento do fluxo de verificação (workflow). Funciona para IDs de sessão de Verificação de usuários (KYC) e de Verificação de empresas (KYB). Os eventos são armazenados de forma assíncrona, então um evento novo pode levar alguns segundos para aparecer. Os resultados são paginados com `limit` e `offset`; siga `next` até que seja `null`. Uma chave de API com escopo precisa de `sessions: read` e `decisions: read` e, sem `media: read`, recebe `file_url` como `null`. Os eventos de roteamento estão descritos em [Recuperar sessão](https://docs.didit.me/pt-br/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 da sessão de verificação (o `session_id` retornado por `POST /v3/session/`). Aceita IDs de sessão tanto de Verificação de usuários (KYC) quanto de Verificação de empresas (KYB): o servidor resolve o ID entre os dois tipos de sessão. Deve ser um UUID bem formado; um valor malformado não corresponde à rota e retorna um `404` em HTML.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "limit", "in": "query", "required": false, "description": "Número máximo de eventos por página. O padrão é 50. Um valor abaixo de 1 ou não numérico volta para 50; um valor acima de 1,000,000 retorna `400`.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000, "example": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Número de resultados a pular antes do primeiro retornado. O padrão é 0; um valor negativo ou não numérico volta para 0, e um valor acima de 1,000,000 retorna `400`. Prefira seguir as URLs `next` e `previous`.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000, "example": 0 } }, { "name": "ordering", "in": "query", "required": false, "description": "Substituição opcional da ordenação. A ordem padrão é `-sent_at`. Informe o nome de um campo do resultado (por exemplo `sent_at`, `created_at`, `event_type`, `feature_step` ou `step`) para ordenar em ordem crescente, adicione o prefixo `-` para ordenar em ordem decrescente e separe vários campos com vírgulas. Campos desconhecidos são ignorados.", "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": "Uma página dos eventos da sessão, dos mais recentes para os mais antigos.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Número total de eventos da sessão." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL da próxima página, ou `null` na última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL da página anterior, ou `null` na primeira 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` ou `offset` é maior que 1.000.000. O corpo é um array JSON com uma mensagem.", "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": "A chave de API com escopo expirou. Este é o único caso que retorna `401`: uma chave ausente, inválida ou revogada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "summary": "A data de validade da chave já passou", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falha de autenticação ou autorização. Uma chave ausente retorna `403`, assim como uma chave de outra aplicação, uma chave com escopo sem a permissão exigida por este endpoint e uma requisição de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada retorna `401`. Diferencie-as pelo `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Missing or invalid credentials": { "summary": "Cabeçalho x-api-key ausente, ou a chave falhou na validação", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Uma chave válida que pertence a uma aplicação diferente da aplicação da sessão", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without sessions read": { "summary": "Chave com escopo sem sessions: read", "value": { "detail": "This API key has no read access to sessions." } }, "Scoped key without decisions read": { "summary": "Chave com escopo sem decisions: read", "value": { "detail": "This API key has no read access to decisions." } }, "IP not allowed": { "summary": "Requisição de fora da lista de IPs permitidos da chave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "A sessão não existe, foi excluída ou está fora dos limites de fluxo ou de somente aprovadas de uma chave com escopo. A busca da sessão é feita antes da verificação da credencial, então um `sessionId` desconhecido retorna `404` mesmo sem uma chave válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Unknown session": { "summary": "Não existe nenhuma sessão com este ID, ou ela foi excluída", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "A sessão está fora dos limites de fluxo ou de somente aprovadas de uma chave com escopo", "value": { "detail": "Session not found." } } } } } }, "429": { "description": "Limite de requisições excedido: 600 requisições GET por minuto por chave de API. Aguarde `Retry-After` segundos antes de tentar novamente; os cabeçalhos `X-RateLimit-*` mostram a cota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Rate limited": { "summary": "Orçamento do minuto atual esgotado", "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/aml-screening-history/": { "get": { "summary": "Listar histórico de análise AML", "description": "Lista todas as novas triagens concluídas do monitoramento contínuo da verificação AML de uma sessão, da mais recente para a mais antiga por `completed_at`, incluindo as execuções em que nada mudou: alertas, entradas de atividade e webhooks só são disparados quando um resultado muda, então esse histórico é a evidência de que um titular sem ocorrências continuava sendo triado. Funciona com IDs de sessões KYC e KYB; passe `node_id` quando a sessão executou mais de uma etapa AML. Só são listadas as novas triagens do monitoramento contínuo (a primeira triagem faz parte da decisão da sessão) e as execuções anteriores à existência desse histórico não são reconstruídas, então uma sessão sem monitoramento contínuo retorna uma lista vazia. `count` é exato até 100 e fica limitado a 100 acima disso, então siga `next` até que seja `null`. Passe `month` para ler um mês do calendário por vez. Uma chave de API com escopo precisa de `decisions: read`; consulte [Monitoramento AML contínuo](https://docs.didit.me/pt-br/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 da sessão de verificação (o `session_id` retornado por `POST /v3/session/`). Aceita IDs de sessão tanto de Verificação de usuários (KYC) quanto de Verificação de empresas (KYB): o servidor resolve o ID entre os dois tipos de sessão. Deve ser um UUID bem formado; um valor malformado não corresponde à rota e retorna um `404` em HTML.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "node_id", "in": "query", "required": false, "description": "ID do nó do grafo do fluxo da verificação AML. Necessário apenas quando a sessão executou mais de uma etapa AML; sem ele, é usada a verificação AML mais recente. Um nó desconhecido retorna `404`.", "schema": { "type": "string", "example": "feature_aml_1" } }, { "name": "month", "in": "query", "required": false, "description": "Um mês do calendário UTC no formato `YYYY-MM`. Somente as triagens concluídas nesse mês são retornadas; sem ele, todos os meses são retornados. Um mês malformado retorna `400`.", "schema": { "type": "string", "pattern": "^\\d{4}-(0[1-9]|1[0-2])$", "example": "2026-09" } }, { "name": "limit", "in": "query", "required": false, "description": "Número máximo de execuções de triagem por página. O padrão é 50. Um valor abaixo de 1 ou não numérico volta para 50; um valor acima de 1,000,000 retorna `400`.", "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 1000000, "example": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Número de resultados a pular antes do primeiro retornado. O padrão é 0; um valor negativo ou não numérico volta para 0, e um valor acima de 1,000,000 retorna `400`. Prefira seguir as URLs `next` e `previous`.", "schema": { "type": "integer", "default": 0, "minimum": 0, "maximum": 1000000, "example": 0 } }, { "name": "ordering", "in": "query", "required": false, "description": "Substituição opcional da ordenação. A ordem padrão é `-completed_at`. Informe o nome de um campo do resultado (por exemplo `completed_at`, `started_at`, `outcome` ou `score`) para ordenar em ordem crescente, adicione o prefixo `-` para ordenar em ordem decrescente e separe vários campos com vírgulas. Campos desconhecidos são ignorados.", "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": "Uma página de execuções de análise, das mais recentes para as mais antigas.", "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "maximum": 100, "description": "Número de execuções, exato até 100 e limitado a 100 acima disso." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL da próxima página, ou `null` na última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL da página anterior, ou `null` na primeira 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` ou `offset` é maior que 1.000.000 (um array JSON com uma mensagem), ou `month` não é um mês do calendário no formato `YYYY-MM` (um objeto com a chave `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": "A chave de API com escopo expirou. Este é o único caso que retorna `401`: uma chave ausente, inválida ou revogada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "summary": "A data de validade da chave já passou", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falha de autenticação ou autorização. Uma chave ausente retorna `403`, assim como uma chave de outra aplicação, uma chave com escopo sem a permissão exigida por este endpoint e uma requisição de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada retorna `401`. Diferencie-as pelo `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Missing or invalid credentials": { "summary": "Cabeçalho x-api-key ausente, ou a chave falhou na validação", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Uma chave válida que pertence a uma aplicação diferente da aplicação da sessão", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions read": { "summary": "Chave com escopo sem decisions: read", "value": { "detail": "This API key has no read access to decisions." } }, "IP not allowed": { "summary": "Requisição de fora da lista de IPs permitidos da chave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "A sessão não existe, foi excluída ou está fora dos limites de uma chave com escopo, ou não tem verificação AML (para o `node_id` informado). A busca da sessão é feita antes da verificação da credencial, então um `sessionId` desconhecido retorna `404` mesmo sem uma chave válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Unknown session": { "summary": "Não existe nenhuma sessão com este ID, ou ela foi excluída", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "A sessão está fora dos limites de uma chave com escopo (também retornado para uma sessão excluída há instantes)", "value": { "detail": "Session not found." } }, "No AML check": { "summary": "A sessão nunca executou uma etapa AML", "value": { "detail": "The session does not have an AML check." } }, "No AML check for node": { "summary": "node_id não corresponde a uma verificação AML da sessão", "value": { "detail": "The session does not have an AML check for node 'feature_aml_2'." } } } } } }, "429": { "description": "Limite de requisições excedido: 600 requisições GET por minuto por chave de API. Aguarde `Retry-After` segundos antes de tentar novamente; os cabeçalhos `X-RateLimit-*` mostram a cota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Rate limited": { "summary": "Orçamento do minuto atual esgotado", "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/aml-screening-history/export/": { "get": { "summary": "Exportar o histórico de Análise AML em CSV", "description": "Baixe o mesmo histórico de monitoramento contínuo de `GET /v3/session/{sessionId}/aml-screening-history/` como um arquivo CSV, com uma linha por nova análise concluída, das mais recentes para as mais antigas, pronto para entregar a um auditor. O arquivo é transmitido por inteiro (sem paginação) e começa com uma linha de cabeçalho; uma célula vazia significa desconhecido, as datas dos conjuntos de dados nunca são estimadas e um valor que iniciaria uma fórmula de planilha recebe um apóstrofo como prefixo. Funciona com IDs de sessão de KYC e KYB; informe `node_id` quando a sessão tiver executado mais de uma etapa de AML. Informe `month` para exportar um mês do calendário. Os erros são retornados como JSON, não como CSV. Uma chave de API com escopo precisa de `decisions: read` e `media: read`: a resposta é um arquivo, então uma chave sem `media: read` recebe `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 da sessão de verificação (o `session_id` retornado por `POST /v3/session/`). Aceita IDs de sessão tanto de Verificação de usuários (KYC) quanto de Verificação de empresas (KYB): o servidor resolve o ID entre os dois tipos de sessão. Deve ser um UUID bem formado; um valor malformado não corresponde à rota e retorna um `404` em HTML.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "node_id", "in": "query", "required": false, "description": "ID do nó do grafo do fluxo da verificação AML. Necessário apenas quando a sessão executou mais de uma etapa AML; sem ele, é usada a verificação AML mais recente. Um nó desconhecido retorna `404`.", "schema": { "type": "string", "example": "feature_aml_1" } }, { "name": "month", "in": "query", "required": false, "description": "Um mês do calendário UTC no formato `YYYY-MM`. Somente as triagens concluídas nesse mês são retornadas; sem ele, todos os meses são retornados. Um mês malformado 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": "O arquivo CSV, transmitido como `text/csv` com quebras de linha CRLF. Colunas, em ordem: `screened_at` (quando a nova análise terminou), `outcome` (`NO_CHANGE`, `CHANGED` ou `FAILED`), `provider` (identificador opaco da fonte de dados de AML; não crie ramificações com base nele), `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` (a execução de monitoramento), `entities_screened` (`1`, ou `0` para uma execução com falha) e `new_hits` (vazio quando desconhecido). As datas estão em ISO 8601 com deslocamento UTC. Uma sessão ainda sem novas análises retorna apenas a linha de cabeçalho.", "headers": { "Content-Disposition": { "description": "`attachment; filename=\"aml-screening-history-{sessionId}.csv\"`, ou `aml-screening-history-{sessionId}-{month}.csv` quando `month` é informado.", "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` não é um mês do calendário no formato `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": "A chave de API com escopo expirou. Este é o único caso que retorna `401`: uma chave ausente, inválida ou revogada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "summary": "A data de validade da chave já passou", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falha de autenticação ou autorização. Uma chave ausente retorna `403`, assim como uma chave de outra aplicação, uma chave com escopo sem a permissão exigida por este endpoint e uma requisição de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada retorna `401`. Diferencie-as pelo `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Missing or invalid credentials": { "summary": "Cabeçalho x-api-key ausente, ou a chave falhou na validação", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Uma chave válida que pertence a uma aplicação diferente da aplicação da sessão", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions read": { "summary": "Chave com escopo sem decisions: read", "value": { "detail": "This API key has no read access to decisions." } }, "Scoped key without media read": { "summary": "Chave com escopo sem media: read (a resposta é um arquivo)", "value": { "detail": "This API key has no read access to media." } }, "IP not allowed": { "summary": "Requisição de fora da lista de IPs permitidos da chave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "A sessão não existe, foi excluída ou está fora dos limites de uma chave com escopo, ou não tem verificação AML (para o `node_id` informado). A busca da sessão é feita antes da verificação da credencial, então um `sessionId` desconhecido retorna `404` mesmo sem uma chave válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Unknown session": { "summary": "Não existe nenhuma sessão com este ID, ou ela foi excluída", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "A sessão está fora dos limites de uma chave com escopo (também retornado para uma sessão excluída há instantes)", "value": { "detail": "Session not found." } }, "No AML check": { "summary": "A sessão nunca executou uma etapa AML", "value": { "detail": "The session does not have an AML check." } }, "No AML check for node": { "summary": "node_id não corresponde a uma verificação AML da sessão", "value": { "detail": "The session does not have an AML check for node 'feature_aml_2'." } } } } } }, "429": { "description": "Limite de requisições excedido: 600 requisições GET por minuto por chave de API. Aguarde `Retry-After` segundos antes de tentar novamente; os cabeçalhos `X-RateLimit-*` mostram a cota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Rate limited": { "summary": "Orçamento do minuto atual esgotado", "value": { "detail": "GET request rate limit exceeded. You can make up to 600 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/add-images/": { "patch": { "summary": "Adicionar uma imagem a uma sessão", "description": "Anexe uma imagem ou um PDF adicional ao resultado da Verificação de identidade (`model_type=kyc`) ou do Comprovante de endereço (`model_type=poa`) de uma sessão de Verificação de usuários (KYC) finalizada, por exemplo, evidências coletadas fora do fluxo. A sessão deve estar como `Approved`, `Declined`, `In Review` ou `Kyc Expired` e conter o resultado indicado por `model_type`; sessões de Verificação de empresas (KYB) não são suportadas. Cada chamada adiciona um arquivo (ao resultado mais recente quando a etapa foi executada mais de uma vez), mantém os arquivos existentes e registra uma entrada `FILE_ADDED` no registro de atividades da sessão; o envio não dispara nenhum webhook e não altera o status da sessão. O arquivo é comprimido no envio e é retornado em `extra_files` da decisão da sessão. Este endpoint é limitado a 10 requisições por minuto por chave de API. Uma chave de API com escopo precisa de `sessions: write` e, sem `media: read`, recebe os links de `extra_files` como `null`.", "operationId": "patch_v3_session_add_images", "x-didit-sdk": { "resource": "sessions", "method": "add_images", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "description": "UUID da sessão de Verificação de usuários (KYC) à qual o arquivo será adicionado (o `session_id` retornado por `POST /v3/session/`). Um ID de sessão de Verificação de empresas (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": "A imagem ou o PDF. Extensões permitidas: `jpg`, `jpeg`, `png`, `webp`, `tiff`, `pdf`. No máximo 15 MB no envio; o arquivo é então comprimido e rejeitado com `400` se ainda for maior que 2 MB (2.097.152 bytes). Arquivos vazios são rejeitados." }, "model_type": { "type": "string", "enum": [ "kyc", "poa" ], "description": "`kyc` adiciona o arquivo ao resultado da verificação de identidade, `poa` ao resultado do Comprovante de endereço.", "example": "kyc" }, "file_password": { "type": "string", "description": "Senha de um PDF criptografado. Sem ela, ou com uma senha errada, um PDF criptografado 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": "Arquivo adicionado. Retorna todos os arquivos extras desse resultado, incluindo o novo.", "content": { "application/json": { "schema": { "type": "object", "required": [ "extra_files" ], "properties": { "extra_files": { "type": "array", "description": "Links pré-assinados de curta duração para todos os arquivos extras do resultado indicado por `model_type`, do mais antigo para o mais recente. Cada link é `null` para uma chave de API com escopo sem `media: read`. Obtenha links novos a partir da decisão da sessão posteriormente.", "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": "Erro de validação. Os erros de campo chegam como `{\"\": [\"\"]}`; os erros de PDF criptografado, como `{\"detail\": \"...\"}`.", "content": { "application/json": { "examples": { "Missing file": { "summary": "Nenhuma parte de arquivo no formulário", "value": { "file": [ "No file was submitted." ] } }, "Missing model_type": { "summary": "model_type omitido", "value": { "model_type": [ "This field is required." ] } }, "Invalid model_type": { "summary": "model_type não é kyc nem poa", "value": { "model_type": [ "\"passport\" is not a valid choice." ] } }, "File too large": { "summary": "Upload acima de 15 MB", "value": { "file": [ "File size should not exceed 15 MB" ] } }, "Too large after compression": { "summary": "Ainda acima de 2 MB após a compressão", "value": { "file": [ "File size is too big. Max allowed size is 2097152 bytes." ] } }, "Encrypted PDF": { "summary": "PDF criptografado sem file_password", "value": { "detail": "The PDF is encrypted. Please upload a decrypted PDF or a photo instead." } }, "Wrong PDF password": { "summary": "file_password não abre o PDF", "value": { "detail": "The PDF password is incorrect. Please provide the correct password." } } } } } }, "401": { "description": "A chave de API com escopo expirou. Este é o único caso que retorna `401`: uma chave ausente, inválida ou revogada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "summary": "A data de validade da chave já passou", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falha de autenticação ou autorização. Uma chave ausente retorna `403`, assim como uma chave de outra aplicação, uma chave com escopo sem a permissão exigida por este endpoint e uma requisição de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada retorna `401`. Diferencie-as pelo `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Missing or invalid credentials": { "summary": "Cabeçalho x-api-key ausente, ou a chave falhou na validação", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Uma chave válida que pertence a uma aplicação diferente da aplicação da sessão", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without sessions write": { "summary": "Chave com escopo sem sessions: write", "value": { "detail": "This API key has no write access to sessions." } }, "IP not allowed": { "summary": "Requisição de fora da lista de IPs permitidos da chave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "A sessão não existe, foi excluída ou está fora dos limites de uma chave com escopo; é uma sessão KYB ou não está em `Approved`, `Declined`, `In Review` ou `Kyc Expired`; ou não tem resultado do `model_type` solicitado (verificado antes da validação do arquivo). A busca da sessão é feita antes da verificação da credencial, então um `sessionId` desconhecido retorna `404` mesmo sem uma chave válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Unknown session": { "summary": "Não existe nenhuma sessão com este ID, ou ela foi excluída", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "A sessão está fora dos limites de fluxo ou de somente aprovadas de uma chave com escopo", "value": { "detail": "Session not found." } }, "Not eligible": { "summary": "Sessão ainda não concluída, ou ID de uma sessão KYB", "value": { "detail": "No Session matches the given query." } }, "No ID verification": { "summary": "model_type=kyc em uma sessão sem verificação de identidade", "value": { "detail": "The session does not have KYC data." } }, "No Proof of Address": { "summary": "model_type=poa em uma sessão sem Comprovante de endereço", "value": { "detail": "The session does not have POA data." } } } } } }, "429": { "description": "Limite de requisições excedido: 10 requisições de adição de imagens por minuto por chave de API (requisições rejeitadas também contam). A cota compartilhada de 300 requisições de escrita por minuto também se aplica. Aguarde `Retry-After` segundos antes de tentar novamente; os cabeçalhos `X-RateLimit-*` mostram a cota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Rate limited": { "summary": "Orçamento do minuto atual esgotado", "value": { "detail": "Session add-images rate limit exceeded. You can make up to 10 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/session/{sessionId}/update-aml-status/": { "patch": { "summary": "Atualizar o status de uma verificação AML", "description": "Define o status da verificação de Análise AML de uma sessão como um todo (o `status` de uma entrada `aml_screenings[]` na decisão da sessão), por exemplo `Approved` depois que sua equipe liberou todos os resultados. Funciona para IDs de sessão de KYC e KYB; informe `node_id` (parâmetro de consulta ou campo do corpo) quando a sessão executou mais de uma etapa AML; caso contrário, a verificação AML mais recente é atualizada. Quando o status de fato muda, uma entrada de atividade `AML_STATUS_UPDATED` é registrada e um [webhook](https://docs.didit.me/pt-br/integration/webhooks) `data.updated` é enviado; enviar o status atual retorna `200` e não altera nada. O status da sessão não é recalculado: use `PATCH /v3/session/{sessionId}/update-status/` para a decisão da sessão e `PATCH /v3/session/{sessionId}/update-aml-hit-status/` para resultados individuais. Uma chave de API com escopo precisa de `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 da sessão de verificação (o `session_id` retornado por `POST /v3/session/`). Aceita IDs de sessão tanto de Verificação de usuários (KYC) quanto de Verificação de empresas (KYB): o servidor resolve o ID entre os dois tipos de sessão. Deve ser um UUID bem formado; um valor malformado não corresponde à rota e retorna um `404` em HTML.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "node_id", "in": "query", "required": false, "description": "ID do nó do grafo do fluxo da verificação AML a ser atualizada. Necessário apenas quando a sessão executou mais de uma etapa AML. Tem precedência sobre `node_id` no corpo.", "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": "Novo status da verificação AML.", "example": "Approved" }, "node_id": { "type": "string", "description": "ID do nó do grafo do fluxo da verificação AML, como alternativa ao parâmetro de consulta.", "example": "feature_aml_1" } } }, "example": { "status": "Approved" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X PATCH 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-aml-status/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"status\": \"Approved\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.update_aml_status(\n \"11111111-2222-3333-4444-555555555555\",\n status=\"Approved\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.updateAmlStatus(\"11111111-2222-3333-4444-555555555555\", {\n status: \"Approved\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateAMLStatus(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsUpdateAMLStatusParams{\n\tStatus: \"Approved\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsUpdateAmlStatusParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().updateAmlStatus(\"11111111-2222-3333-4444-555555555555\", SessionsUpdateAmlStatusParams.builder()\n .status(SessionsUpdateAmlStatusParams.Status.of(\"Approved\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->updateAmlStatus('11111111-2222-3333-4444-555555555555', [\n 'status' => 'Approved',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.update_aml_status(\n \"11111111-2222-3333-4444-555555555555\",\n status: \"Approved\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UpdateAmlStatusAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsUpdateAmlStatusParams\n{\n Status = \"Approved\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Status da verificação AML definido (ou inalterado quando já tinha esse 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": "Status atual da verificação AML." }, "previous_status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Status antes da chamada. Igual a `status` quando nada mudou." } } }, "example": { "message": "AML status updated successfully", "status": "Approved", "previous_status": "In Review" } } } }, "400": { "description": "Erro de validação: `status` ausente ou fora dos valores permitidos. A busca da verificação AML é executada primeiro, então uma sessão sem verificação AML retorna `404` mesmo com um corpo inválido.", "content": { "application/json": { "examples": { "Missing status": { "summary": "Corpo vazio ou sem status", "value": { "status": [ "This field is required." ] } }, "Invalid status": { "summary": "status não está no enum", "value": { "status": [ "\"Cleared\" is not a valid choice." ] } } } } } }, "401": { "description": "A chave de API com escopo expirou. Este é o único caso que retorna `401`: uma chave ausente, inválida ou revogada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "summary": "A data de validade da chave já passou", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falha de autenticação ou autorização. Uma chave ausente retorna `403`, assim como uma chave de outra aplicação, uma chave com escopo sem a permissão exigida por este endpoint e uma requisição de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada retorna `401`. Diferencie-as pelo `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Missing or invalid credentials": { "summary": "Cabeçalho x-api-key ausente, ou a chave falhou na validação", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Uma chave válida que pertence a uma aplicação diferente da aplicação da sessão", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "Chave com escopo sem decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Requisição de fora da lista de IPs permitidos da chave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "A sessão não existe, foi excluída ou está fora dos limites de uma chave com escopo, ou não tem verificação AML (para o `node_id` informado). A busca da sessão é feita antes da verificação da credencial, então um `sessionId` desconhecido retorna `404` mesmo sem uma chave válida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Unknown session": { "summary": "Não existe nenhuma sessão com este ID, ou ela foi excluída", "value": { "detail": "Not found." } }, "Outside key limits": { "summary": "A sessão está fora dos limites de uma chave com escopo (também retornado para uma sessão excluída há instantes)", "value": { "detail": "Session not found." } }, "No AML check": { "summary": "A sessão nunca executou uma etapa AML", "value": { "detail": "The session does not have an AML check." } }, "No AML check for node": { "summary": "node_id não corresponde a uma verificação AML da sessão", "value": { "detail": "The session does not have an AML check for node 'feature_aml_2'." } } } } } }, "429": { "description": "Limite de requisições excedido: 300 requisições de escrita (POST, PATCH, DELETE) por minuto por chave de API. Aguarde `Retry-After` segundos antes de tentar novamente; os cabeçalhos `X-RateLimit-*` mostram a cota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Rate limited": { "summary": "Orçamento do minuto atual esgotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/status/": { "get": { "summary": "Obter o status do serviço (público, sem autenticação)", "description": "Retorna o estado de cada serviço da Didit (`operational`, `degraded` ou `down`), o estado geral (o pior entre eles) e os incidentes em andamento ou resolvidos nos últimos 7 dias. Use-o para alimentar um widget de status ou para verificar a saúde da Didit a partir da sua integração.\n\nPúblico: não envie cabeçalho de autenticação. A resposta não contém dados da organização e é a mesma para todos os chamadores. As respostas ficam em cache por 30 segundos, portanto consulte no máximo uma vez a cada 30 segundos.", "operationId": "get_v3_status", "tags": [ "Status" ], "security": [ {} ], "parameters": [], "responses": { "200": { "description": "Status atual do serviço.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceStatusFeed" }, "examples": { "One service degraded": { "summary": "Um incidente em andamento e um resolvido nesta semana", "value": { "status": "degraded", "updated_at": "2026-10-13T09:41:07.512345Z", "services": [ { "key": "service_id_verification", "name": "ID verification", "status": "operational" }, { "key": "service_liveness_face_match", "name": "Liveness and face match", "status": "operational" }, { "key": "service_aml_screening", "name": "AML screening", "status": "operational" }, { "key": "service_kyb_registries", "name": "KYB registries", "status": "operational" }, { "key": "service_database_validation", "name": "Database validation", "status": "degraded" }, { "key": "service_phone_delivery", "name": "Phone verification delivery", "status": "operational" }, { "key": "service_email_delivery", "name": "Email verification delivery", "status": "operational" }, { "key": "service_transaction_monitoring", "name": "Transaction monitoring", "status": "operational" } ], "incidents": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "service": "service_database_validation", "service_name": "Database validation", "state": "degraded", "status": "ongoing", "title": "Database validation is degraded in Brazil.", "body": "Checks against Brazil (CPF) may be slow or fail since 08:55 UTC.", "affected": "Brazil (CPF)", "country_name": "Brazil", "started_at": "2026-10-13T08:55:00Z", "resolved_at": null, "duration_minutes": null }, { "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "service": "service_aml_screening", "service_name": "AML screening", "state": "down", "status": "resolved", "title": "AML screening is back to normal.", "body": "Recovered at 14:32 UTC after 17 minutes.", "affected": "", "country_name": "", "started_at": "2026-10-11T14:15:00Z", "resolved_at": "2026-10-11T14:32:00Z", "duration_minutes": 17 } ] } }, "All operational": { "summary": "Nenhum incidente nos últimos 7 dias", "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": "Mais de 600 requisições GET em um minuto a partir do mesmo endereço IP (ou da mesma chave de API, se você enviar uma). Respeite `Retry-After` antes de tentar novamente.", "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": "Obter os preços de verificação bancária (público, sem autenticação)", "description": "Retorna o preço de tabela de cada método de Verificação bancária em cada país: login bancário com seus complementos de saldo e transações, e a verificação de conta. A Verificação bancária ainda não está habilitada em produção, portanto uma etapa bancária é recusada em fluxos de produção até que esteja; trate esses preços como preço de tabela, não como uma oferta que você pode comprar hoje. Use-o para orçar uma etapa bancária antes de criar um fluxo ou para exibir preços bancários no seu próprio produto.\n\nPúblico: não envie cabeçalho de autenticação. A resposta não contém dados da organização e é a mesma para todos os chamadores. Ela fica em cache público por uma hora e inclui um `ETag`, então envie `If-None-Match` para receber `304 Not Modified` quando nada tiver mudado.\n\nUm método só é `available` onde a Didit o oferece em produção hoje, e seu `price_usd` é `null` em todos os outros lugares, de modo que o feed nunca mostra um preço que você não pode comprar. `available: false` abrange um país sem preço aprovado, um método que o país não suporta e uma rota que ainda não foi ativada.\n\nEsses são preços de tabela antes do desconto do seu plano. O desconto do seu plano se aplica ao preço bancário inteiro, e um preço negociado ou contratual substitui o preço de tabela para a sua organização.", "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": "Preços de tabela da verificação bancária por país.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankVerificationPricing" }, "examples": { "Two countries": { "summary": "Um país com os dois métodos, outro com nenhum", "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": "Não modificado: o `ETag` que você enviou em `If-None-Match` ainda corresponde. Sem corpo." } } } }, "/v3/session/{sessionId}/simulate/": { "post": { "summary": "Simular o status de uma sessão de sandbox", "description": "Força um status final em uma sessão de sandbox depois do fato, a partir do seu backend, sem executar o fluxo. Apenas para aplicações de sandbox: uma sessão de produção retorna `404`. Funciona para sessões de Verificação de usuários (KYC) e Verificação de empresas (KYB).\n\nDefina `new_status` ou deixe que `scenario` ou `risk` o forneça. `risk` (ou o primeiro risco presente nos valores mágicos do cenário) adiciona esse aviso à sessão. A alteração é registrada na atividade da sessão.\n\n`send_webhooks` (padrão `true`) envia exatamente os webhooks que uma alteração real de status envia. Com `false`, o status ainda muda e o console ainda é atualizado em tempo real, mas nenhum webhook é registrado ou enviado, a recuperação de webhooks perdidos nunca reenvia essa decisão, e a próxima alteração de status envia webhooks normalmente. A resposta retorna o valor aplicado.\n\nRequer o privilégio `write:sessions`; uma chave de API com escopo precisa de acesso de escrita a sessões. Um `session_id` desconhecido retorna `404` e uma sessão de outra aplicação retorna `403`, ambos antes de o corpo ser lido; uma sessão de produção retorna `404` somente depois que o corpo é validado. Para simular a partir do fluxo hospedado com o próprio token da sessão, use `POST /v3/session/{sessionId}/sandbox/simulate/`. Consulte [Sandbox e dados de teste](/pt-br/integration/sandbox-testing) para ver o catálogo de cenários.", "operationId": "post_v3_session_simulate", "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID da sessão de verificação de sandbox. Aceita IDs de sessão tanto de usuário (KYC) quanto de empresa (KYB).", "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxSimulateRequest" }, "examples": { "Scenario Without Webhooks": { "summary": "Recusar por meio de um cenário sem enviar webhooks", "value": { "scenario": "decline_aml_hit", "send_webhooks": false } }, "Status Only": { "summary": "Aprovar e enviar os webhooks habituais", "value": { "new_status": "Approved" } } } } } }, "responses": { "200": { "description": "O status mudou.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxSimulateResponse" }, "examples": { "Simulated": { "summary": "Recusado por meio de um cenário, webhooks não enviados", "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": "Erro de validação: cenário ou risco desconhecido, ausência de `new_status` quando nem `scenario` nem `risk` fornecem um, um status que este endpoint não define, ou a sessão já tem o status solicitado (um array JSON simples).", "content": { "application/json": { "examples": { "Unknown Scenario": { "summary": "o cenário não está no catálogo", "value": { "scenario": [ "Unknown sandbox scenario: 'not-a-scenario'." ] } }, "Unknown Risk": { "summary": "risk não está no catálogo", "value": { "risk": [ "Unknown sandbox risk case: 'NOT_A_RISK'." ] } }, "Missing new_status": { "summary": "Nenhum new_status, scenario ou risk", "value": { "new_status": [ "This field is required." ] } }, "Invalid new_status": { "summary": "Um status que a simulação não define", "value": { "new_status": [ "\"Resubmitted\" is not a valid choice." ] } }, "Same Status": { "summary": "A sessão já está com este status", "value": [ "The new status is the same as the current status." ] } } } } }, "401": { "description": "A chave de API com escopo expirou.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Chave de API com escopo após a data de validade", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Credenciais ausentes, um chamador sem o privilégio `write:sessions`, uma chave de API com escopo sem o acesso de que este endpoint precisa, ou um `session_id` que pertence a outra aplicação.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente ou inválido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "O chamador não tem write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Chave de API com escopo sem este acesso", "value": { "detail": "This API key has no write access to sessions." } } } } } }, "404": { "description": "Não existe nenhuma sessão com este `session_id`, ou ela é uma sessão de produção (fora do sandbox).", "content": { "application/json": { "examples": { "Not Found": { "summary": "Sessão desconhecida ou de produção", "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 o status de uma sessão de sandbox a partir do cliente", "description": "A mesma simulação de `POST /v3/session/{sessionId}/simulate/`, autenticada com o próprio `Session-Token` da sessão (retornado em `session_token` por [Create Session](/pt-br/sessions-api/create-session)) em vez da sua chave de API, para que um ambiente de testes ou o fluxo hospedado possa chamá-la a partir do cliente. O corpo, a resposta e `send_webhooks` se comportam exatamente como nesse endpoint.\n\nUm `Session-Token` de uma aplicação de produção (não sandbox), ou que não corresponda ao `sessionId` no caminho, retorna `404`. Consulte [Sandbox & Test Data](/pt-br/integration/sandbox-testing).", "operationId": "post_v3_session_sandbox_simulate", "tags": [ "Sessions" ], "security": [ { "SessionTokenAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID da sessão de verificação de sandbox. Deve corresponder à sessão codificada no Session-Token usado para autenticação.", "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": "Recusar por meio de um cenário sem enviar webhooks", "value": { "scenario": "decline_aml_hit", "send_webhooks": false } }, "Status Only": { "summary": "Aprovar e enviar os webhooks habituais", "value": { "new_status": "Approved" } } } } } }, "responses": { "200": { "description": "O status mudou.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxSimulateResponse" }, "examples": { "Simulated": { "summary": "Recusado por meio de um cenário, webhooks não enviados", "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": "Erro de validação: cenário ou risco desconhecido, ausência de `new_status` quando nem `scenario` nem `risk` fornecem um, um status que este endpoint não define, ou a sessão já tem o status solicitado (um array JSON simples).", "content": { "application/json": { "examples": { "Unknown Scenario": { "summary": "o cenário não está no catálogo", "value": { "scenario": [ "Unknown sandbox scenario: 'not-a-scenario'." ] } }, "Unknown Risk": { "summary": "risk não está no catálogo", "value": { "risk": [ "Unknown sandbox risk case: 'NOT_A_RISK'." ] } }, "Missing new_status": { "summary": "Nenhum new_status, scenario ou risk", "value": { "new_status": [ "This field is required." ] } }, "Invalid new_status": { "summary": "Um status que a simulação não define", "value": { "new_status": [ "\"Resubmitted\" is not a valid choice." ] } }, "Same Status": { "summary": "A sessão já está com este status", "value": [ "The new status is the same as the current status." ] } } } } }, "403": { "description": "O cabeçalho `Session-Token` está ausente ou é inválido.", "content": { "application/json": { "examples": { "Invalid Session Token": { "summary": "Session-Token ausente ou inválido", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "O `Session-Token` pertence a uma aplicação de produção (não sandbox) ou não corresponde ao `sessionId` no caminho.", "content": { "application/json": { "examples": { "Not Found": { "summary": "Sessão de produção, ou session_id / token incompatíveis", "value": { "detail": "Not found." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST \\\n https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/sandbox/simulate/ \\\n -H 'Session-Token: YOUR_SESSION_TOKEN' \\\n -H 'Content-Type: application/json' \\\n -d '{\"new_status\": \"Approved\", \"send_webhooks\": false}'" }, { "lang": "python", "label": "Python", "source": "import requests\n\nresponse = requests.post(\n \"https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/sandbox/simulate/\",\n headers={\"Session-Token\": \"YOUR_SESSION_TOKEN\"},\n json={\"new_status\": \"Approved\", \"send_webhooks\": False},\n)\nresponse.raise_for_status()\nprint(response.json())" } ], "x-didit-sdk": { "resource": "sessions", "method": "simulate_sandbox", "auth": "device_token", "server": false } } }, "/v3/session/{sessionId}/features/overrides/": { "get": { "summary": "Listar as substituições de verificações de uma sessão", "description": "Todas as substituições do status de um recurso individual (etapa) em uma sessão de Verificação de usuários (KYC) ou Verificação de empresas (KYB), da mais recente para a mais antiga e sem paginação: as aplicadas, as que aguardam a pessoa concluir o fluxo (`pending_until_flow_finishes`) e as canceladas, cada uma com quem a solicitou, o motivo e se foi aplicada enquanto a pessoa ainda estava no fluxo (`forced`).\n\n`person_in_flow` indica se uma nova substituição com `defer_until_flow_finishes: true` aguardaria. `flow_finished_at` é quando a pessoa concluiu o fluxo pela última vez; é `null` enquanto ela ainda está nele (incluindo um reenvio) e quando a sessão foi encerrada antes de ela concluir.\n\nRequer o privilégio `read:sessions`; uma chave de API com escopo precisa de acesso de leitura a decisões.", "operationId": "get_v3_session_feature_overrides", "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID da sessão de verificação. Aceita IDs de sessão tanto de usuário (KYC) quanto de empresa (KYB).", "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } ], "responses": { "200": { "description": "As substituições de verificações da sessão, das mais recentes para as mais antigas.", "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": "Se a pessoa ainda está no fluxo, caso em que uma nova substituição com `defer_until_flow_finishes: true` aguardaria.", "example": true }, "flow_finished_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a pessoa concluiu o fluxo pela última vez. `null` enquanto ela ainda está nele (incluindo um reenvio) e quando a sessão foi encerrada antes de ela concluir (abandonada, expirada ou decidida no meio do fluxo).", "example": null }, "overrides": { "type": "array", "description": "Todas as substituições da sessão, da mais recente para a mais antiga.", "items": { "$ref": "#/components/schemas/FeatureStatusOverride" } } } }, "examples": { "Overrides": { "summary": "Uma substituição aguardando, uma 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": "A chave de API com escopo expirou.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Chave de API com escopo após a data de validade", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Credenciais ausentes, um chamador sem o privilégio `read:sessions`, uma chave de API com escopo sem o acesso de que este endpoint precisa, ou um `session_id` que pertence a outra aplicação.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente ou inválido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "O chamador não tem read:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Chave de API com escopo sem este acesso", "value": { "detail": "This API key has no read access to decisions." } } } } } }, "404": { "description": "Não existe nenhuma sessão de KYC ou KYB com este `session_id`.", "content": { "application/json": { "examples": { "Not Found": { "summary": "session_id desconhecido", "value": { "detail": "Not found." } } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET \\\n https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/features/overrides/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.list_feature_overrides(\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.listFeatureOverrides(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ListFeatureOverrides(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().listFeatureOverrides(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->listFeatureOverrides('3fa85f64-5717-4562-b3fc-2c963f66afa6');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.list_feature_overrides(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ListFeatureOverridesAsync(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "x-didit-sdk": { "resource": "sessions", "method": "list_feature_overrides", "auth": "api_key", "server": true } } }, "/v3/session/{sessionId}/features/overrides/{overrideId}/cancel/": { "post": { "summary": "Cancelar uma substituição de verificação que aguarda o fim do fluxo", "description": "Cancela uma substituição do status de um recurso (etapa) que ainda está como `pending_until_flow_finishes`, para que ela nunca seja aplicada. A verificação mantém seu status, o cancelamento é registrado na atividade da sessão como `FEATURE_OVERRIDE_CANCELLED` e nenhum webhook é enviado. A resposta é a substituição com `state: cancelled` e `cancel_reason: cancelled_by_reviewer`.\n\nUma substituição que já foi aplicada ou cancelada retorna `409` com o código `feature_override_not_pending`. Encontre os IDs de substituição com `GET /v3/session/{sessionId}/features/overrides/` ou no `override` retornado pela atualização de status do recurso.\n\nRequer o privilégio `write:sessions`; uma chave de API com escopo precisa de acesso de escrita a decisões.", "operationId": "post_v3_session_feature_override_cancel", "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID da sessão de verificação. Aceita IDs de sessão tanto de usuário (KYC) quanto de empresa (KYB).", "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, { "in": "path", "name": "overrideId", "required": true, "description": "O `id` da substituição a ser cancelada.", "schema": { "type": "string", "format": "uuid", "example": "9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3" } } ], "responses": { "200": { "description": "A substituição foi cancelada e nunca será aplicada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureStatusOverride" }, "examples": { "Cancelled": { "summary": "A substituição cancelada", "value": { "id": "9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3", "node_id": "feature_liveness_1", "feature_type": "", "feature_model": "Face", "previous_status": "Declined", "new_status": "Approved", "state": "cancelled", "forced": false, "reason": "Liveness retried with a reviewer present.", "requested_by": { "email": "reviewer@example.com", "name": "Alex Reviewer", "type": "CONSOLE_USER" }, "requested_at": "2026-10-13T09:15:00Z", "applied_at": null, "cancelled_at": "2026-10-13T09:20:00Z", "cancel_reason": "cancelled_by_reviewer" } } } } } }, "401": { "description": "A chave de API com escopo expirou.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Chave de API com escopo após a data de validade", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Credenciais ausentes, um chamador sem o privilégio `write:sessions`, uma chave de API com escopo sem o acesso de que este endpoint precisa, ou um `session_id` que pertence a outra aplicação.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente ou inválido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "O chamador não tem write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Chave de API com escopo sem este acesso", "value": { "detail": "This API key has no write access to decisions." } } } } } }, "404": { "description": "Não existe nenhuma sessão de KYC ou KYB com este `session_id`, ou a sessão não tem nenhuma substituição com este `overrideId`.", "content": { "application/json": { "examples": { "Not Found": { "summary": "session_id desconhecido", "value": { "detail": "Not found." } }, "Override Not Found": { "summary": "Nenhuma substituição com este id na sessão", "value": { "detail": "Override not found." } } } } } }, "409": { "description": "A substituição já foi aplicada ou foi cancelada.", "content": { "application/json": { "examples": { "Not Pending": { "summary": "Somente uma substituição em espera pode ser cancelada", "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": "Adicionar uma tag a uma rede", "description": "Adiciona uma das tags da sua aplicação à rede. Retorna o detalhe da rede, cujo `tags` lista as tags da sua aplicação na rede, com `201` quando a tag foi adicionada e `200` quando ela já estava na rede. Uma tag que pertence a outra aplicação, ou que não existe, retorna 404 `Tag not found.`. Requer uma chave de API com acesso total, ou `write:networks` para um membro do console.", "operationId": "add_network_tag", "tags": [ "Networks" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "description": "UUID da rede." } ], "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": "A tag foi adicionada. Retorna o detalhe da rede.", "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": "A tag já estava na rede e permanece como está. Retorna o detalhe da rede.", "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": "Corpo inválido: `tag_uuid` está ausente ou não é um UUID.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tag_uuid": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Missing tag_uuid": { "summary": "tag_uuid ausente", "value": { "tag_uuid": [ "This field is required." ] } }, "Invalid tag_uuid": { "summary": "tag_uuid inválido", "value": { "tag_uuid": [ "Must be a valid UUID." ] } } } } } }, "401": { "description": "Credenciais ausentes ou inválidas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente em erros com código, por exemplo `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Credenciais ausentes ou inválidas", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "A chave de API pertence a outra aplicação ou é uma chave com acesso restrito: os endpoints de Networks exigem uma chave com acesso total. Um token de membro do console precisa de `write:networks`. Também é retornado com `code: networks_not_entitled` quando o Networks não está habilitado para a organização.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente em erros com código, por exemplo `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Redes não habilitadas", "value": { "detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled" } }, "Restricted API key": { "summary": "Chave de API restrita", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Sem permissão", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não encontrado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente em erros com código, por exemplo `networks_not_entitled`." } } }, "examples": { "Network not found": { "summary": "Rede não encontrada", "value": { "detail": "Network not found." } }, "Tag not found": { "summary": "Tag não encontrada", "value": { "detail": "Tag not found." } } } } } } }, "x-didit-sdk": { "resource": "networks", "method": "add_tag", "auth": "api_key", "server": true, "scope": "application" } } }, "/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/remove/": { "post": { "summary": "Remover uma tag de uma rede", "description": "Remove da rede uma das tags da sua aplicação. Retorna o detalhe da rede. Retorna 404 quando a tag não está na rede ou não pertence à sua aplicação. Requer uma chave de API com acesso total, ou `write:networks` para um membro do console.", "operationId": "remove_network_tag", "tags": [ "Networks" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." }, { "name": "network_uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "description": "UUID da rede." } ], "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": "A tag foi removida da rede. Retorna o detalhe da rede.", "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": "Corpo inválido: `tag_uuid` está ausente ou não é um UUID.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tag_uuid": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Missing tag_uuid": { "summary": "tag_uuid ausente", "value": { "tag_uuid": [ "This field is required." ] } }, "Invalid tag_uuid": { "summary": "tag_uuid inválido", "value": { "tag_uuid": [ "Must be a valid UUID." ] } } } } } }, "401": { "description": "Credenciais ausentes ou inválidas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente em erros com código, por exemplo `networks_not_entitled`." } } }, "examples": { "Missing or invalid credentials": { "summary": "Credenciais ausentes ou inválidas", "value": { "detail": "Authentication credentials were not provided or are invalid." } } } } } }, "403": { "description": "A chave de API pertence a outra aplicação ou é uma chave com acesso restrito: os endpoints de Networks exigem uma chave com acesso total. Um token de membro do console precisa de `write:networks`. Também é retornado com `code: networks_not_entitled` quando o Networks não está habilitado para a organização.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente em erros com código, por exemplo `networks_not_entitled`." } } }, "examples": { "Networks not enabled": { "summary": "Redes não habilitadas", "value": { "detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled" } }, "Restricted API key": { "summary": "Chave de API restrita", "value": { "detail": "This API key has no access to this endpoint." } }, "No permission": { "summary": "Sem permissão", "value": { "detail": "You do not have permission to perform this action." } } } } } }, "404": { "description": "Não encontrado.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "description": "Presente em erros com código, por exemplo `networks_not_entitled`." } } }, "examples": { "Network not found": { "summary": "Rede não encontrada", "value": { "detail": "Network not found." } }, "Tag not found": { "summary": "Tag não encontrada", "value": { "detail": "Tag not found." } }, "Tag not on the network": { "summary": "A tag não está na rede", "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": "Lembrar o cliente de uma requisição", "description": "Reenvie o e-mail de uma requisição ao cliente em espera, para o mesmo destinatário verificado e com o mesmo conteúdo. Você pode enviar um lembrete de uma requisição no máximo uma vez a cada 24 horas. Um lembrete não altera mais nada: a requisição mantém o prazo e o caso mantém o status. Cada lembrete é registrado no caso como um evento CUSTOMER_REQUEST com a ação `reminded`. O `delivery_status` da resposta indica como terminou a entrega deste lembrete: SENT, SIMULATED (o e-mail não foi enviado) ou UNKNOWN (o e-mail pode ter sido aceito; ele não é reenviado automaticamente). `next_reminder_at` indica quando você pode enviar um novo lembrete desta requisição. Retorna 409 com um `reason` quando o cliente já não tem a requisição para responder, e 429 com `retry_at` e um cabeçalho `Retry-After` quando a requisição recebeu um lembrete nas últimas 24 horas. Requer `write:cases`.", "operationId": "organization_application_cases_requests_remind_create", "parameters": [ { "in": "path", "name": "organization_id", "schema": { "type": "string", "format": "uuid" }, "required": true, "description": "UUID da organização." }, { "in": "path", "name": "application_id", "schema": { "type": "string", "format": "uuid" }, "required": true, "description": "UUID da aplicação." }, { "in": "path", "name": "case_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true, "description": "UUID do caso." }, { "in": "path", "name": "request_uuid", "schema": { "type": "string", "format": "uuid" }, "required": true, "description": "UUID da requisição ao cliente, obtido da lista de requisições do caso." } ], "tags": [ "Case Management" ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/requests/3fa85f64-5717-4562-b3fc-2c963f66afa6/remind/' \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nresult = client.cases.requests.remind(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nconst result = await didit.cases.requests.remind(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\",\n);\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Requests.Remind(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nvar result = client.cases().requests().remind(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "cases->requests->remind('11111111-2222-3333-4444-555555555555', '11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\nresult = didit.cases.requests.remind(\n \"11111111-2222-3333-4444-555555555555\",\n \"11111111-2222-3333-4444-555555555555\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nvar result = await client.Cases.Requests.RemindAsync(\"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "O lembrete foi registrado e seu e-mail foi enviado.", "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": "Quando este lembrete foi registrado." }, "delivery_status": { "type": "string", "enum": [ "SENT", "SIMULATED", "UNKNOWN" ], "description": "Como terminou a entrega deste lembrete. SIMULATED: o e-mail não foi enviado. UNKNOWN: o e-mail pode ter sido aceito; ele não é reenviado automaticamente." }, "next_reminder_at": { "type": "string", "format": "date-time", "description": "Quando você pode enviar um novo lembrete para esta requisição: `reminded_at` mais 24 horas." } } }, "example": { "request": { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "purpose": "confirm_details", "language": "en", "recipient": "customer@example.com", "expires_at": "2026-10-20T09:00:00Z", "actor_email": "reviewer@example.com", "delivery_status": "SENT", "delivered_at": "2026-10-13T09:00:04Z", "cancelled_at": null, "responded_at": null, "response": null, "has_attachment": false, "created_at": "2026-10-13T09:00:00Z" }, "reminded_at": "2026-10-14T10:30:00Z", "delivery_status": "SENT", "next_reminder_at": "2026-10-15T10:30:00Z" } } } }, "400": { "description": "O caso tem uma resolução pendente de aprovação. O corpo é uma lista de strings.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "Customer messages require an active case without a pending resolution." ] } } }, "403": { "description": "O chamador não tem a permissão de casos necessária." }, "404": { "description": "A requisição ou o caso não está disponível para este solicitante." }, "409": { "description": "A requisição não aguarda mais o cliente, então não há nada para lembrá-lo. `reason` informa o motivo: `answered` (o cliente respondeu), `cancelled`, `expired`, `closed` (o caso foi resolvido depois do envio da requisição, mesmo que tenha sido reaberto desde então), `not_actionable` (uma atualização de revisão em andamento não pede nada), `not_delivered` (o primeiro e-mail ainda não foi enviado) ou `contact_unavailable` (o e-mail verificado não está mais disponível).", "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": "Já foi enviado um lembrete desta requisição nas últimas 24 horas. `retry_at` e o cabeçalho `Retry-After` informam quando você pode enviar um novo lembrete.", "headers": { "Retry-After": { "description": "Segundos de espera até que você possa enviar um novo lembrete desta requisição.", "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": "Pré-visualizar o e-mail de decisão de uma sessão", "description": "Renderiza o e-mail que a pessoa recebe quando você define uma sessão como `Approved` ou `Declined` com `send_email: true`, sem alterar a sessão nem enviar nada. A resposta mostra o assunto e o HTML exatamente como são enviados, o destinatário, o remetente, o idioma e se a confirmação da alteração de fato envia o e-mail (`will_be_sent`, `not_sent_reason`).\n\nO destinatário é o próprio endereço da pessoa: o que ela verificou em uma etapa de verificação de e-mail do fluxo ou, caso contrário, o informado em `contact_details` quando a sessão foi criada. O remetente é o domínio de envio verificado da sua aplicação quando a marca própria se aplica (`sender_kind: customer`) ou, caso contrário, o remetente da Didit (`sender_kind: didit`).\n\nPara enviar exatamente o que você pré-visualizou, chame [Update Session Status](/pt-br/sessions-api/update-status) com o mesmo `new_status`, `send_email: true`, `email_address` definido como `recipient`, `email_language` definido como `language` e `email_preview_token` definido como `preview_token`. O comprovante expira após 15 minutos. Quando o destinatário, o idioma, o status da sessão, o remetente ou o e-mail mudaram desde a pré-visualização, a atualização retorna `409` antes que qualquer coisa seja alterada; pré-visualize novamente e confirme com o novo comprovante.\n\nFunciona para sessões de Verificação de usuários (KYC) e Verificação de empresas (KYB) com status `Approved`, `Declined`, `In Review`, `Kyc Expired`, `Abandoned` ou `Resubmitted`. A verificação de status é executada antes da validação do corpo. Requer o privilégio `write:sessions`; uma chave de API com escopo precisa de acesso de escrita a decisões. As respostas usam `Cache-Control: no-store`: trate-as como conteúdo de verificação sensível.", "operationId": "post_v3_session_decision_email_preview", "tags": [ "Sessions" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "in": "path", "name": "sessionId", "required": true, "description": "UUID da sessão de verificação. Aceita IDs de sessão tanto de usuário (KYC) quanto de empresa (KYB).", "schema": { "type": "string", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "new_status" ], "properties": { "new_status": { "type": "string", "enum": [ "Approved", "Declined" ], "description": "A decisão cujo e-mail você quer pré-visualizar.", "example": "Approved" }, "email_language": { "type": "string", "default": "en", "description": "Idioma do e-mail, com o mesmo padrão de Update Session Status. Um idioma que não é oferecido passa a usar inglês; `language` na resposta indica qual é usado.", "example": "en" } } }, "examples": { "Approved": { "summary": "Pré-visualizar o e-mail de aprovação em inglês", "value": { "new_status": "Approved" } }, "Declined in Spanish": { "summary": "Pré-visualizar o e-mail de recusa em espanhol", "value": { "new_status": "Declined", "email_language": "es" } } } } } }, "responses": { "200": { "description": "Somente pré-visualização. A sessão não é alterada e nenhum e-mail é enviado.", "headers": { "Cache-Control": { "description": "Sempre `no-store`: a pré-visualização contém conteúdo da verificação e não deve ser armazenada em cache.", "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": "O endereço para o qual o e-mail vai. Uma string vazia quando nenhum endereço da pessoa é conhecido. Nesse caso, nenhum e-mail pode ser enviado e `preview_token` também fica vazio. Envie-o como `email_address` ao confirmar.", "example": "person@example.com" }, "recipient_source": { "type": "string", "enum": [ "email_verification", "contact_details", "" ], "description": "A origem de `recipient`. `email_verification`: o endereço que a pessoa verificou em uma etapa de verificação de e-mail do fluxo. `contact_details`: o endereço informado em `contact_details` quando a sessão foi criada. Uma string vazia quando não há endereço.", "example": "email_verification" }, "sender": { "type": "string", "description": "O cabeçalho `From` com o qual o e-mail é enviado.", "example": "Example App " }, "sender_name": { "type": "string", "description": "A parte do nome de exibição de `sender`.", "example": "Example App" }, "sender_email": { "type": "string", "format": "email", "description": "A parte de endereço de `sender`.", "example": "no-reply@mail.example.com" }, "sender_kind": { "type": "string", "enum": [ "customer", "didit" ], "description": "`customer`: o e-mail é enviado a partir do domínio de remetente verificado da sua aplicação (marca própria). `didit`: ele é enviado a partir do remetente da própria Didit.", "example": "customer" }, "subject": { "type": "string", "description": "A linha de assunto exatamente como é enviada.", "example": "Your verification has been approved in Example App" }, "html": { "type": "string", "description": "O HTML do e-mail exatamente como é enviado, com o logotipo incorporado como data URL. Renderize-o em um frame isolado (sandbox), nunca diretamente no DOM da sua aplicação.", "example": "..." }, "text": { "type": "string", "description": "O texto do e-mail em texto simples, como a conversa de Mensagens da pessoa o mantém, para uma pré-visualização compacta (o HTML continua sendo o e-mail que a pessoa recebe).", "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": "O idioma em que o e-mail está escrito. Inglês (`en`) quando o `email_language` solicitado não é oferecido.", "example": "en" }, "will_be_sent": { "type": "boolean", "description": "Indica se confirmar a alteração com `send_email: true` envia este e-mail. `false` quando `not_sent_reason` está definido.", "example": true }, "not_sent_reason": { "type": "string", "nullable": true, "enum": [ "status_unchanged", "notification_emails_disabled", "no_recipient", "sandbox", null ], "description": "Por que a confirmação não enviaria nenhum e-mail, ou `null` quando ele será enviado. `status_unchanged`: a sessão já tem esse status, então a atualização não muda nada e não envia nada. `notification_emails_disabled`: a sessão foi criada sem `contact_details.send_notification_emails: true`, então nenhum e-mail de decisão é enviado ao endereço informado em `contact_details`. `no_recipient`: nenhum endereço é conhecido para a pessoa. `sandbox`: uma sessão sandbox cujo destinatário não ativou a entrega de e-mails no sandbox, então o envio é apenas simulado.", "example": null }, "preview_token": { "type": "string", "description": "Recibo assinado para este e-mail exato, válido por 15 minutos. Passe-o como `email_preview_token` para [Atualizar status da sessão](/pt-br/sessions-api/update-status). Uma string vazia quando não há destinatário.", "example": "eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000" } } }, "examples": { "Will Be Sent": { "summary": "O e-mail de aprovação é enviado para o endereço verificado no fluxo", "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": "Nenhum endereço é conhecido para a pessoa", "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": "A sessão não está em um status aceito por este endpoint (`{\"detail\": ...}`), ou o corpo é inválido (`{\"\": [\"\"]}`).", "content": { "application/json": { "examples": { "Wrong Current Status": { "summary": "A sessão não está em um status aceito por este endpoint", "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 não é Approved nem Declined", "value": { "new_status": [ "\"Resubmitted\" is not a valid choice." ] } }, "Missing new_status": { "summary": "Campo obrigatório omitido", "value": { "new_status": [ "This field is required." ] } } } } } }, "401": { "description": "A chave de API com escopo expirou.", "content": { "application/json": { "examples": { "Expired API Key": { "summary": "Chave de API com escopo após a data de validade", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Credenciais ausentes, um chamador sem o privilégio `write:sessions`, uma chave de API com escopo sem o acesso de que este endpoint precisa, ou um `session_id` que pertence a outra aplicação.", "content": { "application/json": { "examples": { "Invalid Credentials": { "summary": "x-api-key ausente ou inválido", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Missing Privilege": { "summary": "O chamador não tem write:sessions", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped Key Without Access": { "summary": "Chave de API com escopo sem este acesso", "value": { "detail": "This API key has no write access to decisions." } } } } } }, "404": { "description": "Não existe nenhuma sessão de KYC ou KYB com este `session_id`.", "content": { "application/json": { "examples": { "Not Found": { "summary": "session_id desconhecido", "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": "Obter um convite de adesão gratuita", "description": "Público, sem autenticação. Mostra o convite ao qual um link de adesão se refere enquanto ele está aberto: quem solicitou, o endereço para o qual foi enviado e os valores do diretório que serão preenchidos previamente. O token é a autenticação.", "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": "O token do convite presente no link de ingresso." } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl https://verification.didit.me/v3/travel-rule/join/{token}/" } ], "responses": { "200": { "description": "O convite.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleJoinInvitation" } } } }, "404": { "description": "Nenhum convite tem este link." }, "410": { "description": "O convite não está mais aberto: expirou, já foi usado ou foi revogado." } } }, "post": { "summary": "Registrar uma conta gratuita da Travel Rule", "description": "Público, sem autenticação. Cria uma conta gratuita de Travel Rule para um VASP contraparte que recebeu uma requisição. O e-mail deve ser o endereço para o qual o convite foi enviado. Um código de 6 caracteres é enviado a esse e-mail; envie-o ao endpoint de verificação para concluir. As tentativas de cadastro estão sujeitas a limite de requisições por endereço e por IP.", "operationId": "registerTravelRuleJoin", "x-didit-sdk": { "resource": "travel_rule.join", "method": "register", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "description": "O token do convite presente no link de ingresso." } ], "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": "A conta foi criada e um código foi enviado por e-mail.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Orienta a contraparte a verificar o e-mail para obter o código de verificação." }, "email": { "type": "string", "format": "email", "description": "O endereço para o qual o código foi enviado." } } } } } }, "400": { "description": "O e-mail não é o endereço convidado, ou a senha ou o endereço foi recusado." }, "404": { "description": "Nenhum convite tem este link." }, "410": { "description": "O convite não está mais aberto: expirou, já foi usado ou foi revogado." }, "429": { "description": "Tentativas demais de entrar. Os cabeçalhos `X-RateLimit-*` indicam qual cota foi esgotada." } } } }, "/v3/travel-rule/join/{token}/verify/": { "post": { "summary": "Verificar uma conta gratuita de Travel Rule", "description": "Público, sem autenticação. Consome o código enviado por e-mail, cria a organização gratuita e responde com as credenciais que a aplicação dela usa nos endpoints do workspace. Receber dados de Travel Rule é gratuito.", "operationId": "verifyTravelRuleJoin", "x-didit-sdk": { "resource": "travel_rule.join", "method": "verify", "auth": "public", "server": false }, "tags": [ "Travel Rule" ], "security": [ {} ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "description": "O token do convite presente no link de ingresso." } ], "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": "As credenciais da organização e da aplicação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleJoinCredentials" } } } }, "400": { "description": "O código ou o e-mail foi recusado." }, "404": { "description": "Nenhum convite tem este link." }, "410": { "description": "O convite não está mais aberto: expirou, já foi usado ou foi revogado." }, "429": { "description": "Tentativas demais de entrar. Os cabeçalhos `X-RateLimit-*` indicam qual cota foi esgotada." } } } }, "/v3/travel-rule/workspace/": { "get": { "summary": "Obter o espaço de trabalho gratuito da Travel Rule", "description": "Lê o espaço de trabalho gratuito de uma aplicação que aderiu gratuitamente: reivindicação no diretório, comprovação de domínio, faturamento e listagem na rede 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": "O workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "404": { "description": "Esta aplicação não entrou pelo plano gratuito, portanto não tem um workspace gratuito." } } } }, "/v3/travel-rule/workspace/claim/": { "post": { "summary": "Reivindicar uma entrada do diretório", "description": "Reivindica a entrada do diretório que corresponde a este workspace. Quando o e-mail corporativo pertence a um domínio listado na entrada, a reivindicação é comprovada e aplicada imediatamente: o perfil de VASP e as configurações de Travel Rule são preenchidos a partir da entrada e a Travel Rule é ativada, de modo que a próxima transferência para ela é roteada pela rede da Didit. Caso contrário, a reivindicação aguarda revisão (`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": "O workspace com o status de reivindicação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "400": { "description": "Nenhuma entrada do diretório tem este id." }, "404": { "description": "Esta aplicação não entrou pelo plano gratuito, portanto não tem um workspace gratuito." } } } }, "/v3/travel-rule/workspace/domain/code/": { "post": { "summary": "Enviar um código de verificação de domínio por e-mail", "description": "Envia por e-mail um código de uso único para o endereço corporativo do espaço de trabalho, para comprovar que ele controla o domínio de e-mail. Há limite de envios, e cada código aceita um número limitado de tentativas incorretas. Também retorna o registro TXT para a alternativa por DNS.", "operationId": "sendTravelRuleWorkspaceDomainCode", "x-didit-sdk": { "resource": "travel_rule.workspace", "method": "send_domain_code", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/workspace/domain/code/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.workspace.send_domain_code()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.workspace.sendDomainCode();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.Workspace.SendDomainCode(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().workspace().sendDomainCode();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->workspace->sendDomainCode();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.workspace.send_domain_code\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Workspace.SendDomainCodeAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "O domínio, seu status e o registro TXT.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspaceDomainCodeResponse" } } } }, "404": { "description": "Esta aplicação não entrou pelo plano gratuito, portanto não tem um workspace gratuito." } } } }, "/v3/travel-rule/workspace/domain/confirm/": { "post": { "summary": "Confirmar o código de verificação do domínio", "description": "Consome o código enviado por e-mail e marca o domínio de e-mail como verificado.", "operationId": "confirmTravelRuleWorkspaceDomain", "x-didit-sdk": { "resource": "travel_rule.workspace", "method": "confirm_domain", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspaceDomainConfirmRequest" }, "example": { "code": "123456" } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/workspace/domain/confirm/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"code\": \"123456\"}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.workspace.confirm_domain(\n code=\"123456\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.workspace.confirmDomain({\n code: \"123456\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.Workspace.ConfirmDomain(ctx, didit.TravelRuleWorkspaceDomainConfirmRequest{\n\tCode: \"123456\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleWorkspaceDomainConfirmRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().workspace().confirmDomain(TravelRuleWorkspaceDomainConfirmRequest.builder()\n .code(\"123456\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->workspace->confirmDomain([\n 'code' => '123456',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.workspace.confirm_domain(code: \"123456\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Workspace.ConfirmDomainAsync(new TravelRuleWorkspaceDomainConfirmRequest\n{\n Code = \"123456\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "O workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "400": { "description": "O código está incorreto, expirou ou já foi usado." }, "404": { "description": "Esta aplicação não entrou pelo plano gratuito, portanto não tem um workspace gratuito." } } } }, "/v3/travel-rule/workspace/domain/dns/": { "post": { "summary": "Verificar o domínio pelo seu registro TXT", "description": "Procura o registro TXT `didit-tr-verify.` retornado pelo endpoint de código e marca o domínio como verificado quando ele corresponde. Uma das duas provas, o código enviado por e-mail ou o registro TXT, é suficiente.", "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": "O workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "400": { "description": "O registro TXT não foi encontrado ou não corresponde." }, "404": { "description": "Esta aplicação não entrou pelo plano gratuito, portanto não tem um workspace gratuito." } } } }, "/v3/travel-rule/workspace/billing/": { "post": { "summary": "Ativar o faturamento de saída", "description": "Ativa o faturamento de Travel Rule de saída para o workspace. O recebimento continua gratuito. Isso não pode ser desativado pela API: entre em contato com o suporte da 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": "O workspace com `billing_enabled` definido como true.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWorkspace" } } } }, "400": { "description": "`enabled` era false." }, "404": { "description": "Esta aplicação não entrou pelo plano gratuito, portanto não tem um workspace gratuito." } } } }, "/v3/investigator/summary/": { "get": { "operationId": "investigator_summary", "summary": "Resumo do investigador", "description": "Estágio, contagens das filas, relatórios preparados e decididos hoje, concordância em 30 dias, preços e o nível de autonomia de cada fila. Chaves restritas precisam do escopo `decisions` (leitura); alertas de transação também precisam de `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": "Chave de API ausente ou inválida." }, "403": { "description": "A chave não tem o escopo, o tipo de item não pode ser lido ou o plano não inclui o Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sessões e casos não abertos por uma regra de transação) ou `transactions` (alertas de transação e casos abertos por uma regra de transação)." }, { "in": "query", "name": "timezone", "schema": { "type": "string" }, "description": "Fuso horário IANA (por exemplo, `Europe/Madrid`) a partir do qual \"hoje\" é contado. UTC por padrão." } ], "x-didit-sdk": { "resource": "investigator", "method": "retrieve_summary", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.retrieve_summary()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.retrieveSummary();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.RetrieveSummary(ctx, didit.InvestigatorRetrieveSummaryParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().retrieveSummary();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->retrieveSummary();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.retrieve_summary\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.RetrieveSummaryAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/queue/": { "get": { "operationId": "investigator_queue", "summary": "Listar a fila do Investigator", "description": "Relatórios abertos, primeiro os **Ready to accept**, depois por prazo, risco e tempo de espera. `counts` abrange todos os tipos no escopo. `count` é limitado a 100. Chaves restritas precisam do escopo `decisions` (leitura); alertas de transação também precisam de `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": "Chave de API ausente ou inválida." }, "403": { "description": "A chave não tem o escopo, o tipo de item não pode ser lido ou o plano não inclui o Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sessões e casos não abertos por uma regra de transação) ou `transactions` (alertas de transação e casos abertos por uma regra de transação)." }, { "in": "query", "name": "kind", "schema": { "type": "string" }, "description": "`session`, `business_session`, `transaction` ou `case`, ou vários deles separados por vírgulas." }, { "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": "Nome, empresa, título do caso, número, ID da transação ou ID do item." }, { "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": "Obter um relatório do Investigator", "description": "O relatório completo de uma execução. 404 quando a execução não tem relatório concluído ou quando seu item foi excluído. Chaves restritas precisam do escopo `decisions` (leitura); alertas de transação também precisam de `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorRunDetail" } } } }, "404": { "description": "Não encontrado ou sem relatório." }, "401": { "description": "Chave de API ausente ou inválida." }, "403": { "description": "A chave não tem o escopo, o tipo de item não pode ser lido ou o plano não inclui o 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": "Aceitar uma recomendação", "description": "Aplica a ação recomendada pelo caminho normal do item, de modo que seus webhooks habituais são disparados. Um `narrative` a torna editada e aceita. Chaves restritas precisam do escopo `decisions` (escrita); alertas de transação também precisam de `transactions` (escrita). Escalar uma verificação ou transação abre um caso.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorDecision" } } } }, "409": { "description": "Já foi decidido, o relatório ainda não está pronto, ou uma regra de proteção está retendo o item." }, "401": { "description": "Chave de API ausente ou inválida." }, "403": { "description": "A chave não tem o escopo, o tipo de item não pode ser lido ou o plano não inclui o 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": "Substituir uma recomendação", "description": "Executa outra ação com uma categoria e um motivo. Também substitui uma decisão que o Investigator tomou por conta própria enquanto ela ainda estiver vigente. Chaves restritas precisam do escopo `decisions` (escrita); alertas de transação também precisam de `transactions` (escrita). Escalar uma verificação ou transação abre um caso.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorDecision" } } } }, "409": { "description": "Já foi decidido, ou uma regra de proteção está retendo o item." }, "401": { "description": "Chave de API ausente ou inválida." }, "403": { "description": "A chave não tem o escopo, o tipo de item não pode ser lido ou o plano não inclui o 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": "Aceitar recomendações em lote", "description": "Aceita até 50 relatórios marcados como Pronto para aceitar. Cada um é uma decisão própria: um relatório que não pode ser aceito é ignorado, com o motivo informado. Chaves restritas precisam do escopo `decisions` (escrita); alertas de transação também precisam de `transactions` (escrita). Escalar uma verificação ou transação abre um caso.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorBatchAcceptResponse" } } } }, "401": { "description": "Chave de API ausente ou inválida." }, "403": { "description": "A chave não tem o escopo, o tipo de item não pode ser lido ou o plano não inclui o 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": "Obter a revisão do Investigator de uma transação", "description": "A revisão mais recente da transação, ou `investigator: null` quando ela nunca teve uma. Chaves restritas precisam dos escopos `decisions` e `transactions` (leitura).", "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": "Não é uma transação desta aplicação." }, "401": { "description": "Chave de API ausente ou inválida." }, "403": { "description": "A chave não tem o escopo, o tipo de item não pode ser lido ou o plano não inclui o Investigator." } }, "parameters": [ { "in": "path", "name": "transaction_id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "x-didit-sdk": { "resource": "investigator", "method": "retrieve_transaction", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.retrieve_transaction(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.retrieveTransaction(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.RetrieveTransaction(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().retrieveTransaction(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->retrieveTransaction('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.retrieve_transaction(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.RetrieveTransactionAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/guardrails/": { "get": { "operationId": "investigator_guardrails", "summary": "Listar as salvaguardas bloqueadas", "description": "As cinco proteções que se aplicam a todas as filas. Elas não podem ser desativadas. Chaves restritas precisam do escopo `decisions` (leitura); alertas de transação também precisam de `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": "Chave de API ausente ou inválida." }, "403": { "description": "A chave não tem o escopo, o tipo de item não pode ser lido ou o plano não inclui o 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": "Painel do investigador", "description": "Os últimos 30 dias: revisões, decisões, taxa de automação, horas economizadas, gastos, sobrescritas, amostras de qualidade desde a entrada em produção, números por fila e semanais. Chaves restritas precisam do escopo `decisions` (leitura); alertas de transações também precisam de `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": "Chave de API ausente ou inválida." }, "403": { "description": "A chave não tem o escopo, o tipo de item não pode ser lido ou o plano não inclui o Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sessões e casos não abertos por uma regra de transação) ou `transactions` (alertas de transação e casos abertos por uma regra de transação)." } ], "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": "Desempenho do investigador", "description": "Concordância com sua equipe, volume, tempo economizado, calibração de confiança, resultados por fila, motivos de substituição e divergências em um período. Chaves restritas exigem o escopo `decisions` (leitura); alertas de transação também exigem `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": "Chave de API ausente ou inválida." }, "403": { "description": "A chave não tem o escopo, o tipo de item não pode ser lido ou o plano não inclui o Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sessões e casos não abertos por uma regra de transação) ou `transactions` (alertas de transação e casos abertos por uma regra de transação)." }, { "in": "query", "name": "period", "schema": { "type": "string", "enum": [ "7", "30", "90" ], "default": "30" }, "description": "Dias, terminando hoje." } ], "x-didit-sdk": { "resource": "investigator", "method": "retrieve_performance", "auth": "api_key", "server": true }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.investigator.retrieve_performance()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.investigator.retrievePerformance();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Investigator.RetrievePerformance(ctx, didit.InvestigatorRetrievePerformanceParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.investigator().retrievePerformance();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "investigator->retrievePerformance();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.investigator.retrieve_performance\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Investigator.RetrievePerformanceAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/investigator/activity/": { "get": { "operationId": "investigator_activity", "summary": "Listar atividade do Investigator", "description": "A trilha de auditoria somente de acréscimo, da mais recente para a mais antiga. Uma aceitação em lote é uma única entrada. Adiciona `counts` por grupo e `actors`. Chaves restritas precisam do escopo `decisions` (leitura); alertas de transação também precisam de `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": "Chave de API ausente ou inválida." }, "403": { "description": "A chave não tem o escopo, o tipo de item não pode ser lido ou o plano não inclui o Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sessões e casos não abertos por uma regra de transação) ou `transactions` (alertas de transação e casos abertos por uma regra de transação)." }, { "in": "query", "name": "group", "schema": { "type": "string", "enum": [ "agent", "decisions", "overrides", "autonomy" ] } }, { "in": "query", "name": "actor", "schema": { "type": "string" }, "description": "`agent` para o Investigator, ou o e-mail de uma pessoa." }, { "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 a atividade do Investigator", "description": "As mesmas entradas em CSV, uma linha por decisão, das mais recentes para as mais antigas, até 10,000 entradas. Chaves restritas precisam do escopo `decisions` (leitura); alertas de transação também precisam de `transactions`.", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "text/csv": { "schema": { "type": "string" } } } }, "401": { "description": "Chave de API ausente ou inválida." }, "403": { "description": "A chave não tem o escopo, o tipo de item não pode ser lido ou o plano não inclui o Investigator." } }, "parameters": [ { "in": "query", "name": "scope", "schema": { "type": "string", "enum": [ "all", "identity", "transactions" ], "default": "all" }, "description": "`identity` (sessões e casos não abertos por uma regra de transação) ou `transactions` (alertas de transação e casos abertos por uma regra de transação)." }, { "in": "query", "name": "group", "schema": { "type": "string", "enum": [ "agent", "decisions", "overrides", "autonomy" ] } }, { "in": "query", "name": "actor", "schema": { "type": "string" }, "description": "`agent` para o Investigator, ou o e-mail de uma pessoa." }, { "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": "Obter as configurações do Investigator", "description": "O estágio (`none`, `shadow` ou `live`) e o limite de gastos mensal com o gasto deste mês. Chaves restritas precisam do escopo `applications` (leitura).", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorSettings" } } } }, "401": { "description": "Chave de API ausente ou inválida." }, "403": { "description": "A chave não tem o escopo, o tipo de item não pode ser lido ou o plano não inclui o 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": "Atualizar configurações do Investigator", "description": "Altera o estágio, o limite de gasto mensal ou ambos. Avançar além de `none` exige um plano que inclua o Investigator (Growth ou superior); `live` também exige um contrato que o precifique, se você tiver um. Chaves restritas precisam do escopo `applications` (escrita).", "tags": [ "Investigator" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigatorSettings" } } } }, "400": { "description": "Nenhum dos campos foi enviado, ou um valor é inválido." }, "401": { "description": "Chave de API ausente ou inválida." }, "403": { "description": "A chave não tem o escopo, o tipo de item não pode ser lido ou o plano não inclui o 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 endereços de carteira em massa", "description": "Adicione até 10.000 carteiras ao seu catálogo de endereços da Travel Rule em uma única chamada, em JSON ou como arquivo CSV. Uma carteira pode ser enviada pelo endereço, pelo SHA-256 do endereço em minúsculas (`address_hash`) para manter o endereço privado, ou por ambos. A importação é idempotente: uma carteira que já está no catálogo é informada como `existing` e não é alterada, então o mesmo arquivo pode ser enviado novamente. Cada linha é validada individualmente, então uma linha inválida nunca faz as outras falharem. Uma carteira importada apenas pelo hash só corresponde a transferências para esse endereço e pode ter sua propriedade comprovada com o widget de propriedade de carteira, como qualquer outra 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": "Um arquivo CSV em UTF-8 de no máximo 5 MB, com uma linha de cabeçalho que nomeia suas colunas (os campos da linha ou seus aliases). Células vazias contam como não enviadas; colunas que a importação não lê são ignoradas." } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl (JSON)", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/wallet-addresses/import/ \\\n -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \\\n -d '{\"entries\": [{\"address\": \"0xBeneficiaryWallet01\", \"chain\": \"ETH\", \"holder_name\": \"Ana Diaz\"}, {\"address\": \"rExchangeSharedAddress01\", \"chain\": \"XRP\", \"memo\": \"104729\"}]}'" }, { "lang": "curl", "label": "curl (CSV)", "source": "curl -X POST https://verification.didit.me/v3/travel-rule/wallet-addresses/import/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -F 'file=@wallets.csv;type=text/csv'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.wallet_addresses.bulk_import(\n body={\n \"entries\": [{\n \"address\": \"0xBeneficiaryWallet01\",\n \"chain\": \"ETH\",\n \"holder_name\": \"Ana Diaz\",\n \"holder_vendor_data\": \"user-042\",\n }, {\n \"address_hash\": \"4f7d2e1c9b8a7f6e5d4c3b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f2e\",\n \"chain\": \"bitcoin\",\n \"holder_vendor_data\": \"user-043\",\n }, {\n \"address\": \"rExchangeSharedAddress01\",\n \"chain\": \"XRP\",\n \"memo\": \"104729\",\n \"holder_name\": \"Ana Diaz\",\n }],\n },\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.walletAddresses.bulkImport({\n file: await fileFromPath(\"wallet-addresses.csv\"),\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.WalletAddresses.BulkImport(ctx, didit.TravelRuleWalletAddressesBulkImportParams{\n\tFile: didit.Some(didit.FileFromPath(\"wallet-addresses.csv\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport me.didit.Didit;\nimport me.didit.types.TravelRuleWalletAddressesBulkImportParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().walletAddresses().bulkImport(TravelRuleWalletAddressesBulkImportParams.builder()\n .file(Path.of(\"wallet-addresses.csv\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->walletAddresses->bulkImport([\n 'file' => File::fromPath('wallet-addresses.csv'),\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.wallet_addresses.bulk_import(\n body: {\n entries: [{\n address: \"0xBeneficiaryWallet01\",\n chain: \"ETH\",\n holder_name: \"Ana Diaz\",\n holder_vendor_data: \"user-042\",\n }, {\n address_hash: \"4f7d2e1c9b8a7f6e5d4c3b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f2e\",\n chain: \"bitcoin\",\n holder_vendor_data: \"user-043\",\n }, {\n address: \"rExchangeSharedAddress01\",\n chain: \"XRP\",\n memo: \"104729\",\n holder_name: \"Ana Diaz\",\n }],\n }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.WalletAddresses.BulkImportAsync(new TravelRuleWalletAddressesBulkImportParams\n{\n File = FileUpload.FromPath(\"wallet-addresses.csv\"),\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Cada linha foi criada, já estava na base ou era repetição de uma linha 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": "Pelo menos uma linha falhou; as demais foram importadas. Cada linha com falha indica seus erros.", "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": "A própria requisição não pode ser lida: `entries` e um `file` ao mesmo tempo, ou nenhum dos dois; mais de 10,000 linhas; um arquivo com mais de 5 MB, que não seja CSV em UTF-8, sem linha de cabeçalho ou sem linhas.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "file": [ "At most 10000 rows per import." ] } } } } } } }, "/v3/travel-rule/counterparty-contacts/": { "get": { "summary": "Listar contatos da contraparte", "description": "Os endereços de conformidade para os quais o canal EMAIL pode escrever em nome da sua aplicação: os contatos da plataforma Didit mais os contatos privados da própria aplicação, incluindo os que retornaram com falha de entrega, do mais recente para o mais antigo. Paginado com `limit` (padrão 50) e `offset`; `count` para em 100, então 100 significa 100 ou mais.", "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": "Somente os contatos desta entrada do diretório. Deve ser um UUID; um valor vazio significa nenhum filtro." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "Tamanho da página, padrão 50." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "Linhas a ignorar." } ], "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": "Os contatos.", "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` não é um UUID.", "content": { "application/json": { "example": { "counterparty": [ "Must be a valid UUID." ] } } } } } }, "post": { "summary": "Adicionar um contato de contraparte", "description": "Adiciona um endereço de conformidade privado para uma entrada do diretório. Somente a sua aplicação o vê e o usa, e o canal EMAIL escreve para ele antes de qualquer contato da plataforma. Adicionar um endereço que a entrada já tem entre os seus próprios contatos retorna esse contato.", "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": "O contato foi adicionado.", "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": "Um campo está ausente ou é inválido, ou nenhuma entrada do diretório tem este id.", "content": { "application/json": { "example": { "counterparty": [ "No directory entry with this id." ] } } } } } } }, "/v3/travel-rule/counterparty-contacts/{contact_uuid}/": { "delete": { "summary": "Excluir um contato de contraparte", "description": "Exclui um dos contatos próprios da sua aplicação. O canal EMAIL deixa de enviar para ele imediatamente. Contatos da plataforma não podem ser excluídos.", "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": "Excluído." }, "404": { "description": "Nenhum contato da sua aplicação tem este id. Um contato da plataforma também responde 404." } } } }, "/v3/travel-rule/transfers/": { "get": { "summary": "Listar transferências da Travel Rule", "description": "As transferências de Travel Rule da sua aplicação, das mais recentes para as mais antigas, paginadas com `limit` (padrão 50) e `offset`. As linhas trazem apenas nomes de VASPs, carteiras e memos, nunca dados de pessoas. Valores separados por vírgula selecionam vários. Um valor desconhecido responde 400 indicando o parâmetro, por exemplo `{\"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 ou ambos separados por vírgula. Diferencia maiúsculas de minúsculas." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Um ou mais status de transferência, separados por vírgula." }, { "name": "rail", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Um ou mais entre INTERNAL, TRP, GTR, TRUST, VERIFYVASP, SYGNA, EMAIL, TEST_VASP, separados por vírgula." }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string" }, "description": "withdrawal, deposit ou message, separados por vírgula." }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" }, "description": "A moeda da transação, sem distinção entre maiúsculas e minúsculas." }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Transferências criadas neste dia (UTC) ou depois dele, YYYY-MM-DD." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Transferências criadas neste dia (UTC) ou antes dele, YYYY-MM-DD." }, { "name": "counterparty", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "O `id` de uma entrada do diretório ou de um membro da rede Didit retornado por GET /v3/travel-rule/vasps/: suas transferências com essa contraparte. Um valor que não seja um id válido retorna 400." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "Tamanho da página, padrão 50." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "Linhas a ignorar." } ], "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": "Uma página de transferências.", "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": "Um valor de filtro não é válido.", "content": { "application/json": { "example": { "start_date": [ "Use the YYYY-MM-DD format." ] } } } } } } }, "/v3/session/imports/providers/": { "get": { "summary": "Listar provedores de migração", "description": "Os 15 provedores dos quais você pode migrar verificações: o que cada um precisa para se conectar, se a API dele pode listar registros, as permissões de que a chave dele precisa e o mapeamento de status padrão.", "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": "Provedores de migração.", "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": "Chave de API ausente, inválida ou revogada, ou o chamador não pode importar verificações para esta aplicação.", "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": "Verificar uma chave de provedor", "description": "Consulte o provedor com a sua chave antes de criar uma migração. Nada é armazenado.", "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": "Origem da migração, obtida de `GET /v3/session/imports/providers/`. Obrigatório quando `source` é `provider`." }, "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A chave somente leitura do provedor, com os nomes de campo listados em `credential_fields`. Criptografada em repouso, nunca retornada e apagada quando a importação termina. Envie-a como uma string JSON no multipart." }, "options": { "type": "object", "properties": { "region": { "type": "string", "description": "A região do provedor, uma das suas `regions` (Onfido: `eu`, `us`, `ca`)." } } }, "record_ids": { "type": "array", "items": { "type": "string" }, "description": "Para provedores `api_ids`: o ID do primeiro registro da sua exportação." } }, "required": [ "provider", "credentials" ] }, "example": { "provider": "sumsub", "credentials": { "app_token": "YOUR_PROVIDER_APP_TOKEN", "secret_key": "YOUR_PROVIDER_SECRET_KEY" } } } } }, "responses": { "200": { "description": "A chave pode ler registros.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "provider": { "type": "string" }, "credential_hint": { "type": "string", "nullable": true } } } } } }, "400": { "description": "O provedor recusou a chave: `code`, `detail`, `missing_permissions`, `suggested_region`." }, "403": { "description": "Chave de API ausente, inválida ou revogada, ou o chamador não pode importar verificações para esta aplicação.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.check_provider(\n provider=\"sumsub\",\n credentials={\"app_token\": \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\": \"YOUR_PROVIDER_SECRET_KEY\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.checkProvider({\n provider: \"sumsub\",\n credentials: { app_token: \"YOUR_PROVIDER_APP_TOKEN\", secret_key: \"YOUR_PROVIDER_SECRET_KEY\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.CheckProvider(ctx, didit.SessionsImportsCheckProviderParams{\n\tProvider: \"sumsub\",\n\tCredentials: map[string]string{\"app_token\": \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\": \"YOUR_PROVIDER_SECRET_KEY\"},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SessionsImportsCheckProviderParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().checkProvider(SessionsImportsCheckProviderParams.builder()\n .provider(SessionsImportsCheckProviderParams.Provider.of(\"sumsub\"))\n .credentials(Map.of(\"app_token\", \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\", \"YOUR_PROVIDER_SECRET_KEY\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->checkProvider([\n 'provider' => 'sumsub',\n 'credentials' => ['app_token' => 'YOUR_PROVIDER_APP_TOKEN', 'secret_key' => 'YOUR_PROVIDER_SECRET_KEY'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.check_provider(\n provider: \"sumsub\",\n credentials: { app_token: \"YOUR_PROVIDER_APP_TOKEN\", secret_key: \"YOUR_PROVIDER_SECRET_KEY\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.CheckProviderAsync(new SessionsImportsCheckProviderParams\n{\n Provider = \"sumsub\",\n Credentials = new Dictionary { [\"app_token\"] = \"YOUR_PROVIDER_APP_TOKEN\", [\"secret_key\"] = \"YOUR_PROVIDER_SECRET_KEY\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/{importId}/start/": { "post": { "summary": "Iniciar uma execução de teste", "description": "Inicie uma migração cuja simulação (dry run) terminou (`READY`): o mesmo job faz a importação real, com o mapeamento de status e a escolha de templates faciais enviados agora.", "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": "Alterações no mapeamento de status padrão do provedor: status de origem para status da Didit. `Not Finished` e `Abandoned` são ignorados e contabilizados, nunca importados." }, "face_templates": { "type": "boolean", "default": false, "description": "Gera templates faciais a partir das selfies importadas e os busca entre os rostos e a lista de bloqueio da aplicação. As correspondências são apenas sinalizadas para revisão. Requer `lawful_basis_confirmed`." }, "lawful_basis_confirmed": { "type": "boolean", "default": false, "description": "Confirma que você tem uma base legal para compartilhar essas selfies com a Didit, na qualidade de operadora." } } } } } }, "responses": { "200": { "description": "A tarefa de importação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "A tarefa não está em um estado ao qual esta ação se aplica." }, "403": { "description": "Chave de API ausente, inválida ou revogada, ou o chamador não pode importar verificações para esta aplicação.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.start(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.start(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Start(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsImportsStartParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().start(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->start('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.start(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.StartAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/{importId}/pause/": { "post": { "summary": "Pausar um job de importação", "description": "Pausa uma importação na fila ou em execução.", "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": "A tarefa de importação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "A tarefa não está em um estado ao qual esta ação se aplica." }, "403": { "description": "Chave de API ausente, inválida ou revogada, ou o chamador não pode importar verificações para esta aplicação.", "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": "Retomar uma importação", "description": "Retome uma importação que você pausou. Uma importação pausada pelo limite de requisições do provedor é retomada automaticamente.", "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": "A tarefa de importação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "A tarefa não está em um estado ao qual esta ação se aplica." }, "403": { "description": "Chave de API ausente, inválida ou revogada, ou o chamador não pode importar verificações para esta aplicação.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.resume(\n \"11111111-2222-3333-4444-555555555555\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.resume(\"11111111-2222-3333-4444-555555555555\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Resume(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().resume(\"11111111-2222-3333-4444-555555555555\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->resume('11111111-2222-3333-4444-555555555555');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.resume(\"11111111-2222-3333-4444-555555555555\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.ResumeAsync(\"11111111-2222-3333-4444-555555555555\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/imports/{importId}/cancel/": { "post": { "summary": "Cancelar um job de importação", "description": "Cancelar uma importação. O que já foi importado permanece; o arquivo enviado e a chave são apagados.", "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": "A tarefa de importação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "A tarefa não está em um estado ao qual esta ação se aplica." }, "403": { "description": "Chave de API ausente, inválida ou revogada, ou o chamador não pode importar verificações para esta aplicação.", "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": "Tentar novamente uma migração", "description": "Executa novamente uma migração encerrada como um novo job, com uma nova chave (a antiga foi apagada). Mantém o provedor, o fluxo, a região, o mapeamento de status e a escolha de templates faciais; tudo o que já está na Didit é ignorado.", "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": "A chave somente leitura do provedor, com os nomes de campo listados em `credential_fields`. Criptografada em repouso, nunca retornada e apagada quando a importação termina. Envie-a como uma string JSON no multipart." }, "file": { "type": "string", "format": "binary", "description": "Os IDs de registro ou o arquivo de exportação novamente, para provedores `api_ids` e `export_file`." } } }, "example": { "credentials": { "app_token": "YOUR_PROVIDER_APP_TOKEN", "secret_key": "YOUR_PROVIDER_SECRET_KEY" } } } } }, "responses": { "201": { "description": "O novo job de importação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionImportJob" } } } }, "400": { "description": "Não é uma migração, não foi encerrada ou o provedor recusou a chave." }, "403": { "description": "Chave de API ausente, inválida ou revogada, ou o chamador não pode importar verificações para esta aplicação.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.retry(\n \"11111111-2222-3333-4444-555555555555\",\n credentials={\"app_token\": \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\": \"YOUR_PROVIDER_SECRET_KEY\"},\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.retry(\"11111111-2222-3333-4444-555555555555\", {\n credentials: { app_token: \"YOUR_PROVIDER_APP_TOKEN\", secret_key: \"YOUR_PROVIDER_SECRET_KEY\" },\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.Retry(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsImportsRetryParams{\n\tCredentials: didit.Some(map[string]string{\"app_token\": \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\": \"YOUR_PROVIDER_SECRET_KEY\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.util.Map;\nimport me.didit.Didit;\nimport me.didit.types.SessionsImportsRetryParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().retry(\"11111111-2222-3333-4444-555555555555\", SessionsImportsRetryParams.builder()\n .credentials(Map.of(\"app_token\", \"YOUR_PROVIDER_APP_TOKEN\", \"secret_key\", \"YOUR_PROVIDER_SECRET_KEY\"))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->retry('11111111-2222-3333-4444-555555555555', [\n 'credentials' => ['app_token' => 'YOUR_PROVIDER_APP_TOKEN', 'secret_key' => 'YOUR_PROVIDER_SECRET_KEY'],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.retry(\n \"11111111-2222-3333-4444-555555555555\",\n credentials: { app_token: \"YOUR_PROVIDER_APP_TOKEN\", secret_key: \"YOUR_PROVIDER_SECRET_KEY\" }\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.RetryAsync(\"11111111-2222-3333-4444-555555555555\", new SessionsImportsRetryParams\n{\n Credentials = new Dictionary { [\"app_token\"] = \"YOUR_PROVIDER_APP_TOKEN\", [\"secret_key\"] = \"YOUR_PROVIDER_SECRET_KEY\" },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/import-jobs/": { "get": { "summary": "Listar tarefas de importação de listas", "description": "Todas as importações da aplicação em um único formato: importações e migrações de verificações, pessoas e empresas.", "operationId": "get_v3_import_jobs_list", "x-didit-sdk": { "resource": "sessions.imports", "method": "list_jobs", "auth": "api_key", "server": true }, "tags": [ "Sessions" ], "parameters": [ { "name": "scope", "in": "query", "schema": { "type": "string", "enum": [ "all", "sessions", "users", "businesses" ], "default": "all" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "responses": { "200": { "description": "Jobs de importação, do mais recente para o mais antigo.", "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": "Chave de API ausente, inválida ou revogada, ou o chamador não pode importar verificações para esta aplicação.", "content": { "application/json": { "examples": { "Forbidden": { "value": { "detail": "You do not have permission to perform this action." } } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.imports.list_jobs()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.imports.listJobs();\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Imports.ListJobs(ctx, didit.SessionsImportsListJobsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().imports().listJobs();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->imports->listJobs();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.imports.list_jobs\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.Imports.ListJobsAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/import-jobs/active/": { "get": { "summary": "Listar trabalhos de importação ativos", "description": "O que está em execução ou aguardando, além do que acabou de terminar, para um indicador de progresso.", "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": "Trabalhos de importação ativos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/ImportJobSummary" } }, "running": { "type": "integer" } } } } } }, "403": { "description": "Chave de API ausente, inválida ou revogada, ou o chamador não pode importar verificações para esta aplicação.", "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": "Excluir transações em lote", "description": "Exclui uma ou mais transações de forma permanente. Selecione-as com `transaction_uuids` ou exclua todas as transações da aplicação com `delete_all: true`.\n\nUma transação excluída leva consigo os registros que pertencem apenas a ela: suas partes, tags, notas, vínculos com métodos de pagamento, documentos e todas as versões armazenadas de seus arquivos, execuções de regras, alertas, resultados de provedores, snapshot da rede e dados de Travel Rule. Casos, pessoas e empresas são mantidos, e o vínculo deles com a transação excluída é removido. Os relatórios regulatórios em rascunho deixam de listá-la e são reconstruídos sem ela. A exclusão é permanente e irreversível; não existe endpoint para desfazê-la.\n\nSe alguma transação selecionada estiver listada em um relatório regulatório finalizado, a requisição inteira é recusada com `409` e nada é excluído. O corpo usa `code: in_filed_report` e identifica cada transação e os relatórios que a listam. Exclua esses relatórios e repita a requisição.", "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 da organização." }, { "name": "application_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID da aplicação." } ], "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": "UUIDs das transações na Didit a excluir. Obrigatório, a menos que `delete_all` seja true.", "minItems": 1 }, "delete_all": { "type": "boolean", "enum": [ false ], "default": false, "description": "Omita ou envie `false` quando você selecionar transações com `transaction_uuids`." } } }, { "title": "All transactions", "required": [ "delete_all" ], "properties": { "delete_all": { "type": "boolean", "enum": [ true ], "description": "Exclui todas as transações da aplicação. `transaction_uuids` é ignorado." }, "transaction_uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ignorado quando `delete_all` é true." } } } ] }, "examples": { "Selected transactions": { "value": { "transaction_uuids": [ "abcdef12-3456-7890-abcd-ef1234567890", "12345678-90ab-cdef-1234-567890abcdef" ] } }, "All transactions": { "value": { "delete_all": true } } } } } }, "x-codeSamples": [ { "lang": "curl", "label": "curl (selected transactions)", "source": "curl -X DELETE 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/transactions/delete/' \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\"transaction_uuids\": [\"abcdef12-3456-7890-abcd-ef1234567890\"]}'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\nclient = Didit()\n\nclient.transactions.batch_delete(\n body={\n \"transaction_uuids\": [\"abcdef12-3456-7890-abcd-ef1234567890\", \"12345678-90ab-cdef-1234-567890abcdef\"],\n },\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nconst didit = new Didit();\n\nawait didit.transactions.batchDelete({\n transaction_uuids: [\"abcdef12-3456-7890-abcd-ef1234567890\", \"12345678-90ab-cdef-1234-567890abcdef\"],\n});" }, { "lang": "java", "label": "Java", "source": "import java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.TransactionsBatchDeleteParams;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nDidit client = new Didit();\n\nclient.transactions().batchDelete(TransactionsBatchDeleteParams.builder()\n .putAdditionalProperty(\"transaction_uuids\", List.of(\"abcdef12-3456-7890-abcd-ef1234567890\", \"12345678-90ab-cdef-1234-567890abcdef\"))\n .build());" }, { "lang": "php", "label": "PHP", "source": "transactions->batchDelete([\n 'transaction_uuids' => ['abcdef12-3456-7890-abcd-ef1234567890', '12345678-90ab-cdef-1234-567890abcdef'],\n]);" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n# and DIDIT_APPLICATION_ID.\ndidit = Didit::Client.new\n\ndidit.transactions.batch_delete(\n body: {\n transaction_uuids: [\"abcdef12-3456-7890-abcd-ef1234567890\", \"12345678-90ab-cdef-1234-567890abcdef\"],\n }\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nusing var client = new DiditClient();\n\nawait client.Transactions.BatchDeleteAsync(new TransactionsBatchDeleteParams\n{\n TransactionUuids = new string[] { \"abcdef12-3456-7890-abcd-ef1234567890\", \"12345678-90ab-cdef-1234-567890abcdef\" },\n});" } ], "responses": { "204": { "description": "Transações selecionadas excluídas." }, "400": { "description": "Nenhum seletor de transação foi informado.", "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": "A chave de API não pode excluir transações. O endpoint exige `write:transactions`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } } }, "409": { "description": "Pelo menos uma das transações selecionadas consta em um relatório regulatório finalizado. Nada é excluído.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InFiledReportError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/travel-rule/networks/": { "get": { "summary": "Obter as redes de Travel Rule", "description": "Leia, para esta aplicação, o estado real de cada rede: se ela envia pela sua própria adesão ou pela da Didit, e por que ainda não pode. Também retorna o questionário de due diligence e os seus participantes. A leitura não cria nada.", "operationId": "getTravelRuleNetworks", "x-didit-sdk": { "resource": "travel_rule.networks", "method": "retrieve", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X GET https://verification.didit.me/v3/travel-rule/networks/ \\\n -H 'x-api-key: YOUR_API_KEY'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.networks.retrieve()\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.networks.retrieve();\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().networks().retrieve();\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->networks->retrieve();\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.networks.retrieve\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.Networks.RetrieveAsync();\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "responses": { "200": { "description": "Estados da rede, questionário e participantes.", "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": "Chave de API ausente ou inválida." } } } }, "/v3/travel-rule/networks/questionnaire/": { "get": { "summary": "Obter o questionário da rede", "description": "Lê o questionário de due diligence de rede da Didit para esta aplicação, seu status e a nota de revisão da Didit. Uma aplicação que nunca salvou um questionário retorna um rascunho vazio.", "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": "O questionário.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaire" } } } }, "401": { "description": "Chave de API ausente ou inválida." } } }, "put": { "summary": "Salvar respostas do questionário da rede", "description": "Salva as respostas do questionário enquanto ele estiver em draft ou changes_requested. Os salvamentos são parciais: as respostas que você não enviar são mantidas.", "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": "O questionário com as respostas mescladas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaire" } } } }, "400": { "description": "Erro de validação, indexado por campo." }, "401": { "description": "Chave de API ausente ou inválida." }, "403": { "description": "O acesso à rede por meio da associação da Didit ainda não está disponível.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_platform_networks_disabled" ] } } } } } }, "409": { "description": "O questionário está com a Didit ou já foi decidido: ele só pode ser alterado enquanto estiver em draft ou changes_requested.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_questionnaire_not_editable" ] } } } } } } } } }, "/v3/travel-rule/networks/questionnaire/submit/": { "post": { "summary": "Enviar o questionário da rede", "description": "Envie o questionário salvo para a revisão da Didit. As respostas salvas devem estar completas: todos os campos, exceto lei e data_protection_contact_email, com as três declarações como true. A Didit o aprova, solicita alterações (edite e envie novamente) ou o rejeita. As redes que você solicitou enquanto ele estava pendente são encaminhadas para o respectivo onboarding quando ele é aprovado.", "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": "O questionário enviado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaire" } } } }, "400": { "description": "As respostas salvas estão incompletas ou são inválidas, indexadas por campo." }, "401": { "description": "Chave de API ausente ou inválida." }, "403": { "description": "O acesso à rede por meio da associação da Didit ainda não está disponível.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_platform_networks_disabled" ] } } } } } }, "409": { "description": "O questionário está com a Didit ou já foi decidido: ele só pode ser alterado enquanto estiver em draft ou changes_requested.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_questionnaire_not_editable" ] } } } } } } } } }, "/v3/travel-rule/networks/{network}/request/": { "post": { "summary": "Solicitar uma rede de Travel Rule", "description": "Solicite o participante próprio desta aplicação em uma rede coberta pela associação da Didit (GTR ou Sygna). Sem um questionário aprovado, o participante aguarda por ele (questionnaire_pending); com um, ele segue para o onboarding da rede (submitted_to_network) e fica ativo assim que a rede lhe atribui um código. Idempotente: um participante pendente, em onboarding ou ativo é retornado sem alterações. Se a rede recusou o registro (last_error está preenchido), uma nova solicitação faz uma nova tentativa. TRUST e VerifyVASP só são acessíveis por meio da sua própria associação: o TRUST admite membros por VASP, e um Enclave do VerifyVASP atende a um único id de VASP.", "operationId": "requestTravelRuleNetworkAccess", "x-didit-sdk": { "resource": "travel_rule.networks", "method": "request_access", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "network", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "gtr", "sygna" ] }, "description": "A rede à qual aderir por meio da associação da 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": "Seu participante na rede.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleNetworkParticipant" } } } }, "400": { "description": "Rede desconhecida, uma rede que a Didit não oferece (conecte sua própria associação) ou uma aplicação 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": "Chave de API ausente ou inválida." }, "403": { "description": "O acesso à rede por meio da associação da Didit ainda não está disponível.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "travel_rule_platform_networks_disabled" ] } } } } } } } } }, "/v3/address-validation/": { "post": { "summary": "Validar um endereço", "description": "Confirme que um endereço existe e receba-o normalizado: suas linhas de entrega, componentes e coordenadas. A validação confirma apenas o endereço; ela nunca vincula o endereço a uma pessoa.\n\n**Requisição.** Envie o endereço em uma única linha (`address`) ou como campos estruturados (`address_line_1` e, opcionalmente, `address_line_2`, `city`, `region`, `postal_code`), nunca as duas formas, e sempre o seu `country` (ISO 3166-1 alfa-2 ou alfa-3).\n\n**Resultado.** `address_validation.status` é `verified` (confirmado até o nível do edifício), `partially_verified` (confirmado apenas até o nível da rua ou acima), `not_verified` (apenas a região ou a cidade correspondeu, ou nada correspondeu) ou `unavailable` (não foi possível executar a validação). O HTTP é `200` para toda requisição concluída, incluindo `unavailable`; tente novamente mais tarde quando o resultado for `unavailable`.\n\n**Faturamento.** Uma chamada em produção custa $0.10 por endereço validado. Um resultado `unavailable` não é cobrado. Nada é armazenado além do registro de uso: nenhuma sessão é criada e o resultado é retornado apenas nesta resposta.\n\n**Sandbox.** Chaves de sandbox validam a requisição e sempre retornam um resultado `verified` determinístico que repete o endereço enviado, sem consumir créditos.\n\n**Autenticação.** Envie a chave de API da sua aplicação em `x-api-key`. Credenciais ausentes ou inválidas retornam `403`: esta API nunca retorna `401`.\n\n**Limite de requisições.** Cota de escrita compartilhada de 300 requisições por minuto por chave de API em todos os endpoints POST/PATCH/DELETE.", "operationId": "post_v3_address_validation", "x-didit-sdk": { "resource": "address_validation", "method": "validate", "auth": "api_key", "server": true }, "tags": [ "Standalone APIs" ], "security": [ { "ApiKeyAuth": [] } ], "x-codeSamples": [ { "lang": "curl", "label": "curl", "source": "curl -X POST https://verification.didit.me/v3/address-validation/ \\\n -H 'x-api-key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"address_line_1\": \"1600 Amphitheatre Pkwy\",\n \"city\": \"Mountain View\",\n \"region\": \"CA\",\n \"postal_code\": \"94043\",\n \"country\": \"US\"\n }'" }, { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.address_validation.validate(\n address_line_1=\"1600 Amphitheatre Pkwy\",\n city=\"Mountain View\",\n region=\"CA\",\n postal_code=\"94043\",\n country=\"US\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.addressValidation.validate({\n address_line_1: \"1600 Amphitheatre Pkwy\",\n city: \"Mountain View\",\n region: \"CA\",\n postal_code: \"94043\",\n country: \"US\",\n});\nconsole.log(result);" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.AddressValidationRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.addressValidation().validate(AddressValidationRequest.builder()\n .addressLine1(\"1600 Amphitheatre Pkwy\")\n .city(\"Mountain View\")\n .region(\"CA\")\n .postalCode(\"94043\")\n .country(\"US\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "addressValidation->validate([\n 'address_line_1' => '1600 Amphitheatre Pkwy',\n 'city' => 'Mountain View',\n 'region' => 'CA',\n 'postal_code' => '94043',\n 'country' => 'US',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.address_validation.validate(\n address_line_1: \"1600 Amphitheatre Pkwy\",\n city: \"Mountain View\",\n region: \"CA\",\n postal_code: \"94043\",\n country: \"US\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.AddressValidation.ValidateAsync(new AddressValidationRequest\n{\n AddressLine1 = \"1600 Amphitheatre Pkwy\",\n City = \"Mountain View\",\n Region = \"CA\",\n PostalCode = \"94043\",\n Country = \"US\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressValidationRequest" }, "examples": { "Structured": { "summary": "Campos estruturados do endereço", "value": { "address_line_1": "1600 Amphitheatre Pkwy", "city": "Mountain View", "region": "CA", "postal_code": "94043", "country": "US" } }, "One line": { "summary": "O endereço completo em uma linha", "value": { "address": "Paseo de la Castellana 259, 28046 Madrid", "country": "ES" } } } } } }, "responses": { "200": { "description": "A validação foi concluída. Leia `address_validation.status`; o HTTP é sempre `200` para uma requisição concluída.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressValidationResponse" }, "examples": { "Verified": { "summary": "Um endereço real, confirmado até o nível do edifício", "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": "Uma rua inventada: apenas a cidade correspondeu", "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": "Não foi possível executar a validação; não cobrado", "value": { "request_id": "3c1b2a0f-9e8d-4c7b-b6a5-1f0e9d8c7b6a", "address_validation": { "status": "unavailable", "verification_level": null, "address": null, "formatted_address": null, "latitude": null, "longitude": null }, "created_at": "2026-10-27T11:22:00.000000+00:00" } } } } } }, "400": { "$ref": "#/components/responses/AddressValidationValidationError" }, "403": { "$ref": "#/components/responses/AddressValidationPermissionDenied" }, "429": { "$ref": "#/components/responses/RateLimitedWrite" } } } }, "/v3/travel-rule/wallet-proofs/": { "get": { "summary": "Listar comprovantes de carteira por captura de tela para revisão", "description": "Sua fila de revisão das provas de propriedade de carteira por captura de tela. Uma captura de tela é a única prova que a Didit não consegue verificar sozinha: depois que o usuário final a envia pelo widget, ela fica PENDING até que você a aprove ou rejeite com POST /v3/travel-rule/wallet-proofs/{proof_uuid}/decision/. As mais antigas aparecem primeiro, para que a fila seja trabalhada a partir da prova que espera há mais tempo. Só aparecem capturas de tela enviadas, nunca uma prova cujo usuário final ainda não enviou um arquivo, e nunca uma de uma carteira que você excluiu do seu catálogo de endereços (a Didit as encerra como OWNERSHIP_CHANGED).", "operationId": "listTravelRuleWalletProofs", "x-didit-sdk": { "resource": "travel_rule.wallet_proofs", "method": "list", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "status", "in": "query", "description": "Quais comprovantes listar. O padrão é PENDING, os que ainda aguardam decisão.", "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": "Comprovações por captura de tela paginadas. count é exato até 100 e limitado a 100 acima disso.", "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": "Status desconhecido." }, "401": { "description": "x-api-key ausente ou inválido." }, "403": { "description": "O chamador não tem a permissão de transações." } } } }, "/v3/travel-rule/wallet-proofs/{proof_uuid}/decision/": { "post": { "summary": "Aprovar ou rejeitar um comprovante de carteira por captura de tela", "description": "Decida sobre uma prova por captura de tela a partir da sua fila de revisão. approve verifica a prova e a entrada do catálogo de endereços e aplica a propriedade à transferência para a qual a sessão do widget foi criada, exatamente como uma assinatura verificada faz. Uma captura de tela nunca confirma uma transferência que outro cliente da Didit enviou pelo trilho INTERNAL: isso exige uma mensagem assinada ou um depósito de teste. reject encerra a prova como REJECTED com failure_reason REVIEW_REJECTED; o usuário final pode iniciar uma nova prova pelo widget. A nota é mantida junto com a 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 da fila de revisão.", "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": "O comprovante decidido.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWalletProofReview" } } } }, "400": { "description": "Decisão inválida ou uma nota com mais de 512 caracteres." }, "401": { "description": "x-api-key ausente ou inválido." }, "403": { "description": "O chamador não tem a permissão de transações." }, "404": { "description": "Não existe nenhum comprovante por captura de tela enviado com este id na sua aplicação." }, "409": { "description": "A comprovação já foi decidida (o corpo traz o status dela), ou código OWNERSHIP_CHANGED: o titular da carteira mudou ou a carteira foi excluída depois que a sessão do widget foi criada; por isso, a comprovação está encerrada e o titular atual precisa de uma nova.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } } } } }, "/v3/travel-rule/widget/{token}/proofs/": { "post": { "summary": "Iniciar uma prova de propriedade de carteira", "description": "Endpoint público identificado pelo token de sessão do widget, sem necessidade de chave de API: o widget hospedado o chama quando o usuário final escolhe um método de prova. Uma prova só passa a existir, e a contar no seu funil de provas, a partir desta chamada. Escolher o mesmo método novamente retorna a prova já aberta (200, mesmo desafio ou mesmo valor de depósito) em vez de iniciar uma segunda; escolher outro método encerra a prova não concluída como METHOD_SWITCHED, exceto uma captura de tela já enviada ou um depósito de teste que ainda está sendo verificado. MESSAGE_SIGNING retorna o desafio a ser assinado; SATOSHI_TEST, o endereço de depósito, o valor exato e a janela; SELF_DECLARATION é verificado imediatamente (status VERIFIED). Formatos de assinatura verificados por família de blockchain: redes EVM aceitam uma assinatura personal_sign (EIP-191), codificada em hex; Bitcoin aceita uma assinatura signmessage BIP-137 (endereços P2PKH, P2SH-P2WPKH e P2WPKH) ou uma assinatura BIP-322 simple (endereços P2WPKH e P2TR), codificada em base64; Solana aceita uma assinatura Ed25519 sobre o desafio, codificada em base58; Tron aceita uma assinatura signMessageV2 (TIP-191), codificada em hex. Uma assinatura BIP-322 full ou proof-of-funds, ou um endereço multisig, falha com 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 sessão opaco retornado quando a sessão do widget foi criada.", "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": "Um novo comprovante PENDING (VERIFIED para SELF_DECLARATION).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofSummary" } } } }, "200": { "description": "A comprovação já aberta para este método, retomada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofSummary" } } } }, "400": { "description": "Corpo inválido, uma carteira que não corresponde à transferência, SCREENSHOT não permitido ou o código CHAIN_UNSUPPORTED quando o método não está disponível na blockchain.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } }, "403": { "description": "SELF_DECLARATION não é permitido para esta aplicação." }, "404": { "description": "Token desconhecido." }, "409": { "description": "código OWNERSHIP_CHANGED: o titular da carteira mudou ou a carteira foi excluída depois que a sessão foi gerada; gere uma nova sessão para o titular atual. Também é retornado para SATOSHI_TEST quando a sessão não tem satoshi_deposit_address, e quando a sessão não tem mais tentativas (sem código; o corpo traz max_attempts, attempts_used e attempts_remaining 0): gere uma nova sessão.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } }, "410": { "description": "A sessão expirou." } } } }, "/v3/travel-rule/widget/{token}/proofs/{proof_id}/verify/": { "post": { "summary": "Enviar evidências de prova de propriedade da carteira", "description": "Endpoint público identificado pelo token de sessão do widget, sem necessidade de chave de API. Envie a evidência que o método da prova exige: signature para MESSAGE_SIGNING, txid para SATOSHI_TEST (JSON) ou um arquivo para SCREENSHOT (multipart). Cada envio conta como uma tentativa. Uma assinatura que não é verificada, ou um depósito que não corresponde, responde 400 com um código e mantém a prova como PENDING para que o usuário final possa tentar novamente. Um depósito detectado, mas ainda não confirmado, responde 200 com status PENDING e é verificado novamente de forma automática até a janela se encerrar. Uma captura de tela responde 200 com status PENDING e aguarda na sua fila de revisão (GET /v3/travel-rule/wallet-proofs/). Uma prova EXPIRED ou REJECTED nunca é verificada depois: inicie uma nova. Formatos de assinatura verificados por família de blockchain: redes EVM aceitam uma assinatura personal_sign (EIP-191), codificada em hex; Bitcoin aceita uma assinatura signmessage BIP-137 (endereços P2PKH, P2SH-P2WPKH e P2WPKH) ou uma assinatura BIP-322 simple (endereços P2WPKH e P2TR), codificada em base64; Solana aceita uma assinatura Ed25519 sobre o desafio, codificada em base58; Tron aceita uma assinatura signMessageV2 (TIP-191), codificada em hex. Uma assinatura BIP-322 full ou proof-of-funds, ou um endereço multisig, falha com 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 sessão opaco retornado quando a sessão do widget foi criada.", "schema": { "type": "string" } }, { "name": "proof_id", "in": "path", "required": true, "description": "proof_id retornado quando a prova foi iniciada.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "signature": { "type": "string", "description": "MESSAGE_SIGNING: a assinatura da carteira sobre o desafio da prova." }, "txid": { "type": "string", "description": "SATOSHI_TEST: o ID da transação do depósito de teste." } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary", "description": "SCREENSHOT: uma imagem mostrando a carteira no aplicativo de carteira do usuário 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 ou ainda PENDING (uma captura de tela aguardando revisão, um depósito ainda não indexado ou ainda não confirmado, com o código DEPOSIT_NOT_FOUND ou DEPOSIT_UNCONFIRMED).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofVerifyResult" } } } }, "400": { "description": "Evidência ausente; uma tentativa com falha que mantém a prova como PENDING para que o usuário final possa tentar novamente (código SIGNATURE_INVALID, SIGNATURE_UNSUPPORTED_SCHEME ou DEPOSIT_LOOKUP_FAILED); ou um depósito de teste que rejeita a prova (código DEPOSIT_MISMATCH, DEPOSIT_STALE ou TXID_REUSED, status REJECTED, com as contagens de tentativas da sessão): escolher um método novamente inicia uma nova prova enquanto attempts_remaining for maior que 0.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } }, "404": { "description": "Token desconhecido, ou essa prova não existe nesta sessão." }, "409": { "description": "código OWNERSHIP_CHANGED (a prova é encerrada com ele); uma prova encerrada (REJECTED ou EXPIRED), com seu status, o código com que foi encerrada e as contagens de tentativas da sessão: escolha um método novamente para iniciar uma nova prova; ou uma prova SELF_DECLARATION, que é verificada ao ser iniciada.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleWidgetProofError" } } } }, "410": { "description": "A sessão expirou, ou o código WINDOW_EXPIRED quando a janela do teste de satoshi foi encerrada.", "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": "Carteiras da Digital Credentials API (Google Wallet): envie o que a carteira retornou para sua página ou app em uma verificação cujo next_action seja request_digital_credential. A Didit o descriptografa, verifica a assinatura do emissor em relação às raízes de emissores confiáveis, cada valor retornado em relação ao seu digest assinado e a assinatura do dispositivo sobre a sua origem e esta requisição, e então decide a verificação: verified (cobrada uma única vez) ou declined com o código de erro. Uso único: um segundo envio retorna a verificação já decidida.", "summary": "Enviar uma resposta de carteira", "parameters": [ { "in": "path", "name": "request_id", "schema": { "type": "string", "format": "uuid" }, "description": "O request_id retornado pelo endpoint de início.", "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": "Credenciais ausentes (x-api-key ou Authorization: Bearer)." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro not_found: nenhuma verificação de carteira desta aplicação tem este request_id." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest" } } }, "description": "Erros de validação de campo ({field: [messages]})." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro not_a_digital_credentials_wallet: esta verificação não aceita uma resposta de carteira." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue verificar a carteira." } }, "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": "Inicie um login com Google Wallet (Google Wallet (ID pass) e emissores estaduais dos EUA (carteira de habilitação móvel); USA, GBR, BRA, SGP, TWN) sem nenhum fluxo. A cobrança é feita uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=request_digital_credential com uma requisição que a Didit assinou para a sua aplicação, utilizável somente a partir de origin. Nessa origem, em um gesto do usuário, passe next_action.digital_credentials.request para navigator.credentials.get({digital: ...}) (ou para o Android Credential Manager como requestJson de GetDigitalCredentialOption) e, em seguida, envie via POST o que a carteira retornar para /v3/id-verification/wallets/verifications/{request_id}/response/. O navegador exibe o próprio QR code quando a carteira está em outro dispositivo. Aplicações de sandbox recebem uma simulação determinística (simulated: true) que nunca entra em contato com o provedor.", "summary": "Iniciar verificação com Google Wallet", "parameters": [ { "in": "header", "name": "Idempotency-Key", "schema": { "type": "string" }, "description": "Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo 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": "Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, origin_invalid, origin_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden" } } }, "description": "Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After)." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationError" } } }, "description": "Erro wallet_not_configured: este ambiente não consegue acessar a carteira." } }, "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": "Enviar documentos KYB para uma sessão", "description": "Envie um ou mais documentos societários (contrato social, livro de registro de acionistas, certidão de constituição, ...) para a etapa KYB Documents de uma sessão de Verificação de empresas, a partir do seu próprio servidor em vez da página hospedada. A Didit executa o mesmo pipeline da página hospedada: compressão, OCR, verificações de adulteração e entre documentos, agrupamento de documentos, e avança a sessão quando os grupos de documentos exigidos são atendidos. A etapa tem uma tarifa fixa única, independentemente de quantos arquivos você enviar. A sessão deve estar aberta e na etapa KYB Documents, e a empresa escolhida na etapa de registro deve existir. Consulte as pessoas mencionadas nos documentos com `GET /v3/session/{sessionId}/kyb/extracted-parties/`. Requer `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 da sessão de Verificação de empresas (KYB). Ela deve pertencer à aplicação da chave de API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nó do fluxo da etapa de KYB. Necessário apenas quando o fluxo tem mais de um nó de KYB; por padrão, a Didit usa o próprio nó da sessão.", "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": "Arquivos a enviar: JPG, JPEG, PNG, TIFF, WEBP, PDF ou arquivos ZIP contendo esses formatos. PDFs de até 50 MB, fotos de até 6 MB antes da compressão." }, "document_passwords": { "type": "array", "items": { "type": "string" }, "description": "Uma entrada por arquivo em `documents`, na mesma ordem: a senha de um PDF protegido, vazia para qualquer outro arquivo." }, "document_group": { "type": "string", "enum": [ "LEGAL_PRESENCE", "COMPANY_DETAILS", "OWNERSHIP_STRUCTURE", "REPRESENTATIVES_AUTHORIZATION" ], "description": "Grupo de documentos obrigatório ao qual este envio responde." }, "locale": { "type": "string", "maxLength": 10, "description": "Localidade usada para traduzir a resposta da próxima etapa." } } } } } }, "responses": { "200": { "description": "Documentos processados. Quando todos os grupos obrigatórios são atendidos, a sessão avança e `next_step` indica a próxima etapa; caso contrário, ela permanece na etapa Documentos e `document_groups` e `document_answer` informam o que ainda falta.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "next_step": { "type": "string", "nullable": true, "description": "Etapa em que a sessão está após o upload." }, "kyb_status": { "type": "string", "description": "Status da verificação da empresa." }, "document_answer": { "type": "object", "additionalProperties": true, "description": "Resultado por documento enviado e os envios restantes." } }, "additionalProperties": true }, "example": { "valid": true, "next_step": "KYB_KEY_PEOPLE", "kyb_status": "In Progress" } } } }, "400": { "description": "Um documento foi rejeitado (adulterado, ilegível ou não suportado) ou a sessão ainda não tem uma empresa de KYB. Tente novamente com outro arquivo enquanto houver tentativas restantes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "example": { "message": "No KYB company found. Submit company data first." } } } }, "402": { "description": "A organização não tem mais crédito para a etapa de documentos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "example": { "detail": "Insufficient credits." } } } }, "401": { "description": "A chave de API com escopo expirou. Este é o único caso que retorna `401`: uma chave ausente, inválida ou revogada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "summary": "A data de validade da chave já passou", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falha de autenticação ou autorização. Uma chave ausente retorna `403`, assim como uma chave de outra aplicação, uma chave com escopo sem a permissão exigida por este endpoint e uma requisição de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada retorna `401`. Diferencie-as pelo `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Missing or invalid credentials": { "summary": "Cabeçalho x-api-key ausente, ou a chave falhou na validação", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Uma chave válida que pertence a uma aplicação diferente da aplicação da sessão", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "Chave com escopo sem decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Requisição de fora da lista de IPs permitidos da chave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "A sessão não existe, foi excluída, pertence a outra aplicação ou está fora dos limites de uma chave com escopo; nenhum detalhe diferencia esses casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "A sessão foi finalizada (`kyb_session_not_writable`) ou não está na etapa KYB Documents (`kyb_step_mismatch`, com `next_step` indicando a etapa em que ela está).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." }, "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": "Limite de requisições excedido: 300 requisições de escrita (POST, PATCH, DELETE) por minuto por chave de API. Aguarde `Retry-After` segundos antes de tentar novamente; os cabeçalhos `X-RateLimit-*` mostram a cota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Rate limited": { "summary": "Orçamento do minuto atual esgotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.upload_kyb_documents(\n \"33333333-4444-5555-6666-777777777777\",\n documents=[open(\"document.pdf\", \"rb\")],\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit, { fileFromPath } from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.uploadKybDocuments(\"33333333-4444-5555-6666-777777777777\", {\n documents: [await fileFromPath(\"document.pdf\")],\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UploadKYBDocuments(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsUploadKYBDocumentsParams{\n\tDocuments: []didit.File{didit.FileFromPath(\"document.pdf\")},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.nio.file.Path;\nimport java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.SessionsUploadKybDocumentsParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().uploadKybDocuments(\"33333333-4444-5555-6666-777777777777\", SessionsUploadKybDocumentsParams.builder()\n .documents(List.of(Path.of(\"document.pdf\")))\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->uploadKybDocuments('33333333-4444-5555-6666-777777777777', [\n 'documents' => [File::fromPath('document.pdf')],\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.upload_kyb_documents(\n \"33333333-4444-5555-6666-777777777777\",\n documents: [Pathname(\"document.pdf\")]\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.UploadKybDocumentsAsync(\"33333333-4444-5555-6666-777777777777\", new SessionsUploadKybDocumentsParams\n{\n Documents = new FileUpload[] { FileUpload.FromPath(\"document.pdf\") },\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/kyb/extracted-parties/": { "get": { "summary": "Listar as partes citadas nos documentos enviados", "description": "Retorna os acionistas e diretores citados nos documentos enviados para esta sessão de KYB, consolidados por pessoa e atribuídos aos documentos que os citaram. Mostre-os ao solicitante para confirmação e, em seguida, declare-os com os endpoints de rascunho de partes. Um intervalo continua sendo um intervalo: `ownership_percent.text` mantém o valor literal, e `min` / `max` os números extraídos dele. Ninguém é classificado como UBO aqui; isso é decidido quando as partes são enviadas, com base nas configurações de função e nos limiares de propriedade do fluxo. A mesma lista está na decisão da sessão como `document_verifications[].extracted_parties`. Requer `read:businesses` ou `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 da sessão de Verificação de empresas (KYB). Ela deve pertencer à aplicação da chave de API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nó do fluxo da etapa de KYB. Necessário apenas quando o fluxo tem mais de um nó de KYB; por padrão, a Didit usa o próprio nó da sessão.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Partes nomeadas pelos documentos atuais.", "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": "O percentual de propriedade exatamente como o documento o informa, como `25-50%`, `>50%` ou `NO EXHIBE`." }, "min": { "type": "number", "nullable": true, "description": "O número menor lido de `text`; null quando o texto não informa nenhum." }, "max": { "type": "number", "nullable": true, "description": "Número superior extraído de `text`; null quando não houver nenhum." } } } } } }, "documents": { "type": "array", "description": "Os documentos enviados que mencionaram esta parte.", "items": { "type": "object", "properties": { "document_uuid": { "type": "string", "format": "uuid" }, "document_type": { "type": "string", "nullable": true }, "document_subtype": { "type": "string", "nullable": true }, "original_filename": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } } } } } }, "description": "Os acionistas e diretores mencionados nos documentos enviados, consolidados por pessoa. Ninguém é classificado como UBO aqui: isso é decidido quando as partes são enviadas." }, "document_count": { "type": "integer", "description": "Número de documentos enviados a partir dos quais a lista foi lida." }, "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": "A chave de API com escopo expirou. Este é o único caso que retorna `401`: uma chave ausente, inválida ou revogada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "summary": "A data de validade da chave já passou", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falha de autenticação ou autorização. Uma chave ausente retorna `403`, assim como uma chave de outra aplicação, uma chave com escopo sem a permissão exigida por este endpoint e uma requisição de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada retorna `401`. Diferencie-as pelo `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Missing or invalid credentials": { "summary": "Cabeçalho x-api-key ausente, ou a chave falhou na validação", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Uma chave válida que pertence a uma aplicação diferente da aplicação da sessão", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "Chave com escopo sem decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Requisição de fora da lista de IPs permitidos da chave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "A sessão não existe, foi excluída, pertence a outra aplicação ou está fora dos limites de uma chave com escopo; nenhum detalhe diferencia esses casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "example": { "detail": "Session not found." } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.list_kyb_extracted_parties(\n \"33333333-4444-5555-6666-777777777777\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.listKybExtractedParties(\"33333333-4444-5555-6666-777777777777\");\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ListKYBExtractedParties(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsListKYBExtractedPartiesParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().listKybExtractedParties(\"33333333-4444-5555-6666-777777777777\");\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->listKybExtractedParties('33333333-4444-5555-6666-777777777777');\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.list_kyb_extracted_parties(\"33333333-4444-5555-6666-777777777777\")\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.ListKybExtractedPartiesAsync(\"33333333-4444-5555-6666-777777777777\");\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/kyb/parties/drafts/": { "get": { "summary": "Listar os rascunhos de partes de KYB", "description": "Lista as partes que você está preparando para esta sessão de KYB, das mais antigas para as mais recentes. Um rascunho não é uma parte declarada: ele não aparece na decisão nem no console e não cria nenhuma sessão de verificação até que você o envie com `POST /v3/session/{sessionId}/kyb/parties/submit/`. Requer `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 da sessão de Verificação de empresas (KYB). Ela deve pertencer à aplicação da chave de API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nó do fluxo da etapa de KYB. Necessário apenas quando o fluxo tem mais de um nó de KYB; por padrão, a Didit usa o próprio nó da sessão.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Os rascunhos armazenados.", "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": "Se a parte é uma pessoa física ou uma empresa." }, "full_name": { "type": "string", "maxLength": 255, "description": "Nome completo de uma pessoa. Envie este campo ou `first_name` e `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": "Função exercida pela parte. Intercambiável com `roles`; quando ambos são enviados, eles são mesclados." }, "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": "Todas as funções que a parte exerce. Uma pessoa precisa de pelo menos uma função (aqui ou em `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Cargo de uma pessoa." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Nome de uma parte do tipo empresa. Obrigatório quando `entity_type` é `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registro de uma parte que é empresa." }, "email": { "type": "string", "format": "email", "description": "Para onde o link de verificação é enviado. Obrigatório quando a parte precisa concluir a verificação, o que depende das configurações de função e dos limiares de propriedade do fluxo de verificação (workflow)." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Participação na empresa detida pela parte." }, "nationality": { "type": "string", "maxLength": 100, "description": "Nacionalidade de uma pessoa ou país de constituição de uma empresa. Obrigatório para todas as partes." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Campos extras definidos pelo fluxo." }, "skip_verification": { "type": "boolean", "default": false, "description": "Solicite que a verificação desta parte seja pulada. Atendido apenas quando a função da parte permite pular a verificação nas configurações de Pessoas-chave do fluxo." } } } } } }, "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": "A chave de API com escopo expirou. Este é o único caso que retorna `401`: uma chave ausente, inválida ou revogada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "summary": "A data de validade da chave já passou", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falha de autenticação ou autorização. Uma chave ausente retorna `403`, assim como uma chave de outra aplicação, uma chave com escopo sem a permissão exigida por este endpoint e uma requisição de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada retorna `401`. Diferencie-as pelo `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Missing or invalid credentials": { "summary": "Cabeçalho x-api-key ausente, ou a chave falhou na validação", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Uma chave válida que pertence a uma aplicação diferente da aplicação da sessão", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "Chave com escopo sem decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Requisição de fora da lista de IPs permitidos da chave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "A sessão não existe, foi excluída, pertence a outra aplicação ou está fora dos limites de uma chave com escopo; nenhum detalhe diferencia esses casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "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": "Criar um rascunho de parte de KYB", "description": "Adiciona uma parte (uma pessoa ou uma empresa) à lista que você está preparando para esta sessão de KYB. Valem os mesmos campos e regras da tela hospedada de Pessoas-chave: uma pessoa precisa de `full_name` ou de `first_name` e `last_name`, de pelo menos uma função e de uma nacionalidade; uma empresa precisa de `company_name` e do país de constituição em `nationality`. Nada é declarado nem cobrado até `POST /v3/session/{sessionId}/kyb/parties/submit/`. Requer `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 da sessão de Verificação de empresas (KYB). Ela deve pertencer à aplicação da chave de API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nó do fluxo da etapa de KYB. Necessário apenas quando o fluxo tem mais de um nó de KYB; por padrão, a Didit usa o próprio nó da sessão.", "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": "Se a parte é uma pessoa física ou uma empresa." }, "full_name": { "type": "string", "maxLength": 255, "description": "Nome completo de uma pessoa. Envie este campo ou `first_name` e `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": "Função exercida pela parte. Intercambiável com `roles`; quando ambos são enviados, eles são mesclados." }, "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": "Todas as funções que a parte exerce. Uma pessoa precisa de pelo menos uma função (aqui ou em `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Cargo de uma pessoa." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Nome de uma parte do tipo empresa. Obrigatório quando `entity_type` é `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registro de uma parte que é empresa." }, "email": { "type": "string", "format": "email", "description": "Para onde o link de verificação é enviado. Obrigatório quando a parte precisa concluir a verificação, o que depende das configurações de função e dos limiares de propriedade do fluxo de verificação (workflow)." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Participação na empresa detida pela parte." }, "nationality": { "type": "string", "maxLength": 100, "description": "Nacionalidade de uma pessoa ou país de constituição de uma empresa. Obrigatório para todas as partes." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Campos extras definidos pelo fluxo." }, "skip_verification": { "type": "boolean", "default": false, "description": "Solicite que a verificação desta parte seja pulada. Atendido apenas quando a função da parte permite pular a verificação nas configurações de Pessoas-chave do fluxo." } } }, "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": "Rascunho criado.", "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": "Se a parte é uma pessoa física ou uma empresa." }, "full_name": { "type": "string", "maxLength": 255, "description": "Nome completo de uma pessoa. Envie este campo ou `first_name` e `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": "Função exercida pela parte. Intercambiável com `roles`; quando ambos são enviados, eles são mesclados." }, "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": "Todas as funções que a parte exerce. Uma pessoa precisa de pelo menos uma função (aqui ou em `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Cargo de uma pessoa." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Nome de uma parte do tipo empresa. Obrigatório quando `entity_type` é `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registro de uma parte que é empresa." }, "email": { "type": "string", "format": "email", "description": "Para onde o link de verificação é enviado. Obrigatório quando a parte precisa concluir a verificação, o que depende das configurações de função e dos limiares de propriedade do fluxo de verificação (workflow)." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Participação na empresa detida pela parte." }, "nationality": { "type": "string", "maxLength": 100, "description": "Nacionalidade de uma pessoa ou país de constituição de uma empresa. Obrigatório para todas as partes." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Campos extras definidos pelo fluxo." }, "skip_verification": { "type": "boolean", "default": false, "description": "Solicite que a verificação desta parte seja pulada. Atendido apenas quando a função da parte permite pular a verificação nas configurações de Pessoas-chave do fluxo." } } } } }, "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": "Um campo da parte é inválido ou um campo obrigatório está ausente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "example": { "non_field_errors": [ "Person parties require at least one role." ] } } } }, "401": { "description": "A chave de API com escopo expirou. Este é o único caso que retorna `401`: uma chave ausente, inválida ou revogada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "summary": "A data de validade da chave já passou", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falha de autenticação ou autorização. Uma chave ausente retorna `403`, assim como uma chave de outra aplicação, uma chave com escopo sem a permissão exigida por este endpoint e uma requisição de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada retorna `401`. Diferencie-as pelo `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Missing or invalid credentials": { "summary": "Cabeçalho x-api-key ausente, ou a chave falhou na validação", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Uma chave válida que pertence a uma aplicação diferente da aplicação da sessão", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "Chave com escopo sem decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Requisição de fora da lista de IPs permitidos da chave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "A sessão não existe, foi excluída, pertence a outra aplicação ou está fora dos limites de uma chave com escopo; nenhum detalhe diferencia esses casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "A sessão foi finalizada (`kyb_session_not_writable`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." }, "code": { "type": "string" } } }, "example": { "detail": "This verification session is no longer accepting changes.", "code": "kyb_session_not_writable" } } } }, "429": { "description": "Limite de requisições excedido: 300 requisições de escrita (POST, PATCH, DELETE) por minuto por chave de API. Aguarde `Retry-After` segundos antes de tentar novamente; os cabeçalhos `X-RateLimit-*` mostram a cota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Rate limited": { "summary": "Orçamento do minuto atual esgotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.create_kyb_party_draft(\n \"33333333-4444-5555-6666-777777777777\",\n entity_type=\"person\",\n first_name=\"Ana\",\n last_name=\"Lopez\",\n roles=[\"ubo\", \"director\"],\n date_of_birth=\"1984-06-12\",\n email=\"ana.lopez@example.com\",\n ownership_percent=60.0,\n nationality=\"MEX\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.createKybPartyDraft(\"33333333-4444-5555-6666-777777777777\", {\n entity_type: \"person\",\n first_name: \"Ana\",\n last_name: \"Lopez\",\n roles: [\"ubo\", \"director\"],\n date_of_birth: \"1984-06-12\",\n email: \"ana.lopez@example.com\",\n ownership_percent: 60.0,\n nationality: \"MEX\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.CreateKYBPartyDraft(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsCreateKYBPartyDraftParams{\n\tEntityType: \"person\",\n\tFirstName: didit.String(\"Ana\"),\n\tLastName: didit.String(\"Lopez\"),\n\tRoles: didit.Some([]didit.SessionsCreateKYBPartyDraftParamsRoles{\"ubo\", \"director\"}),\n\tDateOfBirth: didit.String(\"1984-06-12\"),\n\tEmail: didit.String(\"ana.lopez@example.com\"),\n\tOwnershipPercent: didit.Float(60.0),\n\tNationality: \"MEX\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import java.time.LocalDate;\nimport java.util.List;\nimport me.didit.Didit;\nimport me.didit.types.SessionsCreateKybPartyDraftParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().createKybPartyDraft(\"33333333-4444-5555-6666-777777777777\", SessionsCreateKybPartyDraftParams.builder()\n .entityType(SessionsCreateKybPartyDraftParams.EntityType.of(\"person\"))\n .firstName(\"Ana\")\n .lastName(\"Lopez\")\n .roles(List.of(SessionsCreateKybPartyDraftParams.Roles.of(\"ubo\"), SessionsCreateKybPartyDraftParams.Roles.of(\"director\")))\n .dateOfBirth(LocalDate.parse(\"1984-06-12\"))\n .email(\"ana.lopez@example.com\")\n .ownershipPercent(60.0)\n .nationality(\"MEX\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->createKybPartyDraft('33333333-4444-5555-6666-777777777777', [\n 'entity_type' => 'person',\n 'first_name' => 'Ana',\n 'last_name' => 'Lopez',\n 'roles' => ['ubo', 'director'],\n 'date_of_birth' => '1984-06-12',\n 'email' => 'ana.lopez@example.com',\n 'ownership_percent' => 60.0,\n 'nationality' => 'MEX',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.create_kyb_party_draft(\n \"33333333-4444-5555-6666-777777777777\",\n entity_type: \"person\",\n first_name: \"Ana\",\n last_name: \"Lopez\",\n roles: [\"ubo\", \"director\"],\n date_of_birth: \"1984-06-12\",\n email: \"ana.lopez@example.com\",\n ownership_percent: 60.0,\n nationality: \"MEX\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.CreateKybPartyDraftAsync(\"33333333-4444-5555-6666-777777777777\", new SessionsCreateKybPartyDraftParams\n{\n EntityType = \"person\",\n FirstName = \"Ana\",\n LastName = \"Lopez\",\n Roles = new SessionsCreateKybPartyDraftParamsRoles[] { \"ubo\", \"director\" },\n DateOfBirth = \"1984-06-12\",\n Email = \"ana.lopez@example.com\",\n OwnershipPercent = 60.0,\n Nationality = \"MEX\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/kyb/parties/drafts/{draftId}/": { "patch": { "summary": "Editar o rascunho de uma parte KYB", "description": "Altera campos do rascunho de uma parte. A edição é mesclada ao rascunho armazenado e a parte resultante é validada como um todo, então uma edição que deixaria a parte incompleta é rejeitada. Alterar `first_name` ou `last_name` substitui o nome completo armazenado. Requer `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 da sessão de Verificação de empresas (KYB). Ela deve pertencer à aplicação da chave de API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "draftId", "in": "path", "required": true, "description": "UUID do rascunho da parte (`draft_id` retornado quando ele foi criado).", "schema": { "type": "string", "format": "uuid", "example": "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nó do fluxo da etapa de KYB. Necessário apenas quando o fluxo tem mais de um nó de KYB; por padrão, a Didit usa o próprio nó da sessão.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Qualquer subconjunto dos campos da parte. A edição é mesclada ao rascunho armazenado e a parte resultante é validada como um todo, de modo que um rascunho que podia ser enviado antes de uma edição continua podendo ser enviado depois dela.", "properties": { "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Se a parte é uma pessoa física ou uma empresa." }, "full_name": { "type": "string", "maxLength": 255, "description": "Nome completo de uma pessoa. Envie este campo ou `first_name` e `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": "Função exercida pela parte. Intercambiável com `roles`; quando ambos são enviados, eles são mesclados." }, "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": "Todas as funções que a parte exerce. Uma pessoa precisa de pelo menos uma função (aqui ou em `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Cargo de uma pessoa." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Nome de uma parte do tipo empresa. Obrigatório quando `entity_type` é `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registro de uma parte que é empresa." }, "email": { "type": "string", "format": "email", "description": "Para onde o link de verificação é enviado. Obrigatório quando a parte precisa concluir a verificação, o que depende das configurações de função e dos limiares de propriedade do fluxo de verificação (workflow)." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Participação na empresa detida pela parte." }, "nationality": { "type": "string", "maxLength": 100, "description": "Nacionalidade de uma pessoa ou país de constituição de uma empresa. Obrigatório para todas as partes." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Campos extras definidos pelo fluxo." }, "skip_verification": { "type": "boolean", "default": false, "description": "Solicite que a verificação desta parte seja pulada. Atendido apenas quando a função da parte permite pular a verificação nas configurações de Pessoas-chave do fluxo." } } }, "example": { "ownership_percent": 55 } } } }, "responses": { "200": { "description": "Rascunho atualizado.", "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": "Se a parte é uma pessoa física ou uma empresa." }, "full_name": { "type": "string", "maxLength": 255, "description": "Nome completo de uma pessoa. Envie este campo ou `first_name` e `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": "Função exercida pela parte. Intercambiável com `roles`; quando ambos são enviados, eles são mesclados." }, "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": "Todas as funções que a parte exerce. Uma pessoa precisa de pelo menos uma função (aqui ou em `role`)." }, "position": { "type": "string", "maxLength": 128, "description": "Cargo de uma pessoa." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "company_name": { "type": "string", "maxLength": 255, "description": "Nome de uma parte do tipo empresa. Obrigatório quando `entity_type` é `company`." }, "registration_number": { "type": "string", "maxLength": 100, "description": "Número de registro de uma parte que é empresa." }, "email": { "type": "string", "format": "email", "description": "Para onde o link de verificação é enviado. Obrigatório quando a parte precisa concluir a verificação, o que depende das configurações de função e dos limiares de propriedade do fluxo de verificação (workflow)." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Participação na empresa detida pela parte." }, "nationality": { "type": "string", "maxLength": 100, "description": "Nacionalidade de uma pessoa ou país de constituição de uma empresa. Obrigatório para todas as partes." }, "phone_number": { "type": "string", "maxLength": 32 }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Campos extras definidos pelo fluxo." }, "skip_verification": { "type": "boolean", "default": false, "description": "Solicite que a verificação desta parte seja pulada. Atendido apenas quando a função da parte permite pular a verificação nas configurações de Pessoas-chave do fluxo." } } } } }, "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": "A parte mesclada é inválida.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "example": { "non_field_errors": [ "Person parties require at least one role." ] } } } }, "401": { "description": "A chave de API com escopo expirou. Este é o único caso que retorna `401`: uma chave ausente, inválida ou revogada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "summary": "A data de validade da chave já passou", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falha de autenticação ou autorização. Uma chave ausente retorna `403`, assim como uma chave de outra aplicação, uma chave com escopo sem a permissão exigida por este endpoint e uma requisição de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada retorna `401`. Diferencie-as pelo `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Missing or invalid credentials": { "summary": "Cabeçalho x-api-key ausente, ou a chave falhou na validação", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Uma chave válida que pertence a uma aplicação diferente da aplicação da sessão", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "Chave com escopo sem decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Requisição de fora da lista de IPs permitidos da chave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "A sessão ou o rascunho não existe, ou a sessão está fora da aplicação da chave ou dos limites de uma chave com escopo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "A sessão foi finalizada (`kyb_session_not_writable`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." }, "code": { "type": "string" } } }, "example": { "detail": "This verification session is no longer accepting changes.", "code": "kyb_session_not_writable" } } } }, "429": { "description": "Limite de requisições excedido: 300 requisições de escrita (POST, PATCH, DELETE) por minuto por chave de API. Aguarde `Retry-After` segundos antes de tentar novamente; os cabeçalhos `X-RateLimit-*` mostram a cota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Rate limited": { "summary": "Orçamento do minuto atual esgotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "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": "Excluir um rascunho de parte KYB", "description": "Descarta um rascunho de parte. As partes declaradas não são afetadas. Requer `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 da sessão de Verificação de empresas (KYB). Ela deve pertencer à aplicação da chave de API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "draftId", "in": "path", "required": true, "description": "UUID do rascunho da parte (`draft_id` retornado quando ele foi criado).", "schema": { "type": "string", "format": "uuid", "example": "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nó do fluxo da etapa de KYB. Necessário apenas quando o fluxo tem mais de um nó de KYB; por padrão, a Didit usa o próprio nó da sessão.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Rascunho excluído. Sem corpo." }, "401": { "description": "A chave de API com escopo expirou. Este é o único caso que retorna `401`: uma chave ausente, inválida ou revogada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "summary": "A data de validade da chave já passou", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falha de autenticação ou autorização. Uma chave ausente retorna `403`, assim como uma chave de outra aplicação, uma chave com escopo sem a permissão exigida por este endpoint e uma requisição de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada retorna `401`. Diferencie-as pelo `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Missing or invalid credentials": { "summary": "Cabeçalho x-api-key ausente, ou a chave falhou na validação", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Uma chave válida que pertence a uma aplicação diferente da aplicação da sessão", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "Chave com escopo sem decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Requisição de fora da lista de IPs permitidos da chave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "A sessão ou o rascunho não existe, ou a sessão está fora da aplicação da chave ou dos limites de uma chave com escopo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "A sessão foi finalizada (`kyb_session_not_writable`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." }, "code": { "type": "string" } } }, "example": { "detail": "This verification session is no longer accepting changes.", "code": "kyb_session_not_writable" } } } }, "429": { "description": "Limite de requisições excedido: 300 requisições de escrita (POST, PATCH, DELETE) por minuto por chave de API. Aguarde `Retry-After` segundos antes de tentar novamente; os cabeçalhos `X-RateLimit-*` mostram a cota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Rate limited": { "summary": "Orçamento do minuto atual esgotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nclient.sessions.delete_kyb_party_draft(\n \"33333333-4444-5555-6666-777777777777\",\n \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\",\n)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nawait didit.sessions.deleteKybPartyDraft(\n \"33333333-4444-5555-6666-777777777777\",\n \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\",\n);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nif err := client.Sessions.DeleteKYBPartyDraft(ctx, \"33333333-4444-5555-6666-777777777777\", \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\", didit.SessionsDeleteKYBPartyDraftParams{}); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nclient.sessions().deleteKybPartyDraft(\"33333333-4444-5555-6666-777777777777\", \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\");" }, { "lang": "php", "label": "PHP", "source": "sessions->deleteKybPartyDraft('33333333-4444-5555-6666-777777777777', '5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d');" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.sessions.delete_kyb_party_draft(\n \"33333333-4444-5555-6666-777777777777\",\n \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\"\n)" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait client.Sessions.DeleteKybPartyDraftAsync(\"33333333-4444-5555-6666-777777777777\", \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\");" } ] } }, "/v3/session/{sessionId}/kyb/parties/submit/": { "post": { "summary": "Enviar os rascunhos das partes do KYB", "description": "Declare os rascunhos armazenados como as pessoas-chave da empresa. Esta é a etapa hospedada de Pessoas-chave sob a sua chave de API: a Didit decide, a partir das configurações de função e dos limiares de propriedade do fluxo, quais partes devem ser verificadas, cria uma sessão de KYC individual (ou uma subsessão de KYB para um proprietário pessoa jurídica) para cada uma delas, envia os e-mails que o fluxo solicita e avança a sessão. Cada sessão filha é cobrada como no fluxo hospedado. Os rascunhos são consumidos. Repetir a chamada após um envio bem-sucedido não altera nada e responde `200` com `already_submitted: true` e as partes que já existem. A sessão deve estar na etapa de Pessoas-chave. Envie a cada pessoa o seu `kyc_session_url` ou incorpore-o. Requer `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 da sessão de Verificação de empresas (KYB). Ela deve pertencer à aplicação da chave de API.", "schema": { "type": "string", "format": "uuid", "example": "33333333-4444-5555-6666-777777777777" } }, { "name": "node_id", "in": "query", "required": false, "description": "Nó do fluxo da etapa de KYB. Necessário apenas quando o fluxo tem mais de um nó de KYB; por padrão, a Didit usa o próprio nó da sessão.", "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "locale": { "type": "string", "maxLength": 10, "description": "Localidade usada para traduzir a resposta da etapa para a qual a sessão avança." } } }, "example": { "locale": "es" } } } }, "responses": { "200": { "description": "Partes declaradas (ou já declaradas).", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "next_step": { "type": "string", "nullable": true, "description": "Etapa em que a sessão está." }, "status": { "type": "string", "description": "Status da sessão de empresa." }, "advanced": { "type": "boolean", "description": "`true` quando esta chamada declarou as partes e avançou a sessão." }, "already_submitted": { "type": "boolean", "description": "`true` quando as partes já haviam sido declaradas por uma chamada 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": "A organização não tem mais crédito para as sessões de verificação filhas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "example": { "detail": "Insufficient credits." } } } }, "401": { "description": "A chave de API com escopo expirou. Este é o único caso que retorna `401`: uma chave ausente, inválida ou revogada retorna `403`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Expired key": { "summary": "A data de validade da chave já passou", "value": { "detail": "This API key has expired." } } } } } }, "403": { "description": "Falha de autenticação ou autorização. Uma chave ausente retorna `403`, assim como uma chave de outra aplicação, uma chave com escopo sem a permissão exigida por este endpoint e uma requisição de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada retorna `401`. Diferencie-as pelo `detail`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Missing or invalid credentials": { "summary": "Cabeçalho x-api-key ausente, ou a chave falhou na validação", "value": { "detail": "Authentication credentials were not provided or are invalid." } }, "Other application": { "summary": "Uma chave válida que pertence a uma aplicação diferente da aplicação da sessão", "value": { "detail": "You do not have permission to perform this action." } }, "Scoped key without decisions write": { "summary": "Chave com escopo sem decisions: write", "value": { "detail": "This API key has no write access to decisions." } }, "IP not allowed": { "summary": "Requisição de fora da lista de IPs permitidos da chave", "value": { "detail": "This API key can't be used from this IP address." } } } } } }, "404": { "description": "A sessão não existe, foi excluída, pertence a outra aplicação ou está fora dos limites de uma chave com escopo; nenhum detalhe diferencia esses casos.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "example": { "detail": "Session not found." } } } }, "409": { "description": "`kyb_no_party_drafts`: não há nada para enviar. `kyb_parties_already_submitted`: rascunhos foram adicionados depois que as partes foram declaradas. `kyb_step_mismatch`: a sessão não está na etapa de pessoas-chave (`next_step` indica a etapa em que ela está). `kyb_session_not_writable`: a sessão foi finalizada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." }, "code": { "type": "string" }, "next_step": { "type": "string" } } }, "example": { "detail": "There are no draft parties to submit.", "code": "kyb_no_party_drafts" } } } }, "429": { "description": "Limite de requisições excedido: 300 requisições de escrita (POST, PATCH, DELETE) por minuto por chave de API. Aguarde `Retry-After` segundos antes de tentar novamente; os cabeçalhos `X-RateLimit-*` mostram a cota.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem de erro legível." } } }, "examples": { "Rate limited": { "summary": "Orçamento do minuto atual esgotado", "value": { "detail": "Write request rate limit exceeded. You can make up to 300 requests per minute." } } } } }, "headers": { "Retry-After": { "description": "Segundos de espera antes de tentar novamente.", "schema": { "type": "integer", "minimum": 1, "example": 30 } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.sessions.submit_kyb_parties(\n \"33333333-4444-5555-6666-777777777777\",\n locale=\"es\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.sessions.submitKybParties(\"33333333-4444-5555-6666-777777777777\", {\n locale: \"es\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.SubmitKYBParties(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsSubmitKYBPartiesParams{\n\tLocale: didit.String(\"es\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.SessionsSubmitKybPartiesParams;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.sessions().submitKybParties(\"33333333-4444-5555-6666-777777777777\", SessionsSubmitKybPartiesParams.builder()\n .locale(\"es\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "sessions->submitKybParties('33333333-4444-5555-6666-777777777777', [\n 'locale' => 'es',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.sessions.submit_kyb_parties(\n \"33333333-4444-5555-6666-777777777777\",\n locale: \"es\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.Sessions.SubmitKybPartiesAsync(\"33333333-4444-5555-6666-777777777777\", new SessionsSubmitKybPartiesParams\n{\n Locale = \"es\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } }, "/v3/session/{sessionId}/files-export/": { "post": { "summary": "Exportar todos os arquivos de uma sessão", "description": "Inicie a preparação de um único ZIP com todas as imagens, vídeos e documentos de uma sessão de Verificação de usuários (KYC) ou Verificação de empresas (KYB), em qualidade original: os arquivos são armazenados no ZIP exatamente como foram capturados, nunca recomprimidos. Responde `202` com a exportação; consulte-a com `GET /v3/session/{sessionId}/files-export/{exportId}/` até que `status` seja `READY` e, então, baixe `download_url`. Enquanto uma exportação da mesma sessão ainda estiver sendo preparada, essa exportação é retornada em vez de uma nova.\n\nO ZIP é excluído 24 horas depois de ficar pronto, e imediatamente quando a sessão é excluída. Uma sessão excluída não pode ser exportada. Toda exportação e todo link de download fornecido são gravados no registro de auditoria da sessão. Uma chave de API com escopo precisa de `media: read` e `decisions: read`; um usuário do console precisa do privilégio de leitura de sessões.", "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 da sessão de verificação (o `session_id` retornado por `POST /v3/session/`). Aceita IDs de sessão tanto de Verificação de usuários (KYC) quanto de Verificação de empresas (KYB). Uma sessão excluída 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": "A exportação, em preparação.", "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": "Obter uma exportação de arquivos da sessão", "description": "Progresso de uma exportação iniciada com `POST /v3/session/{sessionId}/files-export/`. Quando `status` for `READY`, `download_url` é uma URL assinada do ZIP que permanece válida por pouco tempo; até `expires_at`, leia a exportação novamente para obter uma nova. Cada leitura que entrega um link de download é gravada no registro de auditoria da sessão. A exportação de uma sessão excluída 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 da sessão de verificação (o `session_id` retornado por `POST /v3/session/`). Aceita IDs de sessão tanto de Verificação de usuários (KYC) quanto de Verificação de empresas (KYB). Uma sessão excluída retorna `404`.", "schema": { "type": "string", "format": "uuid", "example": "11111111-2222-3333-4444-555555555555" } }, { "name": "exportId", "in": "path", "required": true, "description": "O `export_id` retornado por `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": "A exportação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionFilesExport" }, "example": { "export_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "session_id": "11111111-2222-3333-4444-555555555555", "status": "READY", "file_count": 9, "size_bytes": 18734120, "download_url": "https://storage.example.com/session/11111111-2222-3333-4444-555555555555/files-export/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/session-42-files.zip?X-Amz-Signature=...", "expires_at": "2026-10-30T12:00:41Z", "error": null, "created_at": "2026-10-29T12:00:03Z", "completed_at": "2026-10-29T12:00:41Z" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v3/travel-rule/unmatched/": { "get": { "summary": "Listar depósitos da Travel Rule sem correspondência", "description": "Depósitos recebidos que ainda aguardam os dados de Travel Rule do VASP de origem: a transferência deles está em `AWAITING_COUNTERPARTY`, `NOT_ENOUGH_COUNTERPARTY_DATA` ou `COUNTERPARTY_VASP_NOT_FOUND`, nenhuma mensagem recebida foi pareada com eles e ninguém os associou manualmente. As linhas e os filtros são os mesmos de `GET /v3/travel-rule/transfers/`, do mais recente para o mais antigo, paginados com `limit` (padrão 50) e `offset`. Pareie um depósito com a mensagem enviada pelo VASP de origem usando `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 ou ambos separados por vírgula. Diferencia maiúsculas de minúsculas." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Um ou mais status de transferência, separados por vírgula." }, { "name": "rail", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Um ou mais entre INTERNAL, TRP, GTR, TRUST, VERIFYVASP, SYGNA, EMAIL, TEST_VASP, separados por vírgula." }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string" }, "description": "withdrawal, deposit ou message, separados por vírgula." }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" }, "description": "A moeda da transação, sem distinção entre maiúsculas e minúsculas." }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Transferências criadas neste dia (UTC) ou depois dele, YYYY-MM-DD." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Transferências criadas neste dia (UTC) ou antes dele, YYYY-MM-DD." }, { "name": "counterparty", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "O `id` de uma entrada do diretório ou de um membro da rede Didit retornado por GET /v3/travel-rule/vasps/: suas transferências com essa contraparte. Um valor que não seja um id válido retorna 400." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000000 }, "description": "Tamanho da página, padrão 50." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000000 }, "description": "Linhas a ignorar." } ], "responses": { "200": { "description": "Uma página de depósitos sem correspondência.", "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": "Um valor de filtro não é válido.", "content": { "application/json": { "example": { "start_date": [ "Use the YYYY-MM-DD format." ] } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nfor item in client.travel_rule.unmatched_deposits.list():\n print(item)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nfor await (const item of didit.travelRule.unmatchedDeposits.list()) {\n console.log(item);\n}" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.TravelRule.UnmatchedDeposits.ListAutoPaging(ctx, didit.TravelRuleUnmatchedDepositsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nfor (var item : client.travelRule().unmatchedDeposits().list()) {\n System.out.println(item);\n}" }, { "lang": "php", "label": "PHP", "source": "travelRule->unmatchedDeposits->list() as $item) {\n print_r($item->toArray());\n}" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\ndidit.travel_rule.unmatched_deposits.list.auto_paging_each do |item|\n puts item.to_h\nend" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nawait foreach (var item in await client.TravelRule.UnmatchedDeposits.ListAsync())\n{\n Console.WriteLine(JsonSerializer.Serialize(item));\n}" } ] } }, "/v3/travel-rule/unmatched/{transaction_uuid}/match/": { "post": { "summary": "Associar um depósito da Travel Rule a uma mensagem recebida", "operationId": "matchUnmatchedTravelRuleDeposit", "x-didit-sdk": { "resource": "travel_rule.unmatched_deposits", "method": "match", "auth": "api_key", "server": true }, "tags": [ "Travel Rule" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Associe um depósito de entrada que ainda aguarda os dados do remetente à mensagem de Travel Rule que o VASP de origem enviou para ele. O depósito recebe os dados do remetente, o VASP contraparte e o canal da mensagem, e ambas as transferências registram a correspondência em suas linhas do tempo. `transaction_uuid` é o `transaction_id` do depósito obtido em `GET /v3/travel-rule/unmatched/`. `transaction_id` no corpo é o `transaction_id` da mensagem recebida, obtido em uma linha de `GET /v3/travel-rule/transfers/?kind=message`; o `id` da própria transferência não é encontrado. A mensagem deve ser do mesmo ativo que o depósito. Um depósito ou uma mensagem excluídos pelo Console respondem `404`; um que já tenha avançado (correspondido ou que não esteja mais aguardando) responde `409`.", "parameters": [ { "name": "transaction_uuid", "in": "path", "required": true, "description": "O `transaction_id` do depósito sem correspondência.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelRuleManualMatchRequest" }, "example": { "transaction_id": "e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24" } } } }, "responses": { "200": { "description": "Ambas as transferências após a correspondê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": "Erro de validação: `transaction_id` está ausente, é o próprio depósito, não é uma mensagem de Travel Rule recebida ou se refere a um ativo diferente do depósito; ou a transação no caminho não é um depósito de entrada.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Error": { "value": { "transaction_id": [ "The travel rule message is for a different asset than the deposit." ] } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "description": "Depósito ou mensagem desconhecidos, ou um deles foi excluído.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "example": { "detail": "No TravelRuleTransfer matches the given query." } } } }, "409": { "description": "O depósito não está mais aguardando dados do remetente, ou a mensagem já foi associada a um depósito.", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } }, "examples": { "Error": { "value": { "detail": "This deposit is no longer waiting for originator data." } } } } } } }, "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "from didit import Didit\n\n# Reads DIDIT_API_KEY.\nclient = Didit()\n\nresult = client.travel_rule.unmatched_deposits.match(\n \"11111111-2222-3333-4444-555555555555\",\n transaction_id=\"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\",\n)\nprint(result)" }, { "lang": "javascript", "label": "Node.js", "source": "import Didit from \"@didit-protocol/sdk-node\";\n\n// Reads DIDIT_API_KEY.\nconst didit = new Didit();\n\nconst result = await didit.travelRule.unmatchedDeposits.match(\"11111111-2222-3333-4444-555555555555\", {\n transaction_id: \"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\",\n});\nconsole.log(result);" }, { "lang": "go", "label": "Go", "source": "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.UnmatchedDeposits.Match(ctx, \"11111111-2222-3333-4444-555555555555\", didit.TravelRuleManualMatchRequest{\n\tTransactionID: \"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" }, { "lang": "java", "label": "Java", "source": "import me.didit.Didit;\nimport me.didit.types.TravelRuleManualMatchRequest;\n\n// Reads DIDIT_API_KEY.\nDidit client = new Didit();\n\nvar result = client.travelRule().unmatchedDeposits().match(\"11111111-2222-3333-4444-555555555555\", TravelRuleManualMatchRequest.builder()\n .transactionId(\"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\")\n .build());\nSystem.out.println(result);" }, { "lang": "php", "label": "PHP", "source": "travelRule->unmatchedDeposits->match('11111111-2222-3333-4444-555555555555', [\n 'transaction_id' => 'e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24',\n]);\nprint_r($result->toArray());" }, { "lang": "ruby", "label": "Ruby", "source": "require \"didit\"\n\n# Reads DIDIT_API_KEY.\ndidit = Didit::Client.new\n\nresult = didit.travel_rule.unmatched_deposits.match(\n \"11111111-2222-3333-4444-555555555555\",\n transaction_id: \"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\"\n)\nputs result.to_h" }, { "lang": "csharp", "label": ".NET", "source": "using System;\nusing System.Text.Json;\nusing Didit;\n\n// Reads DIDIT_API_KEY.\nusing var client = new DiditClient();\n\nvar result = await client.TravelRule.UnmatchedDeposits.MatchAsync(\"11111111-2222-3333-4444-555555555555\", new TravelRuleManualMatchRequest\n{\n TransactionId = \"e90a4d7b-1c2f-4b83-a6d5-8f0e3c1b7a24\",\n});\nConsole.WriteLine(JsonSerializer.Serialize(result));" } ] } } }, "components": { "schemas": { "DocumentAIDetectedCode": { "type": "object", "required": [ "type", "page_number", "position", "x", "y", "width", "height", "page_width", "page_height", "raw_payload", "parsed_payload" ], "properties": { "type": { "type": "string", "description": "Simbologia detectada, por exemplo `QR_CODE`, `CODE_128`, `EAN_13`, `DATA_MATRIX` ou `PDF_417`." }, "page_number": { "type": "integer", "minimum": 1, "description": "Número da página, começando em 1." }, "position": { "type": "array", "nullable": true, "description": "Polígono detectado em coordenadas de pixels da página renderizada. É `null` quando não há uma localização confiável disponível.", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "integer" } } }, "x": { "type": "integer", "nullable": true, "description": "Borda esquerda da caixa delimitadora, em pixels da página renderizada." }, "y": { "type": "integer", "nullable": true, "description": "Borda superior da caixa delimitadora, em pixels da página renderizada." }, "width": { "type": "integer", "nullable": true, "description": "Largura da caixa delimitadora em pixels da página renderizada." }, "height": { "type": "integer", "nullable": true, "description": "Altura da caixa delimitadora em pixels da página renderizada." }, "page_width": { "type": "integer", "description": "Largura da página renderizada, em pixels." }, "page_height": { "type": "integer", "description": "Altura da página renderizada, em pixels." }, "raw_payload": { "type": "string", "description": "Payload bruto do decodificador como string base64, quando disponível; caso contrário, uma string vazia." }, "parsed_payload": { "nullable": true, "description": "String decodificada ou valor estruturado. `null` quando o código foi localizado, mas não pôde ser decodificado." } } }, "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 da tarefa de importação. Use este valor para consultar o progresso e obter os erros das linhas." }, "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": "O estado da tarefa conforme exibido no console; `errors` é uma tarefa concluída com linhas rejeitadas." }, "source": { "type": "string", "enum": [ "file", "api", "provider" ] }, "provider": { "type": "string", "description": "Origem da migração; vazio para importação por arquivo ou API." }, "provider_options": { "type": "object" }, "credential_hint": { "type": "string", "description": "Os primeiros caracteres da chave que a migração guarda. A chave em si nunca é retornada." }, "credentials_expires_at": { "type": "string", "format": "date-time", "nullable": true }, "resumes_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando um job pausado pelo limite de requisições do provedor é retomado automaticamente." }, "status_mapping": { "type": "object", "additionalProperties": { "type": "string" } }, "is_dry_run": { "type": "boolean" }, "dry_run_summary": { "type": "object", "description": "O que uma simulação (dry run) encontrou: `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": "Corpo de atualização parcial da identidade visual. Informe apenas os campos que deseja alterar. As cores hexadecimais aceitam `#RRGGBB` ou `#RRGGBBAA`. Domínio personalizado e e-mail de marca própria não são aceitos aqui.", "properties": { "color_primary": { "type": "string", "description": "Cor dos cabeçalhos / do texto principal." }, "color_secondary": { "type": "string", "description": "Cor do texto de parágrafo / secundário." }, "color_background": { "type": "string", "description": "Cor de fundo da página." }, "color_panel": { "type": "string", "description": "Cor do painel / de destaque." }, "color_panel_10": { "type": "string", "description": "Cor do painel com 10% de opacidade." }, "color_on_panel_1": { "type": "string", "description": "Cor do texto de apoio nos painéis." }, "color_on_panel_2": { "type": "string", "description": "Cor da pílula / badge nos painéis." }, "color_on_background": { "type": "string", "description": "Cor do texto sobre o fundo." }, "color_button_1": { "type": "string", "description": "Cor do botão principal." }, "color_button_2": { "type": "string", "description": "Cor do botão secundário." }, "color_button_text_1": { "type": "string", "description": "Cor do texto do botão principal." }, "color_button_text_2": { "type": "string", "description": "Cor do texto do botão secundário." }, "color_pill_text": { "type": "string", "description": "Cor do texto de pills, campos de entrada e seletores." }, "border_radius_panel": { "type": "integer", "minimum": 0, "description": "Raio dos cantos do painel, em pixels." }, "border_radius_buttons": { "type": "integer", "minimum": 0, "description": "Raio dos cantos do botão em pixels." }, "font_family": { "type": "string", "description": "Nome da família de fontes do Google Fonts (por exemplo, `Inter`, `AR One Sans`)." }, "font_weight": { "type": "string", "description": "Peso da fonte disponível para a família selecionada (por exemplo, `regular`, `500`, `700`)." }, "app_public_name": { "type": "string", "nullable": true, "description": "Nome público exibido no fluxo de verificação." }, "privacy_policy_url": { "type": "string", "nullable": true, "description": "URL da política de privacidade exibida ao usuário final." }, "skip_welcome_screen": { "type": "boolean", "description": "Pular a tela de boas-vindas inicial." }, "disable_login_with_didit": { "type": "boolean", "description": "Continuar como convidado em vez de mostrar a tela de login com a Didit. Não pode voltar a ser `false` enquanto houver um domínio personalizado configurado (400)." }, "hide_progress_bar": { "type": "boolean", "description": "Oculta a barra de progresso durante o fluxo." }, "callback_seconds": { "type": "integer", "minimum": 0, "description": "Atraso (em segundos) antes do redirecionamento para a URL de retorno." }, "delete_logo_square": { "type": "boolean", "description": "Quando `true`, remove o logotipo quadrado atual." }, "delete_logo_rectangular": { "type": "boolean", "description": "Quando `true`, remove o logotipo retangular atual." }, "delete_logo_rectangular_dark": { "type": "boolean", "description": "Quando `true`, remove o logotipo atual do modo escuro, e `logo_rectangular_dark` passa a retornar `null`. Se a mesma requisição multipart também enviar `image_rectangular_dark`, o envio prevalece." }, "delete_favicon": { "type": "boolean", "description": "Quando `true`, remove o favicon atual." } } }, "BrandingCustomization": { "type": "object", "description": "Identidade visual de marca própria de uma aplicação: cores, fontes, raios, URLs de logotipo e opções de UI/UX. As URLs de logotipo são somente leitura (defina-as enviando imagens). Domínio personalizado e e-mail de marca própria não estão incluídos.", "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": "Somente leitura. URL resolvida da folha de estilo do Google Fonts para a família selecionada." }, "logo_square": { "type": "string", "nullable": true, "description": "URL somente leitura do logotipo quadrado. Envie via `image_square`." }, "logo_rectangular": { "type": "string", "nullable": true, "description": "URL somente leitura do logotipo retangular. Envie via `image_rectangular`." }, "logo_rectangular_dark": { "type": "string", "format": "uri", "nullable": true, "description": "Somente leitura. URL assinada temporária do logotipo retangular para o modo escuro, exibido sobre fundo escuro. `null` quando nenhum logotipo escuro está definido ou quando logotipos retangulares não são exibidos para a sua conta. Envie-o com `image_rectangular_dark`." }, "favicon": { "type": "string", "nullable": true, "description": "URL somente leitura do favicon. Envie via `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": "Nome de evento de webhook compatível. Use exatamente estas strings em `subscribed_events`; valores não compatíveis são rejeitados.", "enum": [ "status.updated", "data.updated", "user.status.updated", "user.data.updated", "business.status.updated", "business.data.updated", "activity.created", "transaction.created", "transaction.status.updated", "travel_rule.status.updated", "workflow.compliance_changed", "transaction_rule_suggestions.created", "auth.signup", "auth.login", "auth.login_failed", "auth.password_reset_requested", "auth.password_reset_completed", "auth.mfa_changed", "auth.new_device", "auth.account_locked", "investigator.report.ready", "investigator.decision.automated", "investigator.decision.overridden", "investigator.decision.contested", "investigator.question.raised", "investigator.automation.paused", "investigator.rfi.answered", "investigator.rfi.overdue", "investigator.drift.detected", "investigator.sla.breached", "investigator.qa.failed", "investigator.external.report.ready" ] }, "WebhookSubscribedEvents": { "type": "array", "description": "Filtro de eventos deste destino do webhook. A Didit entrega apenas webhooks cujo tipo de evento corresponde exatamente a um destes valores; não existe assinatura curinga. Quando enviada, a lista deve conter pelo menos um evento válido (um `[]` explícito é rejeitado com 400); um destino cuja lista está vazia (campo omitido na criação) não recebe nada. Na atualização, a lista é substituída por inteiro, nunca mesclada.", "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 da sessão da verificação. Um envio `Retry` retorna o mesmo `request_id` do envio original. Este ID aparece no Business Console, é retornado novamente por um `POST /v3/phone/check/` finalizado e pode ser passado para `GET /v3/session/{sessionId}/decision/`." }, "status": { "type": "string", "enum": [ "Success", "Retry", "Blocked" ], "description": "`Success`: OTP enviado para uma nova verificação. `Retry`: OTP reenviado para a verificação pendente criada por um envio anterior. `Blocked`: a camada antifraude recusou o envio; a verificação é finalizada imediatamente como `Declined` e nada é cobrado." }, "reason": { "type": "string", "nullable": true, "description": "Motivo pelo qual um envio ficou `Blocked` (por exemplo, `repeated_attempts`, `suspicious`, `spam`). `null` em `Success` e `Retry`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco do `vendor_data` armazenado na sessão (do primeiro envio)." }, "metadata": { "type": "object", "nullable": true, "description": "Eco do `metadata` armazenado na sessão (do primeiro envio)." } } }, "PhoneVerificationCheckResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Em `Approved`/`Declined`: o ID da sessão da verificação correspondente, idêntico ao `request_id` retornado por `POST /v3/phone/send/`. Em `Failed` e `Expired or Not Found`: um UUID aleatório de uso único que não pode ser consultado depois." }, "status": { "type": "string", "enum": [ "Approved", "Declined", "Failed", "Expired or Not Found" ], "description": "`Approved`: código correto, sem risco que cause recusa. `Declined`: terminal; um risco que causa recusa foi identificado ou o limite de tentativas (3) foi esgotado. `Failed`: código errado, ainda restam tentativas. `Expired or Not Found`: não há verificação pendente para este número nos últimos 5 minutos." }, "message": { "type": "string", "description": "Explicação legível do resultado, incluindo o número de tentativas restantes após um código incorreto." }, "phone": { "type": "object", "nullable": true, "description": "Relatório completo do telefone. Presente (não nulo) somente em resultados finalizados (`Approved`/`Declined`); `null` em `Failed` e ausente em `Expired or Not Found`.", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Not Finished", "Expired" ], "description": "Status final da verificação de telefone. Corresponde ao `status` de nível superior nas verificações finalizadas." }, "phone_number_prefix": { "type": "string", "description": "Código de discagem do país com `+` no início (por exemplo, `+1`).", "example": "+1" }, "phone_number": { "type": "string", "description": "Número nacional sem o código de discagem do país.", "example": "4155552671" }, "full_number": { "type": "string", "description": "Número completo no formato E.164.", "example": "+14155552671" }, "country_code": { "type": "string", "nullable": true, "description": "País do número, no formato ISO 3166-1 alpha-2.", "example": "US" }, "country_name": { "type": "string", "description": "Nome completo do país derivado de `country_code`.", "example": "United States" }, "carrier": { "type": "object", "description": "Rede que atende o número atualmente, obtida pela consulta à operadora executada na finalização.", "properties": { "name": { "type": "string", "description": "Nome da operadora. String vazia quando a consulta não conseguiu identificá-la." }, "type": { "type": "string", "description": "Tipo de linha informado pela consulta: `mobile`, `fixed_line`, `voip`, `isp`, `vpn`, `toll_free`, `premium_rate`, `pager`, `payphone`, `satellite`, `service`, `shared_cost`, `short_codes_commercial`, `calling_cards`, `local_rate`, `universal_access`, `voice_mail`, `other` ou `unknown`." } } }, "is_disposable": { "type": "boolean", "description": "`true` quando o número pertence a um serviço de números temporários/descartáveis." }, "is_virtual": { "type": "boolean", "description": "`true` quando o tipo de linha é virtual (`voip`, `isp` ou `vpn`)." }, "verification_method": { "type": "string", "description": "Canal que efetivamente entregou o OTP, depois que a entrega é confirmada (por exemplo, `whatsapp`, `sms`); até lá, o canal solicitado." }, "verification_attempts": { "type": "integer", "description": "Número de envios de OTP para esta verificação (1, ou 2 após uma nova tentativa)." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o código correto foi inserido. `null` se a verificação nunca foi aprovada." }, "warnings": { "type": "array", "description": "Avisos de risco registrados durante a verificação (duplicado, descartável, VoIP, tentativas excedidas, lista de bloqueio etc.). Array vazio quando não há nenhum.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Recurso que gerou o aviso. Sempre `PHONE` aqui." }, "risk": { "type": "string", "description": "Código de risco legível por máquina." }, "additional_data": { "type": "object", "nullable": true, "description": "Contexto específico do risco (por exemplo, o ID da sessão duplicada para riscos de duplicidade). `null` quando o risco não traz dados adicionais." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Severidade. Riscos `error` recusam a verificação, `warning` a sinaliza para revisão e `information` é registrado sem afetar o status." }, "short_description": { "type": "string", "description": "Resumo legível do risco em uma linha." }, "long_description": { "type": "string", "description": "Explicação legível do risco." } } } }, "lifecycle": { "type": "array", "description": "Trilha de auditoria cronológica da verificação. O `type` do evento é um destes: `PHONE_VERIFICATION_MESSAGE_SENT`, `PHONE_VERIFICATION_RETRY_MESSAGE_SENT`, `PHONE_VERIFICATION_BLOCKED`, `PHONE_DELIVERY_DELIVERED`, `PHONE_DELIVERY_UNDELIVERABLE`, `VALID_CODE_ENTERED`, `INVALID_CODE_ENTERED`, `PHONE_VERIFICATION_APPROVED`, `PHONE_VERIFICATION_DECLINED`, `PHONE_VERIFICATION_IN_REVIEW`, `PHONE_VERIFICATION_EXPIRED`.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Tipo de evento." }, "timestamp": { "type": "string", "format": "date-time", "description": "Quando o evento ocorreu." }, "details": { "type": "object", "nullable": true, "description": "Payload específico do evento. Eventos de envio: `{status, reason, channel, actual_channel}` (`actual_channel` é preenchido quando a entrega é confirmada). Eventos de entrega: `{channel, status}`. Eventos de inserção de código: `{code_tried, status}`. Eventos de status final: `null`, ou `{reason}` quando recusado ou em revisão." }, "fee": { "type": "number", "description": "Valor em USD cobrado por este evento. Diferente de zero apenas em eventos de envio (o preço da entrega); 0 para inserções de código, confirmações de entrega e eventos de status." } } } }, "matches": { "type": "array", "description": "Outras sessões da sua aplicação (KYC, KYB ou API) em que o mesmo número de telefone foi usado por um usuário diferente (`vendor_data` diferente). Até 5 entradas, com uma correspondência sintética de entrada da lista de bloqueio em primeiro lugar quando houver (as correspondências derivadas de sessões mantêm a ordem da consulta). Array vazio quando não há correspondências.", "items": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID da sessão da outra verificação que usou este número de telefone." }, "session_number": { "type": "integer", "description": "Número sequencial de fácil leitura dessa sessão." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` dessa sessão." }, "verification_date": { "type": "string", "description": "Quando essa sessão foi criada (`YYYY-MM-DDTHH:MM:SSZ`)." }, "phone_number": { "type": "string", "description": "O número de telefone correspondente." }, "status": { "type": "string", "description": "Status dessa sessão (por exemplo, `Approved`, `Declined`, `In Progress`)." }, "is_blocklisted": { "type": "boolean", "description": "Se o número de telefone está na lista de bloqueio da sua aplicação." }, "api_service": { "type": "string", "nullable": true, "description": "Para sessões do tipo API, a API independente que a criou (por exemplo, `PHONE_VERIFICATION`); `null` para sessões de verificação comuns." }, "source": { "type": "string", "description": "Onde a correspondência foi encontrada. Normalmente `session`; uma ocorrência na lista de bloqueio por meio de uma entrada de lista da organização adiciona no início uma correspondência sintética com `source: \"list_entry\"` e `session_id`/`session_number` nulos." } } } }, "phone_social": { "$ref": "#/components/schemas/PhoneSocialFootprint" }, "phone_intelligence": { "allOf": [ { "$ref": "#/components/schemas/PhoneIntelligence" } ], "description": "Sinais de inteligência de telefone. Presente apenas quando `enable_enrichment` era `true` na verificação." } } }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` da sessão da verificação correspondente. `null` em `Expired or Not Found`." }, "metadata": { "type": "object", "nullable": true, "description": "`metadata` da sessão da verificação correspondente. `null` em `Expired or Not Found`." }, "created_at": { "type": "string", "format": "date-time", "description": "Data e hora desta resposta de verificação." } } }, "EmailVerificationSendResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "ID da sessão da verificação. Um envio `Retry` retorna o mesmo `request_id` do envio original. Este ID aparece no Business Console, é retornado novamente por um `POST /v3/email/check/` finalizado e pode ser passado para `GET /v3/session/{sessionId}/decision/`." }, "status": { "type": "string", "enum": [ "Success", "Retry", "Undeliverable" ], "description": "`Success`: OTP enviado por e-mail para uma nova verificação (cobrado). `Retry`: novo OTP enviado por e-mail para a verificação pendente criada por um envio anterior (gratuito). `Undeliverable`: o endereço não passou na validação de entregabilidade ou não foi possível enviar a mensagem; a verificação é finalizada imediatamente como `Declined` e nada é cobrado." }, "reason": { "type": "string", "nullable": true, "enum": [ "email_can_not_be_delivered", null ], "description": "`email_can_not_be_delivered` quando `status` é `Undeliverable`; `null` nos demais casos." }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco do `vendor_data` armazenado na sessão (do primeiro envio)." }, "metadata": { "type": "object", "nullable": true, "description": "Eco do `metadata` armazenado na sessão (do primeiro envio)." } } }, "EmailVerificationCheckResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Em `Approved`/`Declined`: o ID da sessão da verificação correspondente, idêntico ao `request_id` retornado por `POST /v3/email/send/`. Em `Failed` e `Expired or Not Found`: um UUID aleatório de uso único que não pode ser consultado depois." }, "status": { "type": "string", "enum": [ "Approved", "Declined", "Failed", "Expired or Not Found" ], "description": "`Approved`: código correto, sem risco que cause recusa. `Declined`: terminal; um risco que causa recusa foi identificado ou o limite de tentativas (3) foi esgotado. `Failed`: código errado, ainda restam tentativas. `Expired or Not Found`: não há verificação pendente para este endereço nos últimos 5 minutos." }, "message": { "type": "string", "description": "Explicação legível do resultado, incluindo o número de tentativas restantes após um código incorreto." }, "email": { "type": "object", "nullable": true, "description": "Relatório completo de e-mail. Presente (não nulo) somente em resultados finalizados (`Approved`/`Declined`); `null` em `Failed` e ausente em `Expired or Not Found`.", "properties": { "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Not Finished", "Expired" ], "description": "Status final da verificação de e-mail. Corresponde ao `status` de nível superior nas verificações finalizadas." }, "email": { "type": "string", "format": "email", "description": "O endereço de e-mail verificado.", "example": "alice@example.com" }, "is_breached": { "type": "boolean", "description": "`true` quando o endereço aparece em vazamentos de dados conhecidos (consulta de inteligência sobre vazamentos executada na finalização)." }, "breaches": { "type": "array", "description": "Até 5 vazamentos conhecidos mais recentes que contêm este endereço. Array vazio (ou omitido) quando `is_breached` é `false`.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Identificador do vazamento." }, "domain": { "type": "string", "description": "Domínio do serviço vazado." }, "breach_date": { "type": "string", "format": "date", "description": "Data em que a violação ocorreu." }, "breach_emails_count": { "type": "integer", "description": "Número total de contas expostas no vazamento." }, "description": { "type": "string", "description": "Descrição legível do vazamento (pode conter marcação HTML)." }, "logo_path": { "type": "string", "description": "URL do logotipo do serviço vazado." }, "data_classes": { "type": "array", "items": { "type": "string" }, "description": "Categorias de dados expostos, em snake_case (por exemplo, `email_addresses`, `passwords`)." }, "is_verified": { "type": "boolean", "description": "Se o vazamento foi verificado como legítimo." } } } }, "is_disposable": { "type": "boolean", "description": "`true` quando o domínio pertence a um provedor conhecido de e-mail descartável/temporário." }, "is_undeliverable": { "type": "boolean", "description": "`true` quando o endereço não pode receber e-mails (falha na validação de sintaxe ou de DNS/MX, ou a mensagem foi devolvida)." }, "verification_attempts": { "type": "integer", "description": "Número de envios de OTP para esta verificação (1, ou 2 após uma nova tentativa)." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o código correto foi inserido. `null` se a verificação nunca foi aprovada." }, "warnings": { "type": "array", "description": "Avisos de risco registrados durante a verificação (duplicado, vazado, descartável, não entregável, tentativas excedidas, lista de bloqueio etc.). Array vazio quando não há nenhum.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Recurso que gerou o aviso. Sempre `EMAIL` aqui." }, "risk": { "type": "string", "description": "Código de risco legível por máquina." }, "additional_data": { "type": "object", "nullable": true, "description": "Contexto específico do risco (por exemplo, o ID da sessão duplicada para riscos de duplicidade). `null` quando o risco não traz dados adicionais." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Severidade. Riscos `error` recusam a verificação, `warning` a sinaliza para revisão e `information` é registrado sem afetar o status." }, "short_description": { "type": "string", "description": "Resumo legível do risco em uma linha." }, "long_description": { "type": "string", "description": "Explicação legível do risco." } } } }, "lifecycle": { "type": "array", "description": "Trilha de auditoria cronológica da verificação. O `type` do evento é um destes: `EMAIL_VERIFICATION_MESSAGE_SENT`, `EMAIL_VERIFICATION_RETRY_MESSAGE_SENT`, `VALID_CODE_ENTERED`, `INVALID_CODE_ENTERED`, `EMAIL_VERIFICATION_APPROVED`, `EMAIL_VERIFICATION_DECLINED`, `EMAIL_VERIFICATION_IN_REVIEW`, `EMAIL_VERIFICATION_EXPIRED`.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Tipo de evento." }, "timestamp": { "type": "string", "format": "date-time", "description": "Quando o evento ocorreu." }, "details": { "type": "object", "nullable": true, "description": "Payload específico do evento. Eventos de envio: `{status, reason}`. Eventos de inserção de código: `{code_tried, status}`. Eventos de status final: `null`, ou `{reason}` quando recusado ou em revisão." }, "fee": { "type": "number", "description": "Valor em USD cobrado por este evento. Diferente de zero apenas no primeiro envio bem-sucedido; 0 para novas tentativas, inserções de código e eventos de status." } } } }, "matches": { "type": "array", "description": "Outras sessões da sua aplicação (KYC, KYB ou API) em que o mesmo endereço de e-mail foi usado por um usuário diferente (`vendor_data` diferente). Até 5 entradas; uma correspondência sintética de entrada da lista de bloqueio é adicionada no início quando presente (e somente quando não existe nenhum e-mail bloqueado derivado de sessão); as correspondências derivadas de sessões mantêm a ordem de created_at. Array vazio quando não há correspondências.", "items": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID da sessão da outra verificação que usou este endereço de e-mail." }, "session_number": { "type": "integer", "description": "Número sequencial de fácil leitura dessa sessão." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` dessa sessão." }, "verification_date": { "type": "string", "description": "Quando essa sessão foi criada (`YYYY-MM-DDTHH:MM:SSZ`)." }, "email": { "type": "string", "description": "O endereço de e-mail correspondente." }, "status": { "type": "string", "description": "Status dessa sessão (por exemplo, `Approved`, `Declined`, `In Progress`)." }, "is_blocklisted": { "type": "boolean", "description": "Se o endereço de e-mail está na lista de bloqueio da sua aplicação." }, "api_service": { "type": "string", "nullable": true, "description": "Para sessões do tipo API, a API independente que a criou (por exemplo, `PHONE_VERIFICATION`); `null` para sessões de verificação comuns." }, "source": { "type": "string", "description": "Onde a correspondência foi encontrada. Normalmente `session`; uma ocorrência na lista de bloqueio por meio de uma entrada de lista da organização adiciona no início uma correspondência sintética com `source: \"list_entry\"` e `session_id`/`session_number` nulos." } } } }, "email_social": { "$ref": "#/components/schemas/EmailSocialFootprint" }, "email_intelligence": { "allOf": [ { "$ref": "#/components/schemas/EmailIntelligence" } ], "description": "Sinais de inteligência de e-mail. Presente apenas quando `enable_enrichment` era `true` na verificação." } } }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` da sessão da verificação correspondente. `null` em `Expired or Not Found`." }, "metadata": { "type": "object", "nullable": true, "description": "`metadata` da sessão da verificação correspondente. `null` em `Expired or Not Found`." }, "created_at": { "type": "string", "format": "date-time", "description": "Data e hora desta resposta de verificação." } } }, "WorkflowListItem": { "type": "object", "description": "Uma versão do fluxo na visualização em lista.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID da versão. Use como `{settings_uuid}` para obter/atualizar/excluir e como `workflow_id` ao criar sessões." }, "workflow_id": { "type": "string", "format": "uuid", "description": "ID de grupo estável compartilhado por todas as versões do mesmo fluxo. É igual a `uuid` na versão 1." }, "workflow_label": { "type": "string", "description": "Nome de exibição do fluxo de verificação (workflow)." }, "workflow_type": { "type": "string", "nullable": true, "description": "Tipo base para fluxos simples: `kyc`, `kyb`, `adaptive_age_verification`, `biometric_authentication` etc. `null` para fluxos baseados em grafo sem um recurso de KYB." }, "is_default": { "type": "boolean", "description": "Se este é o fluxo de verificação (workflow) padrão para novas sessões." }, "is_archived": { "type": "boolean" }, "is_white_label_enabled": { "type": "boolean", "description": "Se a personalização de marca própria se aplica às sessões criadas com este fluxo." }, "total_price": { "type": "number", "description": "Preço fixo por verificação em USD (número JSON; exclui recursos com preço variável, como DATABASE_VALIDATION e PHONE_VERIFICATION)." }, "min_price": { "type": "number", "description": "Menor preço fixo entre os caminhos do grafo do fluxo, em USD." }, "max_price": { "type": "number", "description": "Preço fixo mais alto entre os caminhos do grafo do fluxo, em USD." }, "features": { "type": "string", "description": "Recursos ativados como uma única string unida por `\" + \"`, por exemplo `\"OCR + LIVENESS + FACE_MATCH\"`. Divida por `\" + \"` para obter uma lista." }, "is_simple_workflow": { "type": "boolean", "description": "True quando o fluxo não tem um grafo de fluxo personalizado." }, "is_editable": { "type": "boolean", "description": "True quando esta versão é um `draft` (rascunhos podem ser editados diretamente; versões publicadas são imutáveis no Console)." }, "workflow_url": { "type": "string", "format": "uri", "description": "URL pública e compartilhável de verificação para este fluxo (`https://verify.didit.me/u/`)." }, "max_retry_attempts": { "type": "integer", "description": "Número máximo de novas tentativas permitidas após uma verificação recusada (0-10)." }, "retry_window_days": { "type": "integer", "nullable": true, "description": "Janela móvel em dias usada para contar as novas tentativas (1-365). `null` = limite para todo o histórico." }, "session_expiration_time": { "type": "integer", "description": "Segundos até a expiração de uma sessão não concluída (3600-2419200)." }, "version": { "type": "integer", "description": "Número da versão dentro do grupo `workflow_id`, começando em 1." }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Status da versão. Novas sessões usam a versão `published` mais recente de um grupo." }, "has_draft": { "type": "boolean", "description": "True quando alguma versão deste grupo de `workflow_id` está atualmente em rascunho." }, "created_by": { "type": "object", "nullable": true, "description": "Quem criou esta versão: `{name, email, type}`, em que `type` é `user` (usuário do Console, com `email` definido) ou `api_key` (`name` é o client id, `email` é null). `null` quando nenhum criador foi registrado.", "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": "Cria um fluxo de verificação (workflow) linear simples. A API converte internamente esta lista de recursos em um grafo de fluxo baseado em nós. Lista de campos permitidos RESTRITA: qualquer chave não listada aqui (incluindo `workflow_type`) é rejeitada com 400.", "required": [ "features" ], "properties": { "workflow_label": { "type": "string", "maxLength": 50, "default": "ID Verification", "description": "Nome de exibição do fluxo de verificação (workflow) (máximo de 50 caracteres). O padrão é `\"ID Verification\"` quando omitido; sempre defina-o para que os fluxos continuem distinguíveis.", "example": "Standard KYC" }, "is_default": { "type": "boolean", "description": "Define este fluxo como padrão para novas sessões." }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Omita este campo para criar um fluxo publicado, pronto para sessões. Use `draft` somente quando quiser salvar sem publicar." }, "features": { "type": "array", "minItems": 1, "description": "Recursos de verificação em ordem de execução. A API vincula cada item ao seguinte e adiciona automaticamente um nó final de status.", "items": { "$ref": "#/components/schemas/SimpleWorkflowFeature" } }, "is_white_label_enabled": { "type": "boolean", "description": "Ativa a personalização de marca própria para as sessões criadas com este fluxo.", "default": false }, "is_desktop_allowed": { "type": "boolean", "description": "Permite que o fluxo de verificação seja executado em navegadores desktop.", "default": false }, "max_retry_attempts": { "type": "integer", "minimum": 0, "maximum": 10, "default": 3, "description": "Número máximo de novas tentativas permitidas após uma verificação recusada. `0` bloqueia o usuário após a primeira recusa." }, "retry_window_days": { "type": "integer", "minimum": 1, "maximum": 365, "nullable": true, "default": 7, "description": "Janela móvel em dias usada para contar as novas tentativas. `null` aplica um limite para todo o histórico." }, "face_liveness_max_attempts": { "type": "integer", "minimum": 1, "maximum": 3, "default": 3, "description": "Número máximo de envios de prova de vida por sessão. Padrão 3: uma tentativa inicial mais duas novas tentativas. Esse valor também é copiado para os nós de prova de vida e de estimativa de idade gerados no fluxo de verificação (workflow), a menos que a configuração no nível do recurso o substitua." }, "face_match_max_attempts": { "type": "integer", "minimum": 1, "maximum": 3, "default": 3, "description": "Número máximo de envios de correspondência facial por sessão. Padrão 3: uma tentativa inicial mais duas novas tentativas. Esse valor também é copiado para os nós de correspondência facial gerados no fluxo de verificação (workflow), a menos que a configuração no nível do recurso o substitua." }, "session_expiration_time": { "type": "integer", "minimum": 3600, "maximum": 2419200, "default": 604800, "description": "Segundos até a expiração de uma sessão não concluída. Mínimo de 1 hora (3600), máximo de 4 semanas (2419200)." } } }, "SimpleWorkflowUpdateRequest": { "type": "object", "description": "Atualize os metadados do fluxo de verificação ou substitua a lista linear completa de recursos. Lista de campos permitidos ESTRITA: qualquer chave não listada aqui é rejeitada com 400.", "properties": { "workflow_label": { "type": "string", "maxLength": 50, "description": "Nome de exibição do fluxo de verificação (workflow) (máximo de 50 caracteres)." }, "is_default": { "type": "boolean", "description": "Define este fluxo como padrão para novas sessões." }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Controla o versionamento. Omita para atualizar a versão atual no próprio lugar (rascunhos são publicados automaticamente). `published` em uma versão já publicada cria e retorna uma NOVA versão. `draft` só é válido enquanto a versão ainda é um rascunho." }, "features": { "type": "array", "minItems": 1, "description": "Se informado, substitui toda a ordem e a configuração dos recursos.", "items": { "$ref": "#/components/schemas/SimpleWorkflowFeature" } }, "is_white_label_enabled": { "type": "boolean", "description": "Ativa a personalização de marca própria para as sessões criadas com este fluxo." }, "is_desktop_allowed": { "type": "boolean", "description": "Permite que o fluxo de verificação seja executado em navegadores desktop." }, "max_retry_attempts": { "type": "integer", "minimum": 0, "maximum": 10, "description": "Número máximo de novas tentativas permitidas após uma verificação recusada. `0` bloqueia o usuário após a primeira recusa." }, "retry_window_days": { "type": "integer", "minimum": 1, "maximum": 365, "nullable": true, "description": "Janela móvel em dias usada para contar as novas tentativas. `null` aplica um limite para todo o histórico." }, "face_liveness_max_attempts": { "type": "integer", "minimum": 1, "maximum": 3, "description": "Número máximo de envios de prova de vida por sessão. Esse valor também é copiado para os nós de prova de vida e de estimativa de idade gerados no fluxo de verificação (workflow), a menos que a configuração no nível do recurso o substitua." }, "face_match_max_attempts": { "type": "integer", "minimum": 1, "maximum": 3, "description": "Número máximo de envios de correspondência facial por sessão. Esse valor também é copiado para os nós de correspondência facial gerados no fluxo de verificação (workflow), a menos que a configuração no nível do recurso o substitua." }, "session_expiration_time": { "type": "integer", "minimum": 3600, "maximum": 2419200, "description": "Segundos até a expiração de uma sessão não concluída. Mínimo de 1 hora (3600), máximo de 4 semanas (2419200)." } } }, "SimpleWorkflowFeature": { "type": "object", "required": [ "feature" ], "properties": { "feature": { "type": "string", "description": "Recurso a ser executado. Use os valores em maiúsculas mostrados aqui.", "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": "Configurações específicas do recurso. Para `QUESTIONNAIRE`, inclua `questionnaire_uuid` com o `questionnaire_id` retornado pelo endpoint de criação de questionário. Para `SIGNATURE`, um fluxo de verificação (workflow) que entra em produção precisa de um documento para assinar: defina `signature_documents_source` como `session` ou `both` para que cada sessão possa trazer o seu, ou envie `status: \"draft\"` e adicione os documentos antes de publicar. `signature_level: \"aes\"` é recusado com `aes_not_available` enquanto `signature_availability.aes` for `false` no fluxo. Para `OCR`, `methods` seleciona quais métodos de Verificação de identidade cada país pode usar (captura de documento, consulta sem documento a uma fonte governamental ou outra fonte oficial e carteiras de identidade digital); se omitido, todos os países usam somente captura de documento. Para `SIGNATURE`, consulte as [configurações de Assinatura eletrônica](/pt-br/management-api/workflows/feature-configs#assinatura-eletrônica): `signature_level` aceita, por enquanto, `simple` (o padrão, sem necessidade de verificação de identidade, e-mail ou telefone) e `aes`, e os documentos do fluxo e seus campos são gerenciados no console; por isso, pela API, envie documentos e campos por sessão com `signature_documents_source: \"session\"`.", "additionalProperties": true }, "label": { "type": "string", "description": "Rótulo interno opcional para este nó do fluxo." } } }, "ReviewItem": { "type": "object", "description": "Uma entrada do feed de revisão / atividade de uma sessão. As mudanças de status trazem `previous_status`, `new_status`, `previous_value`, `new_value` e `changed_fields`; os comentários trazem `comment` e (para comentários do Console) `mentioned_emails`; os demais campos são `null` ou vazios quando não se aplicam ao tipo de atividade.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador único desta entrada do feed.", "example": "de0561bc-5583-4409-9171-1a31a4c8a5f4" }, "activity_type": { "type": "string", "enum": [ "COMMENT", "STATUS_UPDATED", "KYC_DATA_UPDATED", "POA_DATA_UPDATED", "FILE_ADDED", "FILE_REMOVED", "AML_ONGOING_MATCH", "AML_STATUS_UPDATED", "AML_HIT_STATUS_UPDATED", "KYB_DATA_UPDATED", "KYB_DOCUMENT_UPLOADED", "TAG_ADDED", "TAG_REMOVED", "FEATURE_OVERRIDE_PENDING", "FEATURE_OVERRIDE_APPLIED", "FEATURE_OVERRIDE_CANCELLED" ], "description": "O tipo de atividade que este registro documenta. Linhas `STATUS_UPDATED` vêm de decisões manuais (`PATCH /v3/session/{session_id}/update-status/`) e de registros adicionados via `POST …/reviews/` (que usam esse tipo por padrão mesmo quando nenhum status é registrado). Linhas `COMMENT` vêm de revisores no Console; visualizações da página de detalhes no Console também são armazenadas como linhas `COMMENT` marcadas com `metadata.system_event = \"DETAIL_VIEWED\"`. Os demais tipos acompanham edições de dados, alterações de arquivos, tags e atividade de monitoramento AML. Linhas STATUS_UPDATED também são gravadas por atores do sistema (por exemplo, o monitoramento AML contínuo com actor_type SYSTEM e atualizações automáticas de status de recursos), não apenas pelo endpoint update-status e por envios de revisão manual. `FEATURE_OVERRIDE_PENDING`, `FEATURE_OVERRIDE_APPLIED` e `FEATURE_OVERRIDE_CANCELLED` registram uma substituição do status de uma verificação (`PATCH /v3/session/{session_id}/features/{node_id}/update-status/`): solicitada para aguardar a conclusão do fluxo, aplicada ou cancelada. Elas trazem o status da verificação em `previous_value` / `new_value` (`{\"status\": ...}`), deixam `previous_status` e `new_status` como `null` e identificam a substituição em `metadata` (`feature_override_id`, `node_id`, `feature_model`, `forced`, `state`, `cancel_reason`). O registro da requisição traz o `comment` do revisor; uma substituição aplicada quando o fluxo termina é registrada com `actor_type` `SYSTEM`.", "example": "STATUS_UPDATED" }, "actor_display": { "type": "string", "description": "Rótulo legível do autor, resolvido nesta ordem: nome completo do ator → identificador da conta do Console → parte local de `actor_email` → `\"API Client\"` (para atores `API_KEY`) → `\"System\"` (para atores `SYSTEM`) → `\"Unknown\"`. Entradas criadas via `POST …/reviews/` sempre exibem `\"Unknown\"`, porque esse endpoint não registra a atribuição de ator.", "example": "API Client" }, "actor_email": { "type": "string", "nullable": true, "description": "E-mail do usuário do Console que executou a ação. `null` para chaves de API e atores do sistema.", "example": null }, "actor_type": { "type": "string", "enum": [ "API_KEY", "CONSOLE_USER", "SYSTEM" ], "description": "Quem executou a ação: uma chave de API, um usuário do Console ou a própria Didit (`SYSTEM`, por exemplo, o monitoramento contínuo AML). Entradas criadas via `POST …/reviews/` recebem o padrão `CONSOLE_USER`, independentemente de quem fez a chamada.", "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": "Status da sessão registrado por esta entrada (para atualizações de status). `null` para comentários e entradas de alteração de dados.", "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": "Status que a sessão tinha antes da alteração. Preenchido nas entradas `STATUS_UPDATED` gravadas pelo endpoint de atualização de status; `null` nas entradas adicionadas via `POST …/reviews/`. Também preenchido nas linhas STATUS_UPDATED gravadas pelo sistema.", "example": "In Review" }, "comment": { "type": "string", "nullable": true, "description": "Nota em texto livre anexada à entrada, ou `null`.", "example": "Document re-checked manually; address matches." }, "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Usuários do console mencionados com `@email` no comentário. Sempre vazio para entradas criadas por esta API: o processamento de menções é um recurso exclusivo do console.", "example": [] }, "previous_value": { "type": "object", "nullable": true, "description": "Snapshot dos dados alterados antes da ação, por exemplo `{\"status\": \"In Review\"}` em uma mudança de status. `null` quando nada foi alterado.", "example": { "status": "In Review" } }, "new_value": { "type": "object", "nullable": true, "description": "Snapshot dos dados alterados após a ação, por exemplo `{\"status\": \"Approved\"}`. É `null` quando nada foi alterado.", "example": { "status": "Approved" } }, "changed_fields": { "type": "array", "items": { "type": "string" }, "description": "Nomes dos campos modificados por esta atividade (por exemplo, `[\"status\"]`). Vazio para comentários e para entradas adicionadas via `POST …/reviews/`.", "example": [ "status" ] }, "metadata": { "type": "object", "nullable": true, "description": "Contexto adicional para entradas geradas pelo sistema. Visualizações de páginas de detalhes no console trazem `{\"system_event\": \"DETAIL_VIEWED\", \"detail_type\": \"verification\"}` para que possam ser excluídas da lógica de notificações por filtro. `null` para entradas comuns.", "example": null }, "created_at": { "type": "string", "format": "date-time", "description": "Quando a entrada foi gravada, em ISO 8601 UTC.", "example": "2026-06-12T00:19:31.918735Z" } } }, "QuestionnaireListItem": { "type": "object", "description": "Uma versão de questionário na visualização em lista.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID da versão. Use como `{questionnaire_uuid}` para obter/atualizar/excluir e como `questionnaire_uuid` na configuração do recurso QUESTIONNAIRE de um fluxo." }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "languages": { "type": "array", "items": { "type": "string" } }, "default_language": { "type": "string" }, "is_active": { "type": "boolean" }, "is_simple_questionnaire": { "type": "boolean", "description": "True para questionários lineares criados por meio desta API; false para questionários baseados em grafo criados no Console." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "question_types": { "type": "array", "items": { "type": "string" }, "description": "Tipos de elemento em maiúsculas das perguntas que podem ser respondidas, na ordem de criação (por exemplo, `SHORT_TEXT`, `MULTIPLE_CHOICE`, `FILE_UPLOAD`). Os elementos estruturais `SECTION_HEADER` e `SEPARATOR` são excluídos. Há uma entrada por pergunta, portanto os valores podem se repetir." }, "workflow_names": { "type": "array", "items": { "type": "string" }, "description": "Nomes dos fluxos que usam este questionário. Atualmente sempre `[]` neste endpoint (preenchido apenas na listagem do Console)." }, "questionnaire_group_id": { "type": "string", "format": "uuid", "description": "Identificador estável que agrupa todas as versões do mesmo questionário." }, "version": { "type": "integer", "description": "Número da versão dentro do grupo, começando em 1." }, "status": { "type": "string", "enum": [ "draft", "published" ] }, "published_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando esta versão foi publicada. `null` para rascunhos." }, "is_editable": { "type": "boolean", "description": "True quando esta versão é um `draft`." } } }, "SimpleQuestionnaireRequest": { "type": "object", "description": "Cria um questionário linear simples. A API converte `form_elements` no grafo interno do questionário.", "required": [ "title", "languages", "form_elements" ], "properties": { "title": { "type": "string", "description": "Nome interno do questionário." }, "description": { "type": "string", "nullable": true }, "languages": { "type": "array", "description": "Idiomas incluídos em cada rótulo. Deve incluir `en`.", "items": { "type": "string" }, "example": [ "en" ] }, "default_language": { "type": "string", "description": "Idioma padrão. Deve estar incluído em `languages`.", "example": "en" }, "is_active": { "type": "boolean", "default": true }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "Omita este campo para criar um questionário publicado, pronto para os fluxos." }, "form_elements": { "type": "array", "minItems": 1, "description": "Perguntas na ordem exata em que os usuários devem vê-las. Ramificações e campos condicionais não são suportados.", "items": { "$ref": "#/components/schemas/SimpleQuestionnaireElement" } } } }, "SimpleQuestionnaireUpdateRequest": { "type": "object", "description": "Atualize os metadados do questionário ou substitua a lista linear completa `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": "Se informado, substitui toda a lista linear de perguntas.", "items": { "$ref": "#/components/schemas/SimpleQuestionnaireElement" } } } }, "SimpleQuestionnaireElement": { "type": "object", "required": [ "element_type", "label" ], "properties": { "id": { "type": "string", "description": "ID estável opcional da pergunta. Se omitido, a API gera `q1`, `q2` etc. Use letras minúsculas, números e sublinhados para facilitar a leitura.", "example": "source_of_funds" }, "element_type": { "type": "string", "description": "Tipo de pergunta. A API aceita estes valores em minúsculas e seus equivalentes em maiúsculas.", "enum": [ "short_text", "long_text", "dropdown", "single_choice", "multiple_choice", "number", "image", "file_upload", "time", "email", "address", "phone", "country", "date_picker", "consent", "section_header", "separator", "heading", "paragraph" ] }, "label": { "type": "object", "description": "Rótulo da pergunta por código de idioma, por exemplo `{ \"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": "Use para `dropdown`, `single_choice` e `multiple_choice`. Se `value` for omitido, a API gera um a partir do rótulo da opção.", "items": { "type": "object", "required": [ "label" ], "properties": { "value": { "type": "string" }, "label": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "max_files": { "type": "integer", "minimum": 1, "maximum": 5, "description": "Use com `file_upload` ou `image`." }, "validation": { "type": "object", "nullable": true, "description": "Validação de formato opcional para `short_text`, `long_text` ou `number`. É aplicada enquanto o usuário preenche o campo (ele não pode avançar até que a validação seja aprovada) e verificada novamente pela API no envio.", "properties": { "pattern": { "type": "string", "description": "Expressão regular (subconjunto do ECMA-262) à qual o valor deve corresponder por completo. Para `short_text` e `long_text`. Não adicione as âncoras ^/$; o valor inteiro é verificado." }, "min_length": { "type": "integer", "minimum": 0, "description": "Número mínimo de caracteres. Para `short_text` e `long_text`." }, "max_length": { "type": "integer", "minimum": 0, "description": "Número máximo de caracteres. Para `short_text` e `long_text`." }, "min": { "type": "number", "description": "Valor numérico mínimo. Para `number`." }, "max": { "type": "number", "description": "Valor numérico máximo. Para `number`." }, "error_message": { "type": "object", "description": "Mensagem traduzida exibida quando a validação falha, indexada pelo código do idioma.", "additionalProperties": { "type": "string" } } } } } }, "QuestionnaireDetail": { "type": "object", "description": "Detalhes completos do questionário retornados pelos endpoints GET, POST (criação) e PATCH (atualização).", "properties": { "questionnaire_id": { "type": "string", "format": "uuid", "description": "Identificador único do questionário. Use este id ao referenciar o questionário a partir de um fluxo ou em requisições posteriores de atualização/exclusão." }, "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": "Estrutura de grafo com start_node e o mapa de nós." }, "sections": { "type": "array", "description": "Conteúdo do questionário agrupado em seções (derivado do grafo).", "items": { "type": "object" } }, "questionnaire_group_id": { "type": "string", "format": "uuid", "description": "Identificador estável que agrupa todas as versões do mesmo questionário." }, "version": { "type": "integer" }, "status": { "type": "string", "enum": [ "draft", "published" ] }, "published_at": { "type": "string", "format": "date-time", "nullable": true }, "is_editable": { "type": "boolean", "description": "True quando o questionário ainda pode ser editado diretamente (versões de rascunho)." } } }, "UserListItem": { "type": "object", "description": "Um usuário verificado.", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "UUID interno estável da Didit para este usuário." }, "vendor_data": { "type": "string", "nullable": true, "description": "Seu identificador exclusivo deste usuário (passado ao criar sessões). Pode ser nulo quando nenhum identificador do fornecedor foi informado." }, "display_name": { "type": "string", "nullable": true, "description": "Nome de exibição personalizado definido por você" }, "full_name": { "type": "string", "nullable": true, "description": "Nome completo extraído dos documentos verificados" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "effective_name": { "type": "string", "nullable": true, "description": "Melhor nome disponível: display_name, se definido; caso contrário, full_name" }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Status do ciclo de vida do registro do usuário (NÃO é um status de sessão). `ACTIVE` é o padrão, `FLAGGED` marca o usuário para atenção manual e `BLOCKED` impede novas sessões para este `vendor_data`." }, "portrait_image_url": { "type": "string", "nullable": true, "description": "URL pré-assinada da foto de retrato do usuário (expira após algumas horas)" }, "session_count": { "type": "integer", "description": "Número total de sessões de verificação deste usuário" }, "approved_count": { "type": "integer", "description": "Número de sessões aprovadas" }, "declined_count": { "type": "integer", "description": "Número de sessões recusadas" }, "in_review_count": { "type": "integer", "description": "Número de sessões em revisão" }, "issuing_states": { "type": "array", "items": { "type": "string" }, "description": "Códigos ISO 3166-1 alpha-3 dos países emissores encontrados nos documentos de identidade aprovados deste usuário, por exemplo, `[\"USA\", \"ESP\"]`. Array vazio quando não houver nenhum." }, "approved_emails": { "type": "array", "items": { "type": "string" }, "description": "Endereços de e-mail verificados coletados das sessões aprovadas deste usuário, por exemplo, `[\"john@example.com\"]`." }, "approved_phones": { "type": "array", "items": { "type": "string" }, "description": "Números de telefone verificados coletados das sessões aprovadas deste usuário, por exemplo, `[\"+14155551234\"]`." }, "features": { "type": "object", "description": "Status agregado por recurso em todas as sessões deste usuário. Chaves possíveis: `ID_VERIFICATION`, `NFC`, `LIVENESS`, `FACE_MATCH`, `POA`, `QUESTIONNAIRE`, `EMAIL_VERIFICATION`, `PHONE`, `AML`, `IP_ANALYSIS`, `AGE_ESTIMATION`, `DATABASE_VALIDATION`. Valores possíveis: `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub Requested`." }, "features_list": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string" }, "status": { "type": "string" } } }, "description": "Os mesmos dados de `features`, como um array ordenado de objetos `{feature, status}`." }, "last_session_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data e hora da sessão mais recente" }, "first_session_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data e hora da primeira sessão" }, "last_activity_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data e hora da atividade mais recente deste usuário (sessão, transação, mudança de status, edição de dados etc.)." }, "tags": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string" } } }, "description": "Tags atribuídas a este usuário" }, "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": "Detalhes completos do usuário. Estende UserListItem com metadados, comentários e updated_at.", "allOf": [ { "$ref": "#/components/schemas/UserListItem" }, { "type": "object", "properties": { "metadata": { "type": "object", "description": "JSON de metadados personalizados que você anexou a este usuário. O padrão é `{}`." }, "tags": { "type": "array", "description": "Atribuições de tags. OBSERVAÇÃO: nas respostas de detalhe, cada entrada é um objeto de *vínculo* de tag (`{uuid, tag: {...}, added_by_email, added_by_name, created_at}`), diferente do formato plano `{uuid, name, color}` usado nas respostas de lista.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID da atribuição da tag (não da tag em 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": "Valores anteriores dos campos para entradas PROFILE_UPDATED." }, "new_value": { "type": "object", "nullable": true, "description": "Novos valores de campo para entradas PROFILE_UPDATED." }, "changed_fields": { "type": "array", "items": { "type": "string" }, "description": "Nomes dos campos alterados por uma entrada PROFILE_UPDATED." }, "metadata": { "type": "object", "nullable": true }, "mentioned_emails": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" } } }, "description": "Registro de atividades e comentários deste usuário (alterações de status, edições de perfil, notas manuais)." }, "updated_at": { "type": "string", "format": "date-time" } } } ] }, "BusinessListItem": { "type": "object", "description": "Uma empresa verificada.", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "UUID interno estável da Didit para esta empresa." }, "vendor_data": { "type": "string", "nullable": true, "description": "Seu identificador exclusivo desta empresa (passado ao criar sessões). Pode ser nulo quando nenhum identificador do fornecedor foi informado." }, "display_name": { "type": "string", "nullable": true, "description": "Nome de exibição personalizado definido por você" }, "legal_name": { "type": "string", "nullable": true, "description": "Razão social oficial obtida do registro de empresas ou inserida manualmente" }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registro ou de constituição da empresa" }, "country_code": { "type": "string", "nullable": true, "description": "País de constituição (ISO 3166-1 alpha-2, por exemplo, `GB`, `US`)." }, "effective_name": { "type": "string", "nullable": true, "description": "Melhor nome disponível: display_name, se definido; caso contrário, legal_name" }, "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Status do ciclo de vida do registro da empresa (NÃO é um status de sessão). `ACTIVE` é o padrão, `FLAGGED` o marca para atenção manual e `BLOCKED` impede novas sessões para este `vendor_data`." }, "session_count": { "type": "integer", "description": "Número total de sessões de verificação desta empresa" }, "approved_count": { "type": "integer", "description": "Número de sessões aprovadas" }, "declined_count": { "type": "integer", "description": "Número de sessões recusadas" }, "in_review_count": { "type": "integer", "description": "Número de sessões em revisão" }, "features": { "type": "object", "description": "Status agregado por recurso em todas as sessões de KYB desta empresa. Atualmente, a única chave é `KYB` (o status da verificação da empresa no registro). Valores possíveis: `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub Requested`." }, "features_list": { "type": "array", "items": { "type": "object", "properties": { "feature": { "type": "string" }, "status": { "type": "string" } } }, "description": "Os mesmos dados de `features`, como um array ordenado de objetos `{feature, status}`." }, "last_session_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data e hora da sessão mais recente" }, "first_session_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data e hora da primeira sessão" }, "last_activity_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data e hora da atividade mais recente (mudança de status, atualização da sessão etc.)" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string" } } }, "description": "Tags atribuídas a esta empresa" }, "created_at": { "type": "string", "format": "date-time" } } }, "BusinessDetailItem": { "type": "object", "description": "Detalhes completos da empresa. Estende BusinessListItem com metadata e updated_at.", "allOf": [ { "$ref": "#/components/schemas/BusinessListItem" }, { "type": "object", "properties": { "metadata": { "type": "object", "description": "JSON de metadados personalizados que você anexou a esta empresa. O padrão é `{}`." }, "updated_at": { "type": "string", "format": "date-time" } } } ] }, "TransactionDetail": { "type": "object", "description": "Registro de monitoramento completo de uma transação, conforme retornado por `GET /v3/transactions/{transaction_id}/` e `POST /v3/transactions/`.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador estável da transação na Didit. Use como `{transaction_id}` nas chamadas subsequentes." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Ambiente da aplicação proprietária da transação. Uma transação `sandbox` é armazenada, mas nunca é avaliada, analisada, notificada ou cobrada, portanto o seu `rule_runs` vazio significa \"não avaliada\"." }, "transaction_number": { "type": "integer", "description": "Número sequencial da transação no escopo da aplicação exibido no Console (por exemplo, `4123`)." }, "txn_id": { "type": "string", "description": "O `transaction_id` que você informou na criação (máximo de 128 caracteres). Único por aplicação." }, "txn_date": { "type": "string", "format": "date-time", "description": "Quando a transação ocorreu (a partir de `transaction_at`; o padrão é o momento do envio)." }, "zone_id": { "type": "string", "nullable": true, "description": "Identificador de fuso horário IANA informado na criação." }, "transaction_type": { "type": "string", "description": "Categoria de nível superior, como armazenada: `finance`, `kyc`, `travelRule`, `userPlatformEvent`, `gamblingBet`, `gamblingLimitChange`, `gamblingBonusChange`, `auditTrailEvent`. Observe que valores com várias palavras são retornados em camelCase mesmo quando enviados em snake_case." }, "action_type": { "type": "string", "description": "Subtipo dentro da categoria (por exemplo `deposit`, `withdrawal`, `transfer`). O padrão é a categoria quando não for informado." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Direção em relação ao titular. Armazenada em maiúsculas, independentemente da caixa usada no envio (`in`/`out`/`inbound`/`outbound` são aceitos na entrada)." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Veredito de monitoramento atual. As transações são criadas como `APPROVED`; as regras podem alterá-las para `IN_REVIEW`/`DECLINED` de forma síncrona." }, "source": { "type": "string", "enum": [ "LIVE", "IMPORTED" ], "description": "Como o registro se originou: `LIVE` para transações enviadas pela API ou pelo SDK, `IMPORTED` para transações carregadas pela importação do console." }, "amount": { "type": "string", "description": "Valor da transação como string decimal, sem zeros à direita (por exemplo, `\"1500\"`, `\"0.5\"`, `\"0.123456789012345678\"`). Até 18 casas decimais." }, "currency": { "type": "string", "description": "Código da moeda de `amount`. Qualquer código alfabético ISO 4217 é aceito (por exemplo, `EUR`, `USD`, `NGN`), assim como um símbolo de ativo cripto (por exemplo, `BTC`). Prefira um código atualmente em circulação. Nem todo código aceito tem taxa de câmbio: quando não há nenhuma disponível para o código (por exemplo, a unidade contábil ISO `XSU` ou um símbolo cripto que a Didit não precifica), a conversão automática falha e `preferred_currency_amount` é retornado como null, a menos que a requisição tenha fornecido um `amount_in_default_currency` já convertido." }, "currency_type": { "type": "string", "nullable": true, "description": "`fiat` ou `crypto`, conforme enviado em `currency_kind`." }, "amount_in_default_currency": { "type": "string", "nullable": true, "description": "Valor já convertido que você informou, como string decimal sem zeros à direita." }, "default_currency_code": { "type": "string", "nullable": true }, "preferred_currency_amount": { "type": "string", "nullable": true, "description": "`amount` convertido para a moeda preferida da aplicação, quando disponível." }, "preferred_currency_code": { "type": "string", "nullable": true }, "payment_details": { "type": "string", "nullable": true, "description": "Referência ou memorando de pagamento em texto livre do envio." }, "payment_txn_id": { "type": "string", "nullable": true, "description": "Referência do sistema de pagamento externo (por exemplo, hash da transação na blockchain) obtida de `payment_reference_id`." }, "score": { "type": "integer", "description": "Pontuação de risco acumulada pelas regras (normalmente de 0 a 100). Quanto maior, mais arriscado." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "description": "Gravidade categórica do risco definida por regras ou provedores (`UNKNOWN`, `LOW`, `MEDIUM`, `HIGH`, `CRITICAL`). `null` até que algo a defina." }, "decision_reason_code": { "type": "string", "nullable": true, "description": "Motivo legível por máquina do `status` atual." }, "decision_reason_label": { "type": "string", "nullable": true, "description": "Rótulo legível de `decision_reason_code`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Cópia de conveniência do `vendor_data` do solicitante." }, "metadata": { "type": "object", "description": "Snapshot dos payloads `subject` e `counterparty` como foram enviados no momento da criação." }, "props": { "type": "object", "description": "As `custom_properties` que você informou na criação. Cada chave pode ser referenciada nas condições de regras como `custom_values.`." }, "tags": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string" }, "description": { "type": "string", "nullable": true }, "source": { "type": "string", "enum": [ "didit", "custom" ], "description": "Se a tag é uma predefinição da Didit ou uma tag personalizada." } } }, "description": "Tags anexadas à transação (manualmente ou por regras)." }, "parties": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "role": { "type": "string", "enum": [ "APPLICANT", "REMITTER", "BENEFICIARY", "COUNTERPARTY" ], "description": "Função da parte. O endpoint de criação atribui `APPLICANT` (o titular) e `COUNTERPARTY`." }, "entity_type": { "type": "string", "enum": [ "individual", "company", "external", "unhostedWallet" ] }, "kind": { "type": "string", "enum": [ "USER", "BUSINESS", "EXTERNAL" ], "description": "Partes `USER`/`BUSINESS` se vinculam a uma entidade da Didit por meio de `vendor_data`. Partes `EXTERNAL` não têm nenhuma entidade da Didit por trás." }, "vendor_data": { "type": "string", "nullable": true, "description": "Seu identificador interno de usuário/empresa." }, "full_name": { "type": "string", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true, "description": "Código do país a partir do `address.country` enviado (normalmente ISO 3166-1 alpha-3)." }, "dob": { "type": "string", "format": "date", "nullable": true, "description": "Data de nascimento do `date_of_birth` enviado." }, "address": { "type": "object", "description": "Objeto de endereço conforme enviado. `{}` quando omitido." }, "institution_info": { "type": "object", "description": "Dados da instituição conforme enviados. `{}` quando omitidos." }, "device": { "type": "object", "description": "Contexto normalizado do dispositivo, incluindo o enriquecimento de IP no servidor em network_context (geolocalização, indicadores de VPN/data center) quando um IP foi informado.", "properties": { "fingerprint": { "type": "string", "description": "Impressão digital única do dispositivo." }, "persistent_device_id": { "type": "string", "description": "Identificador estável do dispositivo entre sessões (esquema de fingerprint v2)." }, "user_agent": { "type": "string", "description": "String de user agent do navegador ou do app." }, "browser_family": { "type": "string", "description": "Família do navegador (por exemplo, Chrome, Firefox, Safari)." }, "browser_version": { "type": "string", "description": "String da versão do navegador." }, "platform": { "type": "string", "description": "Identificador da plataforma (web, ios, android, macos, windows, linux)." }, "os_family": { "type": "string", "description": "Família do sistema operacional (por exemplo, iOS, Android, Windows)." }, "os_version": { "type": "string", "description": "String de versão do sistema operacional." }, "accept_language": { "type": "string", "description": "Valor do cabeçalho Accept-Language." }, "session_id": { "type": "string", "description": "Identificador da sessão (armazenado nos metadados)." }, "session_age_ms": { "type": "number", "description": "Idade da sessão em milissegundos." }, "network_context": { "type": "object", "description": "Contexto de rede com endereço IP e geolocalização.", "properties": { "ip_address": { "type": "string", "description": "Endereço IP do cliente." }, "ip_country_code": { "type": "string", "description": "País do IP resolvido por geolocalização (ISO 3166-1 alpha-3)." }, "latitude": { "type": "number", "description": "Latitude geográfica do IP." }, "longitude": { "type": "number", "description": "Longitude geográfica do IP." } } } } }, "external_party_snapshot": { "type": "object", "nullable": true, "description": "Cópia congelada dos dados da parte para partes `EXTERNAL`. `null` enquanto a parte estiver vinculada a um usuário ou empresa da Didit." } } }, "description": "Partes da transação (solicitante, contraparte)." }, "payment_methods": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "payment_method_type": { "type": "string", "enum": [ "bank_card", "bank_account", "e_wallet", "crypto_wallet", "unhosted_wallet", "other" ] }, "label": { "type": "string", "nullable": true }, "fingerprint": { "type": "string", "nullable": true, "description": "SHA-256 sobre `type:account_id:issuing_country`: identificador estável para correlacionar a reutilização do mesmo instrumento." }, "account_id": { "type": "string", "nullable": true, "description": "Identificador da conta (IBAN, endereço de carteira, token de cartão, …)." }, "issuing_country": { "type": "string", "nullable": true }, "owner_kind": { "type": "string", "enum": [ "USER", "BUSINESS", "EXTERNAL" ] }, "vendor_data": { "type": "string", "nullable": true, "description": "Seu identificador do usuário/empresa proprietário." }, "owner_name": { "type": "string", "nullable": true }, "institution_info": { "type": "object" }, "details": { "type": "object", "description": "Objeto `payment_method` bruto, conforme enviado." }, "external_owner_snapshot": { "type": "object", "nullable": true }, "role": { "type": "string", "enum": [ "SOURCE", "DESTINATION", "FUNDING", "BENEFICIARY" ], "description": "Como este método foi usado na transação. O endpoint de criação atribui `SOURCE`/`DESTINATION` com base na direção (saída: titular = SOURCE; entrada: titular = DESTINATION)." } } }, "description": "Meios de pagamento vinculados à transação." }, "documents": { "type": "array", "description": "Arquivos anexados à transação pelo console. `[]` quando não há nenhum.", "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 download assinada de curta duração; obtenha-a quando necessário em vez de armazená-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": "Por exemplo, `TRANSACTION_CREATED`, `TRANSACTION_NOTE_ADDED`, `TRANSACTION_STATUS_CHANGED`." }, "source": { "type": "string" }, "status": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "metadata": { "type": "object" }, "occurred_at": { "type": "string", "format": "date-time" } } }, "description": "Entradas do registro de atividades (criação, notas, revisões manuais, alterações de status)." }, "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 vazio atualmente. Um alerta aberto é uma transação com status `IN_REVIEW` ou `AWAITING_USER`." }, "rule_runs": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "rule": { "type": "string", "format": "uuid", "description": "UUID da regra que foi executada." }, "rule_title": { "type": "string" }, "rule_description": { "type": "string", "nullable": true }, "rule_category": { "type": "string" }, "matched": { "type": "boolean", "description": "Se as condições da regra corresponderam a esta transação. Uma execução é registrada apenas para regras correspondidas, então as avaliações em produção sempre trazem `true`." }, "is_test": { "type": "boolean", "description": "True quando a regra foi executada no modo TEST (sem efeito no status/pontuação)." }, "mode": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "TEST" ] }, "severity": { "type": "string", "nullable": true }, "score_delta": { "type": "integer", "description": "Pontuação adicionada pelas ações `add_score` desta regra." }, "status_target": { "type": "string", "nullable": true, "description": "Status definido por uma ação `change_status`, se houver." }, "action_summary": { "type": "string", "nullable": true, "description": "Resumo das ações que a regra executou, unidas com `; ` (por exemplo, `score +30; change_status:IN_REVIEW; add_tag:high_risk_country`). Partes: `score +N`, `change_status:`, `add_tag:`, `add_note`, `add_to_list`, `open_case`. `null` quando a regra não executou nenhuma ação." }, "metadata": { "type": "object", "description": "Detalhe da avaliação: `scope_match`, `conditions[]` e `aggregations[]`. Cada entrada de condição contém `field`, `operator`, `expected_value`, o `current_value` lido da transação, `matched`, `group_index` e `group_logic`. Cada entrada de agregação (velocidade / contagem / soma) contém `metric`, `field`, `operator`, `expected_value`, o `computed_value` resultante da agregação, `window`, `filters`, `matched` e `sample_references`; agregações assíncronas adiadas têm `computed_value: null` e `deferred: true`. Um grupo de condições aninhado é uma entrada de `conditions[]` com `operator` `any_of` ou `all_of`, `field` nulo e os resultados dos seus membros em seu próprio `conditions`." }, "created_at": { "type": "string", "format": "date-time" } } }, "description": "Resultados de execução por regra: qual regra foi acionada e com qual impacto na pontuação." }, "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 bruto da resposta do provedor." }, "created_at": { "type": "string", "format": "date-time" } } }, "description": "Payloads brutos dos provedores (Análise AML, análise de blockchain etc.)." }, "travel_rule": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/TransactionTravelRule" } ], "description": "Transferência ou verificação da Travel Rule. Preenchido quando `travel_rule_details` foi enviado e também quando a Travel Rule está ativada e a transação foi criada com `transaction_category: travelRule` (a própria Didit inicia a troca, mesmo sem `travel_rule_details`). `null` quando não existe transferência nem verificação. Em uma transferência de entrada, os `originator_data` e `beneficiary_data` da contraparte permanecem mascarados (`data_masked: true`) até que a propriedade da carteira seja confirmada." }, "network_snapshot": { "type": "object", "nullable": true, "description": "Snapshot do grafo de transações/partes relacionadas usado pelo motor de regras. É o `network_snapshot` enviado com a transação ou o grafo que a Didit constrói a partir de uma triagem AML de carteira bem-sucedida (que substitui o enviado). `null` quando nenhum dos dois existe.", "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": "Sessão de correção oferecida ao usuário quando a reverificação é necessária. Substituída por `action_required`, que é o bloco canônico; mantida por compatibilidade com versões anteriores.", "properties": { "session_id": { "type": "string" }, "session_token": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "status": { "type": "string" } } }, "action_required": { "type": "object", "nullable": true, "description": "Ação pendente do usuário final necessária para concluir esta transação, ou null quando não houver nenhuma. Os SDKs da Didit iniciam a ação automaticamente por padrão e atualizam a transação quando ela termina. Há duas variantes, diferenciadas por `type`: `verification_session` (uma sessão de verificação hospedada criada por uma ação de regra) e `wallet_ownership` (uma sessão do widget de propriedade da carteira gerada automaticamente para uma transferência da Travel Rule que exige prova de controle da carteira, condicionada à configuração `auto_wallet_verification` da Travel Rule). Quando ambas puderem se aplicar, `wallet_ownership` tem precedência, pois bloqueia a troca da 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": "Custo desta transação: `total_price` e `items`, um por cobrança, cada um com `usage_type`, `price`, `details` e `created_at`. Uma nova triagem da mesma transação gera um novo item." } } }, "TravelRuleSettingsDetail": { "type": "object", "properties": { "is_enabled": { "type": "boolean", "description": "Se o fluxo gerenciado de negociação da Travel Rule está ativo para transações `travelRule` de saída nesta aplicação." }, "jurisdiction": { "type": "string", "maxLength": 8, "description": "Código da jurisdição em que sua VASP opera. Padrão `\"EU\"`. A Didit o associa ao regime que registra nas suas transações de Travel Rule como `travel_rule_regime` (por exemplo, `EU` ou o código de um Estado-membro da UE se torna `eu`), que as regras de transação podem usar como critério. Outros clientes da Didit o veem como sua jurisdição no diretório de VASPs assim que a rede Didit listar seu perfil." }, "name_matching_strictness": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Com que rigor os nomes dos beneficiários devem corresponder antes que uma transferência possa chegar a COMPLETED. `CONTAINS` aceita um nome cujas palavras aparecem todas no outro." }, "confirmation_timeout_hours": { "type": "integer", "minimum": 1, "description": "Horas que uma transferência AWAITING_COUNTERPARTY pode permanecer sem confirmação antes que o processo periódico de varredura a expire. Padrão: 48." }, "timeout_outcome": { "type": "string", "enum": [ "HOLD", "REJECT", "PROCEED" ], "description": "O que acontece com a transação subjacente quando uma transferência expira. Padrão: HOLD. sunrise_policy e non_responsive_policy têm precedência quando se aplicam e estão definidas." }, "threshold_amount": { "type": "string", "description": "String decimal, na moeda padrão da sua aplicação. Valor mínimo de transferência que aciona uma troca gerenciada; transferências abaixo dele são resolvidas diretamente como NOT_APPLICABLE. A Didit compara o valor da transação convertido para a sua moeda padrão, ou o `amount_in_default_currency` que você envia; quando nenhum valor convertido está disponível, o limiar não se aplica. O padrão é \"0.00\" (o EU TFR não aplica valor mínimo)." }, "ownership_validation_mode": { "type": "string", "enum": [ "FULL", "SIMPLIFIED", "AUTOMATED" ], "description": "Quanta comprovação a propriedade de uma carteira exige. `FULL` sempre exige uma comprovação (mensagem assinada, depósito de teste ou captura de tela revisada), nunca a palavra do usuário final. `SIMPLIFIED` aceita uma autodeclaração abaixo de `simplified_validation_threshold` e uma comprovação acima dele. `AUTOMATED` permite que o catálogo de endereços e as comprovações anteriores respondam por conta própria, incluindo autodeclarações enquanto `allow_self_declaration` for true. Padrão `AUTOMATED`." }, "simplified_validation_threshold": { "type": "string", "description": "String decimal, padrão \"0.00\". No modo `SIMPLIFIED`, uma transferência abaixo desse valor (na moeda do limiar) aceita uma autodeclaração. Uma transferência sem valor nessa moeda conta como acima dele." }, "data_sharing_fields": { "$ref": "#/components/schemas/TravelRuleDataSharingFields" }, "matching_rules": { "$ref": "#/components/schemas/TravelRuleMatchingRules" }, "legal_name": { "type": "string", "description": "Razão social do seu VASP. Obrigatório (não pode ficar em branco) para definir is_enabled como true." }, "lei": { "type": "string", "description": "Seu Legal Entity Identifier, exibido no diretório de VASPs." }, "compliance_email": { "type": "string", "format": "email", "description": "E-mail de contato de conformidade do seu perfil de VASP. A rede Didit só lista seu perfil depois que esse endereço é confirmado por meio de um link enviado por e-mail (POST /v3/travel-rule/settings/compliance-email/confirmation/); alterá-lo exige uma nova confirmação." }, "is_discoverable": { "type": "boolean", "description": "Se o seu perfil de VASP pode ser listado na rede Didit: encontrado em GET /v3/travel-rule/vasps/ por outros clientes da Didit e acessado pelo rail INTERNAL. A listagem também exige uma aplicação de produção, a Travel Rule ativada, uma razão social e um e-mail de conformidade confirmado; didit_network indica quais deles estão faltando. Padrão: true." }, "inbound_auto_accept": { "type": "boolean", "description": "Quando verdadeiro, uma consulta TRP de entrada cuja carteira do beneficiário é uma entrada verificada do catálogo de endereços com nome correspondente é aprovada automaticamente. Quando falso, essa consulta fica em ON_HOLD até que você a aprove ou recuse com o endpoint de propriedade. Transferências pela via INTERNAL e após depósito não são afetadas. Padrão: verdadeiro." }, "allow_self_declaration": { "type": "boolean", "description": "Quando verdadeiro, o widget de propriedade de carteira oferece a autodeclaração como método de prova alternativo. Padrão: verdadeiro." }, "allow_screenshot_proof": { "type": "boolean", "description": "Quando verdadeiro, o widget de propriedade de carteira oferece o envio de captura de tela como método de evidência de propriedade. Padrão: verdadeiro." }, "auto_wallet_verification": { "type": "boolean", "description": "Quando verdadeiro, o envio de uma transferência de saída da Travel Rule que exige prova de controle da carteira pelo usuário final cria automaticamente uma sessão do widget de propriedade de carteira vinculada à transação e a expõe no bloco action_required da transação. Padrão: verdadeiro." }, "vasp_attribution_enabled": { "type": "boolean", "description": "Quando verdadeiro, uma transferência de saída da Travel Rule que nenhuma via consegue rotear é atribuída por meio de análise de blockchain: a carteira de destino é associada ao VASP que a controla, a entidade é registrada na transferência e no diretório de VASPs, e as vias são executadas novamente uma vez com o nome atribuído. Padrão: verdadeiro." }, "counterparty_screening_enabled": { "type": "boolean", "description": "Análise opcional de sanções e mídia adversa de VASPs contraparte, cobrada por análise ao preço da Análise AML de empresas. Quando ativada, a Didit analisa a contraparte alcançada por uma troca de saída (reutilizando uma análise com menos de 30 dias) e você pode analisar uma com POST /v3/travel-rule/vasps/{vasp_id}/screening/. Padrão false: nada é analisado nem cobrado." }, "sunrise_policy": { "type": "string", "enum": [ "", "HOLD", "REJECT", "PROCEED" ], "description": "O efeito de uma transferência expirada sobre a sua transação quando a contraparte é uma entrada do diretório em uma jurisdição listada em sunrise_jurisdictions, que ainda não aplica a Travel Rule: HOLD a envia para revisão, REJECT a recusa, PROCEED mantém o status dela inalterado. Vazio (o padrão) segue timeout_outcome. Aplica-se antes de non_responsive_policy." }, "sunrise_jurisdictions": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "Somente leitura. Os países (ISO 3166 alpha-2) que a Didit considera em período de sunrise da Travel Rule, nos quais sunrise_policy se aplica. Atualmente CO, KH e VN. Qualquer outra jurisdição, assim como uma vazia ou desconhecida, segue timeout_outcome." }, "non_responsive_policy": { "type": "string", "enum": [ "", "HOLD", "REJECT", "PROCEED" ], "description": "O efeito de uma transferência expirada sobre a sua transação quando a contraparte é uma entrada do diretório cuja responsividade é UNRESPONSIVE: HOLD, REJECT ou PROCEED, como em timeout_outcome. Vazio (o padrão) segue timeout_outcome. sunrise_policy se aplica primeiro quando ambas se encaixam." }, "travel_address": { "type": "string", "description": "Somente leitura. O travel address do seu próprio VASP - o endpoint codificado de consultas TRP de entrada que outros VASPs usam para chegar até você. Vazio enquanto `is_enabled` for false." }, "disabled_networks": { "type": "array", "items": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA" ] }, "description": "Redes em que a associação da plataforma foi desativada (opt-out). Não desativa as suas próprias associações conectadas nem provisiona redes indisponíveis.", "default": [] }, "networks": { "type": "object", "readOnly": true, "description": "Por rede, como esta aplicação faria o envio e por que não consegue. Nenhuma rede, incluindo a GTR, é incluída por padrão: uma rede fica acessível por meio da sua própria associação conectada, ou por meio da associação da Didit assim que a associação da Didit a essa rede estiver ativa e o seu próprio participante nela estiver ativo. Não é uma verificação em tempo real de funcionamento ou de entrega.", "properties": { "gtr": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "trust": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "verifyvasp": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "sygna": { "$ref": "#/components/schemas/TravelRuleNetworkState" } } }, "didit_network": { "type": "object", "readOnly": true, "description": "Se a rede Didit lista o seu perfil de VASP, para que outros clientes da Didit o encontrem no diretório e o alcancem pelo trilho INTERNAL, e cada condição que ainda não é atendida.", "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": "Vazio quando listado. compliance_email_unconfirmed: envie a confirmação com POST /v3/travel-rule/settings/compliance-email/confirmation/ e abra o link recebido por e-mail. excluded_by_staff: a Didit marcou a aplicação como de teste, de demonstração ou interna." }, "compliance_email_confirmed": { "type": "boolean", "description": "Se o compliance_email atual foi confirmado pelo link enviado por e-mail." } } } } }, "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` aceita um nome cujas palavras aparecem todas no outro." }, "confirmation_timeout_hours": { "type": "integer", "minimum": 1 }, "timeout_outcome": { "type": "string", "enum": [ "HOLD", "REJECT", "PROCEED" ] }, "compliance_email": { "type": "string", "format": "email", "description": "E-mail de contato de conformidade do seu perfil de VASP. A rede Didit só lista seu perfil depois que esse endereço é confirmado por meio de um link enviado por e-mail (POST /v3/travel-rule/settings/compliance-email/confirmation/); alterá-lo exige uma nova confirmação." }, "is_discoverable": { "type": "boolean", "description": "Se o seu perfil de VASP pode ser listado na rede Didit: encontrado em GET /v3/travel-rule/vasps/ por outros clientes da Didit e acessado pelo rail INTERNAL. A listagem também exige uma aplicação de produção, a Travel Rule ativada, uma razão social e um e-mail de conformidade confirmado; didit_network indica quais deles estão faltando. Padrão: true." }, "threshold_amount": { "type": "string", "description": "String decimal, zero ou maior, na moeda padrão da sua aplicação. Valor mínimo de transferência que aciona uma troca gerenciada." }, "ownership_validation_mode": { "type": "string", "enum": [ "FULL", "SIMPLIFIED", "AUTOMATED" ], "description": "Veja o campo da resposta com o mesmo nome." }, "simplified_validation_threshold": { "type": "string", "description": "String decimal, 0 ou mais." }, "data_sharing_fields": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleDataSharingFields" } ], "description": "Mesclado por tipo de entidade: um tipo de entidade que você omitir mantém a escolha atual. Uma escolha que não atenda às obrigações relativas ao remetente do regime da sua `jurisdiction` (EU TFR ou Recomendação 16 do FATF), incluindo uma lista vazia, é recusada com `400`." }, "matching_rules": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleMatchingRules" } ], "description": "Mesclado por tipo de entidade e, dentro dele, por campo. Um campo que esse tipo de entidade não compara (por exemplo, `date_of_birth` para `company`) é recusado com `400`." }, "inbound_auto_accept": { "type": "boolean" }, "allow_self_declaration": { "type": "boolean" }, "allow_screenshot_proof": { "type": "boolean", "description": "Quando verdadeiro, o widget de propriedade de carteira oferece o envio de captura de tela como método de evidência de propriedade. Padrão: verdadeiro." }, "auto_wallet_verification": { "type": "boolean" }, "vasp_attribution_enabled": { "type": "boolean" }, "counterparty_screening_enabled": { "type": "boolean", "description": "Análise opcional de sanções e mídia adversa de VASPs contraparte, cobrada por análise ao preço da Análise AML de empresas. Quando ativada, a Didit analisa a contraparte alcançada por uma troca de saída (reutilizando uma análise com menos de 30 dias) e você pode analisar uma com POST /v3/travel-rule/vasps/{vasp_id}/screening/. Padrão false: nada é analisado nem cobrado." }, "sunrise_policy": { "type": "string", "enum": [ "", "HOLD", "REJECT", "PROCEED" ], "description": "HOLD, REJECT, PROCEED ou vazio para seguir timeout_outcome. Consulte o campo de resposta de mesmo nome." }, "non_responsive_policy": { "type": "string", "enum": [ "", "HOLD", "REJECT", "PROCEED" ], "description": "HOLD, REJECT, PROCEED ou vazio para seguir timeout_outcome. Consulte o campo de resposta de mesmo nome." }, "disabled_networks": { "type": "array", "items": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA" ] }, "description": "Redes em que a associação da plataforma foi desativada (opt-out). Não desativa as suas próprias associações conectadas nem provisiona redes indisponíveis.", "default": [] } }, "description": "Todos os campos são opcionais; o PUT aplica uma atualização parcial." }, "WalletAddressEntry": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "address": { "type": "string", "description": "O endereço da carteira; `\"\"` para uma entrada importada apenas pelo hash. Único por aplicação, cadeia e memo, comparando o endereço sem diferenciar maiúsculas de minúsculas. Depois de excluir uma entrada, você pode registrar o mesmo endereço novamente." }, "chain": { "type": "string", "description": "Token de blockchain do endereço, por exemplo, `ETH` ou `BTC`. Quando a Didit roteia ou registra uma transferência, ela faz a correspondência das entradas do catálogo de endereços pelo endereço da carteira e, quando a transferência informa uma blockchain, também por este valor, sem distinção entre maiúsculas e minúsculas. A blockchain de uma transferência é `beneficiary_data.chain`, preenchida a partir da blockchain cripto ou do símbolo da moeda da transação (por exemplo, `ETH`) quando você não a envia, ou o `chain` de um registro pós-depósito, portanto use o mesmo token em todos os lugares. Uma entrada com blockchain vazia corresponde a qualquer blockchain. Um beneficiário Lightning (um id de nó ou um Lightning Address) registrado em bitcoin é armazenado em minúsculas em `LIGHTNING`, onde as transferências Lightning são correspondidas. Blockchains conhecidas são armazenadas sob um único identificador canônico, independentemente da grafia enviada: \"ethereum\", \"Ethereum\" e \"ERC20\" são todos armazenados como ETH, \"BNB Smart Chain\" e \"BEP20\" como BNB, \"tron\" como TRX. Um nome de blockchain desconhecido é mantido como enviado." }, "holder_vendor_data": { "type": "string", "description": "Seu identificador interno para o titular." }, "holder_name": { "type": "string", "description": "Nome do titular da carteira, usado na correspondência do nome do beneficiário." }, "entity_type": { "type": "string", "description": "Texto livre; o padrão é \"individual\"." }, "is_ownership_verified": { "type": "boolean", "description": "Somente leitura. Indica se a propriedade deste endereço foi comprovada." }, "created_at": { "type": "string", "format": "date-time" }, "travel_address": { "type": "string", "description": "O endereço de viagem (travel address) do VASP da contraparte para esta carteira, se conhecido. Permite que a Didit encaminhe as transferências deste beneficiário pelo canal TRP, para os ativos que o TRP suporta (BTC, ETH e USDC em uma rede especificada)." }, "address_hash": { "type": "string", "description": "Somente leitura. SHA-256 do endereço em minúsculas, em hexadecimal minúsculo. Uma entrada importada apenas pelo hash é correspondida por ele." }, "memo": { "type": "string", "description": "A destination tag ou o memo que faz parte da carteira em uma rede com memo (XRP, XLM, EOS, ATOM, HBAR); `\"\"` para o endereço inteiro. Uma entrada com memo corresponde apenas a transferências que indicam esse memo; uma sem memo corresponde ao endereço inteiro." }, "receiving_travel_address": { "type": "string", "readOnly": true, "description": "Seu travel address por carteira para esta carteira: informe-o ao VASP remetente para que a consulta TRP dele indique esta carteira. Vazio para uma carteira registrada como de outro VASP, enquanto a Travel Rule estiver desativada e antes de o perfil do seu VASP ser salvo." } } }, "WalletAddressEntryCreate": { "type": "object", "required": [ "address" ], "properties": { "address": { "type": "string", "maxLength": 128, "description": "O endereço da carteira. Um X-address da XRP é armazenado como seu endereço clássico e sua tag, para que corresponda a transferências que indiquem qualquer uma das formas." }, "chain": { "type": "string", "maxLength": 32, "description": "Token da rede (chain) do endereço, por exemplo `ETH` ou `BTC`. Quando a Didit roteia ou registra uma transferência, ela associa as entradas do catálogo de endereços pelo endereço da carteira e, quando a transferência informa uma rede, também por este valor, sem diferenciar maiúsculas de minúsculas. A rede de uma transferência é `beneficiary_data.chain`, preenchida a partir da rede cripto ou do símbolo da moeda da transação (por exemplo `ETH`) quando você não a envia, ou o `chain` de um registro pós-depósito; por isso, use o mesmo token em todos os lugares. Uma entrada com rede vazia corresponde a qualquer rede. Redes conhecidas são armazenadas com um único identificador canônico, seja qual for a grafia enviada: \"ethereum\", \"Ethereum\" e \"ERC20\" são todos armazenados como ETH, \"BNB Smart Chain\" e \"BEP20\" como BNB, \"tron\" como TRX. Um nome de rede desconhecido é mantido como foi informado." }, "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": "Somente escrita. Quando true, a entrada é criada já com a propriedade verificada por meio de uma prova SELF_DECLARATION. Retorna 400 quando `allow_self_declaration` está desativado nas suas configurações de Travel Rule." }, "travel_address": { "type": "string", "description": "Opcional. O travel address do VASP da contraparte para esta carteira, que habilita o roteamento TRP para os ativos que o TRP transporta (BTC, ETH e USDC em uma rede nomeada). Um travel address inválido retorna 400.", "maxLength": 512 }, "memo": { "type": "string", "maxLength": 256, "description": "Opcional. A tag de destino ou o memo que faz parte da carteira. XRP: uma tag de destino, um número inteiro de 0 a 4294967295 (um número JSON é aceito). XLM: um memo de texto de até 28 bytes, um id de 64 bits ou um hash de 32 bytes em hexadecimal. EOS: até 256 bytes. ATOM: até 256 caracteres. HBAR: até 100 bytes. Carteiras Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin e Lightning não aceitam memo: enviar um nelas resulta em `400`. Alias: `destinationTag` ou `destination_tag`." } } }, "WalletAddressEntryUpdate": { "type": "object", "properties": { "holder_name": { "type": "string", "maxLength": 255 }, "holder_vendor_data": { "type": "string", "maxLength": 255 }, "entity_type": { "type": "string", "maxLength": 16 }, "travel_address": { "type": "string", "maxLength": 512 } }, "description": "PATCH é uma atualização parcial; a resposta retorna apenas holder_name, holder_vendor_data, entity_type, travel_address, receiving_travel_address, label e owner_type." }, "TravelRuleTransferDetail": { "type": "object", "description": "Objeto de transferência completo retornado pelos endpoints de confirmação de propriedade e de finalização/cancelamento. Enquanto a propriedade da carteira de uma transferência recebida não for confirmada, os campos `originator_data` e `beneficiary_data` da contraparte são retornados mascarados (a primeira letra de cada palavra é mantida; a carteira, a blockchain e o roteamento do VASP continuam legíveis) e `data_masked` é true.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "AWAITING_COUNTERPARTY", "ON_HOLD", "COMPLETED", "FINISHED", "CANCELLED", "EXPIRED", "COUNTERPARTY_MISMATCHED_DATA", "COUNTERPARTY_VASP_NOT_FOUND", "COUNTERPARTY_VASP_NOT_REACHABLE", "UNCONFIRMED_OWNERSHIP", "COUNTERPARTY_VASP_GENERAL_DECLINE", "NOT_ENOUGH_COUNTERPARTY_DATA", "NOT_APPLICABLE" ] }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] }, "rail": { "type": "string", "nullable": true, "enum": [ "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL", "TEST_VASP", null ], "description": "O canal pelo qual a transferência foi roteada, ou null quando nenhum canal foi selecionado (por exemplo, abaixo do limiar, uma carteira autocustodiada da contraparte, um registro após o depósito ou nenhuma contraparte alcançável). INTERNAL significa que ambos os lados são aplicações da Didit; EMAIL significa que a contraparte foi alcançada por um link de retirada enviado por e-mail. TEST_VASP significa que o Didit Test VASP respondeu à transferência no sandbox. Em GTR, VERIFYVASP e SYGNA, a Didit lê a resposta da contraparte a partir da resposta da rede ou consultando-a a cada 5 minutos. TRUST apenas envia, portanto uma transferência TRUST permanece em AWAITING_COUNTERPARTY até expirar. Um canal de rede só é usado quando você conectou sua própria associação a essa rede. Ele é escolhido depois que a criação da transação retorna, por isso é null nessa resposta." }, "protocol": { "type": "string", "nullable": true }, "ivms_version": { "type": "string", "example": "ivms101.2023" }, "required": { "type": "boolean" }, "ownership_confirmed": { "type": "boolean", "nullable": true }, "deadline_at": { "type": "string", "format": "date-time", "nullable": true }, "timeline": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "at": { "type": "string", "format": "date-time" }, "detail": { "type": "string" }, "name_match": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleNameMatch" } ], "nullable": true, "description": "A comparação de nomes que esta entrada decidiu, ao lado de `detail`. Ausente nas entradas que não compararam nenhum nome." }, "reason": { "type": "string", "description": "Presente somente na entrada de uma transição causada por uma falha de entrega: `email_undeliverable` ou `delivery_failed`, o valor que o `reason` da transferência informa." } } } }, "counterparty_vasp": { "type": "object", "nullable": true, "properties": { "name": { "type": "string" }, "lei": { "type": "string" }, "dd_score": { "type": "integer", "description": "Pontuação de due diligence de 0 a 100, em que valores maiores são melhores. Mesma escala do diretório de VASPs." }, "dd_score_breakdown": { "type": "object", "description": "Contribuições de cada componente para o dd_score, um objeto por componente, como no diretório de VASPs (jurisdiction, verification, protocol, lei, history, essentials, responsiveness), cada um com {points, max, reason, detail}. {} até que a contraparte tenha sido avaliada.", "additionalProperties": { "type": "object", "properties": { "points": { "type": "number", "description": "Pontos atribuídos a este componente." }, "max": { "type": "integer", "description": "Pontuação máxima que este componente pode conceder." }, "reason": { "type": "string", "description": "Código legível por máquina do veredito do componente." }, "detail": { "type": "string", "description": "Motivo legível dos pontos atribuídos." } } } }, "dd_assessed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a avaliação de devida diligência foi executada pela última vez. Nulo até que a contraparte tenha sido avaliada." } } }, "originator_data": { "type": "object", "description": "Parte remetente. Em uma transferência de entrada, os valores da contraparte ficam mascarados até que a propriedade seja confirmada." }, "beneficiary_data": { "type": "object", "description": "Parte beneficiária. Em uma transferência recebida, os valores da contraparte ficam mascarados até que a propriedade seja confirmada." }, "name_match": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleNameMatch" } ], "nullable": true, "description": "A comparação de nomes que decidiu a transferência, ou nula até que uma seja executada. Enquanto as partes estão mascaradas, e na cópia do outro cliente de uma troca INTERNAL, `transfer_name`, `compared_name`, `matched_names` e `mismatched_names` ficam ocultos. `score` e `matched` podem divergir: `matched` segue o rigor, enquanto `score` é a similaridade entre os dois nomes completos." }, "data_match": { "$ref": "#/components/schemas/TravelRuleDataMatch" }, "mismatched_fields": { "type": "array", "items": { "type": "string" }, "description": "Atalho para `data_match.mismatched_fields`. Vazio quando nada difere." }, "data_unmasked": { "$ref": "#/components/schemas/TravelRuleDataUnmasked" }, "data_masked": { "type": "boolean", "description": "True enquanto os dados pessoais da contraparte estão mascarados nesta resposta." }, "created_at": { "type": "string", "format": "date-time" }, "delivery": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/TravelRuleDelivery" } ], "description": "Situação da mensagem mais recente que esta transferência deve à outra parte. Nulo quando a transferência nunca deveu uma mensagem (por exemplo, abaixo de `threshold_amount`, em uma carteira autocustodiada declarada ou em um registro de sunrise)." }, "discovery": { "type": "array", "description": "Como a Didit procurou a contraparte, com uma entrada por etapa executada. Vazio quando nenhuma descoberta foi executada, por exemplo, em uma transferência de entrada.", "items": { "$ref": "#/components/schemas/TravelRuleDiscoveryStep" } }, "reason": { "type": "string", "description": "Motivo pelo qual uma transferência `COUNTERPARTY_VASP_NOT_FOUND` ou `COUNTERPARTY_VASP_NOT_REACHABLE` está parada; `\"\"` para qualquer outro status. Uma falha de entrega decide primeiro, apenas em `COUNTERPARTY_VASP_NOT_REACHABLE`: `email_undeliverable` (o provedor de e-mail recusou o e-mail de conformidade e não resta nenhum endereço para tentar: no envio, em um lembrete ou como uma devolução permanente informada depois) ou `delivery_failed` (o canal que fazia a entrega falhou definitivamente: um canal de rede recusou a mensagem ou esgotou as novas tentativas, um host de identidade `TRP` não respondeu ou o host `TRP` da contraparte não aceitou a consulta). Caso contrário, o rastro de `discovery` decide: `awaiting_end_user` (nenhuma etapa indicou uma contraparte que a Didit consiga alcançar), `directory_match_no_route` (uma etapa indicou um VASP do diretório que não tem rota), `picked_member_without_proven_wallet` (o usuário final escolheu um cliente da Didit que não comprovou o controle da carteira) ou `no_directory_match` quando o rastro não indica nenhum outro motivo. Um reenvio faz a transferência avançar, e o motivo é então limpo. Veja [Por que uma transferência está parada](/pt-br/transaction-monitoring/travel-rule#por-que-uma-transferência-fica-travada)." }, "next_actions": { "type": "array", "description": "O que faz a transferência avançar; `[]` para qualquer status que não seja `COUNTERPARTY_VASP_NOT_FOUND` ou `COUNTERPARTY_VASP_NOT_REACHABLE`. `email_undeliverable` oferece `update_compliance_email` e depois `resend`. `delivery_failed` oferece `resend`. Um motivo de descoberta oferece `select_counterparty_vasp`, `declare_self_hosted`, `add_vasp_hint` e `resend`.", "items": { "$ref": "#/components/schemas/TravelRuleNextAction" } }, "chain_details": { "$ref": "#/components/schemas/TravelRuleChainDetails" } } }, "TravelRuleOwnershipConfirmRequest": { "type": "object", "required": [ "confirmed" ], "properties": { "confirmed": { "type": "boolean", "description": "true para confirmar a propriedade, false para negá-la." }, "wallet_address": { "type": "string", "default": "", "description": "Transferências TRP recebidas: o endereço de pagamento que a Didit retorna ao VASP de origem quando você aprova. O padrão é o endereço da entrada correspondente no catálogo de endereços e, depois, beneficiary_data.wallet_address. Em uma transferência declarada de carteira autocustodiada que não indica nenhuma carteira da contraparte, é a carteira cuja propriedade você verificou; sem ela, a requisição é rejeitada com 400. Ignorado nas demais transferências." } } }, "TravelRuleTransferPatchRequest": { "type": "object", "description": "Informe exatamente um destes: payment_txn_id (finalizar), action=cancel, action=resend, action=update_compliance_email com compliance_email, action=update_originator_wallet com wallet_address ou action=beneficiary_vasp com beneficiary_vasp.", "properties": { "payment_txn_id": { "type": "string", "description": "O hash da transação on-chain. Exige que a transferência seja uma transferência de saída com status COMPLETED." }, "action": { "type": "string", "enum": [ "cancel", "resend", "update_compliance_email", "update_originator_wallet", "beneficiary_vasp" ], "description": "\"cancel\" cancela uma transferência que ainda não está em estado final. \"resend\" executa novamente o roteamento de uma transferência de saída parada em COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE ou NOT_ENOUGH_COUNTERPARTY_DATA. \"update_compliance_email\" substitui o e-mail de conformidade para o qual a requisição é enviada, em uma transferência de saída em um desses três status; envie \"resend\" em seguida. \"update_originator_wallet\" registra a carteira da qual os fundos realmente saíram (`wallet_address`, `memo`). \"beneficiary_vasp\" permite que você mesmo indique o VASP da contraparte (exige `beneficiary_vasp`) para uma transferência de saída em um desses status: ela é roteada para esse VASP e enviada novamente." }, "compliance_email": { "type": "string", "format": "email", "maxLength": 254, "description": "Obrigatório com `action: update_compliance_email`. Armazenado como `beneficiary_data.counterparty_vasp_email` desta transferência: pertence apenas a esta transferência e não é adicionado a nenhuma entrada do diretório nem a nenhuma lista de contatos." }, "wallet_address": { "type": "string", "maxLength": 128, "description": "Com `action: update_originator_wallet`: a carteira de onde os fundos saíram. Quando as entradas UTXO da transferência são conhecidas, ela deve ser uma delas." }, "memo": { "type": "string", "maxLength": 256, "description": "Com `action: update_originator_wallet`: o memo ou tag da carteira em uma rede que usa memo. Opcional." }, "beneficiary_vasp": { "type": "string", "format": "uuid", "description": "Obrigatório com action=beneficiary_vasp: o `id` de um VASP do diretório, obtido em `GET /v3/travel-rule/vasps/`. Sua escolha tem prioridade sobre todas as etapas de descoberta automática, que nunca a substituem." } } }, "VaspDirectoryEntry": { "type": "object", "description": "Um VASP do diretório ou um membro da rede Didit, com as rotas que sua aplicação tem até ele. Um cliente é membro da rede Didit somente enquanto sua aplicação estiver em produção, sua Travel Rule estiver ativada, seu perfil for localizável, tiver uma razão social e um e-mail de conformidade confirmado, e a Didit não tiver marcado a aplicação como de teste, demonstração ou interna. Cada linha também traz a avaliação de due diligence compartilhada (dd_score, risk_level, responsiveness, essential_checks) e a decisão, a triagem da entidade e os questionários da sua própria aplicação, que nenhum outro cliente vê.", "properties": { "id": { "type": "string", "format": "uuid", "description": "O id da entrada, para GET /v3/travel-rule/vasps/{vasp_id}/." }, "kind": { "type": "string", "enum": [ "directory", "didit" ], "description": "directory para uma entrada do diretório compartilhado; didit para um membro da rede Didit." }, "name": { "type": "string" }, "lei": { "type": "string" }, "jurisdiction": { "type": "string", "description": "Código de país ISO 3166, conforme informado pela fonte." }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Os domínios web do VASP. Sempre vazio para membros da rede Didit." }, "reachable": { "type": "boolean", "description": "Se a sua aplicação tem uma rota disponível até este VASP ou, no caso de uma marca, até uma de suas entidades. Sempre true para um membro da rede Didit, exceto em uma aplicação de sandbox, onde todas as linhas são 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 (do registro global de LEI), network_name (o nome em uma rede de Travel Rule), attribution (o nome da entidade que a análise de blockchain atribui às carteiras do VASP), merged (o nome de uma entrada duplicada mesclada nesta) ou staff." } } }, "description": "Outros nomes pelos quais o VASP é conhecido." }, "networks": { "type": "array", "items": { "type": "object", "description": "Uma listagem atual deste VASP no diretório de membros de uma rede de Travel Rule. Uma listagem na TRISA indica quem o VASP é na TRISA; a Didit não tem canal TRISA, então ela nunca é uma rota.", "properties": { "network": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA", "TRISA" ] }, "code": { "type": "string", "description": "O identificador do VASP nessa rede." }, "listed_name": { "type": "string", "description": "O nome sob o qual a rede lista o VASP." }, "country": { "type": "string", "description": "O país informado pela rede, quando ela informa um." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a equipe da Didit verificou a listagem. Nulo para listagens lidas de um diretório público." }, "last_seen_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a fonte exibiu a listagem pela última vez. Uma listagem que a fonte não exibe há três semanas é removida." }, "source": { "type": "string", "enum": [ "trisa_directory", "staff" ], "description": "Origem da listagem: o diretório público da TRISA ou a equipe da Didit." } } } }, "routes": { "type": "array", "items": { "type": "object", "description": "Uma forma pela qual sua aplicação pode entregar dados de Travel Rule a este VASP, na ordem em que o envio as tenta. Uma rota de rede exige uma associação a essa rede: a sua própria (conectada no Marketplace) ou a da Didit, quando a Didit tiver uma. Sem ela, a rota é listada como indisponível, com o motivo, e nunca como uma forma de alcançar o VASP.", "properties": { "rail": { "type": "string", "enum": [ "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL" ] }, "status": { "type": "string", "enum": [ "available", "unavailable" ] }, "reason": { "type": "string", "enum": [ "", "no_membership", "network_switched_off", "sandbox_application" ], "description": "Por que uma rota indisponível não pode ser usada: no_membership (nem você nem a Didit têm associação nessa rede), network_switched_off (você desativou essa rede nas suas configurações) ou sandbox_application (uma aplicação sandbox envia apenas para o Didit Test VASP, então nenhuma rota está disponível para ela). Vazio quando a rota está disponível." }, "via": { "type": "string", "enum": [ "", "own_membership", "didit_membership", "directory", "contact", "didit_network" ], "description": "Como uma rota disponível é alcançada: own_membership ou didit_membership para um trilho de rede, directory para um endpoint TRP verificado pelo diretório, contact para o trilho EMAIL, didit_network para um membro da rede Didit. Vazio quando a rota não está disponível." } } } }, "umbrella": { "type": "object", "nullable": true, "description": "A marca da qual esta entrada é uma entidade regulada. Nulo quando não faz parte de nenhuma.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "entities": { "type": "array", "items": { "type": "object", "description": "Uma entidade regulada de uma marca: a entidade jurídica que recebe uma transferência.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "lei": { "type": "string" }, "jurisdiction": { "type": "string" }, "reachable": { "type": "boolean", "description": "Se a sua aplicação tem uma rota disponível até ele." } } }, "description": "Para uma marca, as entidades reguladas que recebem as suas transferências. Uma transferência que indica a marca vai para a entidade acessível na jurisdição que ela informa (beneficiary_data.counterparty_vasp_jurisdiction); caso contrário, para a entidade que a atribuição da análise de blockchain vinculou à carteira de destino; caso contrário, para a única entidade acessível quando nenhuma jurisdição é informada. Nunca se escolhe por suposição entre duas entidades que se encaixam igualmente." }, "contacts": { "type": "array", "items": { "type": "object", "description": "Um contato de conformidade para o qual o canal EMAIL pode escrever.", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" }, "source": { "type": "string", "enum": [ "staff", "application", "learned" ], "description": "staff: curado pela Didit; application: adicionado pela sua aplicação; learned: um endereço que respondeu a uma requisição de Travel Rule pelo link de resposta." }, "scope": { "type": "string", "enum": [ "platform", "application" ], "description": "Os contatos platform são usados nas transferências de todos os clientes da Didit; os contatos application são privados da sua aplicação, que vê apenas os próprios." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando alguém neste endereço respondeu a uma requisição. Nulo enquanto ainda não tiver respondido." } } }, "description": "Os contatos da plataforma para este VASP e os da sua própria aplicação." }, "dd_status": { "type": "string", "enum": [ "NOT_STARTED", "IN_PROGRESS", "COMPLETED", "REJECTED" ], "description": "Status de verificação da entrada atribuído pela Didit, pontuado pelo componente de verificação do dd_score. Sempre COMPLETED para um membro da rede Didit." }, "dd_score": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 100, "description": "A pontuação de due diligence compartilhada de uma entrada do diretório, de 0 a 100, em que valores mais altos são mais seguros (veja dd_score_semantic): a soma dos pontos em dd_score_breakdown. Nula para um membro da rede Didit, que não é pontuado. Uma entrada ainda não avaliada (dd_assessed_at nulo) mostra 0 com risk_level vazio, então leia risk_level em vez da pontuação bruta." }, "reachable_rails": { "type": "array", "items": { "type": "string", "enum": [ "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL" ] }, "description": "Canais registrados na entrada. Consulte as rotas para ver o que sua aplicação pode usar hoje." }, "is_didit_customer": { "type": "boolean", "description": "true para um membro da rede Didit (para esses, dd_status é sempre COMPLETED, dd_score é null e risk_level fica vazio) e para uma entrada do diretório vinculada a um cliente da Didit." }, "dd_score_breakdown": { "type": "object", "description": "Um objeto por componente de dd_score. Componentes, seu peso (máximo) e seus códigos de motivo: jurisdiction, 25 (jurisdiction_not_high_risk, jurisdiction_high_risk, jurisdiction_unknown); verification, 15 (dd_status_completed, dd_status_in_progress, dd_status_not_started, dd_status_rejected); protocol, 15 (native_rail, email_only, no_rail); lei, 10 (lei_valid, lei_missing); history, 10 (history, no_history); essentials, 15 (essential_checks, no_essential_checks); responsiveness, 10 (responsive, unresponsive, responsiveness_unknown). Vazio para um membro da rede Didit.", "additionalProperties": { "type": "object", "properties": { "points": { "type": "number", "description": "Pontos com que o componente contribui, arredondados para uma casa decimal." }, "max": { "type": "integer", "description": "O peso do componente: o máximo de pontos que ele pode somar." }, "reason": { "type": "string", "description": "Código legível por máquina do veredito do componente." }, "detail": { "type": "string", "description": "Explicação de uma linha em inglês." } } } }, "dd_assessed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando dd_score, risk_level e responsiveness foram calculados pela última vez: após uma troca com a entrada ser concluída, finalizada, expirar, apresentar divergência ou ser recusada, quando a Didit atualiza ou faz a curadoria da entrada e na atualização semanal do diretório. Nulo para um membro da rede Didit." }, "dd_score_semantic": { "type": "string", "enum": [ "higher_is_safer" ], "description": "Em que direção o dd_score aponta: sempre higher_is_safer." }, "risk_level": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH", "" ], "description": "A faixa em que dd_score se encontra: LOW (70 ou mais), MEDIUM (40 a 69) ou HIGH (abaixo de 40). Vazio para um membro da rede Didit e para uma entrada ainda não avaliada. Filtre por ela com risk. Sua própria triagem sinalizada nunca altera esse valor compartilhado: em vez disso, ela torna counterparty_risk_level HIGH nas suas regras." }, "responsiveness": { "type": "object", "description": "Se o VASP responde a requisições de Travel Rule: a proporção das requisições que clientes da Didit iniciaram para ele nos últimos 90 dias e que ele respondeu. Só contam as requisições enviadas por um trilho de rede ou de protocolo, ou por e-mail para um endereço compartilhado (o endereço de conformidade da entrada ou um contato da plataforma); uma requisição enviada para um endereço digitado por um cliente, ou para um contato privado de um cliente, nunca conta. Uma requisição expirada é considerada sem resposta; uma troca concluída, uma recusa ou uma divergência de dados é uma resposta; uma requisição cancelada ou um trilho inacessível não é nenhum dos dois. Sempre UNKNOWN com contagens zeradas para um membro da rede Didit.", "properties": { "status": { "type": "string", "enum": [ "RESPONSIVE", "UNRESPONSIVE", "UNKNOWN" ], "description": "UNKNOWN com menos de 5 requisições decididas na janela; UNRESPONSIVE quando menos de 10 por cento delas foram respondidas; RESPONSIVE nos demais casos." }, "answered": { "type": "integer", "description": "Requisições decididas na janela que o VASP respondeu." }, "total": { "type": "integer", "description": "Requisições decididas na janela: respondidas mais expiradas." }, "computed_at": { "type": "string", "format": "date-time", "nullable": true } } }, "essential_checks": { "type": "object", "description": "O relatório de verificações essenciais de uma entrada do diretório, construído apenas a partir das fontes verificadas da plataforma: registration (um registro oficial lista o VASP: o registro provisório MiCA da UE, o diretório público TRISA ou o registro global de LEI), licence (uma autorização MiCA consta nos registros e está vigente), domain (o domínio da entrada corresponde ao seu endpoint TRP ou ao site indicado pelo seu registro) e lei (seu registro LEI está ativo, emitido e consistente com os nomes e o país da entrada). O componente essentials de dd_score é a proporção de verificações decididas que são aprovadas. Fica vazio até que a atualização semanal do diretório verifique a entrada pela primeira vez, e fica sempre vazio para um membro da rede 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 quando nenhuma fonte registrada consegue decidir a verificação." }, "reason": { "type": "string", "description": "Código legível por máquina do veredito." }, "detail": { "type": "string", "description": "Explicação de uma linha em inglês." } } } }, "passed": { "type": "integer" }, "failed": { "type": "integer" }, "unknown": { "type": "integer" }, "total": { "type": "integer" } } }, "decision": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleCounterpartyDecision" } ], "nullable": true, "description": "A decisão da sua aplicação sobre esta VASP ou, para uma entidade sem decisão própria, a da sua marca (inherited_from indica a marca). Nulo quando não há nenhuma. Privada da sua aplicação." }, "entity_screening": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleCounterpartyScreening" } ], "nullable": true, "description": "A análise mais recente de sanções e mídia adversa desta VASP feita pela sua aplicação. Nula quando você nunca a analisou. Privada da sua aplicação." }, "questionnaires": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleCounterpartyQuestionnaire" }, "description": "Os questionários de due diligence da sua aplicação com esta VASP, dos mais recentes para os mais antigos. Privados da sua aplicação." } }, "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": "A decisão da sua aplicação sobre uma VASP contraparte. Privada da sua aplicação: ela nunca altera a entrada compartilhada do diretório e nenhum outro cliente a vê. Ela atua apenas por meio das suas regras de transação (o campo de regra counterparty_dd_status e os presets travel-rule-counterparty-blocked e travel-rule-counterparty-restricted); ela nunca altera como uma transferência é roteada.", "properties": { "decision": { "type": "string", "enum": [ "APPROVED", "RESTRICTED", "BLOCKED" ], "description": "APPROVED: sua equipe liberou a contraparte. RESTRICTED: transferências para ela podem prosseguir após revisão. BLOCKED: sua equipe a recusou." }, "reason": { "type": "string", "maxLength": 255, "description": "Motivo em texto livre que você informou, vazio quando nenhum foi informado." }, "decided_by": { "type": "string", "description": "O usuário do console que tomou a decisão ou a alterou por último. Vazio quando a decisão foi tomada por uma chave de API." }, "updated_at": { "type": "string", "format": "date-time" }, "inherited_from": { "type": "object", "nullable": true, "description": "A marca cuja decisão esta entidade segue porque você não tomou nenhuma decisão na própria entidade. Nulo quando a decisão é da própria contraparte.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } } } }, "TravelRuleCounterpartyDecisionResponse": { "type": "object", "properties": { "decision": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleCounterpartyDecision" } ], "nullable": true, "description": "A decisão que se aplica à contraparte para a sua aplicação: a dela própria ou, caso contrário (para uma entidade de uma marca), a da marca. Nulo quando não há nenhuma." } } }, "TravelRuleCounterpartyDecisionRequest": { "type": "object", "required": [ "decision" ], "properties": { "decision": { "type": "string", "enum": [ "APPROVED", "RESTRICTED", "BLOCKED" ] }, "reason": { "type": "string", "maxLength": 255, "description": "Opcional. Substitui o motivo anterior; omita-o para apagá-lo." } } }, "TravelRuleCounterpartyScreening": { "type": "object", "description": "Uma análise de sanções e mídia adversa da entidade contraparte, executada para a sua aplicação e faturada a ela. Privada para a sua aplicação: nenhum outro cliente a vê.", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Aprovado: nenhuma possível correspondência requer atenção. Em revisão ou Recusado: uma possível correspondência em sanções ou mídia adversa." }, "total_hits": { "type": "integer", "description": "Quantas possíveis correspondências a análise retornou." }, "score": { "type": "number", "nullable": true, "description": "A maior pontuação de risco entre as possíveis correspondências. Nulo quando não houve nenhuma correspondência." }, "screened_at": { "type": "string", "format": "date-time" }, "fresh": { "type": "boolean", "description": "Se a triagem é mais recente que fresh_days (30 dias). Uma triagem recente é reutilizada em vez de ser cobrada novamente." }, "flagged": { "type": "boolean", "description": "true enquanto a análise estiver recente e seu status for In Review ou Declined. Enquanto sua análise mais recente estiver sinalizada e a análise de contrapartes permanecer ativada, counterparty_risk_level é HIGH nas suas regras." } } }, "TravelRuleCounterpartyScreeningStatus": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Sua configuração de Travel Rule counterparty_screening_enabled. Desativada por padrão; nada é analisado nem cobrado enquanto estiver desativada." }, "price": { "type": "string", "description": "String decimal, em USD: quanto uma análise custa para a sua organização, o preço da Análise AML de empresas." }, "fresh_days": { "type": "integer", "description": "Por quantos dias uma análise continua válida e é reutilizada." }, "screening": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleCounterpartyScreening" } ], "nullable": true, "description": "Sua análise mais recente da contraparte. Nulo quando você nunca a analisou." } } }, "TravelRuleCounterpartyScreeningRequest": { "type": "object", "properties": { "refresh": { "type": "boolean", "default": false, "description": "true executa a análise novamente (e cobra novamente) mesmo quando já existe uma análise recente." } } }, "TravelRuleCounterpartyScreeningResult": { "type": "object", "properties": { "outcome": { "type": "string", "enum": [ "screened", "reused" ], "description": "screened: uma nova análise foi executada e cobrada (201). reused: uma análise recente foi retornada e nada foi cobrado (200)." }, "screening": { "$ref": "#/components/schemas/TravelRuleCounterpartyScreening" } } }, "TravelRuleCounterpartyQuestionnaire": { "type": "object", "description": "Um questionário de due diligence que sua aplicação enviou à contraparte: o questionário padrão da Didit, enviado por e-mail a um endereço de conformidade registrado, com um link de resposta de uso único. Privado para sua aplicação.", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "SENT", "ANSWERED", "EXPIRED" ], "description": "SENT: aguardando respostas. ANSWERED: a contraparte respondeu a todas as perguntas. EXPIRED: o link de resposta foi fechado sem resposta (o prazo passou ou um questionário mais recente o substituiu), ou as respostas ultrapassaram valid_until." }, "form_version": { "type": "string", "description": "Versão do questionário padrão da Didit à qual as respostas pertencem. Atualmente 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": "O prazo de resposta, 30 dias após o envio. O link para de funcionar depois dele." }, "answered_at": { "type": "string", "format": "date-time", "nullable": true }, "valid_until": { "type": "string", "format": "date-time", "nullable": true, "description": "Por quanto tempo as respostas permanecem válidas: 365 dias após serem respondidas. Null até serem respondidas." }, "current": { "type": "boolean", "description": "true enquanto o questionário estiver ANSWERED e valid_until não tiver passado." }, "answers": { "type": "object", "additionalProperties": { "type": "string" }, "description": "As respostas indexadas pelo id da pergunta: legal_name, licensing, jurisdictions, aml_program, compliance_officer, sanctions_screening, transaction_monitoring, travel_rule, custody, ownership, record_keeping, data_protection. Cada resposta tem até 2,000 caracteres. Ficam vazias até serem respondidas." } } }, "TravelRuleCounterpartyQuestionnaireRequest": { "type": "object", "properties": { "sent_to": { "type": "string", "format": "email", "description": "Opcional. Um endereço de conformidade registrado para a contraparte: para uma entrada do diretório, seu endereço de conformidade ou um contato visível para a sua aplicação; para um membro da rede Didit, seu e-mail de conformidade confirmado. Padrão: o endereço para o qual vai um e-mail de Travel Rule enviado à contraparte (primeiro o seu próprio contato, depois um contato da plataforma e, por fim, o endereço de conformidade da entrada)." } } }, "TravelRuleCounterpartyQuestionnaireList": { "type": "object", "properties": { "questionnaires": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleCounterpartyQuestionnaire" }, "description": "Mais recentes primeiro." } } }, "TravelRulePickupInfo": { "type": "object", "description": "A troca pendente por trás de um link de retirada enviado por e-mail, conforme exibida na página de resposta da contraparte.", "properties": { "reference": { "type": "string", "format": "uuid", "description": "O uuid da transferência, conforme exibido no console do VASP remetente." }, "requested_at": { "type": "string", "format": "date-time" }, "originator_vasp_name": { "type": "string" }, "originator_vasp_lei": { "type": "string" }, "recipient_vasp_name": { "type": "string", "description": "O VASP da contraparte ao qual a requisição é endereçada." }, "language": { "type": "string", "description": "O idioma do e-mail de requisição e da página de resposta, conforme a jurisdição da contraparte." }, "amount": { "type": "string" }, "currency": { "type": "string" }, "fiat_amount": { "type": "string", "description": "O valor convertido informado pelo remetente, ou vazio." }, "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": "Quando o link deixa de responder." }, "reminders_sent": { "type": "integer" }, "contact": { "type": "string", "description": "O valor `?contact=` do link, devolvido como recebido; vazio quando o link não tem esse valor." }, "decline_reasons": { "type": "array", "items": { "type": "string", "enum": [ "data_mismatch", "not_our_customer", "wallet_not_hosted", "sanctions", "risk_appetite", "jurisdiction", "insufficient_data", "other" ] }, "description": "Os valores aceitos por `decline_reason`." }, "join_invitation": { "type": "object", "description": "Se a contraparte tem um convite ativo para entrar na Didit gratuitamente. O link do convite é enviado apenas no e-mail para o endereço convidado, por isso `url` fica vazio aqui.", "properties": { "eligible": { "type": "boolean" }, "url": { "type": "string" } } }, "originator_data": { "type": "object", "description": "Os campos do remetente que o VASP de envio compartilha (`data_sharing_fields`). O nome e a carteira são sempre incluídos." }, "beneficiary_data": { "type": "object" }, "ivms_request": { "type": "object", "description": "A mesma requisição como objeto IVMS 101. Omitido enquanto `data_masked` for true." }, "data_masked": { "type": "boolean", "description": "Sempre false neste endpoint: uma requisição por e-mail é de saída, e o próprio usuário do remetente nunca é mascarado." } } }, "TravelRulePickupRespondRequest": { "type": "object", "required": [ "decision" ], "properties": { "decision": { "type": "string", "enum": [ "accept", "decline" ] }, "beneficiary_name": { "type": "string", "description": "O nome do beneficiário conforme consta nos seus registros, processado pela regra de nomes do VASP remetente. `ivms_response` tem precedência quando nomeia o beneficiário.", "maxLength": 255 }, "decline_reason": { "type": "string", "enum": [ "", "data_mismatch", "not_our_customer", "wallet_not_hosted", "sanctions", "risk_appetite", "jurisdiction", "insufficient_data", "other" ], "description": "Por que você recusa. Registrado na linha do tempo da transferência do VASP remetente. Vazio (o padrão) quando você não informa um motivo." }, "decline_detail": { "type": "string", "maxLength": 512, "description": "Texto livre; obrigatório quando `decision` é `decline` e `decline_reason` é `other`." }, "ivms_response": { "type": "object", "description": "Sua resposta IVMS 101 completa. O nome do beneficiário nela prevalece sobre `beneficiary_name`." }, "contact": { "type": "string", "format": "uuid", "description": "O contato para o qual o link foi enviado, a partir do valor `?contact=` do link. Quando o corpo não o informa, é usado o parâmetro de consulta `contact`." } } }, "TravelRuleInboundRequest": { "type": "object", "required": [ "chain", "txid", "wallet_address", "amount", "currency" ], "properties": { "chain": { "type": "string", "description": "Blockchain em que o depósito foi liquidado, por exemplo, `ETH`. É armazenado em minúsculas e comparado sem distinção entre maiúsculas e minúsculas com as entradas do seu catálogo de endereços de carteiras, portanto use o mesmo token de blockchain lá.", "maxLength": 32 }, "txid": { "type": "string", "description": "Hash da transação on-chain. Desduplicado em conjunto com wallet_address.", "maxLength": 128 }, "wallet_address": { "type": "string", "description": "A carteira de destino em que você recebeu o depósito. Um X-address XRP é dividido em seu endereço clássico e sua tag.", "maxLength": 128 }, "amount": { "type": "string", "description": "Valor do depósito como string decimal, zero ou maior, com até 18 casas decimais." }, "currency": { "type": "string", "description": "Ativo do depósito, por exemplo, \"USDC\".", "maxLength": 16 }, "originator_data": { "type": "object", "description": "Dados do remetente fornecidos pelo VASP de envio, se conhecidos, como um objeto plano, por exemplo `{\"name\": \"...\"}`. A Didit lê dele name (ou full_name), first_name, last_name e vendor_data.", "additionalProperties": true }, "beneficiary_data": { "type": "object", "description": "Dados do beneficiário (seu cliente), como um objeto simples, por exemplo `{\"name\": \"...\"}`. A Didit compara o nome com o holder_name da entrada correspondente do catálogo de endereços e define wallet_address e chain a partir da requisição.", "additionalProperties": true }, "originating_vasp": { "type": "object", "description": "Descrição opcional da VASP remetente. Ela fica apenas nesta transferência (`metadata.originating_vasp` e a VASP remetente da transferência em GET /v3/travel-rule/transfers/); nunca cria, edita nem vincula uma entrada compartilhada do diretório de VASPs.", "properties": { "name": { "type": "string", "maxLength": 255 }, "lei": { "type": "string", "maxLength": 20, "description": "Opcional. Um LEI ISO 17442 válido de 20 caracteres, ou vazio." }, "travel_address": { "type": "string", "description": "O endereço de Travel Rule do remetente, registrado nesta transferência.", "maxLength": 512 } } }, "memo": { "type": "string", "maxLength": 256, "description": "Opcional. A destination tag ou memo do depósito em uma rede com memo: em um endereço de depósito compartilhado, é o que diferencia seus clientes, e a entrada do catálogo de endereços correspondente a esse memo é usada na correspondência. XRP: uma destination tag, um número inteiro de 0 a 4294967295 (um número JSON é aceito). XLM: um memo de texto de até 28 bytes, um ID de 64 bits ou um hash de 32 bytes em hexadecimal. EOS: até 256 bytes. ATOM: até 256 caracteres. HBAR: até 100 bytes. Carteiras Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin e Lightning não aceitam memo: informar um nelas retorna `400`. Alias: `destinationTag` ou `destination_tag`." }, "utxo": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleUtxo" } ], "description": "Opcional, apenas para blockchains UTXO. As entradas e saídas da transação de depósito: a carteira do remetente é o `originator_data.wallet_address` declarado ou, na ausência dele, a maior entrada." } } }, "TravelRuleInboundResponse": { "type": "object", "properties": { "transaction_id": { "type": "string", "format": "uuid", "description": "UUID da transação na Didit para o depósito recebido." }, "txn_id": { "type": "string", "description": "txn_id da transação de entrada: gerado pela Didit quando a Didit criou a transação, ou o seu próprio quando um depósito não reivindicado foi reutilizado." }, "created": { "type": "boolean", "description": "true quando esta chamada registrou a transferência (HTTP 201); false quando já existia uma transferência para o mesmo txid e wallet_address (HTTP 200)." }, "travel_rule": { "$ref": "#/components/schemas/TravelRuleTransferDetail" } } }, "TravelRuleTestVaspInboundRequest": { "type": "object", "required": [ "beneficiary_wallet_address" ], "properties": { "beneficiary_wallet_address": { "type": "string", "description": "O endereço da carteira de destino. O Didit Test VASP envia para ele, comparando-o com o seu catálogo de endereços de carteiras na blockchain do ativo. Uma carteira sem entrada correspondente é aceita, e a transação recebida é registrada como ON_HOLD." }, "scenario": { "type": "string", "enum": [ "accept", "name_mismatch" ], "default": "accept", "description": "O que o Didit Test VASP declara ser o beneficiário. `accept` declara o próprio nome do titular; `name_mismatch` declara um nome que não corresponde a nenhum titular. A decisão em si é sempre sua." }, "chain": { "type": "string", "default": "ETH", "description": "Blockchain do ativo." }, "amount": { "type": "string", "default": "1", "description": "Valor como string decimal." }, "currency": { "type": "string", "default": "ETH", "description": "Código do ativo." }, "reference": { "type": "string", "description": "Chave de idempotência opcional. Uma repetição com o mesmo valor retorna a transferência registrada pela primeira chamada." } } }, "TravelRuleTestVaspInboundResponse": { "type": "object", "properties": { "transaction_id": { "type": "string", "format": "uuid", "description": "UUID da transação na Didit para a transferência recebida." }, "txn_id": { "type": "string", "description": "txn_id gerado pela Didit." }, "scenario": { "type": "string", "description": "O cenário que foi executado." }, "travel_rule_status": { "type": "string", "description": "O status ao qual a decisão da sua própria aplicação chegou." }, "detail": { "type": "string", "description": "Por que a transferência foi resolvida com esse status." }, "test_vasp": { "type": "boolean", "description": "Sempre true: o remetente foi o Didit Test VASP." }, "travel_rule": { "$ref": "#/components/schemas/TravelRuleTransferDetail" } } }, "TravelRuleWidgetSessionCreate": { "type": "object", "properties": { "wallet_address": { "type": "string", "description": "O endereço da carteira a ser verificado. Opcional; quando vazio, o endereço deve ser informado ao iniciar uma prova.", "maxLength": 128 }, "chain": { "type": "string", "description": "Token da rede (chain) do endereço, por exemplo `ETH`, `BTC` ou `SOL`. Use o mesmo token do catálogo de endereços de carteiras. A assinatura de mensagem e o teste Satoshi são oferecidos apenas para uma rede compatível. A entrada do catálogo de endereços que a prova verifica o armazena com seu identificador canônico (ETH, BTC, SOL, TRX).", "maxLength": 32 }, "holder_name": { "type": "string", "description": "Nome do titular da carteira, usado na correspondência do nome do beneficiário.", "maxLength": 255 }, "vendor_data": { "type": "string", "description": "Seu identificador interno para o titular, transferido para a entrada criada no catálogo de endereços.", "maxLength": 255 }, "transaction_id": { "type": "string", "format": "uuid", "description": "Opcional. UUID de transação da Didit de uma transferência de Travel Rule a ser avançada quando a comprovação for verificada.", "nullable": true }, "satoshi_deposit_address": { "type": "string", "description": "Opcional. Um endereço de depósito que você controla; informá-lo habilita o método de comprovação SATOSHI_TEST.", "maxLength": 128 }, "callback_url": { "type": "string", "description": "Opcional. URL http(s) absoluta para a qual o widget retorna o cliente após a conclusão.", "maxLength": 512 }, "expires_in_minutes": { "type": "integer", "description": "Opcional. Tempo de vida do link gerado, em minutos. É estendido automaticamente para cobrir a janela do teste de Satoshi quando SATOSHI_TEST é oferecido.", "default": 60, "minimum": 5, "maximum": 10080 } } }, "TravelRuleWidgetSessionResponse": { "type": "object", "properties": { "widget_session_id": { "type": "string", "format": "uuid" }, "token": { "type": "string", "description": "Token de sessão opaco incorporado à URL do widget." }, "url": { "type": "string", "description": "A URL do widget hospedado de propriedade da carteira. Abra-a exatamente como está no navegador do sistema (nunca dentro de uma webview de SDK móvel)." }, "expires_at": { "type": "string", "format": "date-time" } } }, "TravelRuleWidgetContext": { "type": "object", "properties": { "vasp_name": { "type": "string", "description": "Razão social do seu perfil de VASP, exibida ao cliente no widget. Vazio quando não existe perfil." }, "wallet_address": { "type": "string" }, "chain": { "type": "string", "description": "A blockchain com a qual a sessão foi criada, como você a enviou." }, "chain_family": { "type": "string", "nullable": true, "enum": [ "EVM", "BTC", "SOL", "TRON", null ], "description": "A família de chaves por trás de chain: EVM (Ethereum, BNB Chain, Polygon, Arbitrum, Base, Optimism, Avalanche, Linea e as demais redes EVM), BTC, SOL ou TRON. Uma única chave EVM controla o mesmo endereço em todas as redes EVM. Nulo quando nenhuma assinatura pode ser verificada na rede." }, "holder_name": { "type": "string" }, "allowed_methods": { "type": "array", "items": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SCREENSHOT", "SATOSHI_TEST", "SELF_DECLARATION" ] }, "description": "Métodos de comprovação disponíveis para esta sessão. MESSAGE_SIGNING exige uma blockchain com chain_family, SATOSHI_TEST exige um satoshi_deposit_address na sessão e uma blockchain cujos depósitos a Didit consiga ler de volta, SCREENSHOT exige a configuração allow_screenshot_proof e SELF_DECLARATION exige a configuração allow_self_declaration." }, "transfer_status": { "type": "string", "nullable": true, "description": "Status da transferência de Travel Rule vinculada. Nulo quando a sessão foi criada sem um transaction_id." }, "callback_url": { "type": "string", "description": "Para onde o widget retorna o cliente após a conclusão. Vazio quando não definido." }, "expires_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Não nulo depois que um comprovante é verificado." }, "proofs": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleWidgetProofSummary" } }, "max_attempts": { "type": "integer", "description": "Provas de carteira rejeitadas que esta sessão permite." }, "attempts_used": { "type": "integer", "description": "Provas rejeitadas até o momento." }, "attempts_remaining": { "type": "integer", "description": "Quando for 0, iniciar outra prova retorna 409 e você gera uma nova sessão do widget." }, "customization": { "type": "object", "nullable": true, "description": "A personalização de marca própria da aplicação (cores, logotipo, família de fonte) quando a marca própria está habilitada - o widget é exibido com a mesma identidade visual do fluxo de verificação. Null nos demais casos." } } }, "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: o usuário final escolheu este método e a prova ainda não foi decidida. Uma assinatura que falhou ou um depósito de teste que ainda não pôde ser lido ou confirmado mantém a prova em PENDING com um failure_reason, para que o usuário final possa tentar novamente; um depósito SATOSHI_TEST enviado é verificado de novo automaticamente até sua janela se encerrar, e um SCREENSHOT enviado aguarda a sua revisão. VERIFIED: a propriedade está comprovada. REJECTED: o depósito de teste está realmente incorreto (outro remetente, valor diferente do esperado para o endereço de depósito, anterior ao desafio ou uma transação que já comprovou outra carteira) ou o seu revisor rejeitou a captura de tela; failure_reason indica qual. Uma prova rejeitada é definitiva e consome uma das tentativas da sessão. EXPIRED: a prova não pode mais ser decidida (sua janela se encerrou, o usuário final trocou de método, a sessão do widget expirou ou o titular da carteira mudou); failure_reason indica qual." }, "wallet_address": { "type": "string" }, "chain": { "type": "string", "description": "Identificador canônico da blockchain da entrada do catálogo de endereços à qual a prova se refere, por exemplo, ETH, BTC, SOL, TRX." }, "deposit_address": { "type": "string", "nullable": true, "description": "Endereço de depósito para o qual o cliente deve enviar o valor de teste em Satoshi. Presente apenas em uma prova SATOSHI_TEST." }, "expected_amount": { "type": "string", "nullable": true, "description": "Valor on-chain exato, na moeda nativa do depósito, ao qual o depósito de teste Satoshi deve corresponder. Presente apenas em uma prova SATOSHI_TEST." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Prazo da janela do teste Satoshi desta prova. Presente apenas em uma prova SATOSHI_TEST; o expires_at da própria sessão do widget é estendido para cobri-lo quando SATOSHI_TEST é oferecido." }, "challenge": { "type": "string", "nullable": true, "description": "Mensagem emitida pela Didit que o cliente assina com a própria carteira. Presente apenas em uma prova MESSAGE_SIGNING." }, "rejection_reason": { "type": "string", "description": "Por que a comprovação foi rejeitada, como uma frase em inglês para o usuário final. Presente apenas quando `status` é REJECTED; vazio quando seu revisor rejeitou uma captura de tela (sua observação fica só com você)." }, "created_at": { "type": "string", "format": "date-time" }, "attempts": { "type": "integer", "description": "Quantas vezes evidências foram enviadas para esta comprovação (assinaturas, IDs de transação, uploads)." }, "failure_reason": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleWalletProofFailureReason" } ], "description": "Por que a última tentativa não foi suficiente, ou por que a comprovação foi encerrada. Vazio quando nada falhou." } } }, "CaseSubject": { "type": "object", "nullable": true, "description": "O único usuário ou empresa ao qual o caso está vinculado.", "properties": { "type": { "type": "string", "enum": [ "user", "business" ] }, "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "external_id": { "type": "string", "nullable": true, "description": "O vendor_data do titular." }, "country": { "type": "string", "nullable": true, "description": "Código de país de três letras do titular (ISO 3166-1 alpha-3), ou null quando não é conhecido. Para uma empresa, o país de constituição. Para uma pessoa, o país emissor de um documento de identidade de suas verificações; uma pessoa com documentos de vários países mostra um deles, e códigos de documento da ICAO como `XXA` podem aparecer.", "example": "ESP" }, "portrait": { "type": "string", "format": "uri", "nullable": true, "description": "URL assinada de curta duração da imagem do retrato da pessoa. Sempre null para uma empresa e null para uma pessoa sem retrato. A URL expira, portanto baixe a imagem ao ler o caso em vez de armazenar a 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": "As seis seções ativáveis que determinam quais abas e campos aparecem na página do caso. Seções ou chaves desconhecidas são rejeitadas.", "properties": { "checklist": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "optional": { "type": "boolean", "description": "Quando verdadeiro, um caso pode ser resolvido com itens da checklist incompletos." }, "items": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 255 }, "order": { "type": "integer" } } } } } }, "aml_control": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "financial": { "type": "boolean" }, "identity": { "type": "boolean" } } }, "identity": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "personal_information": { "type": "boolean" }, "applicant_tags": { "type": "boolean" }, "contact_information": { "type": "boolean" }, "risk_overview": { "type": "boolean" }, "poi_documents": { "type": "boolean" }, "poa_documents": { "type": "boolean" } } }, "verifications": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "summary": { "type": "boolean" } } }, "reporting": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "fiu_reports": { "type": "boolean" } } }, "financial": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "payment_methods": { "type": "boolean" }, "transactions": { "type": "boolean" } } } } }, "CaseNote": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "comment": { "type": "string" }, "actor_email": { "type": "string", "format": "email", "nullable": true }, "actor_name": { "type": "string", "nullable": true }, "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email" } }, "is_internal": { "type": "boolean" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "s3_key": { "type": "string" }, "filename": { "type": "string" }, "file_size": { "type": "integer" }, "url": { "type": "string", "format": "uri" } } } }, "tags": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" } } }, "CaseEvent": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "enum": [ "CREATED", "STATUS_CHANGED", "ASSIGNED", "UNASSIGNED", "RESOLVED", "REOPENED", "LINK_ADDED", "LINK_REMOVED", "NOTE_ADDED", "NOTE_PINNED", "NOTE_UNPINNED", "PRIORITY_CHANGED", "DUE_DATE_CHANGED", "TAG_ADDED", "TAG_REMOVED", "ESCALATED", "TRANSFERRED", "CHECKLIST_COMPLETED", "REPORT_CREATED", "REPORT_FINALIZED", "SUBMITTED_FOR_APPROVAL", "APPROVAL_GRANTED", "APPROVAL_REJECTED", "ENTITY_ACTION", "APPROVAL_INVALIDATED", "CUSTOMER_REQUEST", "STAGE_CHANGED", "TEAM_CHANGED", "CHECKER_ASSIGNED", "CHECKER_UNASSIGNED" ] }, "actor_email": { "type": "string", "format": "email", "nullable": true }, "actor_name": { "type": "string", "nullable": true }, "previous_status": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ], "nullable": true }, "new_status": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ], "nullable": true }, "metadata": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" } } }, "CaseLink": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "linked_entity_type": { "type": "string", "enum": [ "session", "business_session", "transaction" ], "nullable": true }, "linked_entity_uuid": { "type": "string", "format": "uuid", "nullable": true }, "linked_entity_summary": { "type": "object", "nullable": true, "description": "session_id/session_number/status para links de session e business_session; uuid/txn_id/status para links de transação." }, "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": "As seis seções ativáveis que determinam quais abas e campos aparecem na página do caso. Seções ou chaves desconhecidas são rejeitadas.", "properties": { "checklist": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "optional": { "type": "boolean", "description": "Quando verdadeiro, um caso pode ser resolvido com itens da checklist incompletos." }, "items": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 255 }, "order": { "type": "integer" } } } } } }, "aml_control": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "financial": { "type": "boolean" }, "identity": { "type": "boolean" } } }, "identity": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "personal_information": { "type": "boolean" }, "applicant_tags": { "type": "boolean" }, "contact_information": { "type": "boolean" }, "risk_overview": { "type": "boolean" }, "poi_documents": { "type": "boolean" }, "poa_documents": { "type": "boolean" } } }, "verifications": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "summary": { "type": "boolean" } } }, "reporting": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "fiu_reports": { "type": "boolean" } } }, "financial": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "payment_methods": { "type": "boolean" }, "transactions": { "type": "boolean" } } } } }, "creation_sources": { "type": "array", "description": "Conectores que atualmente encaminham novos casos para este blueprint.", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aml", "rule", "workflow" ] }, "id": { "type": "string" }, "name": { "type": "string" } } } }, "receives_escalation_from": { "type": "array", "description": "Outros blueprints cujo destino de escalonamento aponta para este.", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } }, "updated_at": { "type": "string", "format": "date-time" }, "version": { "type": "integer", "readOnly": true }, "default_deadline_hours": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 8760 } } }, "CaseListItem": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "case_number": { "type": "string", "nullable": true, "description": "Atribuído automaticamente, por exemplo, 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": "Definido apenas enquanto uma resolução com aprovação em duas etapas (4-eyes) está preparada no blueprint do verificador, aguardando aprovação ou rejeição da aprovação.", "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": "E-mail do responsável que enviou a resolução. Null quando uma chave de API a enviou: essa resolução não tem autor registrado, portanto approve e reject-approval retornam 403 para qualquer chamador." }, "maker_name": { "type": "string", "nullable": true }, "maker_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID de usuário membro do responsável que enviou a resolução. Null quando uma chave de API a enviou. Esse membro não pode ser indicado como `checker`." }, "maker_blueprint_id": { "type": "string", "format": "uuid" }, "staged_at": { "type": "string", "format": "date-time" } } }, "checker": { "$ref": "#/components/schemas/CaseChecker" }, "priority": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "source": { "type": "string", "enum": [ "MANUAL", "AML_SCREENING", "TRANSACTION_RULE", "WORKFLOW_BUILDER" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "subject": { "$ref": "#/components/schemas/CaseSubject" }, "assigned_to": { "$ref": "#/components/schemas/CaseAssignee" }, "assigned_at": { "type": "string", "format": "date-time", "nullable": true }, "team": { "$ref": "#/components/schemas/CaseTeamSummary" }, "due_at": { "type": "string", "format": "date-time", "nullable": true }, "resolved_at": { "type": "string", "format": "date-time", "nullable": true }, "created_by_email": { "type": "string", "nullable": true }, "created_by_name": { "type": "string", "nullable": true }, "blueprint": { "$ref": "#/components/schemas/CaseBlueprintSummary" }, "links_count": { "type": "integer" }, "notes_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "application_id": { "type": "string", "format": "uuid" }, "application_name": { "type": "string" }, "organization_id": { "type": "string", "format": "uuid" }, "organization_name": { "type": "string" } } }, "CaseDetail": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "case_number": { "type": "string", "nullable": true }, "title": { "type": "string" }, "status": { "type": "string", "enum": [ "OPEN", "AWAITING_USER", "RESOLVED" ] }, "resolution": { "type": "string", "enum": [ "FALSE_POSITIVE", "VALID_THREAT", "INCONCLUSIVE", "REQUIREMENTS_NOT_MET", "REQUIREMENTS_SATISFIED" ], "nullable": true }, "resolution_notes": { "type": "string", "nullable": true }, "priority": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "source": { "type": "string", "enum": [ "MANUAL", "AML_SCREENING", "TRANSACTION_RULE", "WORKFLOW_BUILDER" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "subject": { "$ref": "#/components/schemas/CaseSubject" }, "assigned_to": { "$ref": "#/components/schemas/CaseAssignee" }, "assigned_at": { "type": "string", "format": "date-time", "nullable": true }, "team": { "$ref": "#/components/schemas/CaseTeamSummary" }, "due_at": { "type": "string", "format": "date-time", "nullable": true }, "resolved_at": { "type": "string", "format": "date-time", "nullable": true }, "resolved_by_email": { "type": "string", "nullable": true }, "pending_resolution": { "type": "object", "nullable": true, "description": "Definido apenas enquanto uma resolução com aprovação em duas etapas (4-eyes) está preparada no blueprint do verificador, aguardando aprovação ou rejeição da aprovação.", "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": "E-mail do responsável que enviou a resolução. Null quando uma chave de API a enviou: essa resolução não tem autor registrado, portanto approve e reject-approval retornam 403 para qualquer chamador." }, "maker_name": { "type": "string", "nullable": true }, "maker_user_id": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID de usuário membro do responsável que enviou a resolução. Null quando uma chave de API a enviou. Esse membro não pode ser indicado como `checker`." }, "maker_blueprint_id": { "type": "string", "format": "uuid" }, "staged_at": { "type": "string", "format": "date-time" } } }, "checker": { "$ref": "#/components/schemas/CaseChecker" }, "metadata": { "type": "object" }, "blueprint": { "$ref": "#/components/schemas/CaseBlueprintDetail" }, "notes": { "type": "array", "items": { "$ref": "#/components/schemas/CaseNote" }, "description": "As 50 notas mais recentes." }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/CaseEvent" }, "description": "Os 100 eventos mais recentes." }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/CaseLink" } }, "links_count": { "type": "integer" }, "notes_count": { "type": "integer" }, "checklist_items": { "type": "array", "items": { "$ref": "#/components/schemas/CaseChecklistItem" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "ReportTemplateDetail": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Código de país ISO 3166-1 alpha-2." }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "report_type_display": { "type": "string" }, "field_config": { "type": "object", "description": "Padrões reutilizáveis de cabeçalho do goAML. Campos obrigatórios no nível do modelo: rentity_id, submission_code e currency_code_local (3 letras). Opcionais: enabled_fields (quais blocos opcionais do relatório incluir), além dos padrões de reporting_person, location, reason e action. Os campos de cabeçalho por envio (action, submission_date, transactions, jurisdiction) são exigidos quando o relatório é validado ou finalizado, não no modelo." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "RegulatoryReportDetail": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "case_uuid": { "type": "string", "format": "uuid" }, "case_number": { "type": "string", "nullable": true }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ] }, "report_type_display": { "type": "string" }, "report_code": { "type": "string", "description": "Código de relatório goAML derivado de report_type, por exemplo 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 da entidade declarante emitido pela 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": "Seções narrativas no formato dos cinco Ws.", "properties": { "who": { "type": "string" }, "what": { "type": "string" }, "when": { "type": "string" }, "where": { "type": "string" }, "why": { "type": "string" }, "how": { "type": "string" } } }, "report_indicators": { "type": "array", "items": { "type": "string" } }, "included_fields": { "type": "array", "items": { "type": "string" } }, "transactions": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "validation_errors": { "type": "array", "description": "Resultado da validação mais recente; cada entrada é um objeto {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": "Caminho do campo da transação a ser avaliado. Campos principais: amount, currency, direction, action_type, score, severity, transaction_type, payment_details, preferred_currency_amount (usa amount_in_default_currency como alternativa), 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 (e os equivalentes counterparty_payment_method_*), travel_rule_status, travel_rule_required, travel_rule_obligations_count, counterparty_dd_status (sua decisão sobre a contraparte da Travel Rule: APPROVED, RESTRICTED ou BLOCKED; uma entidade segue a decisão da sua marca), counterparty_risk_level (LOW, MEDIUM ou HIGH; HIGH enquanto a sua própria triagem da contraparte estiver sinalizada), counterparty_jurisdiction (o país do VASP da contraparte), counterparty_responsiveness (RESPONSIVE, UNRESPONSIVE ou UNKNOWN), subject_days_since_previous_transaction, tags e custom_values. para qualquer chave enviada em custom_properties na criação da transação. Campos de código de país aceitam ISO-2 ou ISO-3; ambos os lados são normalizados para ISO-3 antes da comparação." }, "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 comparação. in/not_in testam pertencimento (o valor pode ser uma lista ou um único escalar). contains/not_contains verificam, sem diferenciar maiúsculas de minúsculas, se uma substring está contida em um valor de texto. contains_any recebe uma lista de strings e corresponde quando qualquer uma delas é uma substring do valor do campo, sem diferenciar maiúsculas de minúsculas. regex compara o padrão do valor com o campo. fuzzy_match compara com a string do valor usando o limiar `score` exigido (0-100). gt/gte/lt/lte nunca correspondem quando um dos lados está ausente. exists/is_not_empty/is_not_null (aliases) e not_exists/is_empty/is_null (aliases) são verificações de presença que ignoram `value`." }, "value": { "description": "Valor de comparação. Seu formato depende do operador e de value_type; omita-o nos operadores de verificação de presença. Todos os outros operadores exigem um valor que não seja `null` nem uma lista vazia; caso contrário, a regra é recusada com `400`. `contains_any` exige uma lista de strings, e `contains`, `not_contains` e `regex` exigem uma única string." }, "value_type": { "type": "string", "enum": [ "list", "field", "relative_date" ], "description": "Interpretação opcional do valor. `list`: o valor é o UUID de uma lista, e as entradas da lista passam a ser o valor de comparação. `field`: o valor é o caminho de outro campo, comparado campo a campo. `relative_date`: o valor é um objeto de data relativa, por exemplo {\"direction\": \"past\", \"unit\": \"days\", \"amount\": 30}." }, "score": { "type": "number", "minimum": 0, "maximum": 100, "description": "Obrigatório quando o operator for fuzzy_match: o limiar de similaridade de 0 a 100." }, "group_index": { "type": "integer", "description": "Lógica agrupada opcional. Quando alguma condição tiver group_index, as condições que compartilham um índice formam um grupo, e a avaliação agrupada substitui evaluation_mode." }, "group_logic": { "type": "string", "enum": [ "AND", "OR" ], "default": "AND", "description": "Como as condições se combinam DENTRO de um grupo." }, "groups_logic": { "type": "string", "enum": [ "AND", "OR" ], "default": "OR", "description": "Como os resultados dos grupos se combinam ENTRE os grupos. Lido a partir da primeira condição." } }, "description": "Uma condição lê apenas a transação que está sendo avaliada - ela nunca filtra a janela de agregação." }, "TransactionRuleAggregation": { "type": "object", "required": [ "value" ], "properties": { "metric": { "type": "string", "enum": [ "count", "sum", "max", "min", "avg", "distinct_count" ], "default": "count", "description": "Como as transações históricas correspondentes são agregadas. unique_count é aceito como alias de distinct_count." }, "field": { "type": "string", "default": "amount", "description": "Campo agregado por sum/max/min/avg/distinct_count. Ignorado para count." }, "operator": { "type": "string", "enum": [ "eq", "ne", "gt", "gte", "lt", "lte" ], "default": "eq", "description": "Comparação aplicada à métrica calculada." }, "value": { "type": "number", "description": "Limiar com o qual a métrica calculada é comparada." }, "window": { "type": "string", "pattern": "^\\d+(m|h|d)$", "default": "1d", "description": "Janela retroativa que termina na txn_date da transação: m (MINUTOS, não meses), h (horas) ou d (dias), por exemplo, 30m, 24h, 7d, 30d." }, "filters": { "type": "object", "additionalProperties": true, "description": "Restringe quais transações históricas são agregadas. As chaves são caminhos de campo do catálogo de campos de condição; um valor \"__current__\" é resolvido para o valor do mesmo campo na transação que está sendo avaliada (por exemplo, {\"subject_vendor_data\": \"__current__\"} limita a janela ao mesmo titular), e um valor em lista significa pertencimento. Os filtros comparam SOMENTE por igualdade ou pertencimento: não existe filtro lt/gte, portanto um intervalo como \"transações históricas abaixo de 10,000\" não pode ser expresso aqui. Em vez disso, coloque o intervalo na métrica (a métrica max com o operador lt mantém todas as transações da janela abaixo do limiar)." } }, "description": "Verificação de velocidade sobre as transações históricas da aplicação dentro da janela. Todas as entradas de agregação devem corresponder para que a regra corresponda, independentemente de evaluation_mode. Uma agregação restringe apenas a janela; a transação em avaliação é restringida por scope e conditions, portanto repita direction, currency ou transaction_type nas duas partes quando a regra os garantir." }, "TransactionRuleScope": { "type": "object", "properties": { "transaction_types": { "type": "array", "items": { "type": "string" }, "description": "Restringe a tipos de transação, por exemplo finance, kyc, travel_rule, user_event. Vazio ou ausente = sem restrição." }, "directions": { "type": "array", "items": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] }, "description": "Restringe a direções de transação (sem distinção entre maiúsculas e minúsculas na gravação)." }, "action_types": { "type": "array", "items": { "type": "string" }, "description": "Restringe aos seus valores de action_type, por exemplo withdrawal, deposit." } }, "description": "A quais transações a regra se aplica. Somente estas três chaves são aceitas." }, "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": "Uma ação de regra. Uma regra pode ter várias; todas são aplicadas juntas quando ela corresponde. Regras no modo TEST registram o que teriam feito sem aplicar nenhuma ação." }, "TransactionRuleCreateRequest": { "type": "object", "required": [ "title", "category", "mode" ], "properties": { "title": { "type": "string", "description": "Nome da regra. Único por aplicação entre as regras não excluídas; duplicatas retornam 400." }, "description": { "type": "string", "nullable": true }, "category": { "type": "string", "description": "Tema de risco usado para agrupamento e relatórios, por exemplo 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 avalia em produção. TEST avalia e registra as execuções de regras, mas nunca altera a pontuação nem o status - o modo inicial recomendado. DISABLED é ignorado." }, "evaluation_mode": { "type": "string", "enum": [ "ALL", "ANY" ], "default": "ALL", "description": "Indica se todas as condições devem corresponder (ALL) ou pelo menos uma (ANY). Ignorado quando as condições usam 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": "Metadados livres armazenados na regra." } }, "description": "Cria uma regra CUSTOM. Regras no modo ACTIVE entram em vigor imediatamente para novas transações - crie no modo TEST e faça um backtest primeiro." }, "TransactionRuleUpdateRequest": { "type": "object", "properties": { "title": { "type": "string", "description": "Nome da regra. Único por aplicação entre as regras não excluídas; duplicatas retornam 400." }, "description": { "type": "string", "nullable": true }, "category": { "type": "string", "description": "Tema de risco usado para agrupamento e relatórios, por exemplo 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 avalia em produção. TEST avalia e registra as execuções de regras, mas nunca altera a pontuação nem o status - o modo inicial recomendado. DISABLED é ignorado." }, "evaluation_mode": { "type": "string", "enum": [ "ALL", "ANY" ], "default": "ALL", "description": "Indica se todas as condições devem corresponder (ALL) ou pelo menos uma (ANY). Ignorado quando as condições usam 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": "Metadados livres armazenados na regra." } }, "description": "Atualização parcial. Regras personalizadas aceitam todos os campos; regras da biblioteca (PRESET) aceitam apenas mode, e qualquer outro campo retorna 400." }, "TransactionRuleDetail": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "title": { "type": "string", "description": "Nome da regra. Único por aplicação entre as regras não excluídas; duplicatas retornam 400." }, "description": { "type": "string", "nullable": true }, "category": { "type": "string", "description": "Tema de risco usado para agrupamento e relatórios, por exemplo 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 avalia em produção. TEST avalia e registra as execuções de regras, mas nunca altera a pontuação nem o status - o modo inicial recomendado. DISABLED é ignorado." }, "evaluation_mode": { "type": "string", "enum": [ "ALL", "ANY" ], "default": "ALL", "description": "Indica se todas as condições devem corresponder (ALL) ou pelo menos uma (ANY). Ignorado quando as condições usam 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": "Metadados livres armazenados na regra." }, "severity": { "type": "string", "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "nullable": true, "description": "Severidade informativa usada pelas regras da biblioteca; não pode ser definida em regras personalizadas." }, "source": { "type": "string", "enum": [ "PRESET", "CUSTOM" ], "description": "As regras PRESET vêm da biblioteca (instalar/desinstalar, edições apenas do modo); as regras CUSTOM são inteiramente suas." }, "library_key": { "type": "string", "nullable": true, "description": "Identificador estável da biblioteca; null para regras personalizadas." }, "latest_triggered_at": { "type": "string", "format": "date-time", "nullable": true }, "run_count": { "type": "integer", "description": "Quantas transações corresponderam a esta regra." }, "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": "Configuração hipotética de regra a ser avaliada com base nas transações recentes. Somente leitura e gratuita: nada é criado ou modificado. Envie as mesmas condições, agregação, evaluation_mode E escopo da regra que você pretende ativar. Condições, agregação e escopo omitidos não adicionam restrições próprias; remover o escopo pode incluir direções ou tipos de transação que a regra salva ignora. Se evaluation_mode for omitido, o padrão é ALL (o que pode reduzir as correspondências de uma regra ANY), e se period_days for omitido, o padrão é 90 dias, não o histórico ilimitado." }, "TransactionRuleBacktestResult": { "type": "object", "properties": { "evaluated": { "type": "integer", "description": "Transações avaliadas (as mais recentes primeiro, com limite)." }, "matched": { "type": "integer", "description": "Transações que teriam correspondido à configuração." }, "affected_entities": { "type": "integer", "description": "Titulares distintos (por vendor_data) entre as correspondências." }, "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, por exemplo, 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": "Se esta predefinição está atualmente instalada na aplicação." } } }, "TransactionRuleInstallRequest": { "type": "object", "properties": { "library_keys": { "type": "array", "items": { "type": "string" }, "description": "Presets específicos a instalar ou desinstalar." }, "bundle": { "type": "string", "description": "Em vez disso, instale ou desinstale todas as predefinições deste pacote." } }, "description": "Informe library_keys OU bundle." }, "TransactionRuleInstallResult": { "type": "object", "properties": { "installed_library_keys": { "type": "array", "items": { "type": "string" }, "description": "Somente POST (instalação): presets instalados por esta chamada." }, "installed_count": { "type": "integer", "description": "Somente POST (instalação)." }, "uninstalled_count": { "type": "integer", "description": "Somente em DELETE (desinstalação): predefinições removidas por esta chamada." } } }, "WalletScreeningResult": { "type": "object", "properties": { "provider": { "type": "string", "description": "Provedor que realizou a triagem (por exemplo, `merklescience`, `crystal`)." }, "screening_type": { "type": "string", "enum": [ "WALLET_SCREENING" ], "description": "Sempre `WALLET_SCREENING` neste endpoint." }, "risk_score": { "type": "integer", "description": "Pontuação de risco normalizada de 0 a 100. Quanto maior, maior a exposição a entidades de risco. A Merkle Science classifica um endereço de 0 a 5, o que corresponde a 0, 15, 35, 55, 75 ou 95." }, "severity": { "type": "string", "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "description": "Faixa de risco derivada de `risk_score`: `0-9` UNKNOWN, `10-39` LOW, `40-69` MEDIUM, `70-89` HIGH, `90-100` CRITICAL. `UNKNOWN` é a faixa mais baixa, não um estado separado de ausência de dados. Um `risk_score` 0 (o caso comum de endereço limpo) significa que não há avaliação adversa. Já uma pontuação diferente de zero na faixa de 1-9 é um sinal real, mas abaixo de LOW. Leia o `risk_score`, não apenas a faixa. Nunca trate `UNKNOWN` como uma classificação afirmativa de baixo risco ou de aprovação, e não o exiba como aprovado." }, "status": { "type": "string", "enum": [ "SCREENED", "PENDING", "ERROR" ], "description": "Status do resultado da análise." }, "summary": { "type": "string", "description": "Resumo legível do resultado da triagem." }, "wallet_address": { "type": "string", "description": "O endereço analisado, devolvido na resposta." }, "transaction_hash": { "type": "string", "nullable": true, "description": "Campo de triagem de transações, compartilhado com o formato do resultado. Sempre `null` em um resultado de triagem de carteiras." }, "blockchain": { "type": "string", "description": "A blockchain que foi analisada." }, "block_timestamp": { "type": "string", "nullable": true, "description": "Campo de triagem de transações, compartilhado com o formato do resultado. Sempre `null` em um resultado de triagem de carteiras." }, "total_value_usd": { "type": "number", "nullable": true, "description": "Campo de triagem de transações, compartilhado com o formato do resultado. Sempre `null` em um resultado de triagem de carteiras." }, "fee_usd": { "type": "number", "nullable": true, "description": "Campo de triagem de transações, compartilhado com o formato do resultado. Sempre `null` em um resultado de triagem de carteiras." }, "sender_rows": { "type": "array", "items": { "type": "object" }, "description": "Campo de triagem de transações, compartilhado com o formato do resultado. Sempre vazio em um resultado de triagem de carteiras." }, "receiver_rows": { "type": "array", "items": { "type": "object" }, "description": "Campo de triagem de transações, compartilhado com o formato do resultado. Sempre vazio em um resultado de triagem de carteiras." }, "transaction_flows": { "type": "array", "items": { "type": "object" }, "description": "Campo de triagem de transações, compartilhado com o formato do resultado. Sempre vazio em um resultado de triagem de carteiras." }, "transaction_flows_status": { "type": "string", "nullable": true, "description": "Campo de triagem de transações, compartilhado com o formato do resultado. Sempre `null` em um resultado de triagem de carteiras." }, "transaction_flows_error": { "type": "string", "nullable": true, "description": "Campo de triagem de transações, compartilhado com o formato do resultado. Sempre `null` em um resultado de triagem de carteiras." }, "source_of_funds": { "type": "array", "description": "De onde o endereço recebeu fundos, atribuídos por entidade. Cada entrada é um detalhamento de exposição.", "items": { "type": "object", "properties": { "category": { "type": "string", "description": "Categoria de risco normalizada, por exemplo `exchange_licensed`, `dex`, `defi`, `payment_processor`, `mixer`, `darknet_market`, `sanctioned`, `stolen_funds`, `high_risk_exchange`." }, "percentage": { "type": "number", "description": "Participação na exposição total da direção, de 0 a 100." }, "amount_usd": { "type": "number", "nullable": true, "description": "Valor em USD atribuído a esta entidade." }, "entity_name": { "type": "string", "nullable": true, "description": "Nome da entidade atribuída, por exemplo uma exchange, um mixer ou um grupo sancionado." }, "entity_type": { "type": "string", "nullable": true, "description": "Tipo da entidade no provedor (por exemplo, `Exchange`, `DeFi`, `Sanctions`, `Theft`)." }, "entity_subtype": { "type": "string", "nullable": true, "description": "Subtipo mais detalhado (por exemplo, `Mandatory KYC and AML`, `OFAC`, `Yield Aggregator`)." }, "hops": { "type": "integer", "nullable": true, "description": "Número de saltos até a entidade (1 para uma contraparte direta), quando o provedor informa esse dado. Sempre `null` para a Merkle Science, que informa apenas se a exposição é direta ou indireta: use `exposure_type`." }, "description": { "type": "string", "nullable": true, "description": "`entity_type / entity_subtype`, conforme o provedor classifica a entidade." }, "is_direct": { "type": "boolean", "description": "True quando `exposure_type` é `direct`." }, "exposure_direction": { "type": "string", "enum": [ "incoming", "outgoing", "connected" ], "description": "Se os fundos vieram desta entidade (`incoming`) ou foram enviados a ela (`outgoing`)." }, "exposure_type": { "type": "string", "enum": [ "direct", "indirect" ], "description": "Exposição `direct` (1 salto) ou `indirect` (vários saltos)." }, "provider_entity_id": { "type": "string", "nullable": true, "description": "O identificador próprio do provedor para a entidade." }, "provider_entity_type_id": { "type": "string", "nullable": true, "description": "O identificador próprio do provedor para `entity_type`." }, "provider_entity_subtype_id": { "type": "string", "nullable": true, "description": "O identificador próprio do provedor para `entity_subtype`." }, "country": { "type": "string", "nullable": true, "description": "País principal da entidade no formato ISO 3166-1 alpha-2. Vazio ou `null` quando o provedor não o conhece." }, "raw_amount": { "type": "number", "nullable": true, "description": "Valor na própria unidade do ativo, quando o provedor o informa." }, "raw_currency": { "type": "string", "nullable": true, "description": "Unidade de `raw_amount`, quando o provedor a informa." } } } }, "destination_of_funds": { "type": "array", "description": "Para onde o endereço enviou fundos, atribuídos por entidade. Mesmo formato de item de `source_of_funds`, com `exposure_direction` = `outgoing`.", "items": { "type": "object", "properties": { "category": { "type": "string", "description": "Categoria de risco normalizada, por exemplo `exchange_licensed`, `dex`, `defi`, `payment_processor`, `mixer`, `darknet_market`, `sanctioned`, `stolen_funds`, `high_risk_exchange`." }, "percentage": { "type": "number", "description": "Participação na exposição total da direção, de 0 a 100." }, "amount_usd": { "type": "number", "nullable": true, "description": "Valor em USD atribuído a esta entidade." }, "entity_name": { "type": "string", "nullable": true, "description": "Nome da entidade atribuída, por exemplo uma exchange, um mixer ou um grupo sancionado." }, "entity_type": { "type": "string", "nullable": true, "description": "Tipo da entidade no provedor (por exemplo, `Exchange`, `DeFi`, `Sanctions`, `Theft`)." }, "entity_subtype": { "type": "string", "nullable": true, "description": "Subtipo mais detalhado (por exemplo, `Mandatory KYC and AML`, `OFAC`, `Yield Aggregator`)." }, "hops": { "type": "integer", "nullable": true, "description": "Número de saltos até a entidade (1 para uma contraparte direta), quando o provedor informa esse dado. Sempre `null` para a Merkle Science, que informa apenas se a exposição é direta ou indireta: use `exposure_type`." }, "description": { "type": "string", "nullable": true, "description": "`entity_type / entity_subtype`, conforme o provedor classifica a entidade." }, "is_direct": { "type": "boolean", "description": "True quando `exposure_type` é `direct`." }, "exposure_direction": { "type": "string", "enum": [ "incoming", "outgoing", "connected" ], "description": "Se os fundos vieram desta entidade (`incoming`) ou foram enviados a ela (`outgoing`)." }, "exposure_type": { "type": "string", "enum": [ "direct", "indirect" ], "description": "Exposição `direct` (1 salto) ou `indirect` (vários saltos)." }, "provider_entity_id": { "type": "string", "nullable": true, "description": "O identificador próprio do provedor para a entidade." }, "provider_entity_type_id": { "type": "string", "nullable": true, "description": "O identificador próprio do provedor para `entity_type`." }, "provider_entity_subtype_id": { "type": "string", "nullable": true, "description": "O identificador próprio do provedor para `entity_subtype`." }, "country": { "type": "string", "nullable": true, "description": "País principal da entidade no formato ISO 3166-1 alpha-2. Vazio ou `null` quando o provedor não o conhece." }, "raw_amount": { "type": "number", "nullable": true, "description": "Valor na própria unidade do ativo, quando o provedor o informa." }, "raw_currency": { "type": "string", "nullable": true, "description": "Unidade de `raw_amount`, quando o provedor a informa." } } } }, "counterparty_connections": { "type": "array", "description": "Entidades às quais o provedor atribui o endereço analisado. Para a Merkle Science, elas vêm das tags de proprietário e de usuário do próprio endereço, então a mesma entidade pode aparecer duas vezes, e não trazem fluxos de fundos: `received_usd`, `sent_usd`, `received_hops` e `sent_hops` são `null` e `percentage` é 0. Não tome decisões com base em `risk_level` ou `is_direct` aqui: use `sanctions_hit`, `dominant_risk_category` e `risk_factors[].is_high_risk` para o veredito, e `exposure_type` em `source_of_funds`/`destination_of_funds` para saber se a exposição é direta.", "items": { "type": "object", "properties": { "entity_name": { "type": "string", "nullable": true, "description": "Nome da entidade atribuída." }, "entity_type": { "type": "string", "nullable": true, "description": "Tipo da entidade no provedor." }, "entity_subtype": { "type": "string", "nullable": true, "description": "Subtipo da entidade no provedor." }, "risk_level": { "type": "string", "description": "Em minúsculas e dependente do provedor. Para a Merkle Science, é o próprio grau de risco de 0 a 5 do endereço (`no_risk`, `low`, `medium_low`, `medium`, `high`, `critical`), elevado para `high` quando a categoria da entidade é de alto risco; não é um grau separado da entidade." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Categorias de risco normalizadas da entidade." }, "received_usd": { "type": "number", "nullable": true, "description": "Valor em USD recebido da entidade, quando o provedor o informa." }, "sent_usd": { "type": "number", "nullable": true, "description": "Valor em USD enviado à entidade, quando o provedor o informa." }, "received_hops": { "type": "integer", "nullable": true, "description": "Saltos até a entidade do lado receptor, quando o provedor os informa." }, "sent_hops": { "type": "integer", "nullable": true, "description": "Saltos até a entidade do lado remetente, quando o provedor os informa." }, "percentage": { "type": "number", "description": "Participação na exposição do endereço, quando o provedor a informa; caso contrário, 0." }, "is_direct": { "type": "boolean", "description": "Sempre `true` para a Merkle Science, cujas conexões são atribuições, e não contrapartes." }, "country": { "type": "string", "nullable": true, "description": "País da entidade, quando conhecido." }, "provider_entity_id": { "type": "string", "nullable": true, "description": "O identificador próprio do provedor para a entidade." } } } }, "network_nodes": { "type": "array", "items": { "type": "object" }, "description": "Nós do grafo de exposição para a triagem de transações. Vazio em um resultado de Triagem de carteiras." }, "network_edges": { "type": "array", "items": { "type": "object" }, "description": "Arestas do grafo de exposição para a triagem de transações. Vazio em um resultado de Triagem de carteiras." }, "sanctions_hit": { "type": "boolean", "description": "True se o endereço tem exposição direta ou indireta a sanções." }, "pep_counterparty": { "type": "boolean", "description": "Exposição como pessoa politicamente exposta. `null` quando não há nenhuma constatação de PEP disponível, o que ocorre hoje em todos os resultados, pois nenhum provedor a informa; `false` somente para um resultado de triagem explicitamente negativo. Não interprete `null` como uma verificação de PEP concluída.", "nullable": true }, "dominant_risk_category": { "type": "string", "nullable": true, "description": "Categoria de alto risco com maior peso, ou `null` quando nenhuma predomina (por exemplo, `sanctioned`, `mixer`, `stolen_funds`)." }, "risk_factors": { "type": "array", "description": "Explicação ordenada de `risk_score`: o que levou a este veredito. Os provedores avaliam um endereço com o próprio modelo e retornam apenas um veredito (a Merkle Science retorna um inteiro de 0 a 5), então a pontuação sozinha não permite agir. A ordem é primeiro os de alto risco, depois o valor que passou por cada fator, limitada aos cinco mais fortes; `source_of_funds` e `destination_of_funds` sempre trazem o detalhamento completo. Um `risk_score` alto sem nenhuma entrada `is_high_risk` significa que o provedor não informou correspondência com sanções nem com entidade atribuída e avaliou o endereço apenas com o próprio modelo de exposição. O `summary` informa isso explicitamente.", "items": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "attribution", "exposure" ], "description": "`attribution` é o que o provedor diz que o próprio endereço é (sua própria tag ou cluster); `exposure` é para onde seus fundos de fato se moveram." }, "category": { "type": "string", "description": "Categoria de risco normalizada, com o mesmo vocabulário do detalhamento de exposição." }, "label": { "type": "string", "description": "A descrição do próprio provedor para o fator (por exemplo, `Gambling / Crypto only`), que é o que você também veria no console do provedor." }, "entity_name": { "type": "string", "nullable": true, "description": "Entidade atribuída por trás do fator, por exemplo, um site de apostas ou uma exchange." }, "direction": { "type": "string", "enum": [ "incoming", "outgoing", "connected", "unknown", "attribution" ], "description": "Direção do fluxo de fundos, `attribution` quando o fator determinante é a própria tag do endereço, ou `unknown` quando o provedor não informou uma direção." }, "exposure_type": { "type": "string", "enum": [ "direct", "indirect", "unknown", "attribution" ], "description": "`direct` (1 salto) ou `indirect` (vários saltos), `attribution` para a tag do próprio endereço, ou `unknown` quando o provedor não informou a quantos saltos de distância a contraparte está. Trate `unknown` como não classificado, e não como `direct`." }, "amount_usd": { "type": "number", "format": "float", "nullable": true, "description": "Valor em USD atribuído a este fator." }, "percentage": { "type": "number", "format": "float", "description": "Participação no volume TOTAL analisado do endereço, somando as duas direções, ao contrário de `percentage` dentro de `source_of_funds`/`destination_of_funds`, que é normalizado por direção. Comparável e somável em toda a lista." }, "is_high_risk": { "type": "boolean", "description": "Se a categoria é uma das que a Didit trata como de alto risco (`sanctioned`, `mixer`, `stolen_funds`, `ransomware`, `scam`, `darknet_market`, `terrorist_financing`, `child_exploitation`, `hacked_exchange`, `high_risk_exchange`, `seized_funds`)." }, "description": { "type": "string", "description": "Representação em uma linha do fator determinante, por exemplo `9.01% indirect outgoing exposure to Gambling / Crypto only (Example Gambling)`." } } } }, "raw_response": { "type": "object", "additionalProperties": true, "description": "O payload próprio do provedor. O formato dele é específico de cada provedor e pode mudar sem aviso: leia os campos normalizados em vez de interpretá-lo." }, "report_signature": { "type": "string", "description": "Assinatura HMAC-SHA256 opaca sobre exatamente este resultado, restrita à sua aplicação. Não tem significado por si só: reenvie o corpo completo da resposta, sem modificações e incluindo este campo, para `POST /v3/wallet-screening/pdf/` para gerá-lo como PDF. O endpoint de PDF rejeita a requisição com `400` se `report_signature` estiver ausente ou se qualquer campo assinado (por exemplo, `risk_score`, `severity`, `sanctions_hit`) tiver sido editado antes do reenvio." } }, "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": "Pontuação de risco, de 0 a 100." }, "band": { "type": "string", "enum": [ "low", "medium", "high" ], "description": "Faixa em que a pontuação é exibida. high >= 70, medium >= 40, caso contrário low." }, "bar": { "type": "number", "format": "float", "description": "Valor normalizado de 0 a 1 para renderizar uma barra de risco." } } }, "NetworkNodeTag": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string", "nullable": true, "description": "Null para tags de proteção, cujo token de cor é definido pelo renderizador." }, "source": { "type": "string", "enum": [ "subject_tag", "session_tag", "transaction_tag", "signal_guard" ], "description": "Origem da tag: uma tag no usuário/empresa, uma tag em uma sessão desta rede, uma tag em uma transação da qual uma parte participa ou uma condição de proteção por sinal (por exemplo, hub, IP de datacenter)." }, "category": { "type": "string", "enum": [ "customer", "quality" ], "nullable": true, "description": "customer para tags definidas pelo cliente, quality para tags de proteção da qualidade do sinal. Null quando não se aplica." } } }, "NetworkListItem": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "network_id": { "type": "string", "description": "ID sequencial legível por organização, por exemplo N-0001." }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "active", "in_review", "resolved", "dismissed" ], "description": "Status do ciclo de vida da rede. Diferente do outcome_status por candidato dentro de uma rede (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": "Os padrões de agrupamento detectados nesta rede." }, "signal_types": { "type": "array", "items": { "type": "string", "enum": [ "ip_address", "device", "face", "document_number", "phone", "email", "address" ] }, "description": "Os tipos de sinal distintos presentes nesta rede." }, "member_counts": { "type": "object", "description": "Contagens de membros por categoria (por exemplo, total, por outcome_status)." }, "member_status": { "type": "object", "description": "Distribuição dos membros por outcome_status." }, "signal_coverage": { "type": "object", "description": "Cobertura por signal_type dos membros desta rede." }, "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": "Estatísticas agregadas da rede (por exemplo, totais de membros)." }, "fraud_tags": { "type": "array", "items": { "type": "object" }, "description": "Tags de padrões de fraude identificadas na rede." }, "risk_signals": { "type": "object", "description": "Resumos dos sinais de risco: residential_proxy_reuse, email_intelligence, phone_intelligence." }, "reviewed_at": { "type": "string", "format": "date-time", "nullable": true }, "reviewed_by": { "type": "string", "nullable": true }, "review_reason": { "type": "string", "nullable": true } } } ], "properties": { "notes_count": { "type": "integer", "minimum": 0, "readOnly": true, "description": "Número de notas privadas de analistas nesta investigação." } } }, "NetworkGraphNode": { "type": "object", "description": "Um nó de sujeito ou um nó de sinal, diferenciados por kind. Nós de sujeito (kind: vendor_user | vendor_business | transaction_party) contêm id, kind, subject, node_status (approved | in_review | declined | not_completed) e tags. Nós de sinal (kind: signal) contêm 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 e 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 do nó do sujeito." }, "target": { "type": "string", "description": "ID do nó de sinal." }, "subject_kind": { "type": "string", "enum": [ "vendor_user", "vendor_business", "transaction_party" ] }, "signal_type": { "type": "string", "enum": [ "ip_address", "device", "face", "document_number", "phone", "email", "address" ] }, "confidence": { "type": "number", "format": "float", "description": "1.0 para uma correspondência exata." }, "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": "Profundidade efetiva aplicada, ou null quando ilimitada (depth=all)." }, "truncated": { "type": "boolean", "description": "True se a vizinhança foi cortada pela profundidade." }, "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": "O vendor_user, vendor_business ou transaction_party que este membro representa." }, "outcome_status": { "type": "string", "description": "O resultado da verificação/decisão do titular." }, "node_status": { "type": "string", "enum": [ "approved", "in_review", "declined", "not_completed", "signal_active", "signal_guarded" ], "description": "Para uma linha de membro, é sempre um dos valores de resultado do titular: approved, in_review, declined ou not_completed." }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkNodeTag" } }, "risk": { "$ref": "#/components/schemas/NetworkRiskDisplay" }, "signal_coverage": { "type": "object" }, "shared_infrastructure": { "type": "object" }, "joined_at": { "type": "string", "format": "date-time", "nullable": true }, "last_seen_at": { "type": "string", "format": "date-time", "nullable": true }, "provenance": { "type": "object", "properties": { "session_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "business_session_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "transaction_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "NetworkSignal": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "signal_type": { "type": "string", "enum": [ "ip_address", "device", "face", "document_number", "phone", "email", "address" ] }, "subject_count": { "type": "integer" }, "coverage": { "type": "number", "format": "float" }, "is_hub": { "type": "boolean", "description": "True quando este sinal vincula um número incomumente grande de titulares." }, "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": "Por exemplo, network_detected, signal_observed, network_in_review, network_resolved, network_dismissed." }, "occurred_at": { "type": "string", "format": "date-time", "nullable": true }, "label": { "type": "string" }, "metadata": { "type": "object" } } }, "NetworkMap": { "type": "object", "properties": { "network": { "$ref": "#/components/schemas/NetworkDetail" }, "convergence_count": { "type": "integer", "description": "Número de pontos distintos de endereço/localização em que os membros convergem." }, "countries": { "type": "array", "items": { "type": "string" } }, "points": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "country": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "latitude": { "type": "number", "format": "float", "nullable": true }, "longitude": { "type": "number", "format": "float", "nullable": true }, "observed_at": { "type": "string", "format": "date-time", "nullable": true } } } } } }, "EntityNetworkMembership": { "type": "object", "properties": { "network": { "$ref": "#/components/schemas/NetworkListItem" }, "subject": { "type": "object" }, "signal_types": { "type": "array", "items": { "type": "string", "enum": [ "ip_address", "device", "face", "document_number", "phone", "email", "address" ] } }, "signal_count": { "type": "integer" }, "joined_at": { "type": "string", "format": "date-time", "nullable": true }, "last_seen_at": { "type": "string", "format": "date-time", "nullable": true } } }, "RiskSignals": { "type": "object", "description": "Contexto opcional de dispositivo e rede observado pela sua aplicação. Todos os campos são opcionais. Enviá-los alimenta a detecção de correspondências entre sessões em Networks.", "properties": { "ip": { "type": "string", "format": "ip", "description": "Endereço IPv4 ou IPv6 observado para o usuário final.", "example": "192.0.2.1" }, "device_id": { "type": "string", "maxLength": 255, "description": "Identificador estável do dispositivo coletado pela sua aplicação (`ANDROID_ID` no Android, `identifierForVendor` no iOS)." }, "device_platform": { "type": "string", "enum": [ "android", "ios", "ipados", "tvos", "web" ], "description": "Plataforma do dispositivo do usuário final." }, "device_model": { "type": "string", "maxLength": 255, "description": "Modelo do dispositivo informado pela sua aplicação." }, "os_version": { "type": "string", "maxLength": 64, "description": "Versão do sistema operacional." }, "app_version": { "type": "string", "maxLength": 64, "description": "Versão da sua aplicação." }, "user_agent": { "type": "string", "maxLength": 512, "description": "User agent do navegador ou do app." } } }, "PhoneRiskRequest": { "type": "object", "required": [ "phone_number" ], "properties": { "phone_number": { "type": "string", "maxLength": 20, "description": "Número de telefone a ser pontuado. Ele é validado e normalizado para E.164.", "example": "+14155552671" }, "country_code": { "type": "string", "maxLength": 3, "description": "Indicação opcional de país em ISO 3166-1 alfa-2 ou alfa-3 para a cobertura de inteligência.", "example": "US" }, "signals": { "$ref": "#/components/schemas/RiskSignals" }, "vendor_data": { "type": "string", "description": "Sua referência estável para esta requisição. Armazenada na sessão da API e devolvida na resposta." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Seus metadados JSON não sensíveis. Armazenados na sessão da API e retornados na resposta." }, "enable_social": { "type": "boolean", "default": false, "description": "Quando verdadeiro, também consulta a presença digital do número: as plataformas de mensagens, redes sociais, e-commerce e profissionais em que ele está cadastrado. Cobrado como uma unidade `phone_social` por requisição, além do preço deste endpoint.", "example": true } } }, "EmailRiskRequest": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "description": "Endereço de e-mail a ser pontuado.", "example": "alice@example.com" }, "country_code": { "type": "string", "maxLength": 3, "description": "Indicação opcional de país em ISO 3166-1 alfa-2 ou alfa-3 para a cobertura de inteligência.", "example": "US" }, "signals": { "$ref": "#/components/schemas/RiskSignals" }, "vendor_data": { "type": "string", "description": "Sua referência estável para esta requisição. Armazenada na sessão da API e devolvida na resposta." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Seus metadados JSON não sensíveis. Armazenados na sessão da API e retornados na resposta." }, "enable_social": { "type": "boolean", "default": false, "description": "Quando verdadeiro, também consulta a presença digital do endereço: as plataformas de e-mail, redes sociais, profissionais, e-commerce e entretenimento em que ele está cadastrado. Cobrado como uma unidade `email_social` por requisição, além do preço deste endpoint.", "example": true } } }, "IPRiskRequest": { "type": "object", "required": [ "ip_address" ], "properties": { "ip_address": { "type": "string", "format": "ip", "description": "Endereço IPv4 ou IPv6 a ser pontuado.", "example": "8.8.8.8" }, "claimed_country": { "type": "string", "maxLength": 3, "description": "País opcional em ISO 3166-1 alfa-2 ou alfa-3 declarado pelo usuário ou pela sessão. Usado para calcular `country_mismatch`.", "example": "ESP" }, "user_agent": { "type": "string", "maxLength": 512, "description": "User agent observado pelo seu backend. Armazenado como contexto da requisição; não fornece fingerprinting de dispositivo." }, "vendor_data": { "type": "string", "description": "Sua referência estável para esta requisição. Armazenada na sessão da API e devolvida na resposta." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Seus metadados JSON não sensíveis. Armazenados na sessão da API e retornados na resposta." } } }, "RiskWarning": { "type": "object", "required": [ "feature", "risk", "log_type", "short_description", "long_description" ], "properties": { "feature": { "type": "string", "description": "Recurso que gerou o aviso." }, "risk": { "type": "string", "description": "Código de risco legível por máquina. Novos valores podem ser adicionados com o tempo." }, "additional_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Contexto específico do risco, ou `null`." }, "log_type": { "type": "string", "enum": [ "error", "warning", "information" ], "description": "Severidade usada pelas regras de decisão." }, "short_description": { "type": "string", "description": "Resumo legível de uma linha." }, "long_description": { "type": "string", "description": "Explicação legível." } } }, "RiskLifecycleEvent": { "type": "object", "required": [ "type", "timestamp", "details", "fee" ], "properties": { "type": { "type": "string", "description": "Tipo de evento legível por máquina. Novos valores podem ser adicionados ao longo do tempo." }, "timestamp": { "type": "string", "format": "date-time", "description": "Quando o evento ocorreu." }, "details": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Payload específico do evento, ou `null`." }, "fee": { "type": "number", "description": "Valor em USD cobrado por este evento." } } }, "PhoneMatchItem": { "type": "object", "description": "Outra sessão da sua aplicação que usou o mesmo número de telefone com um `vendor_data` diferente.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID da sessão da outra verificação que usou este número de telefone." }, "session_number": { "type": "integer", "description": "Número sequencial de fácil leitura dessa sessão." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` dessa sessão." }, "verification_date": { "type": "string", "description": "Quando essa sessão foi criada (`YYYY-MM-DDTHH:MM:SSZ`)." }, "phone_number": { "type": "string", "description": "O número de telefone correspondente." }, "status": { "type": "string", "description": "Status dessa sessão (por exemplo, `Approved`, `Declined`, `In Progress`)." }, "is_blocklisted": { "type": "boolean", "description": "Se o número de telefone está na lista de bloqueio da sua aplicação." }, "api_service": { "type": "string", "nullable": true, "description": "Para sessões do tipo API, a API independente que a criou; `null` para sessões de verificação comuns." }, "source": { "type": "string", "description": "Onde a correspondência foi encontrada. Normalmente `session`; uma ocorrência na lista de bloqueio por meio de uma entrada de lista da organização usa `list_entry`." } } }, "EmailMatchItem": { "type": "object", "description": "Outra sessão da sua aplicação que usou o mesmo endereço de e-mail com um `vendor_data` diferente.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "ID da sessão da outra verificação que usou este endereço de e-mail." }, "session_number": { "type": "integer", "description": "Número sequencial de fácil leitura dessa sessão." }, "vendor_data": { "type": "string", "nullable": true, "description": "`vendor_data` dessa sessão." }, "verification_date": { "type": "string", "description": "Quando essa sessão foi criada (`YYYY-MM-DDTHH:MM:SSZ`)." }, "email": { "type": "string", "description": "O endereço de e-mail correspondente." }, "status": { "type": "string", "description": "Status dessa sessão (por exemplo, `Approved`, `Declined`, `In Progress`)." }, "is_blocklisted": { "type": "boolean", "description": "Se o endereço de e-mail está na lista de bloqueio da sua aplicação." }, "api_service": { "type": "string", "nullable": true, "description": "Para sessões do tipo API, a API independente que a criou; `null` para sessões de verificação comuns." }, "source": { "type": "string", "description": "Onde a correspondência foi encontrada. Normalmente `session`; uma ocorrência na lista de bloqueio por meio de uma entrada de lista da organização usa `list_entry`." } } }, "PhoneIntelligence": { "type": "object", "description": "Bloco normalizado de inteligência de telefone. Presente apenas quando o complemento de inteligência foi executado para esta consulta; quando presente, também é exposto sob o alias `enrichment`, com valores idênticos.", "properties": { "score": { "type": "number", "nullable": true, "description": "Pontuação de risco normalizada de 0 a 100. Quanto maior, mais arriscado." }, "phone_type_risk": { "type": "string", "nullable": true, "description": "`Low`, `Medium` ou `High`, derivado da pontuação." }, "phone_trust_index": { "type": "number", "nullable": true, "description": "Inverso da pontuação, para painéis em que valores mais altos são melhores." }, "network_stability_index": { "type": "number", "nullable": true, "description": "Estabilidade da rede da linha." }, "is_disposable": { "type": "boolean", "nullable": true, "description": "`true` quando o número parece descartável ou virtual." }, "is_ported": { "type": "boolean", "nullable": true, "description": "`true` quando o número mudou de operadora." }, "is_recently_ported": { "type": "boolean", "nullable": true, "description": "`true` quando a portabilidade ocorreu recentemente." }, "carrier_type": { "type": "string", "nullable": true, "description": "Classificação da linha informada pela consulta (por exemplo, `mobile`)." }, "reason_codes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Identificador estável da Didit para o sinal, por exemplo `IR-5AC67A32`. Opaco: agrupe e filtre por ele, mas não o interprete." }, "value": { "nullable": true, "description": "Para um indicador de risco (por exemplo, `voip`, `leaked`, `disposable`, `spam_trap`), o seu valor: um booleano, um nível ou uma data. Nulo para um código de motivo com pontuação." }, "direction": { "type": "string", "enum": [ "risk", "trust" ], "description": "Se o sinal aumentou o risco ou acrescentou confiança." }, "message": { "type": "string", "description": "Explicação legível do sinal, em inglês." }, "impact_level": { "type": "string", "nullable": true, "description": "Com que intensidade o sinal alterou a pontuação, por exemplo `low`, `medium` ou `high`." } } }, "description": "Sinais que explicam a pontuação, cada um com um código estável da Didit, uma direção, uma mensagem e um nível de impacto. Novos códigos podem surgir com o tempo, portanto não rejeite códigos desconhecidos." } } }, "EmailIntelligence": { "type": "object", "description": "Bloco normalizado de inteligência de e-mail. Presente apenas quando o complemento de inteligência foi executado para este e-mail; quando presente, também é exposto como o alias `enrichment`, com valores idênticos.", "properties": { "score": { "type": "number", "nullable": true, "description": "Pontuação de risco normalizada de 0 a 100. Quanto maior, mais arriscado." }, "deliverable": { "type": "string", "nullable": true, "description": "Faixa de entregabilidade (por exemplo, `high`)." }, "breach_risk_level": { "type": "string", "nullable": true, "description": "`Low`, `Medium` ou `High`." }, "breach_risk_index": { "type": "number", "nullable": true, "description": "Índice numérico de risco de vazamento." }, "is_recent_breach": { "type": "boolean", "nullable": true, "description": "`true` quando o endereço aparece em um vazamento recente." }, "is_frequent_breached": { "type": "boolean", "nullable": true, "description": "`true` quando o endereço aparece em muitos vazamentos." }, "is_disposable": { "type": "boolean", "nullable": true, "description": "`true` quando o domínio é um provedor descartável." }, "is_free_domain": { "type": "boolean", "nullable": true, "description": "`true` quando o domínio é um provedor de e-mail gratuito." }, "is_breached": { "type": "boolean", "nullable": true, "description": "`true` quando o endereço aparece em vazamentos conhecidos." }, "no_of_breaches": { "type": "number", "nullable": true, "description": "Número de vazamentos conhecidos que contêm o endereço." }, "reason_codes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Identificador estável da Didit para o sinal, por exemplo `IR-5AC67A32`. Opaco: agrupe e filtre por ele, mas não o interprete." }, "value": { "nullable": true, "description": "Para um indicador de risco (por exemplo, `voip`, `leaked`, `disposable`, `spam_trap`), o seu valor: um booleano, um nível ou uma data. Nulo para um código de motivo com pontuação." }, "direction": { "type": "string", "enum": [ "risk", "trust" ], "description": "Se o sinal aumentou o risco ou acrescentou confiança." }, "message": { "type": "string", "description": "Explicação legível do sinal, em inglês." }, "impact_level": { "type": "string", "nullable": true, "description": "Com que intensidade o sinal alterou a pontuação, por exemplo `low`, `medium` ou `high`." } } }, "description": "Sinais que explicam a pontuação, cada um com um código estável da Didit, uma direção, uma mensagem e um nível de impacto. Novos códigos podem surgir com o tempo, portanto não rejeite códigos desconhecidos." } } }, "IPRiskResult": { "type": "object", "description": "Resultado de risco do IP. Campos de enriquecimento individuais podem ser `null` quando a consulta não retornou dados utilizáveis.", "required": [ "status", "threat" ], "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review" ], "description": "`In Review` quando o país identificado diverge de `claimed_country`, ou quando o endereço está associado a VPN, Tor ou infraestrutura de data center. Caso contrário, `Approved`." }, "ip_address": { "type": "string", "nullable": true, "description": "O endereço pontuado. `null` quando nenhuma fonte de enriquecimento retornou dados utilizáveis." }, "ip_country": { "type": "string", "nullable": true, "description": "Nome do país resolvido." }, "ip_country_code": { "type": "string", "nullable": true, "description": "Código do país resolvido. Compare países por meio de `country_mismatch` em vez de comparar você mesmo as strings brutas de país." }, "ip_state": { "type": "string", "nullable": true, "description": "Estado ou região resolvidos." }, "ip_city": { "type": "string", "nullable": true, "description": "Cidade resolvida." }, "latitude": { "type": "number", "nullable": true, "description": "Geolocalização aproximada pela rede, não uma localização precisa do dispositivo." }, "longitude": { "type": "number", "nullable": true, "description": "Geolocalização aproximada pela rede, não uma localização precisa do dispositivo." }, "isp": { "type": "string", "nullable": true, "description": "Provedor de serviços de internet que atende o endereço." }, "organization": { "type": "string", "nullable": true, "description": "Organização proprietária do bloco de endereços." }, "is_vpn_or_tor": { "type": "boolean", "nullable": true, "description": "`true` quando o endereço está associado a infraestrutura de VPN ou Tor." }, "is_data_center": { "type": "boolean", "nullable": true, "description": "`true` quando o endereço pertence a uma rede de hospedagem ou de data center." }, "time_zone": { "type": "string", "nullable": true, "description": "Fuso horário da localização resolvida." }, "time_zone_offset": { "type": "string", "nullable": true, "description": "Deslocamento UTC da localização resolvida." }, "asn_number": { "type": "number", "nullable": true, "description": "Número de sistema autônomo." }, "asn_organization": { "type": "string", "nullable": true, "description": "Organização que opera o sistema autônomo." }, "connection_type": { "type": "string", "nullable": true, "description": "Classificação da conexão (por exemplo, `cellular`, `hosting`)." }, "carrier": { "type": "string", "nullable": true, "description": "Operadora móvel quando o endereço está em uma rede móvel." }, "proxy_type": { "type": "string", "nullable": true, "description": "Classificação de proxy quando o endereço está atrás de um proxy." }, "claimed_country": { "type": "string", "nullable": true, "description": "Eco do `claimed_country` que você enviou." }, "country_mismatch": { "type": "boolean", "nullable": true, "description": "`true` quando o país identificado difere de `claimed_country`. `null` quando não há dados de enriquecimento ou nenhum país declarado disponível." }, "threat": { "type": "object", "additionalProperties": true, "description": "Evidências livres de ameaças de rede vindas da fonte de enriquecimento (por exemplo, `is_proxy`, `is_tor`). Objeto vazio quando não há dados de enriquecimento disponíveis. Trate como detalhe de diagnóstico, não como um contrato estável." } } }, "PhoneRiskResponse": { "type": "object", "required": [ "request_id", "status", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Id da sessão de API criada para esta requisição. Armazene-o com `vendor_data` se precisar correlacionar o resultado com webhooks posteriores ou com a atividade no console." }, "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Decisão final desta sessão de API. Normalmente `Approved`; a avaliação de risco pode resultar em `In Review` ou `Declined`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco do `vendor_data` que você enviou, `null` quando você não enviou nenhum." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Eco do `metadata` que você enviou, `null` quando você não enviou nenhum." }, "created_at": { "type": "string", "format": "date-time", "description": "Data e hora desta resposta." }, "phone": { "type": "object", "description": "Relatório de telefone normalizado, o mesmo bloco usado nas respostas de Verificação de telefone.", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Decisão para este número de telefone. Espelha o `status` de nível superior." }, "phone_number_prefix": { "type": "string", "description": "Código de discagem do país com `+` no início (por exemplo, `+1`).", "example": "+1" }, "phone_number": { "type": "string", "description": "Número nacional sem o código de discagem do país.", "example": "4155552671" }, "full_number": { "type": "string", "description": "Número completo no formato E.164.", "example": "+14155552671" }, "country_code": { "type": "string", "nullable": true, "description": "País do número, no formato ISO 3166-1 alpha-2.", "example": "US" }, "country_name": { "type": "string", "description": "Nome completo do país derivado de `country_code`.", "example": "United States" }, "carrier": { "type": "object", "nullable": true, "description": "Rede que atende o número atualmente. `null` quando a consulta não conseguiu identificar uma operadora.", "properties": { "name": { "type": "string", "description": "Nome da operadora. String vazia quando a consulta não conseguiu identificá-la." }, "type": { "type": "string", "description": "Tipo de linha informado pela consulta: `mobile`, `fixed_line`, `voip`, `isp`, `vpn`, `toll_free`, `premium_rate` ou similar." } } }, "is_disposable": { "type": "boolean", "description": "`true` quando o número pertence a um serviço de números temporários ou descartáveis." }, "is_virtual": { "type": "boolean", "description": "`true` quando o tipo de linha é virtual (`voip`, `isp` ou `vpn`)." }, "verification_method": { "type": "string", "nullable": true, "description": "Canal de OTP da verificação subjacente. `null` para consultas de risco, que nunca enviam um código." }, "verification_attempts": { "type": "integer", "description": "Envios de OTP para este número. `0` para consultas de risco." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o número foi verificado por OTP pela última vez. `null` para consultas de risco." }, "warnings": { "type": "array", "description": "Avisos de risco registrados para esta requisição. Array vazio quando não há nenhum.", "items": { "$ref": "#/components/schemas/RiskWarning" } }, "lifecycle": { "type": "array", "description": "Trilha de auditoria cronológica da requisição. Array vazio para consultas de risco sem eventos de envio.", "items": { "$ref": "#/components/schemas/RiskLifecycleEvent" } }, "matches": { "type": "array", "description": "Outras sessões da sua aplicação em que o mesmo número de telefone foi usado por um usuário diferente (`vendor_data` diferente). Até 5 entradas. Array vazio quando não há correspondências.", "items": { "$ref": "#/components/schemas/PhoneMatchItem" } }, "phone_intelligence": { "$ref": "#/components/schemas/PhoneIntelligence" }, "enrichment": { "$ref": "#/components/schemas/PhoneIntelligence" }, "phone_social": { "$ref": "#/components/schemas/PhoneSocialFootprint" } } } } }, "EmailRiskResponse": { "type": "object", "required": [ "request_id", "status", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Id da sessão de API criada para esta requisição. Armazene-o com `vendor_data` se precisar correlacionar o resultado com webhooks posteriores ou com a atividade no console." }, "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Decisão final desta sessão de API. Normalmente `Approved`; a avaliação de risco pode resultar em `In Review` ou `Declined`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco do `vendor_data` que você enviou, `null` quando você não enviou nenhum." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Eco do `metadata` que você enviou, `null` quando você não enviou nenhum." }, "created_at": { "type": "string", "format": "date-time", "description": "Data e hora desta resposta." }, "email": { "type": "object", "description": "Relatório de e-mail normalizado, o mesmo bloco usado nas respostas de Verificação de e-mail.", "required": [ "status", "email", "is_breached", "breaches", "is_disposable", "is_undeliverable" ], "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review", "Declined" ], "description": "Decisão para este endereço de e-mail. Espelha o `status` de nível superior." }, "email": { "type": "string", "description": "O endereço pontuado.", "example": "alice@example.com" }, "is_breached": { "type": "boolean", "description": "Se o endereço aparece em um vazamento de credenciais conhecido." }, "breaches": { "type": "array", "description": "Até 5 vazamentos conhecidos mais recentes que contêm este endereço. Array vazio quando `is_breached` é `false`.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Identificador do vazamento." }, "domain": { "type": "string", "description": "Domínio do serviço vazado." }, "breach_date": { "type": "string", "format": "date", "description": "Data em que a violação ocorreu." }, "breach_emails_count": { "type": "integer", "description": "Número total de contas expostas no vazamento." }, "description": { "type": "string", "description": "Descrição legível do vazamento (pode conter marcação HTML)." }, "logo_path": { "type": "string", "description": "URL do logotipo do serviço vazado." }, "data_classes": { "type": "array", "items": { "type": "string" }, "description": "Categorias de dados expostos, em snake_case (por exemplo, `email_addresses`, `passwords`)." }, "is_verified": { "type": "boolean", "description": "Se o vazamento foi verificado como legítimo." } } } }, "is_disposable": { "type": "boolean", "description": "Se o domínio pertence a um provedor de e-mails descartáveis." }, "is_undeliverable": { "type": "boolean", "description": "Se o endereço foi considerado não entregável." }, "verification_attempts": { "type": "integer", "description": "Envios de OTP para este endereço. `0` para consultas de risco." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o endereço foi verificado pela última vez por um OTP. `null` para consultas de risco." }, "warnings": { "type": "array", "description": "Avisos de risco registrados para esta requisição. Array vazio quando não há nenhum.", "items": { "$ref": "#/components/schemas/RiskWarning" } }, "lifecycle": { "type": "array", "description": "Trilha de auditoria cronológica da requisição. Array vazio para consultas de risco sem envios.", "items": { "$ref": "#/components/schemas/RiskLifecycleEvent" } }, "matches": { "type": "array", "description": "Outras sessões da sua aplicação em que o mesmo endereço de e-mail foi usado por um usuário diferente (`vendor_data` diferente). Até 5 entradas. Array vazio quando não há correspondências.", "items": { "$ref": "#/components/schemas/EmailMatchItem" } }, "email_intelligence": { "$ref": "#/components/schemas/EmailIntelligence" }, "enrichment": { "$ref": "#/components/schemas/EmailIntelligence" }, "email_social": { "$ref": "#/components/schemas/EmailSocialFootprint" } } } } }, "IPRiskResponse": { "type": "object", "required": [ "request_id", "status", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Id da sessão de API criada para esta requisição. Armazene-o com `vendor_data` se precisar correlacionar o resultado com webhooks posteriores ou com a atividade no console." }, "status": { "type": "string", "enum": [ "Approved", "In Review" ], "description": "Decisão desta sessão de API: `In Review` em caso de risco de rede ou de divergência de país; caso contrário, `Approved`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco do `vendor_data` que você enviou, `null` quando você não enviou nenhum." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Eco do `metadata` que você enviou, `null` quando você não enviou nenhum." }, "created_at": { "type": "string", "format": "date-time", "description": "Data e hora desta resposta." }, "ip": { "type": "object", "description": "Resultado de risco do IP. Campos de enriquecimento individuais podem ser `null` quando a consulta não retornou dados utilizáveis.", "required": [ "status", "threat" ], "properties": { "status": { "type": "string", "enum": [ "Approved", "In Review" ], "description": "`In Review` quando o país identificado diverge de `claimed_country`, ou quando o endereço está associado a VPN, Tor ou infraestrutura de data center. Caso contrário, `Approved`." }, "ip_address": { "type": "string", "nullable": true, "description": "O endereço pontuado. `null` quando nenhuma fonte de enriquecimento retornou dados utilizáveis." }, "ip_country": { "type": "string", "nullable": true, "description": "Nome do país resolvido." }, "ip_country_code": { "type": "string", "nullable": true, "description": "Código do país resolvido. Compare países por meio de `country_mismatch` em vez de comparar você mesmo as strings brutas de país." }, "ip_state": { "type": "string", "nullable": true, "description": "Estado ou região resolvidos." }, "ip_city": { "type": "string", "nullable": true, "description": "Cidade resolvida." }, "latitude": { "type": "number", "nullable": true, "description": "Geolocalização aproximada pela rede, não uma localização precisa do dispositivo." }, "longitude": { "type": "number", "nullable": true, "description": "Geolocalização aproximada pela rede, não uma localização precisa do dispositivo." }, "isp": { "type": "string", "nullable": true, "description": "Provedor de serviços de internet que atende o endereço." }, "organization": { "type": "string", "nullable": true, "description": "Organização proprietária do bloco de endereços." }, "is_vpn_or_tor": { "type": "boolean", "nullable": true, "description": "`true` quando o endereço está associado a infraestrutura de VPN ou Tor." }, "is_data_center": { "type": "boolean", "nullable": true, "description": "`true` quando o endereço pertence a uma rede de hospedagem ou de data center." }, "time_zone": { "type": "string", "nullable": true, "description": "Fuso horário da localização resolvida." }, "time_zone_offset": { "type": "string", "nullable": true, "description": "Deslocamento UTC da localização resolvida." }, "asn_number": { "type": "number", "nullable": true, "description": "Número de sistema autônomo." }, "asn_organization": { "type": "string", "nullable": true, "description": "Organização que opera o sistema autônomo." }, "connection_type": { "type": "string", "nullable": true, "description": "Classificação da conexão (por exemplo, `cellular`, `hosting`)." }, "carrier": { "type": "string", "nullable": true, "description": "Operadora móvel quando o endereço está em uma rede móvel." }, "proxy_type": { "type": "string", "nullable": true, "description": "Classificação de proxy quando o endereço está atrás de um proxy." }, "claimed_country": { "type": "string", "nullable": true, "description": "Eco do `claimed_country` que você enviou." }, "country_mismatch": { "type": "boolean", "nullable": true, "description": "`true` quando o país identificado difere de `claimed_country`. `null` quando não há dados de enriquecimento ou nenhum país declarado disponível." }, "threat": { "type": "object", "additionalProperties": true, "description": "Evidências livres de ameaças de rede vindas da fonte de enriquecimento (por exemplo, `is_proxy`, `is_tor`). Objeto vazio quando não há dados de enriquecimento disponíveis. Trate como detalhe de diagnóstico, não como um contrato estável." } } } } }, "SocialFootprintPlatform": { "type": "object", "properties": { "platform": { "type": "string", "description": "Identificador da plataforma.", "example": "whatsapp" }, "category": { "type": "string", "description": "Categoria da plataforma, por exemplo MESSAGING, SOCIAL_MEDIA, ECOMMERCE, PROFESSIONAL, EMAIL_PROVIDER.", "example": "MESSAGING" }, "scope": { "type": "string", "enum": [ "global", "local" ], "description": "`global` para plataformas de alcance mundial, `local` para plataformas específicas de uma região.", "example": "global" } } }, "SocialFootprintCategorySummary": { "type": "object", "properties": { "registered": { "type": "integer", "nullable": true, "description": "Plataformas desta categoria em que o cadastro foi confirmado.", "example": 2 }, "ratio": { "type": "number", "format": "float", "nullable": true, "description": "Proporção das plataformas verificadas da categoria com cadastro, de 0.0 a 1.0.", "example": 0.6667 } } }, "SocialFootprintProfile": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome do perfil, quando a plataforma o disponibiliza." }, "photo": { "type": "string", "nullable": true, "description": "URL da foto do perfil, quando a plataforma a disponibiliza." }, "about": { "type": "string", "nullable": true, "description": "Texto \"sobre\"/bio do perfil, quando a plataforma o disponibiliza." }, "privacy_status": { "type": "string", "nullable": true, "enum": [ "PUBLIC", "PRIVATE", null ], "description": "Visibilidade do perfil, quando a plataforma a disponibiliza." }, "business_account": { "type": "boolean", "nullable": true, "description": "Se o perfil é uma conta comercial, quando a plataforma informa isso." } } }, "PhoneSocialFootprint": { "type": "object", "nullable": true, "description": "Pegada social do número de telefone: as plataformas online em que ele está cadastrado. Presente apenas quando `enable_social` foi definido e a verificação foi concluída. Qualquer contagem pode ser nula quando nenhum dado foi retornado para ela. `profiles_registered: 0` significa que as plataformas foram verificadas e o número de telefone não foi encontrado em nenhuma delas: uma resposta válida, faturável e um sinal comum de identidade sintética.", "properties": { "profiles_registered": { "type": "integer", "nullable": true, "description": "Plataformas em que o cadastro do número de telefone foi confirmado.", "example": 5 }, "profiles_checked": { "type": "integer", "nullable": true, "description": "Plataformas avaliadas quanto a cadastro.", "example": 14 }, "names_found": { "type": "integer", "nullable": true, "description": "Plataformas que retornaram um nome associado.", "example": 0 }, "photos_found": { "type": "integer", "nullable": true, "description": "Plataformas que retornaram uma foto de perfil.", "example": 0 }, "communication_breadth": { "type": "integer", "nullable": true, "description": "Plataformas de comunicação com presença detectada.", "example": 2 }, "digital_footprint_diversity": { "type": "integer", "nullable": true, "description": "Categorias distintas de plataforma com presença detectada.", "example": 5 }, "digital_sophistication_index": { "type": "integer", "nullable": true, "description": "Indicador composto de maturidade digital, de 0 a 10.", "example": 5 }, "engagement_depth_index": { "type": "integer", "nullable": true, "description": "Indicador de riqueza do perfil, de 0 a 10.", "example": 3 }, "subscription_affordability_index": { "type": "integer", "nullable": true, "description": "Combinação de plataformas gratuitas e pagas, 0-10.", "example": 2 }, "free_platforms": { "type": "integer", "nullable": true, "description": "Registros em plataformas gratuitas.", "example": 4 }, "full_paid_platforms": { "type": "integer", "nullable": true, "description": "Registros em plataformas totalmente pagas.", "example": 0 }, "partial_paid_platforms": { "type": "integer", "nullable": true, "description": "Registros em plataformas freemium.", "example": 1 }, "whatsapp_profile_completeness": { "type": "string", "nullable": true, "enum": [ "Basic", "Partial", "Complete", "Not Present", null ], "description": "Completude do perfil do WhatsApp. Apenas para telefone; null para e-mail.", "example": "Partial" }, "registered_platforms": { "type": "array", "description": "Plataformas em que o cadastro foi confirmado.", "items": { "$ref": "#/components/schemas/SocialFootprintPlatform" } }, "not_registered_platforms": { "type": "array", "description": "Plataformas verificadas com resultado negativo.", "items": { "$ref": "#/components/schemas/SocialFootprintPlatform" } }, "categories": { "type": "object", "description": "Contagem de registros e proporção por categoria de plataforma.", "additionalProperties": { "$ref": "#/components/schemas/SocialFootprintCategorySummary" } }, "profiles": { "type": "object", "description": "Detalhes do perfil por plataforma, indexados por plataforma, quando a plataforma os disponibiliza.", "additionalProperties": { "$ref": "#/components/schemas/SocialFootprintProfile" } } } }, "EmailSocialFootprint": { "type": "object", "nullable": true, "description": "Pegada social do endereço de e-mail: as plataformas online em que ele está cadastrado. Presente apenas quando `enable_social` foi definido e a verificação foi concluída. Qualquer contagem pode ser nula quando nenhum dado foi retornado para ela. `profiles_registered: 0` significa que as plataformas foram verificadas e o endereço de e-mail não foi encontrado em nenhuma delas: uma resposta válida, faturável e um sinal comum de identidade sintética.", "properties": { "profiles_registered": { "type": "integer", "nullable": true, "description": "Plataformas em que o cadastro do endereço de e-mail foi confirmado.", "example": 5 }, "profiles_checked": { "type": "integer", "nullable": true, "description": "Plataformas avaliadas quanto a cadastro.", "example": 14 }, "names_found": { "type": "integer", "nullable": true, "description": "Plataformas que retornaram um nome associado.", "example": 0 }, "photos_found": { "type": "integer", "nullable": true, "description": "Plataformas que retornaram uma foto de perfil.", "example": 0 }, "communication_breadth": { "type": "integer", "nullable": true, "description": "Plataformas de comunicação com presença detectada.", "example": 2 }, "digital_footprint_diversity": { "type": "integer", "nullable": true, "description": "Categorias distintas de plataforma com presença detectada.", "example": 5 }, "digital_sophistication_index": { "type": "integer", "nullable": true, "description": "Indicador composto de maturidade digital, de 0 a 10.", "example": 5 }, "engagement_depth_index": { "type": "integer", "nullable": true, "description": "Indicador de riqueza do perfil, de 0 a 10.", "example": 3 }, "subscription_affordability_index": { "type": "integer", "nullable": true, "description": "Combinação de plataformas gratuitas e pagas, 0-10.", "example": 2 }, "free_platforms": { "type": "integer", "nullable": true, "description": "Registros em plataformas gratuitas.", "example": 4 }, "full_paid_platforms": { "type": "integer", "nullable": true, "description": "Registros em plataformas totalmente pagas.", "example": 0 }, "partial_paid_platforms": { "type": "integer", "nullable": true, "description": "Registros em plataformas freemium.", "example": 1 }, "whatsapp_profile_completeness": { "type": "string", "nullable": true, "enum": [ "Basic", "Partial", "Complete", "Not Present", null ], "description": "Completude do perfil do WhatsApp. Apenas para telefone; null para e-mail.", "example": "Partial" }, "registered_platforms": { "type": "array", "description": "Plataformas em que o cadastro foi confirmado.", "items": { "$ref": "#/components/schemas/SocialFootprintPlatform" } }, "not_registered_platforms": { "type": "array", "description": "Plataformas verificadas com resultado negativo.", "items": { "$ref": "#/components/schemas/SocialFootprintPlatform" } }, "categories": { "type": "object", "description": "Contagem de registros e proporção por categoria de plataforma.", "additionalProperties": { "$ref": "#/components/schemas/SocialFootprintCategorySummary" } }, "profiles": { "type": "object", "description": "Detalhes do perfil por plataforma, indexados por plataforma, quando a plataforma os disponibiliza.", "additionalProperties": { "$ref": "#/components/schemas/SocialFootprintProfile" } } } }, "KYBRegistryAddress": { "type": "object", "description": "Um endereço informado pelo registro, no mesmo formato para todos os países e fontes de registro. Todas as chaves estão sempre presentes; uma parte que o registro não publica é null.", "properties": { "type": { "type": "string", "nullable": true, "description": "Tipo de endereço em letras minúsculas: `registered` para a sede registrada; outros tipos conforme o registro os nomeia (por exemplo, `postal`, `office`). `null` quando o registro não informa o que é o endereço." }, "address": { "type": "string", "description": "O endereço completo em uma única linha. Sempre presente em todo endereço." }, "street": { "type": "string", "nullable": true, "description": "Logradouro e número." }, "city": { "type": "string", "nullable": true, "description": "Cidade ou localidade." }, "postal_code": { "type": "string", "nullable": true, "description": "Código postal." }, "region": { "type": "string", "nullable": true, "description": "Região, estado ou província." }, "country_code": { "type": "string", "nullable": true, "description": "Código de país ISO 3166-1 alpha-2." }, "description": { "type": "string", "nullable": true, "description": "O rótulo próprio do registro para o endereço, quando houver." } }, "required": [ "type", "address", "street", "city", "postal_code", "region", "country_code", "description" ] }, "KYBRegistryIndustry": { "type": "object", "description": "Uma atividade na qual o registro classifica a empresa, no mesmo formato para todos os países e fontes de registro.", "properties": { "code": { "type": "string", "nullable": true, "description": "Código de atividade conforme impresso pelo registro (por exemplo, `73110`)." }, "description": { "type": "string", "nullable": true, "description": "Rótulo da atividade, quando o registro publica um." }, "scheme": { "type": "string", "nullable": true, "description": "Sistema de classificação, com um nome por sistema, independentemente da fonte que o informou: `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`; outros sistemas nacionais mantêm o nome usado pelo próprio registro. Nulo quando o registro não informa o sistema." }, "is_primary": { "type": "boolean", "description": "True para a atividade principal da empresa. Exatamente uma entrada é a principal quando a lista não está vazia." } }, "required": [ "code", "description", "scheme", "is_primary" ] }, "KYBRegistryShareholding": { "type": "object", "nullable": true, "description": "O que um proprietário detém, no mesmo formato para todos os países e fontes de registro. Nulo quando o registro não informa nenhuma participação. Uma faixa (por exemplo, os 25-50% de um PSC do Reino Unido) não é uma participação: `percentage` é nulo e a faixa permanece em `ownership_min_shares` / `ownership_max_shares`.", "properties": { "share_class": { "type": "string", "nullable": true, "description": "Classe ou tipo de ação, conforme denominado pelo registro." }, "number_of_shares": { "type": "number", "nullable": true, "description": "Número de ações detidas." }, "currency": { "type": "string", "nullable": true, "description": "Moeda ISO 4217 dos valores abaixo." }, "nominal_value": { "type": "number", "nullable": true, "description": "Valor nominal por ação." }, "total_value": { "type": "number", "nullable": true, "description": "Valor total da participação." }, "percentage": { "type": "number", "nullable": true, "description": "Participação exata em porcentagem, com quatro casas decimais." } }, "required": [ "share_class", "number_of_shares", "currency", "nominal_value", "total_value", "percentage" ] }, "KYBRegistryOwnership": { "type": "object", "description": "O resultado do nível de propriedade (Acionistas / UBO), no mesmo formato para todos os países e fontes de registro.", "properties": { "status": { "type": "string", "nullable": true, "enum": [ "not_requested", "pending", "delivered", "not_held", "unavailable", null ], "description": "`delivered` quando o registro publicou os dados de propriedade; `not_held` quando o registro de propriedade respondeu e não lista a empresa de forma alguma (consulte `unavailable_reason`); `unavailable` quando ele não forneceu os dados de propriedade por qualquer outro motivo (consulte `unavailable_reason`); `pending` enquanto o registro ainda os está buscando; `not_requested` para o nível Basic." }, "tier_requested": { "type": "string", "nullable": true, "enum": [ "basic", "shareholders", "ubo", null ], "description": "O nível que o fluxo solicitou." }, "tier_delivered": { "type": "string", "nullable": true, "enum": [ "basic", "shareholders", "ubo", null ], "description": "O nível que o registro entregou (e que é faturado). Uma requisição de UBO respondida apenas com acionistas diretos é `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": "Motivo pelo qual um nível de propriedade solicitado não foi entregue. Nulo, a menos que `status` seja `unavailable` ou `pending`." }, "direct_ownership_complete": { "type": "boolean", "nullable": true, "description": "True quando as participações declaradas dos acionistas diretos somam 100% (com margem de um ponto percentual para arredondamento); false quando não somam; null quando a propriedade não foi informada ou uma participação não está declarada." }, "unresolved": { "type": "array", "description": "Partes da cadeia de propriedade que o registro não conseguiu resolver, por exemplo, quando não há estrutura de grupo registrada acima dos proprietários diretos.", "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": "Detalhe normalizado da Didit sobre a empresa no registro de empresas: o resultado de propriedade (`ownership_error`, `section_errors`, `ubo_resolution`, `lite_enrichment`), as correções feitas com update-data e os dados do registro que não têm campo próprio. Nunca inclui o registro original da fonte do registro de empresas. Todas as chaves são opcionais e só estão presentes quando a empresa tem um valor para elas; novas chaves podem ser adicionadas. Consulte os campos canônicos (`addresses`, `industries`, `ownership`, `beneficial_owners[].shareholding`) para tudo o que eles abrangem.", "properties": { "company_name": { "type": "string", "description": "Nome da empresa conforme corrigido no console." }, "registration_number": { "type": "string", "description": "Número de registro conforme informado pelo registro ou por uma correção feita no console." }, "country_code": { "type": "string", "description": "País do registro, conforme informado pelo registro ou por uma correção feita no console." }, "region": { "type": "string", "description": "Região ou estado do registro." }, "incorporation_date": { "type": "string", "description": "Data de constituição (ISO 8601)." }, "registration_date": { "type": "string", "description": "Data de registro (ISO 8601) quando o registro informa uma data distinta da data de constituição." }, "dissolution_date": { "type": "string", "description": "Data de dissolução (ISO 8601), quando o registro a informa." }, "tax_number": { "type": "string", "description": "Número de identificação fiscal." }, "vat_number": { "type": "string", "description": "Número de VAT." }, "legal_address": { "type": "string", "description": "Endereço legal conforme corrigido no console." }, "registered_address": { "type": "string", "description": "Endereço registrado conforme consta no registro." }, "company_type": { "type": "string", "description": "Forma jurídica." }, "registry_status": { "type": "string", "description": "Status da empresa no registro." }, "verification_status": { "type": "string", "description": "Status da verificação." }, "alternative_names": { "type": "string", "description": "Outros nomes comerciais que a empresa usa ou já usou." }, "nature_of_business": { "type": "string", "description": "Descrição da atividade." }, "registered_capital": { "type": "string", "description": "Capital social conforme impresso." }, "registered_capital_amount": { "type": "string", "description": "Valor do capital social, como string decimal." }, "registered_capital_currency": { "type": "string", "description": "Moeda do capital social (ISO 4217)." }, "website": { "type": "string", "description": "Site." }, "email": { "type": "string", "description": "E-mail de contato." }, "phone": { "type": "string", "description": "Telefone de contato." }, "legal_entity_identifier": { "type": "string", "description": "Legal Entity Identifier (LEI)." }, "location_of_registration": { "type": "string", "description": "Local de registro." }, "control_scheme": { "type": "string", "description": "Esquema de governança, quando o registro o expõe." }, "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": "Motivo pelo qual um nível de propriedade solicitado não foi entregue, com os mesmos códigos de `ownership.unavailable_reason`. `no_owners_on_record` (o registro respondeu e não indica nenhum proprietário) e `ownership_section_unavailable` (o registro não retornou a seção de propriedade) são constatações diferentes." }, "section_errors": { "type": "object", "description": "Seções que o registro não retornou, indexadas por seção (`officers`, `shareholders`, `group_structure`). Uma seção listada aqui nunca foi entregue: uma lista vazia ao lado dela não diz nada sobre a 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": "Os campos próprios do registro para a empresa, com as chaves nomeadas como o registro as nomeia, como valores simples (registros legados). Somente os campos revisados como fatos do registro são incluídos." }, "registry_sources": { "type": "array", "description": "Os registros oficiais dos quais o registro foi lido (registros legados). Outras fontes não são nomeadas.", "items": { "$ref": "#/components/schemas/KYBRegistrySource" } }, "previous_names": { "type": "array", "items": { "type": "string" }, "description": "Nomes sob os quais a empresa foi registrada anteriormente (registros legados)." }, "parent_companies": { "type": "array", "items": { "type": "string" }, "description": "Empresas controladoras indicadas pelo registro (registros legados)." }, "documents_available": { "type": "integer", "description": "Quantos documentos arquivados o registro oferece para a empresa (registros legados)." } } }, "KYBRegistryGroupCompany": { "type": "object", "description": "Uma empresa do grupo corporativo, identificada pela sua identidade no registro.", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome da empresa." }, "country_code": { "type": "string", "nullable": true, "description": "País de registro." }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registro." } }, "required": [ "name", "country_code", "registration_number" ] }, "KYBRegistryUboResolution": { "type": "object", "description": "Como o nível UBO percorreu a cadeia de propriedade acima da empresa.", "properties": { "parent_chain": { "type": "array", "description": "Controladoras corporativas, da controladora final até a empresa.", "items": { "$ref": "#/components/schemas/KYBRegistryGroupCompany" } }, "subsidiaries": { "type": "array", "description": "Empresas diretamente abaixo da empresa em seu grupo corporativo.", "items": { "$ref": "#/components/schemas/KYBRegistryGroupCompany" } }, "unresolved": { "type": "array", "description": "Partes da cadeia que o registro não conseguiu resolver (as mesmas entradas de `ownership.unresolved`).", "items": { "type": "object", "properties": { "reason": { "type": "string", "description": "O motivo, por exemplo `no_group_structure_on_record`, `selected_company_not_in_group_structure` ou `section_error`." }, "section": { "type": "string", "nullable": true, "description": "A seção em questão, por exemplo `group_structure`." } }, "required": [ "reason", "section" ] } } }, "required": [ "parent_chain", "subsidiaries", "unresolved" ] }, "KYBRegistrySectionError": { "type": "object", "description": "Uma seção que o registro não retornou.", "properties": { "status_code": { "type": "integer", "nullable": true, "description": "O status que o registro retornou para a seção." } }, "required": [ "status_code" ] }, "KYBRegistryLiteEnrichment": { "type": "object", "description": "Campos vazios do perfil Lite que outra das fontes de registro do país preencheu. A fonte não é identificada.", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "Os campos da empresa que foram preenchidos." }, "people_added": { "type": "integer", "description": "Quantos administradores ou proprietários foram adicionados." } }, "required": [ "fields", "people_added" ] }, "KYBRegistrySource": { "type": "object", "description": "Um registro oficial do qual o dado foi lido. Apenas registros governamentais oficiais, órgãos reguladores e o sistema oficial de identificadores são citados; qualquer outra fonte é omitida.", "properties": { "name": { "type": "string", "description": "Nome do registro, por exemplo `UK Companies House`." }, "source_type": { "type": "string", "enum": [ "official" ], "description": "Sempre `official`." } }, "required": [ "name", "source_type" ] }, "KYBOwnershipStructure": { "type": "object", "nullable": true, "description": "A tabela de capitalização comprovada pelo registro, como estava quando o nível de propriedade foi entregue: `shareholders` diretos e `beneficial_owners`. Nulo quando o registro não comprovou nenhuma propriedade. Nunca contém as linhas da própria fonte do registro; leia `company.beneficial_owners` e `company.ownership` para obter o registro atual.", "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": "Um proprietário do snapshot de propriedade: a mesma identidade de registro e participação de `company.beneficial_owners[]`, e sua `shareholding` canônica.", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome do proprietário conforme consta no registro." }, "first_name": { "type": "string", "nullable": true, "description": "Nome próprio, para uma pessoa física, quando o registro o informa." }, "last_name": { "type": "string", "nullable": true, "description": "Sobrenome, no caso de pessoa física, quando o registro o informa." }, "date_of_birth": { "type": "string", "nullable": true, "description": "Data de nascimento (ISO 8601), quando o registro a publica." }, "country_of_birth": { "type": "string", "nullable": true, "description": "País de nascimento, quando o registro o publica." }, "company_name": { "type": "string", "nullable": true, "description": "Nome da empresa, para um proprietário pessoa jurídica." }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registro, para um proprietário pessoa jurídica." }, "entity_type": { "type": "string", "nullable": true, "enum": [ "person", "company", null ], "description": "Se o proprietário é uma pessoa física ou uma empresa." }, "nationality": { "type": "string", "nullable": true, "description": "Nacionalidade, quando o registro a informa." }, "designation": { "type": "string", "nullable": true, "description": "O título ou a função do proprietário conforme impresso pelo registro." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "`shareholder` para um titular direto, `ubo` para um beneficiário final." }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Limite inferior da participação, em percentual (igual ao limite superior no caso de uma participação exata)." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Limite superior da participação, em percentual." }, "voting_min_shares": { "type": "string", "nullable": true, "description": "Limite inferior dos direitos de voto, em percentual." }, "voting_max_shares": { "type": "string", "nullable": true, "description": "Limite superior dos direitos de voto, em percentual." }, "appointment_date": { "type": "string", "nullable": true, "description": "Data em que a participação ou o cargo começou (ISO 8601)." }, "is_active": { "type": "boolean", "nullable": true, "description": "Falso para um antigo proprietário." }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } }, "required": [ "name", "first_name", "last_name", "date_of_birth", "country_of_birth", "company_name", "registration_number", "entity_type", "nationality", "designation", "roles", "ownership_min_shares", "ownership_max_shares", "voting_min_shares", "voting_max_shares", "appointment_date", "is_active", "shareholding" ] }, "DigitalIdWalletApiWalletVerificationError": { "type": "object", "properties": { "error": { "type": "string", "description": "Código estável e legível por máquina, por exemplo 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": "Erros de validação da requisição: cada campo rejeitado com suas mensagens.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "DigitalIdWalletApiWalletVerificationResponse": { "type": "object", "description": "Uma verificação de carteira avulsa, como todo endpoint de carteira a retorna.", "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": "O objeto de metadados enviado no início, ou nulo." }, "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 enquanto pendente e, depois, Approved (verificado) ou Declined." }, "outcome": { "$ref": "#/components/schemas/DigitalIdWalletApiWalletVerificationResultOutcomeEnum" }, "error": { "type": "string", "nullable": true, "readOnly": true }, "interaction": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiInteractionEnum" } ], "readOnly": true }, "simulated": { "type": "boolean", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time" }, "next_action": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiWalletNextAction" } ], "nullable": true, "readOnly": true }, "identity": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiWalletIdentity" } ], "nullable": true, "readOnly": true }, "attributes": { "type": "object", "additionalProperties": {}, "nullable": true, "readOnly": true }, "level_of_assurance": { "type": "string", "nullable": true }, "verified_at": { "type": "string", "format": "date-time", "nullable": true }, "signature_valid": { "type": "boolean", "nullable": true, "description": "True quando a assinatura da credencial foi verificada; null para uma credencial 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": "Nacionalidade ISO3, somente quando a carteira a declara (nunca inferida)." }, "issuing_state": { "type": "string", "description": "País ISO3 cujo esquema emitiu a identidade." } }, "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: envie o navegador do usuário para url. confirm_in_app: mostre verification_code ao usuário, que confere se ele corresponde ao código no app da carteira e confirma lá; depois, faça polling. request_digital_credential: em um gesto do usuário na mesma origem em que você iniciou, solicite à carteira com digital_credentials.request e envie o que ela retornar para 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": "Somente redirect: onde o usuário faz login com a carteira." }, "digital_credentials": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiWalletDigitalCredentialsRequest" } ], "description": "Somente request_digital_credential: a requisição a ser entregue à carteira." }, "verification_code": { "type": "string", "description": "Somente confirm_in_app: o código de comparação de 4 dígitos que o app da carteira também exibe." }, "poll_interval_seconds": { "type": "integer", "description": "Somente confirm_in_app: com que frequência chamar POST .../verifications/{request_id}/poll/ para obter um retorno rápido. A Didit também consulta os logins pendentes em segundo plano, então o webhook informa o resultado mesmo quando você não faz a consulta." } }, "required": [ "type" ] }, "DigitalIdWalletApiWalletNextActionTypeEnum": { "enum": [ "redirect", "confirm_in_app", "request_digital_credential" ], "type": "string", "description": "* `redirect` - redirect\n* `confirm_in_app` - confirm_in_app\n* `request_digital_credential` - request_digital_credential" }, "DigitalIdWalletApiInteractionEnum": { "enum": [ "redirect", "in_app", "digital_credentials" ], "type": "string", "description": "* `redirect` - redirect\n* `in_app` - in_app\n* `digital_credentials` - digital_credentials" }, "DigitalIdWalletApiWalletVerificationResultOutcomeEnum": { "enum": [ "pending", "verified", "cancelled", "timeout", "failed" ], "type": "string", "description": "* `pending` - Pendente\n* `verified` - Verificado\n* `cancelled` - Cancelado pelo usuário\n* `timeout` - Tempo esgotado\n* `failed` - Falhou" }, "DigitalIdWalletApiWallet": { "type": "object", "properties": { "id": { "type": "string", "description": "Id de catálogo da carteira, por exemplo, bankid_se." }, "name": { "type": "string" }, "issuing_authority": { "type": "string", "nullable": true } }, "required": [ "id", "issuing_authority", "name" ] }, "DigitalIdWalletApiEudiWalletVerificationStartRequest": { "type": "object", "description": "Inicie uma verificação 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": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiEudiWalletVerificationStartCountryEnum" } ], "description": "País ISO 3166-1 alpha-3 da identidade 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 para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "country", "return_url" ] }, "DigitalIdWalletApiDeviceEnum": { "enum": [ "same_device", "cross_device" ], "type": "string", "description": "* `same_device` - same_device\n* `cross_device` - cross_device" }, "DigitalIdWalletApiEudiWalletVerificationStartCountryEnum": { "enum": [ "AUT", "BEL", "BGR", "HRV", "CYP", "CZE", "DNK", "EST", "FIN", "FRA", "DEU", "GRC", "HUN", "IRL", "ITA", "LVA", "LTU", "LUX", "MLT", "NLD", "POL", "PRT", "ROU", "SVK", "SVN", "ESP", "SWE", "ISL", "LIE", "NOR" ], "type": "string", "description": "* `AUT` - AUT\n* `BEL` - BEL\n* `BGR` - BGR\n* `HRV` - HRV\n* `CYP` - CYP\n* `CZE` - CZE\n* `DNK` - DNK\n* `EST` - EST\n* `FIN` - FIN\n* `FRA` - FRA\n* `DEU` - DEU\n* `GRC` - GRC\n* `HUN` - HUN\n* `IRL` - IRL\n* `ITA` - ITA\n* `LVA` - LVA\n* `LTU` - LTU\n* `LUX` - LUX\n* `MLT` - MLT\n* `NLD` - NLD\n* `POL` - POL\n* `PRT` - PRT\n* `ROU` - ROU\n* `SVK` - SVK\n* `SVN` - SVN\n* `ESP` - ESP\n* `SWE` - SWE\n* `ISL` - ISL\n* `LIE` - LIE\n* `NOR` - NOR" }, "DigitalIdWalletApiConnectidWalletVerificationStartRequest": { "type": "object", "description": "Inicie uma verificação ConnectID (AUS).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiConnectidWalletVerificationStartCountryEnum" } ], "default": "AUS", "description": "País ISO 3166-1 alpha-3 da identidade ConnectID. O padrão é AUS, o único país atendido.\n\n* `AUS` - AUS" }, "authorisation_server_id": { "type": "string", "minLength": 1, "description": "ID do servidor de autorização selecionado com o seletor de bancos do ConnectID. No sandbox, o padrão é Mock Bank A.", "maxLength": 36 }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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 uma verificação com Auðkenni (ISL).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiAudkenniWalletVerificationStartCountryEnum" } ], "default": "ISL", "description": "País ISO 3166-1 alpha-3 da identidade Auðkenni. O padrão é ISL, o único país atendido.\n\n* `ISL` - ISL" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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": "Inicie uma verificação FranceConnect (FRA).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiFranceconnectWalletVerificationStartCountryEnum" } ], "default": "FRA", "description": "País ISO 3166-1 alpha-3 da identidade FranceConnect. O padrão é FRA, o único país atendido.\n\n* `FRA` - FRA" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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": "Inicie uma verificação Diia (UKR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDiiaWalletVerificationStartCountryEnum" } ], "default": "UKR", "description": "País ISO 3166-1 alpha-3 da identidade Diia. O padrão é UKR, o único país atendido.\n\n* `UKR` - UKR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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": "Inicie uma verificação com MojeID (CZE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryE2dEnum" } ], "default": "CZE", "description": "País ISO 3166-1 alpha-3 da identidade MojeID. O padrão é CZE, o único país atendido.\n\n* `CZE` - CZE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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 uma verificação com Bank iD (CZE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryE2dEnum" } ], "default": "CZE", "description": "País ISO 3166-1 alpha-3 da identidade Bank iD. O padrão é CZE, o único país atendido.\n\n* `CZE` - CZE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiEparakstsMobileWalletVerificationStartRequest": { "type": "object", "description": "Inicie uma verificação com eParaksts mobile (LVA).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiEparakstsMobileWalletVerificationStartCountryEnum" } ], "default": "LVA", "description": "País ISO 3166-1 alpha-3 da identidade móvel eParaksts. O padrão é LVA, o único país atendido.\n\n* `LVA` - LVA" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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": "Inicie uma verificação com o cartão de identidade estoniano (EST).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiIdcardEeWalletVerificationStartCountryEnum" } ], "default": "EST", "description": "País ISO 3166-1 alpha-3 da identidade do cartão de identidade estoniano. O padrão é EST, o único país atendido.\n\n* `EST` - EST" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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": "Inicie uma verificação com Mobile-ID (EST, LTU).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiMobileIdWalletVerificationStartCountryEnum" } ], "description": "País ISO 3166-1 alpha-3 da identidade Mobile-ID.\n\n* `EST` - EST\n* `LTU` - LTU" }, "personal_code": { "type": "string", "minLength": 1, "description": "O código de identificação pessoal nacional do usuário. Ele direciona a solicitação ao app Mobile-ID do usuário; o usuário confirma o código de comparação e digita o PIN no app. Nunca colete o PIN.", "pattern": "^[0-9-]{6,20}$" }, "phone_number": { "type": "string", "minLength": 1, "description": "O número de telefone do Mobile-ID no formato E.164 (+372... ou +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": "Inicie uma verificação com Smart-ID (EST, LVA, LTU, BEL).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiSmartIdWalletVerificationStartCountryEnum" } ], "description": "País ISO 3166-1 alpha-3 da identidade Smart-ID.\n\n* `EST` - EST\n* `LVA` - LVA\n* `LTU` - LTU\n* `BEL` - BEL" }, "personal_code": { "type": "string", "minLength": 1, "description": "O código de identificação pessoal nacional do usuário. Ele direciona a solicitação ao app Smart-ID do usuário; o usuário confirma o código de comparação e digita o PIN no app. Nunca colete o 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": "Inicie uma verificação com GOV.UK Wallet (GBR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountry520Enum" } ], "default": "GBR", "description": "País ISO 3166-1 alpha-3 da identidade GOV.UK Wallet. O padrão é GBR, o único país atendido.\n\n* `GBR` - GBR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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": "Inicie uma verificação com OneID (GBR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountry520Enum" } ], "default": "GBR", "description": "País ISO 3166-1 alpha-3 da identidade OneID. O padrão é GBR, o único país atendido.\n\n* `GBR` - GBR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiGovbrWalletVerificationStartRequest": { "type": "object", "description": "Inicie uma verificação com gov.br (BRA).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiGovbrWalletVerificationStartCountryEnum" } ], "default": "BRA", "description": "País ISO 3166-1 alpha-3 da identidade gov.br. O padrão é BRA, o único país atendido.\n\n* `BRA` - BRA" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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": "Inicie uma verificação com UAE PASS (ARE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum" } ], "default": "ARE", "description": "País ISO 3166-1 alpha-3 da identidade UAE PASS. O padrão é ARE, o único país atendido.\n\n* `ARE` - ARE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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": "Inicie uma verificação com Freja eID (SWE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryEe9Enum" } ], "default": "SWE", "description": "País ISO 3166-1 alpha-3 da identidade Freja eID. O padrão é SWE, o único país atendido.\n\n* `SWE` - SWE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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": "Inicie uma verificação com Personalausweis (DEU).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiPersonalausweisWalletVerificationStartCountryEnum" } ], "default": "DEU", "description": "País ISO 3166-1 alpha-3 da identidade Personalausweis. O padrão é DEU, o único país atendido.\n\n* `DEU` - DEU" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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": "Inicie uma verificação Finnish Trust Network (FIN).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiFtnWalletVerificationStartCountryEnum" } ], "default": "FIN", "description": "País ISO 3166-1 alpha-3 da identidade Finnish Trust Network. O padrão é FIN, o único país atendido.\n\n* `FIN` - FIN" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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": "Inicie uma verificação com iDIN (NLD).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiIdinWalletVerificationStartCountryEnum" } ], "default": "NLD", "description": "País ISO 3166-1 alpha-3 da identidade iDIN. O padrão é NLD, o único país atendido.\n\n* `NLD` - NLD" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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": "Inicie uma verificação com itsme (BEL, LUX, NLD).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiItsmeWalletVerificationStartCountryEnum" } ], "description": "País ISO 3166-1 alpha-3 da identidade itsme.\n\n* `BEL` - BEL\n* `LUX` - LUX\n* `NLD` - NLD" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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": "Inicie uma verificação Buypass ID (NOR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryAfcEnum" } ], "default": "NOR", "description": "País ISO 3166-1 alpha-3 da identidade Buypass ID. O padrão é NOR, o único país atendido.\n\n* `NOR` - NOR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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": "Inicie uma verificação com Vipps (NOR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryAfcEnum" } ], "default": "NOR", "description": "País ISO 3166-1 alpha-3 da identidade Vipps. O padrão é NOR, o único país atendido.\n\n* `NOR` - NOR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiBankidNoWalletVerificationStartRequest": { "type": "object", "description": "Inicie uma verificação BankID (NOR).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryAfcEnum" } ], "default": "NOR", "description": "País ISO 3166-1 alpha-3 da identidade BankID. O padrão é NOR, o único país atendido.\n\n* `NOR` - NOR" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiBankidSeWalletVerificationStartRequest": { "type": "object", "description": "Inicie uma verificação BankID (SWE).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiCountryEe9Enum" } ], "default": "SWE", "description": "País ISO 3166-1 alpha-3 da identidade BankID. O padrão é SWE, o único país atendido.\n\n* `SWE` - SWE" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do BankID).\n\n* `same_device` - same_device\n* `cross_device` - cross_device" } }, "required": [ "return_url" ] }, "DigitalIdWalletApiMitidWalletVerificationStartRequest": { "type": "object", "description": "Inicie uma verificação com MitID (DNK).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiMitidWalletVerificationStartCountryEnum" } ], "default": "DNK", "description": "País ISO 3166-1 alpha-3 da identidade MitID. O padrão é DNK, o único país atendido.\n\n* `DNK` - DNK" }, "return_url": { "type": "string", "format": "uri", "minLength": 1, "description": "URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook.", "maxLength": 2048 }, "device": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiDeviceEnum" } ], "default": "same_device", "description": "same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do 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": "O próprio endpoint de início da carteira." }, "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": "Se esta aplicação pode iniciá-lo neste ambiente agora. Estar listado não significa estar em produção." } }, "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": "Sessão de verificação nativa criada para esta verificação." }, "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` - Rejeitar" }, "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` - Sessão\n* `business_session` - Sessão de empresa\n* `transaction` - Transação" }, "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` - Disponível\n* `not_requested` - Não solicitado\n* `no_reference` - Sem referência\n* `insufficient_history` - Histórico insuficiente\n* `unsupported_region` - Região não suportada\n* `source_unavailable` - Fonte indisponível" }, "CasePublicationPolicyDraftResponse": { "type": "object", "properties": { "draft": { "allOf": [ { "$ref": "#/components/schemas/CasePublicationPolicyDraft" } ], "nullable": true } }, "required": [ "draft" ] }, "FraudCheckAttributesRequest": { "type": "object", "description": "Atributos de corroboração. Todos são opcionais e ampliam a cobertura dos módulos.", "properties": { "first_name": { "type": "string", "maxLength": 128 }, "last_name": { "type": "string", "maxLength": 128 }, "full_name": { "type": "string", "maxLength": 256 }, "date_of_birth": { "type": "string", "format": "date" }, "nationality": { "type": "string", "maxLength": 3 }, "gender": { "type": "string", "maxLength": 16 }, "address": { "type": "string", "maxLength": 512 }, "city": { "type": "string", "maxLength": 128 }, "state": { "type": "string", "maxLength": 128 }, "postal_code": { "type": "string", "maxLength": 32 } } }, "NetworkNote": { "type": "object", "required": [ "uuid", "actor_email", "comment", "client_reference", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "actor_email": { "type": "string", "format": "email", "readOnly": true, "description": "Autor autenticado, atribuído pelo servidor." }, "comment": { "type": "string", "minLength": 1, "maxLength": 10000 }, "client_reference": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } } }, "CaseActionEntityTypeEnum": { "enum": [ "user", "business" ], "type": "string", "description": "* `user` - user\n* `business` - business" }, "CaseRoutingCondition": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "source", "priority", "tags" ] }, "operator": { "type": "string", "enum": [ "equals", "in", "contains" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "field", "operator", "value" ], "description": "Origem e prioridade aceitam equals ou in, com os valores suportados. Tags aceitam contains, com uma tag não vazia." }, "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": "Sua própria referência para esta verificação. Também funciona como chave de idempotência: reutilizá-la com o mesmo corpo retorna a verificação original sem executar nem cobrar os módulos novamente; reutilizá-la com um corpo diferente retorna 409.", "maxLength": 255 }, "profile": { "type": "string", "minLength": 1, "default": "standard", "description": "ID do perfil de orquestração. O padrão é o perfil `standard` da Didit.", "maxLength": 64 }, "profile_version": { "type": "string", "minLength": 1, "description": "Fixa uma versão congelada do perfil. O padrão é a versão atual do 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` - Normalização\n* `email_risk` - Risco de e-mail\n* `email_social` - Redes sociais do e-mail\n* `phone_social` - Redes sociais do telefone\n* `phone_risk` - Risco de telefone\n* `ip_risk` - Risco de IP\n* `database_validation` - Validação de banco de dados\n* `networks_same_org` - Redes na mesma organização\n* `networks_cross_org` - Redes entre organizações\n* `biometric_identity` - Identidade 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` - Aberto\n* `AWAITING_USER` - Aguardando usuário\n* `RESOLVED` - Resolvido" }, "FraudBandEnum": { "enum": [ "low", "medium", "high", "unknown" ], "type": "string", "description": "* `low` - Baixo\n* `medium` - Médio\n* `high` - Alto\n* `unknown` - Desconhecido" }, "CaseDuplicatePriorityEnum": { "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "* `LOW` - Baixo\n* `MEDIUM` - Médio\n* `HIGH` - Alto" }, "FraudStatusEnum": { "enum": [ "planned", "completed", "skipped", "failed" ], "type": "string", "description": "* `planned` - Planejado\n* `completed` - Concluído\n* `skipped` - Ignorado\n* `failed` - Falhou" }, "FraudCheckInput": { "type": "object", "properties": { "reference": { "type": "string", "description": "Identificador ocultado correspondente ao identificador enviado." }, "type": { "$ref": "#/components/schemas/FraudTypeEnum" }, "namespace": { "type": "object", "additionalProperties": {} }, "quality": { "type": "string" }, "normalization": { "type": "object", "additionalProperties": {} }, "availability": { "$ref": "#/components/schemas/FraudAvailabilityEnum" } }, "required": [ "availability", "namespace", "normalization", "quality", "reference", "type" ] }, "CustomerMessagingPurposesEnum": { "enum": [ "identity_document", "proof_of_address", "business_document", "confirm_details", "review_in_progress" ], "type": "string", "description": "* `identity_document` - identity_document\n* `proof_of_address` - proof_of_address\n* `business_document` - business_document\n* `confirm_details` - confirm_details\n* `review_in_progress` - review_in_progress" }, "FraudTypeEnum": { "enum": [ "email", "phone", "national_id", "tax_number", "passport_number", "driving_licence_number", "residence_permit_number", "voter_id", "external_id" ], "type": "string", "description": "* `email` - E-mail\n* `phone` - Telefone\n* `national_id` - Documento nacional de identidade\n* `tax_number` - Número de identificação fiscal\n* `passport_number` - Número do passaporte\n* `driving_licence_number` - Número da carteira de motorista\n* `residence_permit_number` - Número da autorização de residência\n* `voter_id` - Título de eleitor\n* `external_id` - ID externo" }, "CaseDuplicateCaseSubjectInput": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CaseDuplicateTypeEnum" }, "uuid": { "type": "string", "format": "uuid" } }, "required": [ "type", "uuid" ] }, "CaseReviewTeamCreate": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/CaseReviewTeamMember" }, "maxItems": 250 }, "is_active": { "type": "boolean" } }, "required": [ "name", "members" ] }, "CaseDuplicateCaseDuplicateQueryRequest": { "type": "object", "properties": { "subject": { "$ref": "#/components/schemas/CaseDuplicateCaseSubjectInputRequest" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/CaseDuplicateCaseLinkCreateRequest" } }, "offset": { "type": "integer", "maximum": 1000000, "minimum": 0, "default": 0 } } }, "CaseDuplicateResolutionEnum": { "enum": [ "FALSE_POSITIVE", "VALID_THREAT" ], "type": "string", "description": "* `FALSE_POSITIVE` - Falso positivo\n* `VALID_THREAT` - Ameaç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 em JPEG, PNG ou WebP codificada em Base64, de até 6 MB. Sem imagem de referência nem URL.", "maxLength": 8388672 }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/FraudCheckIdentifierRequest" }, "description": "Um ou mais identificadores tipados. Um é suficiente.", "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 em que o titular declara estar. Apenas contextual - nunca é prova de titularidade da identidade.", "maxLength": 3 }, "purpose": { "type": "string", "maxLength": 128 }, "consent_obtained": { "type": "boolean" } } }, "CustomerMessagingCaseCustomerResponseResult": { "type": "object", "properties": { "responded_at": { "type": "string", "format": "date-time" } }, "required": [ "responded_at" ] }, "CustomerMessagingCaseRequestContact": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" }, "verified_at": { "type": "string", "format": "date-time" } }, "required": [ "email", "uuid", "verified_at" ] }, "FraudClientCredentialsForbiddenErrorMessage": { "type": "object", "properties": { "detail": { "type": "string", "default": "Forbidden - User doesn't have permission" } } }, "CasePublicationAssignmentMethodEnum": { "enum": [ "MANUAL", "AUTOMATIC" ], "type": "string", "description": "* `MANUAL` - Manual\n* `AUTOMATIC` - Automático" }, "CaseDuplicateNullEnum": { "enum": [ null ] }, "CustomerMessagingLanguageEnum": { "enum": [ "en", "es", "pt" ], "type": "string", "description": "* `en` - en\n* `es` - es\n* `pt` - pt" }, "CaseDuplicateCaseFraudSourceContextRequest": { "type": "object", "properties": { "check_id": { "type": "string", "format": "uuid" }, "request_id": { "type": "string", "format": "uuid" }, "source_section": { "type": "string", "minLength": 1, "pattern": "^[A-Z][A-Z0-9_:-]{0,63}$" } }, "required": [ "check_id", "request_id", "source_section" ] }, "FraudCheckPlannedModule": { "type": "object", "properties": { "module": { "$ref": "#/components/schemas/FraudExcludeEnum" }, "available": { "type": "boolean" }, "availability_reason": { "type": "string", "nullable": true }, "will_run": { "type": "boolean" }, "selection_reason": { "type": "string", "nullable": true }, "estimated_price": { "type": "string", "nullable": true } }, "required": [ "availability_reason", "available", "estimated_price", "module", "selection_reason", "will_run" ] }, "CustomerMessagingCaseRequestOptions": { "type": "object", "properties": { "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerMessagingCaseRequestContact" } }, "purposes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerMessagingPurposesEnum" } }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerMessagingLanguagesEnum" } } }, "required": [ "contacts", "languages", "purposes" ] }, "CaseCollaborationPaginatedCaseNoteList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=400&limit=100" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?offset=200&limit=100" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseCollaborationCaseNote" } } } }, "FraudProcessingStatusEnum": { "enum": [ "pending", "running", "completed", "failed" ], "type": "string", "description": "* `pending` - Pendente\n* `running` - Em execução\n* `completed` - Concluído\n* `failed` - Falhou" }, "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": "Versão aberta pelo editor. Quando informada, gravações desatualizadas retornam 409 sem alterar a regra." } } }, "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` - Identidade\n* `contact` - Contato\n* `device_network` - Rede de dispositivos\n* `behavioral` - Comportamental\n* `fraud_network` - Rede de fraude" }, "FraudBadRequestErrorMessage": { "type": "object", "properties": { "detail": { "type": "string", "default": "Bad Request - Invalid request data" } } }, "FraudNextActionEnum": { "enum": [ "none", "manual_review", "step_up", "resubmit_capture" ], "type": "string", "description": "* `none` - Nenhuma\n* `manual_review` - Revisão manual\n* `step_up` - Verificação adicional\n* `resubmit_capture` - Reenviar captura" }, "RoutingPublicationPolicyDraftPreconditionRequest": { "type": "object", "properties": { "expected_version": { "type": "integer", "minimum": 0 }, "expected_revision": { "type": "string", "format": "uuid", "nullable": true } }, "required": [ "expected_revision", "expected_version" ] }, "FraudCheckRisk": { "type": "object", "properties": { "dimension": { "$ref": "#/components/schemas/FraudDimensionEnum" }, "score": { "type": "integer", "nullable": true }, "band": { "$ref": "#/components/schemas/FraudBandEnum" }, "availability": { "$ref": "#/components/schemas/FraudAvailabilityEnum" }, "requested_but_unavailable": { "type": "boolean", "description": "True quando a requisição forneceu tudo o que esta dimensão precisava e, mesmo assim, a plataforma não conseguiu respondê-la. Uma verificação nessa situação nunca é recomendada para aprovação com base apenas nas dimensões que responderam." }, "reason_codes": { "type": "array", "items": { "type": "string" } }, "evidence_indexes": { "type": "array", "items": { "type": "integer" } } }, "required": [ "availability", "band", "dimension", "evidence_indexes", "reason_codes", "requested_but_unavailable", "score" ] }, "CaseDuplicateSourceEnum": { "enum": [ "MANUAL", "AML_SCREENING", "TRANSACTION_RULE", "WORKFLOW_BUILDER" ], "type": "string", "description": "* `MANUAL` - Manual\n* `AML_SCREENING` - Análise AML\n* `TRANSACTION_RULE` - Regra de transação\n* `WORKFLOW_BUILDER` - Construtor de fluxos" }, "CaseCollaborationPatchedCaseNoteUpdateRequest": { "type": "object", "properties": { "is_pinned": { "type": "boolean" } } }, "CustomerMessagingPurposeEnum": { "enum": [ "identity_document", "proof_of_address", "business_document", "confirm_details", "review_in_progress" ], "type": "string", "description": "* `identity_document` - identity_document\n* `proof_of_address` - proof_of_address\n* `business_document` - business_document\n* `confirm_details` - confirm_details\n* `review_in_progress` - review_in_progress" }, "CaseDuplicateTypeEnum": { "enum": [ "user", "business" ], "type": "string", "description": "* `user` - user\n* `business` - business" }, "CaseCollaborationCaseNoteCreateRequest": { "type": "object", "properties": { "comment": { "type": "string", "minLength": 1, "maxLength": 10000 }, "reply_to": { "type": "string", "format": "uuid", "nullable": true }, "client_reference": { "type": "string", "format": "uuid", "nullable": true }, "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email", "minLength": 1 } }, "is_internal": { "type": "boolean", "default": false }, "attachments": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "comment" ] }, "CustomerMessagingLanguagesEnum": { "enum": [ "en", "es", "pt" ], "type": "string", "description": "* `en` - en\n* `es` - es\n* `pt` - pt" }, "CustomerMessagingCaseRequestConfirmRequest": { "type": "object", "properties": { "contact_id": { "type": "string", "format": "uuid" }, "purpose": { "$ref": "#/components/schemas/CustomerMessagingPurposeEnum" }, "language": { "allOf": [ { "$ref": "#/components/schemas/CustomerMessagingLanguageEnum" } ], "default": "en" }, "request_id": { "type": "string", "format": "uuid" }, "expires_at": { "type": "string", "format": "date-time" }, "preview_token": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "contact_id", "expires_at", "preview_token", "purpose", "request_id" ] }, "CaseRoutingRule": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "priority": { "type": "integer", "minimum": 0 }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/CaseRoutingCondition" }, "maxItems": 20 }, "required_skills": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "maxItems": 25 }, "blueprint": { "type": "string", "format": "uuid" }, "team": { "type": "string", "format": "uuid", "nullable": true }, "is_active": { "type": "boolean" }, "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "version": { "type": "integer", "readOnly": true }, "blueprint_name": { "type": "string", "readOnly": true }, "team_name": { "type": "string", "nullable": true, "readOnly": true } } }, "FraudResultEnum": { "enum": [ "match", "mismatch", "inconclusive", "no_reference" ], "type": "string", "description": "* `match` - Correspondência\n* `mismatch` - Divergência\n* `inconclusive` - Inconclusivo\n* `no_reference` - Sem 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": "Defina como false para salvar um rascunho nunca publicado. O registro permanece inativo na versão 0 até que o rascunho seja publicado explicitamente. Omitir este campo mantém a criação imediata para as integrações existentes." } }, "required": [ "name", "conditions", "blueprint" ] }, "FraudCheckIdentifierRequest": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/FraudTypeEnum" } ], "description": "Tipo de identificador. Determina quais campos de namespace são obrigatórios.\n\n* `email` - E-mail\n* `phone` - Telefone\n* `national_id` - Documento nacional de identidade\n* `tax_number` - Número de identificação fiscal\n* `passport_number` - Número do passaporte\n* `driving_licence_number` - Número da carteira de motorista\n* `residence_permit_number` - Número da autorização de residência\n* `voter_id` - Título de eleitor\n* `external_id` - ID externo" }, "value": { "type": "string", "minLength": 1, "description": "O valor do identificador, em qualquer formato usual.", "maxLength": 255 }, "country": { "type": "string", "description": "País emissor ISO-3166 alpha-2 ou alpha-3. Obrigatório para tipos de identificador governamental: os mesmos dígitos correspondem a pessoas diferentes em países diferentes.", "maxLength": 3 }, "issuer": { "type": "string", "description": "Autoridade emissora ou emissor subnacional opcional, quando o país por si só não é único.", "maxLength": 128 } }, "required": [ "type", "value" ] }, "CaseActionActionEnum": { "enum": [ "set_status", "add_tags", "add_note", "add_to_blocklist" ], "type": "string", "description": "* `set_status` - set_status\n* `add_tags` - add_tags\n* `add_note` - add_note\n* `add_to_blocklist` - add_to_blocklist" }, "CaseActionCaseActionReceiptPage": { "type": "object", "properties": { "count": { "type": "integer" }, "next_offset": { "type": "integer", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CaseActionCaseActionReceipt" } } }, "required": [ "count", "next_offset", "results" ] }, "CaseActionCaseEntityActionResult": { "type": "object", "properties": { "receipt": { "$ref": "#/components/schemas/CaseActionCaseActionReceipt" }, "entity_type": { "$ref": "#/components/schemas/CaseActionEntityTypeEnum" }, "entity_uuid": { "type": "string", "format": "uuid" }, "action": { "type": "string" }, "previous_status": { "type": "string" }, "new_status": { "type": "string" }, "tags_added": { "type": "array", "items": { "type": "string" } }, "comment_uuid": { "type": "string", "format": "uuid" }, "blocklisted": { "type": "array", "items": { "type": "string" } } } }, "CustomerMessagingCaseRequest": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "purpose": { "type": "string", "readOnly": true }, "language": { "type": "string", "readOnly": true }, "recipient": { "type": "string", "format": "email", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "readOnly": true }, "actor_email": { "type": "string", "format": "email", "readOnly": true, "nullable": true }, "delivery_status": { "type": "string", "readOnly": true }, "delivered_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "cancelled_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "responded_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "response": { "readOnly": true, "nullable": true }, "has_attachment": { "type": "boolean", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "actor_email", "cancelled_at", "created_at", "delivered_at", "delivery_status", "expires_at", "has_attachment", "language", "purpose", "recipient", "responded_at", "response", "uuid" ] }, "CustomerMessagingCaseRequestPublic": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "purpose": { "$ref": "#/components/schemas/CustomerMessagingPurposeEnum" }, "language": { "$ref": "#/components/schemas/CustomerMessagingLanguageEnum" }, "expires_at": { "type": "string", "format": "date-time" }, "responded_at": { "type": "string", "format": "date-time", "nullable": true }, "copy": { "type": "object", "additionalProperties": {} }, "organization_name": { "type": "string" }, "is_white_label": { "type": "boolean" }, "customization": { "type": "object", "additionalProperties": {}, "nullable": true } }, "required": [ "copy", "customization", "expires_at", "is_white_label", "language", "organization_name", "purpose", "request_id", "responded_at" ] }, "RoutingPublicationFieldEnum": { "enum": [ "source", "priority", "tags" ], "type": "string", "description": "* `source` - source\n* `priority` - priority\n* `tags` - tags" }, "RoutingPublicationCaseRoutingRule": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 500 }, "priority": { "type": "integer", "maximum": 2147483647, "minimum": 0 }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingPublicationRoutingCondition" } }, "required_skills": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "maxItems": 25 }, "blueprint": { "type": "string", "format": "uuid" }, "blueprint_name": { "type": "string", "readOnly": true }, "team": { "type": "string", "format": "uuid", "nullable": true }, "team_name": { "type": "string", "readOnly": true }, "is_active": { "type": "boolean" }, "version": { "type": "integer", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "blueprint", "blueprint_name", "conditions", "created_at", "name", "team_name", "updated_at", "uuid", "version" ] }, "CaseActionStatusEnum": { "enum": [ "APPLIED", "FAILED" ], "type": "string", "description": "* `APPLIED` - Aplicado\n* `FAILED` - Falhou" }, "FraudCheckModuleSelectionRequest": { "type": "object", "properties": { "include": { "type": "array", "items": { "$ref": "#/components/schemas/FraudExcludeEnum" } }, "exclude": { "type": "array", "items": { "$ref": "#/components/schemas/FraudExcludeEnum" } } } }, "SignatureField": { "type": "object", "description": "Um campo a ser colocado em um documento da sessão: qual signatário o preenche, como e onde. Informe uma posição (`page`, `x`, `y`, `width` e `height`) ou um `anchor`. As posições são frações da página conforme ela é exibida, a partir do canto superior esquerdo, arredondadas para 4 casas decimais, e o campo deve caber dentro da página. Um documento aceita até 200 campos e um signatário até 500, e toda função com campos em um documento precisa de um campo `signature` ou `initials` nele. Consulte [Campos no documento](/pt-br/core-technology/electronic-signature/overview#campos-no-documento).", "required": [ "key", "type" ], "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$", "description": "Dá nome ao campo nos resultados e em `sign.field_values`. Único dentro do documento." }, "type": { "type": "string", "enum": [ "signature", "initials", "full_name", "date_signed", "text", "checkbox", "email", "data" ], "description": "O que o campo contém. O signatário aplica a `signature` e as `initials` que adotou, digita em `text`, marca uma `checkbox` e digita um `email` quando a sessão não tem e-mail verificado. A Didit preenche `full_name` (o nome verificado), `date_signed` (a data da assinatura, no fuso horário do signatário), `data` (a partir de `prefill`) e um `email` verificado, e os exibe como somente leitura. Não há um tipo seletor de data: use `text`." }, "role": { "type": "string", "enum": [ "verified_person", "legal_representative", "key_people" ], "description": "Quem preenche o campo, com os valores de `signature_signer`. Uma etapa preenche e carimba apenas os campos do seu próprio signatário. O padrão é o signatário da etapa." }, "page": { "type": "integer", "minimum": 1, "description": "Número da página, de 1 até o total de páginas do documento. Para um documento Word, uma página do PDF convertido." }, "x": { "type": "number", "minimum": 0, "maximum": 1, "description": "Borda esquerda, como fração da largura da página." }, "y": { "type": "number", "minimum": 0, "maximum": 1, "description": "Borda superior, como fração da altura da página." }, "width": { "type": "number", "minimum": 0.02, "maximum": 1, "description": "Largura, como fração da largura da página. Uma assinatura tem pelo menos `0.12` de largura." }, "height": { "type": "number", "minimum": 0.012, "maximum": 1, "description": "Altura, como fração da altura da página. Uma assinatura tem pelo menos `0.035` de altura." }, "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": "Exibido ao signatário e nos resultados. O valor padrão vem do tipo." }, "placeholder": { "type": "string", "nullable": true, "maxLength": 80, "description": "Somente `text` e `email`." }, "validation": { "$ref": "#/components/schemas/SignatureFieldValidation" }, "prefill": { "type": "string", "nullable": true, "description": "De onde vem o 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.` (uma chave do `metadata` da sessão) ou `api.` (uma chave de `sign.field_values`). Obrigatório para `data`. `full_name` sempre usa `identity.full_name` e `email` usa `contact.email`. Os valores dos campos `data`, `full_name` e `email` verificado ficam fixos quando o signatário começa a assinar." }, "editable_when_prefilled": { "type": "boolean", "default": false, "description": "Somente `text` e `email`: o signatário pode alterar um valor pré-preenchido." }, "checked_by_default": { "type": "boolean", "default": false, "description": "Somente `checkbox`: a caixa começa marcada." }, "date_format": { "type": "string", "enum": [ "DD/MM/YYYY", "MM/DD/YYYY", "YYYY-MM-DD", "D MMMM YYYY" ], "default": "DD/MM/YYYY", "description": "Somente `date_signed`." } } }, "SessionSignDocument": { "type": "object", "required": [ "file_name", "content_base64" ], "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Título exibido ao signatário. O padrão é `file_name`." }, "file_name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Nome do arquivo, terminando em `.pdf` ou `.docx`." }, "content_base64": { "type": "string", "format": "byte", "description": "O arquivo, codificado em base64. Um PDF pode ter até 20 MB e 100 páginas, sem senha, scripts ou arquivos anexados. Um arquivo Word (`.docx`) pode ter até 20 MB e é convertido em PDF durante a requisição, em no máximo 25 segundos; o PDF então tem os mesmos limites. Até 5 arquivos Word por sessão. Um arquivo Word com macros, controle de alterações, links para conteúdo externo ou objetos incorporados é recusado com `signature_document_not_supported`, e um que não pode ser convertido retorna `signature_document_conversion_failed`, cada um com um `reason`." }, "fields": { "type": "array", "description": "Campos opcionais a serem posicionados neste documento, até 200. As páginas e posições se referem ao PDF ou, no caso de um arquivo Word, ao PDF convertido. Sem campos, o signatário lê o documento e concorda com ele.", "items": { "$ref": "#/components/schemas/SignatureField" }, "maxItems": 200 } } }, "SignatureResult": { "type": "object", "description": "O resultado de um signatário para uma etapa de Assinatura eletrônica. Consulte o [relatório de Assinatura eletrônica](/pt-br/core-technology/electronic-signature/report-electronic-signature).", "properties": { "id": { "type": "string", "format": "uuid", "description": "Passe-o como `signature_id` para baixar as evidências deste signatário ou validar a assinatura dele." }, "node_id": { "type": "string", "description": "A etapa do fluxo que o produziu." }, "status": { "type": "string", "enum": [ "intro", "review", "code", "signing", "signed", "declined" ], "description": "Em que ponto da etapa o signatário está. Somente `signed` significa que os documentos estão assinados." }, "verdict": { "type": "string", "enum": [ "Not Finished", "Approved", "In Review", "Declined" ], "description": "O resultado da etapa. Um aviso o define por meio da sua regra; regras de status personalizadas são aplicadas depois." }, "level": { "type": "string", "enum": [ "simple", "aes", "qes" ], "description": "`simple` (padrão) ou `aes`. `qes` (Assinatura Eletrônica Qualificada, QES) é um complemento que ainda não está disponível." }, "format": { "type": "string", "enum": [ "pdf", "pades" ], "description": "`pdf` para uma assinatura Simples, `pades` para uma assinatura Avançada (AES)." }, "profile": { "type": "string", "nullable": true, "description": "`PAdES-B-LT` depois que uma assinatura Avançada (AES) é assinada; caso contrário, null." }, "signer": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "O nome do signatário. Verificado (a partir da verificação de identidade aprovada ou da sessão), exceto no nível Simple sem um nome verificado na sessão, caso em que é o nome que o signatário digitou e não é verificado." }, "capacity": { "type": "string", "enum": [ "self", "company" ] }, "company": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true, "description": "O cargo da pessoa-chave, conforme declarado." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "As funções estruturadas da pessoa-chave, conforme declaradas para a empresa." }, "identity_session_id": { "type": "string", "format": "uuid", "description": "A sessão de KYC que verificou o signatário." } } }, "identity_used": { "type": "object", "description": "A identidade verificada na qual a assinatura se baseia. Vazio para uma assinatura Simple sem identidade 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": "O nome com o qual o signatário precisava corresponder." } } }, "certificate": { "type": "object", "nullable": true, "description": "O certificado com o qual os documentos foram assinados. `null` até a assinatura, e sempre `null` para uma assinatura simples.", "properties": { "issuer": { "type": "string" }, "issued_to": { "type": "string" }, "serial": { "type": "string", "description": "Número de série, em hexadecimal." }, "valid_from": { "type": "string", "format": "date-time" }, "valid_until": { "type": "string", "format": "date-time" } } }, "confirmation": { "type": "object", "properties": { "channel": { "type": "string", "nullable": true, "enum": [ "email", "sms" ], "description": "`null` para uma assinatura Simples, que não tem código." }, "destination": { "type": "string", "nullable": true, "description": "O contato mascarado para o qual o código foi enviado." }, "confirmed_at": { "type": "string", "format": "date-time", "nullable": true }, "attempts": { "type": "integer", "description": "Códigos inseridos, incluindo o correto." } } }, "timestamp": { "type": "object", "nullable": true, "description": "O carimbo de tempo RFC 3161 da assinatura, emitido pela Didit. É `null` até a assinatura e sempre `null` para uma assinatura do tipo Simple.", "properties": { "time": { "type": "string", "format": "date-time" }, "qualified": { "type": "boolean", "description": "Sempre `false` para AES." }, "valid": { "type": "boolean" } } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "O documento na cópia deste signatário. Use-o para baixar o arquivo assinado." }, "uuid": { "type": "string", "format": "uuid", "description": "Igual a `id`." }, "title": { "type": "string" }, "file_name": { "type": "string" }, "pages": { "type": "integer", "description": "Páginas do documento assinadas. Para Word, do PDF convertido." }, "size_bytes": { "type": "integer" }, "sha256_original": { "type": "string", "description": "SHA-256 do documento tal como foi exibido ao signatário." }, "sha256_signed": { "type": "string", "nullable": true, "description": "SHA-256 do PDF assinado, depois de assinado." }, "status": { "type": "string", "enum": [ "signed", "declined", "not_signed", "not_reached" ], "description": "`not_signed`: aberto, mas não assinado. `not_reached`: nunca aberto." }, "opened_at": { "type": "string", "format": "date-time", "nullable": true }, "read_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o signatário chegou ao fim de um documento sem campos, quando a etapa exige isso." }, "read_to_end": { "type": "boolean" }, "consented_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o signatário concordou com um documento sem campos, ou concluiu os campos de um documento com campos." }, "consent": { "type": "boolean" }, "signed_file": { "type": "string", "nullable": true, "description": "Caminho do PDF assinado, depois de assinado. Consulte [Baixar um documento assinado](/pt-br/sessions-api/electronic-signature/download-signed-document)." }, "mode": { "type": "string", "enum": [ "fields", "read_and_agree" ], "description": "`fields` para um documento com campos, `read_and_agree` para um documento sem campos." }, "source_format": { "type": "string", "enum": [ "pdf", "docx" ], "description": "`pdf`, ou `docx` para um documento Word que a Didit converteu para PDF." }, "conversion": { "type": "object", "nullable": true, "description": "`null` para um PDF. Para um documento Word, o arquivo original e a conversão.", "properties": { "from": { "type": "string", "enum": [ "docx" ] }, "file_name": { "type": "string", "description": "O nome original do seu arquivo do Word." }, "sha256": { "type": "string", "description": "SHA-256 do seu arquivo Word original." }, "size_bytes": { "type": "integer", "description": "Tamanho do seu arquivo Word original." }, "converter": { "type": "string", "description": "Versão do conversor que gerou o PDF." } } }, "fields": { "type": "array", "description": "Campos do documento, com seus valores. Vazio para um documento sem campos.", "items": { "$ref": "#/components/schemas/SignatureFieldResult" } } } } }, "adopted_signature": { "type": "object", "nullable": true, "description": "A assinatura e as iniciais que o signatário adotou para os campos de assinatura e de iniciais. `null` até que o signatário adote uma.", "properties": { "method": { "type": "string", "enum": [ "typed", "drawn" ], "description": "`typed`: o nome verificado em um estilo de letra cursiva. `drawn`: desenhada com o dedo ou o mouse." }, "font": { "type": "string", "nullable": true, "description": "O estilo de caligrafia de uma assinatura digitada. `null` quando desenhada." }, "adopted_at": { "type": "string", "format": "date-time" } } }, "electronic_signature_consent_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o signatário concordou, na tela de revisão, em assinar os documentos eletronicamente. Definido quando algum documento tem campos." }, "evidence_file": { "type": "string", "nullable": true, "description": "Caminho do PDF de evidências, depois de assinado. Consulte [Baixar as evidências da assinatura](/pt-br/sessions-api/electronic-signature/download-evidence)." }, "warnings": { "type": "array", "description": "Avisos gerados para este signatário. Consulte [Avisos de assinatura eletrônica](/pt-br/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": "A última verificação criptográfica dos documentos assinados. `null` até que os documentos sejam assinados. Se a Didit não conseguir confirmar o resultado da assinatura, o valor é `{\"valid\": null, \"reason\": \"signature_provider_outcome_unknown\", \"checked_at\": ...}` e `status` permanece `signing`: trate-o como não assinado.", "properties": { "valid": { "type": "boolean", "nullable": true, "description": "`true` quando todos os documentos são válidos. `null` quando não foi possível confirmar o resultado da assinatura." }, "reason": { "type": "string", "description": "Preenchido quando `valid` é `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` quando a assinatura e o carimbo de tempo são ambos válidos e confiáveis." }, "integrity": { "type": "boolean", "description": "`true` quando o documento não foi alterado desde a assinatura." }, "trusted": { "type": "boolean", "description": "`true` quando o certificado de assinatura se encadeia a uma raiz confiável." }, "revoked": { "type": "boolean" }, "trusted_list": { "type": "object", "description": "Verificação na EU Trusted List. Para AES: `{\"status\": \"not_applicable\", \"reason\": \"aes_not_qualified\"}`.", "properties": { "status": { "type": "string" }, "reason": { "type": "string" } } }, "certificate": { "type": "object", "nullable": true, "description": "O certificado com o qual os documentos foram assinados. `null` até a assinatura, e sempre `null` para uma assinatura simples.", "properties": { "issuer": { "type": "string" }, "issued_to": { "type": "string" }, "serial": { "type": "string", "description": "Número de série, em hexadecimal." }, "valid_from": { "type": "string", "format": "date-time" }, "valid_until": { "type": "string", "format": "date-time" } } }, "timestamp": { "type": "object", "nullable": true, "description": "O carimbo de tempo RFC 3161 da assinatura, emitido pela Didit. É `null` até a assinatura e sempre `null` para uma assinatura do tipo Simple.", "properties": { "time": { "type": "string", "format": "date-time" }, "qualified": { "type": "boolean", "description": "Sempre `false` para AES." }, "valid": { "type": "boolean" } } } } } } } }, "declined_at": { "type": "string", "format": "date-time", "nullable": true }, "declined_action": { "type": "string", "enum": [ "DECLINE", "REVIEW", "NO_ACTION" ] }, "signed_at": { "type": "string", "format": "date-time", "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "description": "Quando o link de assinatura 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": "O endereço IP do signatário quando ele solicitou o código." }, "place": { "type": "string", "nullable": true, "description": "Não coletado: sempre `null`." }, "place_unavailable_reason": { "type": "string", "nullable": true, "enum": [ "not_collected" ] } } }, "SignatureFieldValidation": { "type": "object", "nullable": true, "description": "Regras para o valor de um campo `text`. A pré-visualização do console, o fluxo de assinatura e a API aplicam as mesmas regras.", "properties": { "kind": { "type": "string", "enum": [ "any", "letters", "number", "email", "pattern" ], "description": "`letters`: letras de qualquer alfabeto, espaços, hífens e apóstrofos. `number`: dígitos com um separador decimal opcional. `pattern`: o valor deve corresponder a `pattern`." }, "min_length": { "type": "integer", "minimum": 0, "maximum": 500, "description": "De `0` até `max_length`." }, "max_length": { "type": "integer", "minimum": 1, "maximum": 500, "default": 120 }, "pattern": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 200, "description": "Obrigatório com `kind: \"pattern\"`. Uma expressão regular à qual o valor inteiro deve corresponder. Lookarounds e referências retroativas (backreferences) não são suportados." }, "message": { "type": "string", "nullable": true, "maxLength": 120, "description": "Exibido ao signatário no lugar do erro padrão." } } }, "SignatureFieldAnchor": { "type": "object", "description": "Posiciona um campo por um trecho de texto no documento em vez de uma posição. A Didit não remove o texto do PDF, então escreva-o na mesma cor do fundo da página. Quando o texto não é encontrado, a chamada retorna `400` com `field_anchor_not_found`. Consulte [Posicionar campos por texto âncora](/pt-br/sessions-api/create-session#posicionar-campos-por-texto-âncora).", "required": [ "text" ], "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 64, "description": "Texto buscado no documento. Para um arquivo Word, no PDF convertido." }, "occurrence": { "type": "string", "enum": [ "first", "all" ], "default": "first", "description": "`all` coloca um campo por correspondência; as chaves após a primeira recebem `_2`, `_3` e assim por diante." }, "offset_x": { "type": "number", "description": "Somado à borda esquerda do texto, como fração da largura da página." }, "offset_y": { "type": "number", "description": "Somado à borda superior do texto, como fração da altura da página." }, "width": { "type": "number", "minimum": 0.02, "maximum": 1, "description": "Largura do campo, como fração da largura da página." }, "height": { "type": "number", "minimum": 0.012, "maximum": 1, "description": "Altura do campo, como fração da altura da página." } } }, "SignatureFieldResult": { "type": "object", "description": "Um campo de um documento assinado, com o seu valor na cópia deste signatário. Consulte [Campos](/pt-br/core-technology/electronic-signature/report-electronic-signature#campos).", "properties": { "key": { "type": "string", "description": "A chave do campo, como usada em `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 da página, a partir de 1. Para um documento Word, uma página do PDF convertido." }, "x": { "type": "number", "description": "Borda esquerda, como fração da largura da página." }, "y": { "type": "number", "description": "Borda superior, como fração da altura da página." }, "width": { "type": "number", "description": "Largura, como fração da largura da página." }, "height": { "type": "number", "description": "Altura, como fração da altura da página." }, "required": { "type": "boolean" }, "value": { "nullable": true, "description": "Uma string para `text`, `email`, `full_name`, `date_signed` e `data`, um booleano para um `checkbox` e `true` para uma assinatura ou rubrica aplicada. `null` quando vazio." }, "display_value": { "type": "string", "nullable": true, "description": "O valor conforme carimbado na página: datas no `date_format` do campo, `Yes` ou `No` para uma caixa de seleção, `Signed` para uma assinatura ou rubrica." }, "value_source": { "type": "string", "nullable": true, "enum": [ "signer", "identity", "contact", "company", "session", "metadata", "api", "signing_time", null ], "description": "Origem do valor: `signer` (digitado, marcado ou aplicado pelo signatário), `identity` (o documento de identidade verificado), `contact` (o e-mail ou telefone verificado), `company` (a empresa verificada), `session` (`vendor_data`), `metadata`, `api` (`sign.field_values`) ou `signing_time` (a data da assinatura)." }, "filled_at": { "type": "string", "format": "date-time", "nullable": true }, "image_url": { "type": "string", "nullable": true, "description": "Somente assinatura e rubrica: o caminho da imagem aplicada. Consulte [Baixar uma imagem de assinatura](/pt-br/sessions-api/electronic-signature/download-field-image)." }, "value_unavailable_reason": { "type": "string", "nullable": true, "enum": [ "source_empty", null ], "description": "`source_empty` quando um campo pré-preenchido não tinha valor na sessão e `signature_field_data_missing_action` permitiu que o signatário assinasse mesmo assim." } } }, "VaspDirectoryWidgetEntry": { "type": "object", "description": "O que o seletor de VASP do usuário final exibe: quem é o VASP e se ele pode ser contatado.", "properties": { "id": { "type": "string", "format": "uuid", "description": "O id da entrada, para GET /v3/travel-rule/vasps/{vasp_id}/." }, "kind": { "type": "string", "enum": [ "directory", "didit" ], "description": "directory para uma entrada do diretório compartilhado; didit para um membro da rede Didit." }, "name": { "type": "string" }, "lei": { "type": "string" }, "jurisdiction": { "type": "string", "description": "Código de país ISO 3166, conforme informado pela fonte." }, "domains": { "type": "array", "items": { "type": "string" }, "description": "Os domínios web do VASP. Sempre vazio para membros da rede Didit." }, "reachable": { "type": "boolean", "description": "Se a sua aplicação tem uma rota disponível até este VASP ou, no caso de uma marca, até uma de suas entidades. Sempre true para um membro da rede Didit." } } }, "TravelRuleDataSharingFields": { "type": "object", "description": "Os campos que a Didit envia à VASP contraparte sobre seus próprios usuários, por tipo de entidade. O `name` e o `wallet_address` são sempre enviados, independentemente do que a lista diga. Um tipo de entidade que você nunca escolheu compartilha todos os campos. Uma lista vazia também é uma escolha: ela compartilha apenas o nome e a carteira.", "properties": { "individual": { "type": "array", "items": { "type": "string", "enum": [ "name", "wallet_address", "address", "national_id", "customer_identification", "date_of_birth", "place_of_birth" ] }, "description": "Campos compartilhados sobre uma pessoa física." }, "company": { "type": "array", "items": { "type": "string", "enum": [ "name", "wallet_address", "address", "national_id", "customer_identification" ] }, "description": "Campos compartilhados sobre uma pessoa jurídica." } } }, "TravelRuleMatchingRules": { "type": "object", "description": "Com que rigor cada campo dos dados da contraparte é comparado com o que você possui, por tipo de entidade. Um campo que você omitir mantém o padrão. `NONE` ignora a comparação, `STRICT` exige exatamente as mesmas palavras, `CONTAINS` aceita um valor cujas palavras aparecem todas no outro, `DEFAULT` é a correspondência padrão por subconjunto e `FUZZY` aceita grafias próximas (e, para datas de nascimento, dia e mês invertidos).", "properties": { "individual": { "type": "object", "description": "Regras para uma pessoa física.", "properties": { "name": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Padrão: segue `name_matching_strictness`." }, "date_of_birth": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Padrão `NONE`." }, "address": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Padrão `NONE`." }, "account": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "A carteira pela qual a troca foi roteada. Padrão `STRICT`." } } }, "company": { "type": "object", "description": "Regras para uma pessoa jurídica.", "properties": { "name": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Padrão: segue `name_matching_strictness`." }, "address": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "Padrão `NONE`." }, "account": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ], "description": "A carteira pela qual a troca foi roteada. Padrão `STRICT`." } } } } }, "TravelRuleDataMatch": { "type": "object", "nullable": true, "description": "Comparação campo a campo entre os dados das partes da transferência e o que o outro lado sabe sobre o titular da carteira. Ela indica campos e resultados, nunca valores, por isso continua legível enquanto os dados da contraparte estão mascarados. Nulo até que uma comparação seja executada.", "properties": { "matched": { "type": "boolean", "description": "True quando nenhum campo comparado é diferente." }, "mismatched_fields": { "type": "array", "items": { "type": "string", "enum": [ "name", "date_of_birth", "address", "account" ] }, "description": "Os campos que diferem." }, "fields": { "type": "object", "description": "Uma entrada por campo comparado para o tipo de entidade da parte (`name`, `date_of_birth`, `address`, `account`; uma empresa não tem `date_of_birth`).", "additionalProperties": { "type": "object", "properties": { "result": { "type": "string", "enum": [ "matched", "mismatched", "not_compared" ], "description": "`not_compared` quando a regra é `NONE` ou um dos lados não tem valor para o campo." }, "strictness": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ] } } } } } }, "TravelRuleDataUnmasked": { "type": "object", "nullable": true, "description": "Registro de auditoria do momento em que os dados da contraparte foram desmascarados. É nulo enquanto os dados ainda estão mascarados e em transferências de saída.", "properties": { "at": { "type": "string", "format": "date-time" }, "reason": { "type": "string", "enum": [ "ownership_confirmed", "wallet_proof", "address_book_match", "own_verified_wallet", "inquiry_approved", "known_payment_method", "travel_address" ], "description": "O que confirmou a propriedade: ownership_confirmed (sua confirmação pelo console ou pela API), wallet_proof (uma prova de carteira no widget ou uma transferência de entrada INTERNAL, definida quando é criada), address_book_match (uma carteira verificada do catálogo de endereços), own_verified_wallet (a carteira verificada do próprio usuário), inquiry_approved (sua aprovação de uma consulta TRP de entrada ou de uma mensagem GTR ou Sygna), known_payment_method (uma carteira com a qual seu usuário já pagou) ou travel_address (o travel address por carteira identificou a carteira)." }, "actor": { "type": "string", "description": "Quem confirmou: o e-mail do usuário do console ou o rótulo da chave de API. Em branco para uma decisão automática." } } }, "TravelRuleMessageAttachment": { "type": "object", "nullable": true, "description": "O documento anexado a uma mensagem, armazenado como qualquer outro documento de transação.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "label": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true }, "uploaded_by": { "type": "string", "nullable": true, "description": "Quem o anexou. No portal de retirada, um arquivo que você enviou mostra o nome do seu VASP, nunca a pessoa ou a chave de API por trás dele." }, "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 download com tempo limitado." }, "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` é o que o próprio lado do leitor enviou. No portal de retirada, a direção é a partir do lado da contraparte." }, "author": { "type": "string", "description": "Quem o escreveu do próprio lado: o e-mail de um usuário do console ou o rótulo de uma chave de API, ou o nome do outro VASP." }, "body": { "type": "string" }, "requested_documents": { "type": "array", "items": { "type": "string" }, "description": "O que um DOCUMENT_REQUEST solicita, nas palavras do solicitante." }, "reply_to": { "type": "string", "format": "uuid", "nullable": true }, "fulfilled_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Definido em um DOCUMENT_REQUEST assim que uma resposta a ele contém um documento." }, "attachment": { "$ref": "#/components/schemas/TravelRuleMessageAttachment" }, "created_at": { "type": "string", "format": "date-time" } } }, "TravelRuleMessageCreateRequest": { "type": "object", "description": "Envie como JSON ou como multipart/form-data com os anexos em `files`.", "properties": { "kind": { "type": "string", "enum": [ "MESSAGE", "DOCUMENT_REQUEST" ], "default": "MESSAGE" }, "body": { "type": "string", "maxLength": 5000, "description": "Obrigatório para uma MESSAGE, a menos que um arquivo seja anexado." }, "requested_documents": { "type": "array", "items": { "type": "string", "maxLength": 255 }, "maxItems": 10, "description": "Obrigatório (pelo menos um) para um DOCUMENT_REQUEST, e permitido somente nele." }, "reply_to": { "type": "string", "format": "uuid", "nullable": true, "description": "Uma mensagem da mesma transferência. Uma resposta que traz um documento atende à solicitação de documento à qual responde." }, "files": { "type": "array", "items": { "type": "string", "format": "binary" }, "maxItems": 5, "description": "Somente multipart. Até 5 arquivos de 10 MB cada." } } }, "SessionDeletionJob": { "type": "object", "description": "Uma exclusão de sessões em massa executada em segundo plano: progresso e contagens por resultado, nunca quais sessões ela excluiu.", "properties": { "job_id": { "type": "string", "format": "uuid", "description": "Consulte `GET /v3/sessions/delete/{job_id}/` periodicamente com este id." }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ], "description": "`PENDING`: aceito, ainda não iniciado. `PROCESSING`: excluindo; `processed` e `outcomes` estão sendo atualizados. `COMPLETED`: todas as sessões selecionadas foram contabilizadas. `FAILED`: o job parou antes do fim; consulte `error`." }, "total": { "type": "integer", "description": "Sessões selecionadas quando a exclusão foi solicitada." }, "processed": { "type": "integer", "description": "Sessões que o job já concluiu até agora." }, "outcomes": { "type": "object", "description": "Quantas sessões terminaram em cada resultado. Todas as chaves estão sempre presentes.", "properties": { "deleted": { "type": "integer", "description": "Sessões excluídas junto com o respectivo embedding facial." }, "none": { "type": "integer", "description": "Sessões excluídas que não tinham embedding facial." }, "retained_with_user": { "type": "integer", "description": "Sessões excluídas mantendo um template biométrico sem imagem para o respectivo User, conforme solicitado pela requisição ou pela política da aplicação." }, "ineligible_no_vendor_user": { "type": "integer", "description": "Sessões excluídas, com o respectivo embedding facial, porque a retenção foi solicitada, mas elas não tinham User vinculado." }, "failed_retryable": { "type": "integer", "description": "Sessões informadas como não excluídas. Um job tenta novamente, por conta própria, excluir um grupo que não conseguiu excluir, em vez de contabilizá-lo aqui." }, "already_deleted": { "type": "integer", "description": "Sessões selecionadas que já tinham sido excluídas, por exemplo por outra requisição, quando o job chegou a elas." } } }, "deleted_child_verifications": { "type": "integer", "description": "Verificações criadas pelas verificações de empresas excluídas, que foram excluídas junto com elas. Sempre `0` para um job iniciado por `POST /v3/sessions/delete/`, que exclui apenas sessões de KYC." }, "error": { "type": "string", "nullable": true, "description": "`null`, a menos que `status` seja `FAILED`; nesse caso, o motivo pelo qual a exclusão parou. As sessões que o job ainda não havia alcançado continuam existindo: repita a requisição para excluí-las." }, "created_at": { "type": "string", "format": "date-time", "description": "Quando a exclusão foi solicitada." }, "completed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o job terminou; `null` enquanto está em execução." } } }, "EntityStatusUpdateRequest": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "ACTIVE", "FLAGGED", "BLOCKED" ], "description": "Novo status do ciclo de vida. `BLOCKED` também adiciona o `vendor_data` à lista de bloqueio do 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": "Prévia de custo. Retornada diretamente quando estimate_only é true (nada é gravado).", "properties": { "users_total": { "type": "integer", "description": "Perfis correspondentes à seleção." }, "already_enabled": { "type": "integer", "description": "Perfis já monitorados (nada a fazer ao ativar; são estes que a desativação desliga)." }, "with_existing_aml": { "type": "integer", "description": "Perfis cuja análise AML existente passará a ser monitorada (sem nova análise)." }, "needing_screening": { "type": "integer", "description": "Perfis sem nenhuma análise AML, que serão analisados primeiro (cobrado como uma análise AML comum)." }, "skipped_no_identity_data": { "type": "integer", "description": "Perfis que não podem ser analisados porque faltam dados de identidade." }, "skipped_blocked": { "type": "integer", "description": "Usuários bloqueados que serão ignorados (sempre 0 para empresas)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Custo único das novas análises." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Custo anual de monitoramento dos perfis que passarão a ser monitorados." }, "balance_sufficient": { "type": "boolean", "description": "Se o saldo da organização cobre a triagem mais o primeiro ano de monitoramento." }, "unmatched": { "type": "array", "items": { "type": "string" }, "description": "Identificadores da requisição que não corresponderam a nenhum perfil nesta aplicação, exatamente como enviados." } } }, { "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 quando o job ativa o monitoramento, false quando o desativa." }, "target_type": { "type": "string", "enum": [ "user", "business" ], "description": "Qual família de perfis a tarefa ativa ou desativa." }, "total": { "type": "integer", "description": "Perfis que o job processa." }, "processed": { "type": "integer", "description": "Perfis processados até agora." }, "outcomes": { "type": "object", "description": "Contadores de resultado por registro. Cada perfil selecionado corresponde a exatamente um contador; nada é ignorado silenciosamente.", "properties": { "enabled": { "type": "integer", "description": "Monitoramento ativado em uma análise AML existente." }, "screened_and_enabled": { "type": "integer", "description": "Uma nova análise AML foi criada (cobrada) e o monitoramento foi ativado nela." }, "already_enabled": { "type": "integer", "description": "O monitoramento já estava ativo; nada foi alterado e nada foi cobrado." }, "disabled": { "type": "integer", "description": "Monitoramento desativado em todas as análises AML do perfil." }, "skipped_no_identity_data": { "type": "integer", "description": "Ignorado: o perfil não tem o nome completo, a data de nascimento e o país (usuários) ou um nome (empresas) necessários para a análise." }, "skipped_blocked": { "type": "integer", "description": "Ignorado: o usuário está bloqueado." }, "skipped_sandbox": { "type": "integer", "description": "Ignorado: aplicação de sandbox, nenhuma análise é criada." }, "failed_provider": { "type": "integer", "description": "Não foi possível concluir a análise; tente novamente mais tarde." }, "failed_insufficient_balance": { "type": "integer", "description": "O saldo acabou enquanto a tarefa estava em execução." } } }, "results": { "type": "array", "description": "Uma entrada por perfil processado, na ordem de processamento. Cresce enquanto o job é executado; fica completa quando o status é COMPLETED. Registrado para jobs iniciados pela API.", "items": { "type": "object", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "ID interno da Didit para o perfil." }, "vendor_data": { "type": "string", "nullable": true, "description": "Seu próprio identificador para o 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": "Mensagem genérica de falha quando o status é FAILED; a causa detalhada é mantida no lado da plataforma." }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "estimate": { "type": "object", "description": "Prévia de custo. Retornada diretamente quando estimate_only é true (nada é gravado).", "properties": { "users_total": { "type": "integer", "description": "Perfis correspondentes à seleção." }, "already_enabled": { "type": "integer", "description": "Perfis já monitorados (nada a fazer ao ativar; são estes que a desativação desliga)." }, "with_existing_aml": { "type": "integer", "description": "Perfis cuja análise AML existente passará a ser monitorada (sem nova análise)." }, "needing_screening": { "type": "integer", "description": "Perfis sem nenhuma análise AML, que serão analisados primeiro (cobrado como uma análise AML comum)." }, "skipped_no_identity_data": { "type": "integer", "description": "Perfis que não podem ser analisados porque faltam dados de identidade." }, "skipped_blocked": { "type": "integer", "description": "Usuários bloqueados que serão ignorados (sempre 0 para empresas)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Custo único das novas análises." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Custo anual de monitoramento dos perfis que passarão a ser monitorados." }, "balance_sufficient": { "type": "boolean", "description": "Se o saldo da organização cobre a triagem mais o primeiro ano de monitoramento." } } }, "unmatched": { "type": "array", "items": { "type": "string" }, "description": "Identificadores da requisição que não corresponderam a nenhum perfil nesta aplicação, exatamente como enviados. Eles não fazem parte da tarefa." } } } ] }, "AMLMonitoringJob": { "type": "object", "properties": { "job_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ] }, "is_enabled": { "type": "boolean", "description": "true quando o job ativa o monitoramento, false quando o desativa." }, "target_type": { "type": "string", "enum": [ "user", "business" ], "description": "Qual família de perfis a tarefa ativa ou desativa." }, "total": { "type": "integer", "description": "Perfis que o job processa." }, "processed": { "type": "integer", "description": "Perfis processados até agora." }, "outcomes": { "type": "object", "description": "Contadores de resultado por registro. Cada perfil selecionado corresponde a exatamente um contador; nada é ignorado silenciosamente.", "properties": { "enabled": { "type": "integer", "description": "Monitoramento ativado em uma análise AML existente." }, "screened_and_enabled": { "type": "integer", "description": "Uma nova análise AML foi criada (cobrada) e o monitoramento foi ativado nela." }, "already_enabled": { "type": "integer", "description": "O monitoramento já estava ativo; nada foi alterado e nada foi cobrado." }, "disabled": { "type": "integer", "description": "Monitoramento desativado em todas as análises AML do perfil." }, "skipped_no_identity_data": { "type": "integer", "description": "Ignorado: o perfil não tem o nome completo, a data de nascimento e o país (usuários) ou um nome (empresas) necessários para a análise." }, "skipped_blocked": { "type": "integer", "description": "Ignorado: o usuário está bloqueado." }, "skipped_sandbox": { "type": "integer", "description": "Ignorado: aplicação de sandbox, nenhuma análise é criada." }, "failed_provider": { "type": "integer", "description": "Não foi possível concluir a análise; tente novamente mais tarde." }, "failed_insufficient_balance": { "type": "integer", "description": "O saldo acabou enquanto a tarefa estava em execução." } } }, "results": { "type": "array", "description": "Uma entrada por perfil processado, na ordem de processamento. Cresce enquanto o job é executado; fica completa quando o status é COMPLETED. Registrado para jobs iniciados pela API.", "items": { "type": "object", "properties": { "didit_internal_id": { "type": "string", "format": "uuid", "description": "ID interno da Didit para o perfil." }, "vendor_data": { "type": "string", "nullable": true, "description": "Seu próprio identificador para o 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": "Mensagem genérica de falha quando o status é FAILED; a causa detalhada é mantida no lado da plataforma." }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "estimate": { "type": "object", "description": "Prévia de custo. Retornada diretamente quando estimate_only é true (nada é gravado).", "properties": { "users_total": { "type": "integer", "description": "Perfis correspondentes à seleção." }, "already_enabled": { "type": "integer", "description": "Perfis já monitorados (nada a fazer ao ativar; são estes que a desativação desliga)." }, "with_existing_aml": { "type": "integer", "description": "Perfis cuja análise AML existente passará a ser monitorada (sem nova análise)." }, "needing_screening": { "type": "integer", "description": "Perfis sem nenhuma análise AML, que serão analisados primeiro (cobrado como uma análise AML comum)." }, "skipped_no_identity_data": { "type": "integer", "description": "Perfis que não podem ser analisados porque faltam dados de identidade." }, "skipped_blocked": { "type": "integer", "description": "Usuários bloqueados que serão ignorados (sempre 0 para empresas)." }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2, "description": "Custo único das novas análises." }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07, "description": "Custo anual de monitoramento dos perfis que passarão a ser monitorados." }, "balance_sufficient": { "type": "boolean", "description": "Se o saldo da organização cobre a triagem mais o primeiro ano de monitoramento." } } }, "unmatched": { "type": "array", "items": { "type": "string" }, "description": "Identificadores da requisição que não corresponderam a nenhum perfil nesta aplicação, exatamente como enviados. Eles não fazem parte da tarefa." } } }, "OngoingMonitoringToggleRequest": { "type": "object", "required": [ "is_enabled" ], "properties": { "is_enabled": { "type": "boolean", "description": "true para ativar o monitoramento, false para desativá-lo." }, "estimate_only": { "type": "boolean", "default": false, "description": "Quando verdadeiro, retorna a estimativa de custo e não realiza nenhuma gravação." }, "update_all": { "type": "boolean", "default": false, "description": "Aplica a todas as entidades da aplicação (com escopo definido pelos parâmetros filter_* quando presentes)." }, "filter_search": { "type": "string" }, "filter_status": { "type": "array", "items": { "type": "string" } }, "filter_country": { "type": "string" }, "filter_date_from": { "type": "string", "format": "date" }, "filter_date_to": { "type": "string", "format": "date" }, "didit_internal_id_list": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Entidades a ativar ou desativar. Obrigatório, a menos que update_all seja true." } } }, "OngoingMonitoringJob": { "type": "object", "properties": { "job_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "COMPLETED", "FAILED" ] }, "is_enabled": { "type": "boolean" }, "total": { "type": "integer" }, "processed": { "type": "integer" }, "outcomes": { "type": "object", "description": "Contadores de resultado por entidade. Nada é ignorado silenciosamente: cada entidade solicitada corresponde a exatamente um contador.", "properties": { "enabled": { "type": "integer", "description": "Monitoramento ativado em uma análise AML existente." }, "screened_and_enabled": { "type": "integer", "description": "Uma nova análise AML foi criada (cobrada) e o monitoramento foi ativado." }, "already_enabled": { "type": "integer", "description": "O monitoramento já estava ativo (linhas duplicadas legadas são consolidadas)." }, "disabled": { "type": "integer", "description": "Monitoramento desativado em todas as linhas AML da entidade." }, "skipped_no_identity_data": { "type": "integer", "description": "Ignorado: não há nome completo + data de nascimento + país disponíveis para a análise." }, "skipped_blocked": { "type": "integer", "description": "Ignorado: o usuário está bloqueado." }, "skipped_sandbox": { "type": "integer", "description": "Ignorado: aplicação de sandbox." }, "failed_provider": { "type": "integer", "description": "A chamada ao provedor de análise falhou." }, "failed_insufficient_balance": { "type": "integer", "description": "O saldo acabou no meio da tarefa." } } }, "error": { "type": "string", "nullable": true }, "estimate": { "type": "object", "description": "Prévia de custo. Retornada diretamente quando estimate_only é true (nenhuma gravação é feita).", "properties": { "users_total": { "type": "integer", "description": "Entidades na seleção." }, "already_enabled": { "type": "integer" }, "with_existing_aml": { "type": "integer", "description": "Entidades cuja análise AML existente passará a ser monitorada." }, "needing_screening": { "type": "integer", "description": "Entidades sem nenhuma análise AML, que serão analisadas primeiro (cobrado)." }, "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": "Prévia de custo. Retornada diretamente quando estimate_only é true (nenhuma gravação é feita).", "properties": { "users_total": { "type": "integer", "description": "Entidades na seleção." }, "already_enabled": { "type": "integer" }, "with_existing_aml": { "type": "integer", "description": "Entidades cuja análise AML existente passará a ser monitorada." }, "needing_screening": { "type": "integer", "description": "Entidades sem nenhuma análise AML, que serão analisadas primeiro (cobrado)." }, "skipped_no_identity_data": { "type": "integer" }, "skipped_blocked": { "type": "integer" }, "estimated_screening_cost_usd": { "type": "number", "example": 0.2 }, "estimated_annual_monitoring_cost_usd": { "type": "number", "example": 0.07 }, "balance_sufficient": { "type": "boolean" } } }, { "$ref": "#/components/schemas/OngoingMonitoringJob" } ] }, "CaseBlueprintPresetInstallResult": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string" } } } }, "CaseBulkUpdateResult": { "type": "object", "properties": { "updated": { "type": "integer" }, "failures": { "type": "array", "items": { "type": "object", "properties": { "case_uuid": { "type": "string", "format": "uuid" }, "detail": { "type": "string" } } } } } }, "RegulatoryReportList": { "type": "object", "properties": { "count": { "type": "integer", "description": "Número de linhas correspondentes, limitado a 100 por desempenho." }, "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": "O identificador único da sessão." }, "session_kind": { "type": "string", "enum": [ "user", "business" ], "description": "Discriminador que indica se esta é uma sessão de Verificação de usuários (KYC) ou de Verificação de empresas (KYB). Quando `user`, os arrays de recursos de KYC (`id_verifications`, `nfc_verifications`, `liveness_checks`, `face_matches`, `poa_verifications`, `document_ai_documents`, `database_validations`, ...) se aplicam e os arrays de empresa estão ausentes. Quando `business`, o payload traz `registry_checks`, `document_verifications`, `key_people_checks`, além dos arrays compartilhados (`aml_screenings`, `phone_verifications`, `email_verifications`, `ip_analyses`, `questionnaire_responses`). **Omitido quando `include=events` é passado**: o formato com eventos existe apenas para sessões de usuário, por isso o discriminador é removido dessa variante." }, "shared_from_session": { "type": "string", "format": "uuid", "nullable": true, "description": "Para uma sessão clonada com `POST /v3/session/import-shared/`: o `session_id` da sessão original na aplicação de origem. `null` para todas as outras sessões. Omitido quando `include=events` é enviado." }, "shared_from_session_number": { "type": "integer", "nullable": true, "description": "`session_number` da sessão de origem, quando esta sessão foi importada de outra aplicação da sua organização. `null` caso contrário." }, "session_number": { "type": "integer", "description": "O número da sessão.", "nullable": true }, "session_url": { "type": "string", "format": "uri", "description": "A URL da sessão.", "nullable": true }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Awaiting User", "In Review", "Approved", "Declined", "Resubmitted", "Expired", "Kyc Expired", "Abandoned" ], "description": "Status geral do ciclo de vida da sessão — o resultado consolidado do fluxo. Os valores finais são `Approved`, `Declined`, `In Review`, `Expired`, `Kyc Expired` e `Abandoned`; `Not Started`, `In Progress`, `Awaiting User` e `Resubmitted` indicam que a sessão ainda está avançando pelo fluxo." }, "status_override": { "type": "object", "nullable": true, "description": "Presente quando um revisor definiu o `status` manualmente. `null` quando o status é o automático. Use-o para distinguir uma aprovação manual de uma automática.", "properties": { "overridden_at": { "type": "string", "format": "date-time", "nullable": true }, "automatic_status": { "type": "string", "nullable": true, "description": "O status a que chegam as verificações da própria plataforma." } } }, "decision_trace": { "type": "object", "description": "Como o status foi alcançado: quem o definiu e quais avisos o determinaram.", "properties": { "status": { "type": "string", "description": "O status da sessão." }, "decided_by": { "type": "string", "nullable": true, "enum": [ "manual", "automatic", "investigator", null ], "description": "Quem definiu o status. `null` enquanto a sessão não tiver uma decisão." }, "decided_at": { "type": "string", "format": "date-time", "nullable": true }, "automatic_status": { "type": "string", "nullable": true, "description": "O que as verificações da própria plataforma concluem, o que difere de `status` após uma decisão manual." }, "terminal_node_id": { "type": "string", "nullable": true, "description": "O nó de status do fluxo que encerrou a sessão, quando houver." }, "actor": { "type": "object", "nullable": true, "description": "O revisor responsável por uma decisão manual.", "properties": { "user": { "type": "string", "nullable": true }, "actor_type": { "type": "string", "nullable": true } } }, "warning_counts": { "type": "object", "description": "Avisos por `log_type` (`error`, `warning`, `information`) e `total`.", "additionalProperties": { "type": "integer" } }, "status_warnings": { "type": "array", "description": "Os avisos que definem um status `Declined` ou `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": "A lista do payload da qual o aviso veio, por exemplo `id_verifications`." }, "short_description": { "type": "string", "nullable": true } } } } } }, "linked_records": { "type": "object", "nullable": true, "description": "Um resumo de outros registros vinculados à sessão. `null` quando não há nada a mostrar e para fluxos que declaram um padrão de garantia de idade.", "properties": { "same_face": { "type": "object", "nullable": true, "description": "Outras pessoas cujo rosto correspondeu a uma das buscas faciais desta sessão.", "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 estável do grupo de fluxos que gerou esta sessão. Os fluxos são versionados: este valor identifica o fluxo em si, não a versão específica.", "nullable": true }, "features": { "type": "array", "items": { "type": "string", "description": "O recurso da sessão." }, "description": "Lista dos recursos de verificação configurados para esta sessão, como nomes de exibição: `ID_VERIFICATION`, `NFC`, `LIVENESS`, `FACE_MATCH`, `POA`, `PHONE`, `EMAIL_VERIFICATION`, `AML`, `IP_ANALYSIS`, `DATABASE_VALIDATION`, `QUESTIONNAIRE`, `AGE_ESTIMATION`, `FACE_SEARCH`, `GEOLOCATION` (verificação de localização) (as sessões de Verificação de empresas usam o conjunto de recursos de KYB: `KYB_REGISTRY`, `KYB_DOCUMENTS`, `KYB_KEY_PEOPLE`, `AML`, `PHONE`, `EMAIL_VERIFICATION`, `IP_ANALYSIS`, `QUESTIONNAIRE`). Com `include=events`, cada entrada se torna um objeto `{feature, node_id}` em vez de uma string simples, e o recurso de e-mail é renomeado: ele aparece como `EMAIL` no modo de eventos em vez do `EMAIL_VERIFICATION` usado aqui." }, "vendor_data": { "type": "string", "description": "Os dados do fornecedor (vendor data) da sessão.", "nullable": true }, "metadata": { "type": "object", "description": "Os metadados da sessão.", "nullable": true }, "expected_details": { "type": "object", "description": "Dados esperados informados na criação da sessão, usados para validação cruzada com os dados extraídos (KYC) ou para pré-preencher a busca no registro de empresas (KYB). Retorna exatamente as chaves que foram informadas; `null` quando nenhuma foi informada. Sessões de KYC trazem os campos da pessoa; sessões de empresa (KYB) trazem `company_name`, `registry_country` e `registration_number`.", "properties": { "first_name": { "type": "string", "description": "Nome do usuário. Por exemplo, `John`." }, "last_name": { "type": "string", "description": "Sobrenome do usuário. Por exemplo, `Doe`." }, "date_of_birth": { "type": "string", "format": "date", "description": "Data de nascimento do usuário no formato YYYY-MM-DD. Por exemplo, `1990-05-15`." }, "gender": { "type": "string", "nullable": true, "enum": [ "M", "F" ], "default": null, "description": "Gênero do usuário. Deve ser 'M', 'F' ou null." }, "nationality": { "type": "string", "description": "Código ISO 3166-1 alpha-3 que representa o país de origem do solicitante. Por exemplo, `USA`." }, "country": { "type": "string", "description": "Código ISO 3166-1 alpha-3 que representa o país do documento de Comprovante de endereço ou o país do documento de identidade do solicitante, que pode ser diferente da nacionalidade. Por exemplo, `GBR`." }, "address": { "type": "string", "description": "O endereço em formato legível, com o máximo de informações possível. Por exemplo, `123 Main St, San Francisco, CA 94105, USA`." }, "identification_number": { "type": "string", "description": "O número do documento, número pessoal ou número fiscal do usuário. Por exemplo, `123456789`." }, "ip_address": { "type": "string", "format": "ipv4", "description": "Endereço IP esperado para a sessão. Se o endereço IP real for diferente desse valor, um aviso será registrado. Por exemplo, `192.168.1.100`." }, "expected_document_types": { "type": "array", "description": "Tipos de documento aos quais a etapa de verificação de identidade foi restrita na criação da sessão. Vazio ou não definido significa sem restrição. Códigos: `P` (passaporte), `ID` (documento nacional de identidade), `DL` (carteira de motorista), `RP` (autorização de residência), `HIC` (cartão de seguro saúde), `TC` (cartão fiscal), `SSC` (cartão de seguridade social).", "items": { "type": "string", "enum": [ "P", "ID", "DL", "RP", "HIC", "TC", "SSC" ] } }, "id_country": { "type": "string", "nullable": true, "description": "País emissor esperado do documento de identidade (ISO 3166-1 alpha-3), quando restrito no momento da criação.", "example": "ESP" }, "poa_country": { "type": "string", "nullable": true, "description": "País esperado do documento de comprovante de endereço (ISO 3166-1 alpha-3), quando restrito no momento da criação.", "example": "ESP" }, "company_name": { "type": "string", "description": "Razão social esperada da empresa. Somente para sessões de empresa (KYB)." }, "registry_country": { "type": "string", "description": "País do registro esperado no formato `XX` ou `XX-YY` (ISO 3166-1 alpha-2, opcionalmente com uma subdivisão ISO 3166-2 para registros de nível estadual, por exemplo, `US-CA`). Somente para sessões de empresa (KYB)." }, "registration_number": { "type": "string", "description": "Número de registro da empresa esperado. Somente sessões de empresas (KYB)." } }, "nullable": true }, "contact_details": { "type": "object", "description": "Dados de contato informados na criação da sessão (usados para e-mails de notificação, verificação de telefone/e-mail pré-preenchida e idioma de comunicação). `null` quando não foi informado nem e-mail nem número de telefone.", "properties": { "email": { "type": "string", "description": "Endereço de e-mail do usuário (por exemplo, \"john.doe@example.com\") que será usado na etapa de Verificação de e-mail. Se não for informado, o usuário deverá fornecê-lo durante o fluxo de verificação." }, "email_lang": { "type": "string", "description": "Código de idioma (ISO 639-1) para notificações por e-mail. Define o idioma de todas as comunicações por e-mail (por exemplo, \"en\", \"es\", \"fr\")." }, "send_notification_emails": { "type": "boolean", "default": false, "description": "Se true e um e-mail for informado, a Didit envia de forma assíncrona o e-mail inicial \"Verifique sua identidade\" quando a sessão de Verificação de usuários (KYC) ou Verificação de empresas (KYB) é criada. A Didit também envia ao endereço de e-mail informado notificações de status da verificação para sessões que exigem revisão manual." }, "phone": { "type": "string", "nullable": true, "description": "Número de telefone do usuário no formato E.164, se disponível (por exemplo, +14155552671). `null` quando apenas um e-mail foi informado na criação da sessão. Observação: este campo retorna o número de telefone original informado na criação da sessão. Se o número era inválido, ele pode não estar no formato E.164." } }, "nullable": true }, "callback": { "type": "string", "format": "uri", "description": "A URL de retorno da sessão.", "nullable": true }, "id_verifications": { "type": "array", "nullable": true, "description": "**Array de relatórios de verificação de identidade (OCR)** produzidos pelas etapas de documento de identidade no grafo do fluxo. Sempre um array JSON: leia `id_verifications[0]` e itere se o seu fluxo puder executar mais de uma verificação de identidade (por exemplo, uma verificação principal mais uma verificação adicional). Fica `null` até que pelo menos uma etapa de identidade tenha produzido dados. Cada item é o relatório completo, incluindo `node_id`, o `status` no nível do recurso, os campos extraídos do documento, URLs das imagens, pontuações de qualidade, MRZ, análise do endereço, correspondências entre sessões e `warnings[]`.", "items": { "type": "object", "description": "Um relatório de verificação de identidade: o relatório completo de uma única etapa de Verificação de identidade. `verification_method` indica qual dos três métodos o gerou (captura de documento, consulta sem documento ou login com carteira), e o bloco de evidências específico do método é preenchido de acordo.", "properties": { "node_id": { "type": "string", "description": "ID do nó do grafo do fluxo da etapa de OCR que gerou este relatório." }, "verification_method": { "type": "string", "enum": [ "document", "id_lookup", "wallet" ], "description": "Qual método de Verificação de identidade gerou este relatório. `document` - o usuário fotografou um documento de identidade físico (o padrão, e o valor em todas as sessões criadas antes de os outros métodos existirem). `id_lookup` - o usuário digitou o número do documento nacional de identidade, que foi verificado em um registro governamental ou em outra fonte oficial desse país (`id_lookup.source` indica qual). `wallet` - o usuário entrou com uma identidade digital governamental ou bancária." }, "assurance": { "type": "string", "enum": [ "documentary", "data_match", "cryptographic" ], "description": "Nível de garantia derivado de `verification_method`: `documentary` para um documento que foi capturado e verificado, `data_match` para dados que corresponderam a um registro mantido pela fonte consultada, `cryptographic` para atributos que um provedor de identidade autenticou e assinou." }, "wallet_provider": { "type": "string", "nullable": true, "description": "Id de catálogo da carteira quando `verification_method` é `wallet` (`mitid`, `bankid_se`, `itsme`, ...). `null` nos demais casos." }, "fallback_from": { "type": "object", "nullable": true, "description": "Motivo pelo qual um método que não usa documento encerrou a etapa de identidade. Definido no relatório recusado quando uma consulta ou um login com carteira falhou e a opção de fallback do país era `decline`. `null` nos demais casos.", "properties": { "method": { "type": "string", "enum": [ "id_lookup", "wallet" ], "description": "O método que falhou." }, "reason": { "type": "string", "description": "O resultado que o encerrou, por exemplo `no_match`, `provider_error`, `cancelled`, `timeout`." }, "action": { "type": "string", "description": "A ação configurada que foi executada, por exemplo `decline`." } } }, "id_lookup": { "type": "object", "nullable": true, "description": "Evidência do registro. Presente apenas quando `verification_method` é `id_lookup`; caso contrário, `null`.", "properties": { "source": { "type": "string", "description": "Nome, voltado ao cliente, da fonte consultada, por exemplo, `Department of Home Affairs` (um registro governamental) ou `UK credit bureau and financial services records` (não é um registro governamental). Esta é a única declaração de procedência da consulta; não presuma que a fonte seja governamental." }, "checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o registro respondeu." }, "attempts": { "type": "integer", "description": "Número da tentativa (começando em 1) da qual este relatório se originou." }, "max_attempts": { "type": "integer", "description": "Limite de tentativas configurado para o país (de 1 a 5, padrão 1)." }, "outcome": { "type": "string", "enum": [ "match", "partial_match", "no_match", "provider_error", "format_rejected" ], "nullable": true, "description": "O que o registro respondeu. Apenas `match`, `partial_match` e `no_match` contam para o limite de tentativas e são cobrados." }, "comparison": { "type": "array", "description": "Uma linha por campo comparável sobre o qual a fonte respondeu, mais uma linha por erro da fonte. As linhas de comparação usam os nomes de campo normalizados abaixo em vez das chaves de campo da requisição do país, porque vários campos da requisição (nome e sobrenome, ou qualquer um dos aliases de identificador) se reduzem a uma única comparação. Uma fonte que falhou acrescenta uma linha com `field: \"provider\"` e `result: \"error\"`, então leia `result` antes de tratar uma linha como veredito de um campo.", "items": { "type": "object", "required": [ "field", "label", "provided", "record", "result" ], "properties": { "field": { "type": "string", "enum": [ "identification_number", "full_name", "date_of_birth", "address", "provider" ], "description": "Campo de comparação normalizado. `provider` não é um campo do usuário: ele indica uma linha de erro da fonte." }, "label": { "type": "string", "description": "Rótulo de exibição da linha, por exemplo `ID number`, `Full name`, `Provider`." }, "provided": { "type": "string", "nullable": true, "description": "O que o usuário digitou. `null` em uma linha de erro de `provider`." }, "record": { "type": "string", "nullable": true, "description": "O que a fonte continha. Em uma linha de erro de `provider`, traz a mensagem de erro no lugar." }, "result": { "type": "string", "enum": [ "match", "partial", "no_match", "error" ], "description": "Resultado da comparação por campo. `error` aparece apenas em uma linha `provider` e significa que essa fonte não respondeu; trate-o como evidência sobre a consulta, nunca como divergência de campo." } } } }, "registry_portrait": { "type": "string", "format": "uri", "nullable": true, "description": "URL pré-assinada de curta duração para o retrato retornado pela fonte. Somente para os quatro registros governamentais que retornam um (África do Sul, Nigéria, Argentina, Panamá)." }, "face_match_score": { "type": "number", "nullable": true, "description": "Selfie comparada ao retrato do registro, de 0 a 100. Somente quando o registro retorna um retrato." } } }, "wallet_verification": { "type": "object", "nullable": true, "description": "Evidência da credencial. Presente apenas quando `verification_method` é `wallet`; caso contrário, `null`.", "properties": { "provider": { "type": "string", "description": "Id de catálogo da carteira, por exemplo, `mitid`." }, "provider_name": { "type": "string", "nullable": true, "description": "Nome da carteira como o usuário final a conhece, por exemplo `MitID`." }, "issuing_authority": { "type": "string", "nullable": true, "description": "A autoridade por trás da carteira, por exemplo `Danish Agency for Digital Government`." }, "issuing_country": { "type": "string", "description": "País ISO 3166-1 alpha-3 em que a carteira foi oferecida." }, "credential_type": { "type": "string", "nullable": true, "description": "Credencial que a carteira apresentou, por exemplo, `person_identification`." }, "level_of_assurance": { "type": "string", "enum": [ "low", "substantial", "high" ], "nullable": true, "description": "O nível de garantia declarado pela carteira. Um login que declara um nível inferior ao solicitado falha em vez de ser rebaixado." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "O instante de autenticação da carteira." }, "signature_valid": { "type": "boolean", "nullable": true, "description": "Se a asserção assinada retornada pela carteira foi validada." }, "attributes": { "type": "object", "additionalProperties": true, "description": "Os atributos que a carteira compartilhou, com as chaves conforme listadas na entrada do catálogo da carteira." }, "portrait": { "type": "string", "format": "uri", "nullable": true, "description": "URL pré-assinada de curta duração para o retrato compartilhado pela carteira, quando ela compartilha um." }, "face_match_score": { "type": "number", "nullable": true, "description": "Selfie comparada ao retrato da carteira, de 0 a 100, quando a carteira compartilha um." } } }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Expired" ], "description": "Status desta etapa de verificação de identidade no nível do recurso. É independente do `status` de nível superior da sessão: uma sessão pode chegar à decisão geral enquanto um recurso individual permanece `In Review`." }, "document_type": { "type": "string", "description": "Tipo de documento de identidade" }, "document_subtype": { "type": "string", "nullable": true, "description": "Código de subtipo de documento aceito nas configurações de documento do fluxo, incluindo a região do documento quando aplicável. Exemplos: `ID_CARD_GENERIC`, `QUEENSLAND_DRIVER_LICENSE_GENERIC`." }, "document_number": { "type": "string", "description": "Número de identificação do documento" }, "personal_number": { "type": "string", "description": "Número de identificação pessoal" }, "portrait_image": { "type": "string", "format": "uri", "description": "URL da imagem do retrato" }, "front_image": { "type": "string", "format": "uri", "description": "URL da imagem da frente do documento" }, "front_video": { "type": "string", "format": "uri", "description": "URL do vídeo da frente do documento" }, "back_image": { "type": "string", "format": "uri", "description": "URL da imagem do verso do documento" }, "back_video": { "type": "string", "format": "uri", "description": "URL do vídeo do verso do documento" }, "full_front_image": { "type": "string", "format": "uri", "description": "URL da imagem completa da frente do documento" }, "full_back_image": { "type": "string", "format": "uri", "description": "URL da imagem completa do verso do documento" }, "front_image_camera_front": { "type": "string", "format": "uri", "description": "URL da imagem da frente do documento capturada pela câmera frontal" }, "back_image_camera_front": { "type": "string", "format": "uri", "description": "URL da imagem do verso do documento capturada pela câmera frontal" }, "date_of_birth": { "type": "string", "format": "date", "description": "Data de nascimento do documento" }, "age": { "type": "integer", "description": "Idade calculada a partir da data de nascimento" }, "expiration_date": { "type": "string", "format": "date", "description": "Data de validade do documento" }, "date_of_issue": { "type": "string", "format": "date", "description": "Data de emissão do documento" }, "issuing_state": { "type": "string", "description": "Código ISO do estado emissor" }, "issuing_state_name": { "type": "string", "description": "Nome completo do Estado emissor" }, "first_name": { "type": "string", "description": "Primeiro nome do documento" }, "last_name": { "type": "string", "description": "Sobrenome no documento" }, "full_name": { "type": "string", "description": "Nome completo do documento" }, "gender": { "type": "string", "description": "Gênero do documento" }, "address": { "type": "string", "description": "Endereço bruto do documento" }, "formatted_address": { "type": "string", "description": "Endereço completo formatado" }, "place_of_birth": { "type": "string", "description": "Local de nascimento extraído do documento" }, "marital_status": { "type": "string", "description": "Estado civil extraído do documento" }, "nationality": { "type": "string", "description": "Código ISO da nacionalidade" }, "extra_fields": { "type": "object", "description": "Campos adicionais do documento. Inclui atributos específicos do documento (por exemplo, `dl_categories`, `blood_group`, `sponsor`, `employer`, `dl_class_code_b_from`, `dl_class_code_b_to`). As datas de validade das categorias da carteira de motorista são retornadas como `dl_class_code__from` e `dl_class_code__to`, e os códigos de restrição/informação por categoria (por exemplo, a coluna 12 das carteiras de motorista do Reino Unido) como `dl_class_code__notes`. Quando o documento contém nomes, endereço ou local de nascimento em vários sistemas de escrita, este objeto também inclui as versões desses campos no sistema de escrita alternativo. A configuração do fluxo `preferred_characters` (`latin` ou `non_latin`) define qual sistema de escrita preenche os campos de nível superior (`first_name`, `last_name`, `full_name`, `address`, `place_of_birth`); o sistema de escrita oposto fica aqui como `first_name_non_latin` / `last_name_non_latin` / `full_name_non_latin` / `middle_name_non_latin` / `address_non_latin` / `place_of_birth_non_latin` (quando `preferred_characters` é `latin`) ou com o sufixo `_latin` (quando `preferred_characters` é `non_latin`). As chaves só aparecem quando o OCR de fato extrai um valor real no sistema de escrita alternativo: um campo cujo valor alternativo está no mesmo sistema de escrita do conjunto preferido (por exemplo, um campo com rótulo em cirílico cujo valor de OCR veio em homóglifos latinos) é ignorado. Quando `preferred_characters` é `latin`, mas o documento contém apenas texto não latino, a Didit translitera os valores extraídos e expõe `first_name_latin` / `last_name_latin` / etc. como alternativa.", "additionalProperties": true, "properties": { "dl_categories": { "type": "array", "items": { "type": "string" } }, "blood_group": { "type": "string", "nullable": true }, "first_name_non_latin": { "type": "string", "description": "Primeiro nome no alfabeto não latino quando `preferred_characters=latin` e há uma versão não latina no documento (por exemplo, `Айна` em uma identidade do Quirguistão)." }, "last_name_non_latin": { "type": "string", "description": "Sobrenome na escrita não latina quando `preferred_characters=latin` e uma versão não latina está presente no documento." }, "middle_name_non_latin": { "type": "string", "description": "Nome do meio / patronímico na escrita não latina quando `preferred_characters=latin` e uma versão não latina está presente no documento." }, "full_name_non_latin": { "type": "string", "description": "Nome completo composto na escrita não latina. Reconstruído a partir dos componentes individuais quando o nome e o sobrenome estão disponíveis." }, "address_non_latin": { "type": "string", "description": "Endereço em escrita não latina quando `preferred_characters=latin` e há uma versão não latina no documento." }, "place_of_birth_non_latin": { "type": "string", "description": "Local de nascimento na escrita não latina quando `preferred_characters=latin` e uma versão não latina está presente no documento." }, "first_name_latin": { "type": "string", "description": "Primeiro nome em alfabeto latino. Preenchido quando `preferred_characters=non_latin` e há uma versão latina no documento ou, como alternativa por transliteração, quando `preferred_characters=latin` mas o documento só contém texto não latino." }, "last_name_latin": { "type": "string", "description": "Sobrenome em escrita latina. Mesmas regras de `first_name_latin`." }, "middle_name_latin": { "type": "string", "description": "Nome do meio / patronímico em escrita latina. Mesmas regras de `first_name_latin`." }, "full_name_latin": { "type": "string", "description": "Nome completo composto em escrita latina. Sempre reconstruído a partir dos componentes individuais quando o nome e o sobrenome estão disponíveis." }, "address_latin": { "type": "string", "description": "Endereço em escrita latina. Mesmas regras de `first_name_latin`." }, "place_of_birth_latin": { "type": "string", "description": "Local de nascimento em escrita latina. Mesmas regras de `first_name_latin`." } } }, "mrz": { "type": "object", "nullable": true, "description": "Campos da Zona de Leitura Mecânica (MRZ) extraídos e interpretados do documento. `null` se nenhuma MRZ foi detectada.", "properties": { "surname": { "type": "string", "example": "MARTINEZ_families` / `very_high_similarity_plus__families`. Presente apenas quando `match_source` é `recovered_high`." } } } }, "browser_version": { "type": "string", "nullable": true }, "os_version": { "type": "string", "nullable": true }, "user_agent": { "type": "string", "nullable": true, "description": "A string de user agent do navegador." }, "accept_language": { "type": "string", "nullable": true, "description": "O cabeçalho `Accept-Language` enviado pelo navegador." }, "session_identifier": { "type": "string", "nullable": true, "description": "Identificador da sessão de navegação em que a verificação foi executada." }, "session_age_ms": { "type": "integer", "nullable": true, "description": "Duração dessa sessão de navegação, em milissegundos, quando a etapa foi executada." }, "coords_accuracy": { "type": "number", "nullable": true, "description": "Raio de precisão, em metros, das coordenadas informadas pelo dispositivo." }, "raw_device_data": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Sinais brutos do dispositivo coletados para a etapa." } } } }, "geolocation_checks": { "type": "array", "nullable": true, "description": "**Array de resultados de verificação de localização**, um por etapa de verificação de localização: a tentativa aceita dessa etapa. Fica `null` até que uma etapa de verificação de localização tenha produzido dados. As tentativas anteriores da mesma etapa estão em `geolocation_attempts`.", "items": { "$ref": "#/components/schemas/GeolocationCheck" } }, "geolocation_attempts": { "type": "array", "nullable": true, "description": "Todas as tentativas de todas as etapas de verificação de localização desta sessão, da mais antiga para a mais recente. Tentativas substituídas por um reenvio ficam de fora. Um fluxo que oculta `geolocation_checks` por meio dos seus atributos de resposta também oculta esta lista.", "items": { "$ref": "#/components/schemas/GeolocationAttempt" } }, "database_validations": { "type": "array", "nullable": true, "description": "**Array de relatórios de Validação de banco de dados** — sempre um array JSON, nunca um objeto `database_validation` singular. `null` até que pelo menos uma etapa de validação de banco de dados tenha produzido dados. Cada item é o relatório completo, incluindo `node_id`, o `status` no nível do recurso, `screened_data`, as `validations[]` por serviço (cada uma com o `source_data` do respectivo registro) e `warnings[]`. Os campos `screened_data` e `source_data` variam por país:\n\n**ARG (Argentina)**: screened_data: {document_number, selfie, gender, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, date_of_death, tax_id, tax_id_type, face_match_score, sit_1_since, banks, last_position, highest_position, rejected_checks}. Usa a validação biométrica de correspondência facial do RENAPER. O gênero é inferido automaticamente a partir da análise facial ou do primeiro nome quando não consta no documento (por exemplo, carteiras de motorista)\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 inclui {identification_number, first_name, last_name, date_of_birth, lgpd_minor, minor_under_18, minor_under_16} para correspondências de CPF bem-sucedidas. Consultas bem-sucedidas de adultos definem essas flags como false. O serviço Consulta CPF da Receita Federal pode retornar HTTP 422 (menor de 18 anos) ou 451 (menor de 16 anos) com dados retidos pela LGPD; nesses casos, source_data define as flags de menoridade como true conforme o caso, inclui o status HTTP retornado pela fonte e a validação no nível do campo é no_match. Consulte a seção Brasil da referência de códigos de resultado da Validação de banco de dados para ver a lista completa de códigos.\n\n**CHL (Chile)**: screened_data: {personal_number, first_name, last_name, date_of_birth}. source_data: {identification_number, first_name, last_name, date_of_birth, gender}\n\n**COL (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} (retorna apenas válido/inválido)\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 (Espanha)**: screened_data: {personal_number, document_type, expiration_date, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, document_type, expiration_date}\n\n**GTM (Guatemala)**: screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}\n\n**HND (Honduras)**: screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}\n\n**MEX (México)**: screened_data: {personal_number (CURP), first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, gender, nationality, curp_status, state_of_birth, doc_probatorio, registration_year, registration_state, registration_municipality, num_acta, crip, issuing_state_code, foreign_registry_number, folio_carta, folio_certificado}. Usa o registro civil do RENAPO. Um serviço separado de verificação de validade do INE também está disponível para MEX como validação individual adicional.\n\n**PAN (Panamá)**: screened_data: {personal_number, selfie}. source_data: {identification_number}. Usa a validação biométrica do SIB\n\n**PER (Peru)**: 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 (Venezuela)**: screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, gender, date_of_birth, document_type}", "items": { "type": "object", "properties": { "node_id": { "type": "string", "description": "Identificador único desta etapa de validação de banco de dados no grafo do fluxo." }, "issuing_state": { "type": "string", "description": "Código ISO 3166-1 alpha-3 do país cujas fontes governamentais ou de registro foram consultadas (por exemplo, `BRA`, `MEX`, `ESP`, `NGA`, `IDN`). A Validação de banco de dados cobre 60+ países nas Américas, Europa, África, Oriente Médio e Ásia-Pacífico, além de fontes globais multipaís. Como a cobertura é ampliada regularmente, trate o valor como um conjunto aberto, e não como um enum fixo." }, "validation_type": { "type": "string", "enum": [ "one_by_one", "two_by_two", "not_enabled" ], "description": "Como o resultado foi corroborado: `one_by_one` (resultado de um único serviço), `two_by_two` (dois ou mais serviços distintos obtiveram, de forma independente, correspondência total com o número de identificação) ou `not_enabled` (persistido quando nenhum serviço produziu uma correspondência utilizável). O valor nunca é `null`. Modos dedicados de validação biométrica 2x2 estão disponíveis atualmente para `ECU` e `PER`." }, "screened_data": { "type": "object", "description": "Os dados de entrada usados para a validação. Os campos variam por país — consulte a documentação de Validação de banco de dados (`/core-technology/database-validation/overview`) para os formatos específicos de cada país.", "properties": { "last_name": { "type": "string" }, "first_name": { "type": "string" }, "tax_number": { "type": "string", "description": "Brasil: CPF (11 dígitos)" }, "personal_number": { "type": "string", "description": "Chile: RUT, DOM: Cédula (11 dígitos), ECU: Cédula (10 dígitos), ESP: DNI/NIE, MEX: CURP (18 caracteres), PER: DNI (8 dígitos), URY: CI" }, "document_number": { "type": "string", "description": "ARG: DNI, BOL: CI, COL: Cédula, GTM: DPI, HND: DNI, PAN: Cédula, PRY: CI, SLV: DUI, VEN: Cédula" }, "date_of_birth": { "type": "string", "format": "date" }, "document_type": { "type": "string", "description": "COL: CC/CE/TI/NIT, ESP: ID/PASSPORT" }, "expiration_date": { "type": "string", "format": "date", "description": "Obrigatório para ESP" } } }, "validations": { "type": "array", "description": "Uma entrada por serviço de registro que retornou um payload de validação. Cada entrada identifica o serviço (`service_id`, `service_name`) e traz a comparação `validation` por campo, o `outcome_code` / `outcome_detail` do serviço quando informado e o registro normalizado em `source_data`.", "items": { "type": "object", "properties": { "service_id": { "type": "string", "description": "Identificador do serviço de registro que produziu este resultado de validação.", "example": "bra_cpf" }, "service_name": { "type": "string", "description": "Nome legível do serviço de registro.", "example": "Brazil - CPF status check" }, "validation": { "type": "object", "description": "Os resultados das validações de campos.", "properties": { "full_name": { "type": "string", "description": "Resultado da correspondência do nome completo (por exemplo, 'full_match', 'partial_match', 'no_match')." }, "date_of_birth": { "type": "string", "description": "Resultado da correspondência da data de nascimento." }, "identification_number": { "type": "string", "description": "Resultado da correspondência do número de identificação." } } }, "outcome_code": { "type": "string", "nullable": true, "description": "Resultado legível por máquina da consulta ao registro (por exemplo, `MATCH`, `NO_MATCH`, `PARTIAL_MATCH`, `INCONCLUSIVE`, códigos específicos da fonte). Presente quando o serviço informa um." }, "outcome_detail": { "type": "string", "nullable": true, "description": "Explicação legível de `outcome_code`, quando fornecida pelo serviço." }, "source_data": { "type": "object", "description": "Os dados retornados pelo banco de dados governamental. Campos comuns: identification_number, first_name, last_name, full_name, date_of_birth, gender. Campos adicionais por país: BRA sempre inclui lgpd_minor, minor_under_18 e minor_under_16 nas correspondências de CPF bem-sucedidas; também inclui o status HTTP da fonte quando os dados do CPF são retidos com base na LGPD (HTTP 422/451). ECU acrescenta street, formatted_address, nationality, education, marital_status, spouse, mother_name, father_name, profession. PER acrescenta paternal_name, maternal_name, verification_number, verification_letter. ESP acrescenta document_type, expiration_date. VEN/COL acrescentam document_type.", "additionalProperties": true } } } }, "errors": { "type": "array", "description": "Erros retornados pelos serviços de registro durante a validação, cada um marcado com o `service_id` que o gerou. **Esta chave é totalmente omitida quando não há erros.**", "items": { "type": "object", "description": "O objeto de erro do serviço upstream repassado sem alterações (suas chaves variam conforme o serviço; normalmente uma mensagem/código e quaisquer detalhes específicos do provedor), mais `service_id`, que identifica o serviço que gerou o erro.", "properties": { "service_id": { "type": "string", "nullable": true, "description": "Identificador do serviço de registro que apresentou erro." } }, "additionalProperties": true } }, "match_type": { "type": "string", "enum": [ "no_match", "partial_match", "full_match" ], "nullable": true, "description": "O resultado agregado da correspondência entre os serviços consultados. `null` até que a validação seja avaliada." }, "status": { "type": "string", "description": "Status desta validação de banco de dados no nível do recurso. É independente do `status` de nível superior da sessão: uma sessão pode chegar à decisão geral enquanto um recurso individual permanece `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": "O recurso que gerou este aviso. O valor identifica o bloco de recurso ao qual o aviso pertence. O array de avisos de cada módulo normalmente usa o valor correspondente ao seu módulo (por exemplo, `PHONE` dentro de `phone_verifications[].warnings`), mas o enum acima é a referência oficial para todos os avisos de recursos no payload de decisão." }, "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": "O ID do nó do grafo do fluxo que gerou este aviso" } } }, "description": "Avisos relacionados à validação de banco de dados." } } } }, "database_validation_not_performed_reason": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Motivo pelo qual uma validação de banco de dados configurada não produziu resultado, no formato `{code, message}` mais campos de contexto. Presente apenas quando `database_validations` é `null` em um fluxo que tem a etapa, para que você possa distinguir \"o registro confirmou\" de \"nada foi executado\". `null` nos demais casos.", "properties": { "code": { "type": "string", "description": "Motivo estável e legível por máquina." }, "message": { "type": "string", "description": "Explicação legível." } } }, "reviews": { "type": "array", "items": { "type": "object", "properties": { "user": { "type": "string", "description": "Quem realizou a revisão. Geralmente é o identificador do revisor no console (o e-mail dele), mas o valor é `\"API Client\"` para atualizações de status feitas com uma chave de API e `\"Unknown\"` quando não foi possível identificar o autor. Por isso, não interprete este campo como um endereço de e-mail." }, "new_status": { "type": "string" }, "comment": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } } }, "assignee": { "type": "object", "nullable": true, "description": "O revisor do Console a quem a sessão está atribuída, ou `null` quando ninguém a detém.", "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": "Quando a sessão começou a aguardar revisão. `null`, a menos que a sessão esteja `In Review` e sua aplicação defina um prazo de revisão." }, "sla_due_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a revisão vence. `null`, a menos que a sessão esteja `In Review` e sua aplicação defina um prazo de revisão." }, "created_at": { "type": "string", "format": "date-time", "description": "Data e hora em que a sessão foi criada (ISO 8601, UTC)." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data e hora em que está prevista a expiração desta sessão. Definido em sessões de Verificação de usuários (KYC) quando uma expiração foi configurada no momento da criação (ou quando o status `Approved` aciona o cálculo de expiração do KYC). `null` para sessões sem expiração configurada e para tipos que não usam expiração (por exemplo, sessões de Verificação de empresas (KYB) que nunca receberam um `expires_at`)." }, "registry_checks": { "type": "array", "nullable": true, "description": "Verificações no registro de empresas. Presente apenas quando `session_kind = business`. Cada item contém o payload completo do registro de empresas.", "items": { "type": "object", "description": "Uma verificação no registro de empresas: o payload completo do registro de empresas, enriquecido com a estrutura de propriedade e avisos. Presente apenas quando `session_kind = business`.", "properties": { "status": { "type": "string", "description": "Status do ciclo de vida do recurso." }, "node_id": { "type": "string", "nullable": true }, "data_resolved": { "type": "boolean" }, "company": { "type": "object", "description": "Payload completo do registro da empresa (registro oficial mesclado com quaisquer dados fornecidos pelo usuário ou editados no console).", "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 constituição (ISO 3166-1 alpha-2, por exemplo, `GB`, `DE`, `US`)." }, "region": { "type": "string", "nullable": true, "description": "Código de subdivisão ISO 3166-2, quando aplicável (por exemplo, `CA`, `NY` para estados dos 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": "Nomes alternativos, comerciais, anteriores ou no idioma original da empresa, em texto, quando informados." }, "nature_of_business": { "type": "string", "nullable": true }, "registered_capital": { "type": "string", "nullable": true }, "registered_capital_amount": { "type": "string", "format": "decimal", "nullable": true, "description": "Valor do capital social/registrado como string decimal (por exemplo, `\"100.00\"`), extraído do registro arquivado no órgão de registro. `null` quando não disponível." }, "registered_capital_currency": { "type": "string", "nullable": true, "description": "Código de moeda ISO 4217 de `registered_capital_amount` (por exemplo, `\"GBP\"`). `null` quando não disponível." }, "website": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true }, "phone": { "type": "string", "nullable": true }, "legal_entity_identifier": { "type": "string", "nullable": true }, "location_of_registration": { "type": "string", "nullable": true }, "vat_number": { "type": "string", "nullable": true, "description": "Número de IVA da UE (EU VAT), quando coletado durante a etapa de registro no fluxo hospedado ou editado posteriormente." }, "vat_validation_status": { "type": "string", "enum": [ "valid", "invalid", "format_valid", "invalid_format", "could_not_validate", "not_applicable" ], "description": "Resultado da validação do número de VAT ou, quando não houver, do `tax_number`, no envio ao registro. `valid` / `invalid`: decidido pelo registro oficial do país (EU VIES, Noruega, Suíça, Brasil, Colômbia, Costa Rica, Equador, Paraguai; a Polônia também pelo seu registro nacional de VAT). `format_valid` / `invalid_format`: decidido pelas regras de formato e dígito verificador do país quando nenhum registro pode ser consultado. `could_not_validate`: o registro estava indisponível. `not_applicable`: nenhum número, um país sem registro nem regras, ou uma sessão de sandbox." }, "vat_validated_number": { "type": "string", "nullable": true, "description": "O número que foi verificado, como a fonte o conhece (por exemplo, o número de IVA derivado de um SIREN francês ou de um RSIN holandês). `null` quando nenhuma verificação foi executada." }, "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": "A fonte que determinou `vat_validation_status`: um registro oficial ou `format_rules`. `null` quando nenhuma verificação foi executada." }, "vat_validated_name": { "type": "string", "nullable": true, "description": "Nome registrado na fonte que validou o número, quando ela o informa. Preenchido apenas quando o status é `valid`." }, "vat_validated_address": { "type": "string", "nullable": true, "description": "Endereço registrado na fonte que validou o número, quando ela o informa. Definido apenas quando o status é `valid`." }, "vat_checked_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data e hora da verificação. `null` quando nenhuma verificação foi executada." }, "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": "Nome próprio, quando informado explicitamente pelo registro; não é inferido a partir do nome completo." }, "last_name": { "type": "string", "nullable": true, "description": "Sobrenome, quando informado explicitamente pelo registro." }, "address": { "type": "string", "nullable": true, "description": "Endereço do administrador informado pelo registro de empresas." }, "appointment_date": { "type": "string", "nullable": true, "description": "Data em que o administrador foi nomeado.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Data em que o cargo terminou, quando informada.", "format": "date" }, "date_of_birth": { "type": "string", "nullable": true, "description": "Data de nascimento completa informada pelo registro. Nula quando apenas o ano ou o mês de nascimento é conhecido.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Ano de nascimento informado pelo registro, inclusive quando a data completa não está disponível." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Mês de nascimento informado pelo registro. Nulo quando apenas o ano é conhecido." } } } }, "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": "Limite inferior do percentual de propriedade conforme informado pelo registro. String em formato livre (por exemplo, `\"25.00\"`, `\"50\"`); use `effective_ownership_percent` para obter um valor numérico interpretado." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Limite superior do percentual de propriedade conforme informado pelo registro. String de formato livre; use `effective_ownership_percent` para obter um valor numérico interpretado." }, "is_active": { "type": "boolean" }, "kyc_status": { "type": "string", "enum": [ "Approved", "Declined", "Pending" ], "nullable": true }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true }, "effective_ownership_percent": { "type": "number", "nullable": true }, "company_name": { "type": "string", "nullable": true }, "registration_number": { "type": "string", "nullable": true }, "country_of_birth": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "designation": { "type": "string", "nullable": true }, "voting_min_shares": { "type": "string", "nullable": true }, "voting_max_shares": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "nullable": true, "description": "Data de nascimento completa, quando informada.", "format": "date" }, "appointment_date": { "type": "string", "nullable": true, "description": "Data de nomeação, quando informada.", "format": "date" }, "shareholding": { "$ref": "#/components/schemas/KYBRegistryShareholding" } } } }, "addresses": { "type": "array", "nullable": true, "description": "Todos os endereços que o registro informa, em um único formato canônico. Nulo quando não informa nenhum.", "items": { "$ref": "#/components/schemas/KYBRegistryAddress" } }, "industries": { "type": "array", "nullable": true, "description": "As atividades em que o registro classifica a empresa, em um único formato canônico. Null quando ele não informa nenhuma.", "items": { "$ref": "#/components/schemas/KYBRegistryIndustry" } }, "accounts": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Datas de arquivamento no registro, quando disponíveis. Declarações anuais e assembleias gerais usam last_annual_return_date e last_agm_date; elas são distintas das demonstrações financeiras." }, "registry_data": { "$ref": "#/components/schemas/KYBRegistryData" }, "user_provided_data": { "type": "object", "description": "Dados confirmados ou editados pelo usuário 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": "O nível de registro solicitado pelo fluxo: `basic`, `shareholders` ou `ubo`. Também em `ownership.tier_requested`." }, "registry_tier_delivered": { "type": "string", "nullable": true, "description": "O nível que o registro entregou e que é faturado. Também disponível em `ownership.tier_delivered`." }, "registry_ownership_status": { "type": "string", "nullable": true, "description": "`not_requested`, `pending`, `delivered`, `not_held` ou `unavailable`. Também em `ownership.status`." }, "registry_monitoring": { "type": "object", "nullable": true, "description": "O monitor de registro mais recente da empresa, ou `null` quando não existe nenhum.", "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": "Os campos da empresa que o monitor acompanha." } } } } }, "ownership_structure": { "$ref": "#/components/schemas/KYBOwnershipStructure" }, "warnings": { "type": "array", "items": { "type": "object" } } } } }, "key_people_checks": { "type": "array", "nullable": true, "description": "Verificações agregadas das pessoas-chave. Presente apenas quando `session_kind = business`. Cada item usa o formato de dois grupos (`registry`, `submitted`, `ubo_kyc_summary`).", "items": { "type": "object", "description": "Verificação agregada dos administradores + UBOs da empresa. Usa o formato `registry` / `submitted`. Presente apenas quando session_kind = business.", "properties": { "status": { "type": "string" }, "node_id": { "type": "string", "nullable": true }, "registry": { "type": "object", "description": "Partes descobertas pela verificação no registro.", "properties": { "officers": { "type": "array", "description": "Administradores encontrados pela consulta ao registro de empresas, cada um enriquecido com o status de qualquer sessão de KYC filha e análise AML criadas para ele.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Nome completo do administrador conforme consta no registro de empresas." }, "designation": { "type": "string", "nullable": true, "description": "Designação em texto livre do registro (por exemplo, `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": "Função normalizada do administrador." }, "nationality": { "type": "string", "nullable": true }, "appointment_date": { "type": "string", "nullable": true, "description": "Data em que o administrador foi nomeado.", "format": "date" }, "termination_date": { "type": "string", "nullable": true, "description": "Data em que o cargo terminou, quando informada.", "format": "date" }, "is_active": { "type": "boolean" }, "address": { "type": "string", "nullable": true, "description": "Endereço do administrador informado pelo registro de empresas." }, "aml_status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "nullable": true, "description": "Status da análise AML executada para este administrador. `null` quando nenhuma análise AML foi executada." }, "kyc_status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "nullable": true, "description": "Status bruto do ciclo de vida da sessão KYC filha criada para este administrador. Este é o enum completo de status da sessão (não um conjunto reduzido Approved/Declined/Pending). `null` quando não existe sessão KYC filha." }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL compartilhável da sessão de KYC filha. `null` quando não existe sessão filha." }, "kyc_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID da sessão KYC filha. Passe-o para este mesmo endpoint de decisão para obter o relatório KYC completo da pessoa. `null` quando não existe sessão filha." }, "verification_workflow_type": { "type": "string", "nullable": true, "description": "Tipo base do fluxo da sessão filha (por exemplo, `kyc`). `null` para fluxos baseados em grafo ou quando não existe sessão filha." }, "verification_workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID do fluxo usado pela sessão filha. `null` quando não existe sessão filha." }, "verification_workflow_label": { "type": "string", "nullable": true, "description": "Rótulo legível do fluxo da sessão filha. `null` quando não definido." }, "verification_workflow_features": { "type": "array", "nullable": true, "description": "Progresso por recurso da sessão de verificação filha, por exemplo `[{\"feature\": \"ID_VERIFICATION\", \"status\": \"Approved\"}]`. `null` quando a sessão filha não tem uma lista de recursos que possa ser resolvida.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Nome de exibição do recurso (por exemplo, `ID_VERIFICATION`, `LIVENESS`, `AML`)." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Status do recurso dentro da sessão filha." } } } }, "didit_internal_id": { "type": "string", "nullable": true, "description": "Identificador interno estável da pessoa verificada por trás da sessão filha, útil para vincular sessões entre si. `null` quando não existe sessão filha ou o usuário ainda não foi identificado." }, "kyc_document_type": { "type": "string", "nullable": true, "description": "Tipo de documento apresentado na sessão de KYC filha (por exemplo, `P`, `ID`, `DL`). `null` até que a sessão filha tenha um resultado de verificação de identidade." }, "kyc_nationality": { "type": "string", "nullable": true, "description": "Nacionalidade extraída do documento na sessão de KYC filha. `null` até estar disponível." }, "kyc_liveness_passed": { "type": "boolean", "nullable": true, "description": "Se a verificação de prova de vida da sessão KYC filha foi aprovada. `null` quando nenhuma verificação de prova de vida foi executada." }, "kyc_verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a sessão de KYC filha atingiu `Approved`. `null` enquanto a sessão filha tiver qualquer outro status." }, "kyc_aml_categories": { "type": "object", "nullable": true, "description": "Resumo por categoria derivado dos resultados AML da pessoa. `null` quando não há resultados.", "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": "Timestamp ISO 8601 da última notificação de convite de verificação enviada para a sessão filha desta pessoa. `null` quando nenhuma foi enviada." }, "first_name": { "type": "string", "nullable": true, "description": "Nome próprio, quando informado explicitamente pelo registro; não é inferido a partir do nome completo." }, "last_name": { "type": "string", "nullable": true, "description": "Sobrenome, quando informado explicitamente pelo registro." }, "date_of_birth": { "type": "string", "nullable": true, "description": "Data de nascimento completa informada pelo registro. Nula quando apenas o ano ou o mês de nascimento é conhecido.", "format": "date" }, "date_of_birth_year": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 9999, "description": "Ano de nascimento informado pelo registro, inclusive quando a data completa não está disponível." }, "date_of_birth_month": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 12, "description": "Mês de nascimento informado pelo registro. Nulo quando apenas o ano é conhecido." } } } }, "beneficial_owners": { "type": "array", "description": "Beneficiários finais identificados pela verificação no registro, cada um enriquecido com o status de qualquer sessão de KYC filha e análise AML gerada para ele.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Nome completo do beneficiário final (ou nome da empresa, no caso de UBOs corporativos)." }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "nullable": true, "description": "Data de nascimento completa, quando informada.", "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": "Nomes das funções exercidas por este proprietário, por exemplo `[\"ubo\", \"shareholder\"]`.", "items": { "type": "string" } }, "ownership_min_shares": { "type": "string", "nullable": true, "description": "Limite inferior do percentual de propriedade conforme informado pelo registro. String em formato livre (por exemplo, `\"25\"`, `\"25-50%\"`); use `effective_ownership_percent` para obter um valor numérico interpretado." }, "ownership_max_shares": { "type": "string", "nullable": true, "description": "Limite superior do percentual de propriedade conforme informado pelo registro. String de formato livre; use `effective_ownership_percent` para obter um valor numérico interpretado." }, "is_active": { "type": "boolean" }, "aml_status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "nullable": true, "description": "Status da análise AML executada para este beneficiário final. `null` quando nenhuma análise AML foi executada." }, "kyc_status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "nullable": true, "description": "Status bruto do ciclo de vida da sessão KYC filha criada para este beneficiário final. Este é o enum completo de status da sessão (não um conjunto reduzido Approved/Declined/Pending). `null` quando não existe sessão KYC filha." }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL compartilhável da sessão de KYC filha. `null` quando não existe sessão filha." }, "kyc_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID da sessão KYC filha. Passe-o para este mesmo endpoint de decisão para obter o relatório KYC completo da pessoa. `null` quando não existe sessão filha." }, "verification_workflow_type": { "type": "string", "nullable": true, "description": "Tipo base do fluxo da sessão filha (por exemplo, `kyc`). `null` para fluxos baseados em grafo ou quando não existe sessão filha." }, "verification_workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID do fluxo usado pela sessão filha. `null` quando não existe sessão filha." }, "verification_workflow_label": { "type": "string", "nullable": true, "description": "Rótulo legível do fluxo da sessão filha. `null` quando não definido." }, "verification_workflow_features": { "type": "array", "nullable": true, "description": "Progresso por recurso da sessão de verificação filha, por exemplo `[{\"feature\": \"ID_VERIFICATION\", \"status\": \"Approved\"}]`. `null` quando a sessão filha não tem uma lista de recursos que possa ser resolvida.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Nome de exibição do recurso (por exemplo, `ID_VERIFICATION`, `LIVENESS`, `AML`)." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Status do recurso dentro da sessão filha." } } } }, "didit_internal_id": { "type": "string", "nullable": true, "description": "Identificador interno estável da pessoa verificada por trás da sessão filha, útil para vincular sessões entre si. `null` quando não existe sessão filha ou o usuário ainda não foi identificado." }, "kyc_document_type": { "type": "string", "nullable": true, "description": "Tipo de documento apresentado na sessão de KYC filha (por exemplo, `P`, `ID`, `DL`). `null` até que a sessão filha tenha um resultado de verificação de identidade." }, "kyc_nationality": { "type": "string", "nullable": true, "description": "Nacionalidade extraída do documento na sessão de KYC filha. `null` até estar disponível." }, "kyc_liveness_passed": { "type": "boolean", "nullable": true, "description": "Se a verificação de prova de vida da sessão KYC filha foi aprovada. `null` quando nenhuma verificação de prova de vida foi executada." }, "kyc_verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a sessão de KYC filha atingiu `Approved`. `null` enquanto a sessão filha tiver qualquer outro status." }, "kyc_aml_categories": { "type": "object", "nullable": true, "description": "Resumo por categoria derivado dos resultados AML da pessoa. `null` quando não há resultados.", "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": "Timestamp ISO 8601 da última notificação de convite de verificação enviada para a sessão filha desta pessoa. `null` quando nenhuma foi enviada." }, "child_beneficial_owners": { "type": "array", "description": "Para UBOs corporativos: os beneficiários finais da própria entidade proprietária, como objetos brutos extraídos do registro. Array vazio quando não se aplica.", "items": { "type": "object" } }, "effective_ownership_percent": { "type": "number", "nullable": true, "description": "Percentual de propriedade numérico interpretado: o limite máximo quando disponível; caso contrário, o limite mínimo. `null` quando nenhum dos limites pôde ser interpretado." }, "voting_min_shares": { "type": "string", "nullable": true }, "voting_max_shares": { "type": "string", "nullable": true }, "appointment_date": { "type": "string", "nullable": true, "description": "Data de nomeação, quando informada.", "format": "date" } } } } } }, "submitted": { "type": "object", "description": "Partes enviadas pelo administrador da empresa durante o fluxo de pessoas-chave (linhas BusinessParty com source=USER).", "properties": { "parties": { "type": "array", "items": { "type": "object", "description": "Parte enviada pelo administrador da empresa pelo fluxo de pessoas-chave (source=USER).", "properties": { "uuid": { "type": "string", "format": "uuid" }, "entity_type": { "type": "string", "enum": [ "person", "company" ] }, "source": { "type": "string", "enum": [ "USER" ], "description": "Sempre `USER` aqui: este grupo contém apenas partes inseridas ou confirmadas pelo usuário final no fluxo de pessoas-chave (as pessoas descobertas no registro aparecem em `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": "Nacionalidade para pessoas; país de constituição para partes que são empresas." }, "phone_number": { "type": "string", "nullable": true }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "position": { "type": "string", "nullable": true, "description": "Cargo/posição em texto livre (somente pessoas)." }, "custom_fields": { "type": "object", "description": "Campos personalizados definidos pelo fluxo e coletados para esta parte; as chaves são definidas pelos descritores de campos de pessoas-chave do fluxo." }, "is_active": { "type": "boolean" }, "is_skipped": { "type": "boolean", "description": "True quando o usuário final pulou a verificação desta parte (possível somente quando a função permite pular)." }, "requires_verification": { "type": "boolean", "description": "True quando uma subsessão de KYC / KYB filha é exigida para esta parte, com base nas configurações da função e nos limiares de propriedade." }, "roles": { "type": "array", "description": "Todas as funções exercidas por esta parte, cada uma com seus próprios percentuais de propriedade e de direito de voto. Não existe `role`/`ownership_percent` escalar na própria parte.", "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 da sessão KYC filha para partes que são pessoas e exigem verificação. `null` caso contrário." }, "kyc_session_status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "nullable": true, "description": "Status do ciclo de vida da sessão de KYC filha. `null` quando não existe sessão de KYC filha." }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true }, "kyb_sub_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID da subsessão KYB filha para partes corporativas que exigem verificação. `null` caso contrário." }, "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": "Status do ciclo de vida da subsessão de KYB filha. `null` quando não existe subsessão." }, "kyb_sub_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL compartilhável da subsessão de KYB filha. `null` quando não existe subsessão." }, "verification_workflow_type": { "type": "string", "nullable": true, "description": "Tipo base do fluxo da sessão filha (de preferência a sessão de KYC, recorrendo à subsessão de KYB). `null` para fluxos baseados em grafo ou quando não existe sessão filha." }, "verification_workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "ID do fluxo usado pela sessão filha. `null` quando não existe sessão filha." }, "verification_workflow_label": { "type": "string", "nullable": true, "description": "Rótulo legível do fluxo da sessão filha. `null` quando não definido." }, "verification_workflow_features": { "type": "array", "nullable": true, "description": "Progresso por recurso da sessão de verificação filha, por exemplo `[{\"feature\": \"ID_VERIFICATION\", \"status\": \"Approved\"}]`. `null` quando a sessão filha não tem uma lista de recursos que possa ser resolvida.", "items": { "type": "object", "properties": { "feature": { "type": "string", "description": "Nome de exibição do recurso (por exemplo, `ID_VERIFICATION`, `LIVENESS`, `AML`)." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Status do recurso dentro da sessão filha." } } } }, "didit_internal_id": { "type": "string", "nullable": true, "description": "Identificador interno estável da pessoa verificada por trás da sessão filha. `null` quando ainda não foi identificado." } } } } } }, "ubo_kyc_summary": { "type": "object", "nullable": true, "description": "Progresso agregado do KYC dos UBOs, ou null quando nenhum UBO tem sessões de KYC vinculadas.", "properties": { "total": { "type": "integer" }, "approved": { "type": "integer" }, "flagged": { "type": "integer", "description": "UBOs cujo KYC está Recusado ou Em revisão." }, "pending": { "type": "integer" } } }, "warnings": { "type": "array", "items": { "type": "object" } } } } }, "document_verifications": { "type": "array", "nullable": true, "description": "Verificações de documentos agrupadas por nó do fluxo. Presente apenas quando `session_kind = business`.", "items": { "type": "object", "description": "Documentos agrupados por nó do fluxo. Presente apenas quando session_kind = business.", "properties": { "status": { "type": "string" }, "node_id": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "document_type": { "type": "string", "enum": [ "LEGAL_PRESENCE", "COMPANY_DETAILS", "OWNERSHIP_STRUCTURE", "REPRESENTATIVES_AUTHORIZATION", "OTHER" ], "nullable": true, "description": "Grupo geral de documentos KYB em que o arquivo foi classificado. `null` enquanto não classificado." }, "document_subtype": { "type": "string", "nullable": true, "description": "Subtipo específico detectado pelo OCR (por exemplo, `CERTIFICATE_OF_INCORPORATION`, `SHAREHOLDER_REGISTRY`); `UNKNOWN` quando o OCR não conseguiu classificar o documento com confiança." }, "document_group": { "type": "string", "enum": [ "LEGAL_PRESENCE", "COMPANY_DETAILS", "OWNERSHIP_STRUCTURE", "REPRESENTATIVES_AUTHORIZATION", "OTHER" ], "nullable": true, "description": "Alias de `document_type`: o nome do grupo usado por `groups` e `required_groups`." }, "file_url": { "type": "string", "format": "uri", "nullable": true, "description": "Link pré-assinado de curta duração para o arquivo enviado. `null` para marcadores de solicitação de documento criados por analistas (`is_requested = true`) que ainda não foram atendidos." }, "original_filename": { "type": "string", "nullable": true, "description": "Nome do arquivo conforme enviado pelo usuário ou analista." }, "file_size": { "type": "integer", "nullable": true, "description": "Tamanho do arquivo em bytes." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Status de verificação por documento." }, "created_at": { "type": "string", "format": "date-time" }, "cross_check_result": { "type": "object", "nullable": true, "description": "Comparação cruzada dos campos do documento extraídos por OCR com o perfil da empresa no registro de empresas. Um objeto com as seções `critical`, `non_critical` e `people`, cada uma mapeando um nome de campo (por exemplo, `company_name`, `registration_number`, `incorporation_date`, `registered_address`) para um registro de comparação como `{\"document\": \"...\", \"registry\": \"...\", \"match\": true, \"score\": 0.97}`. `null` quando o documento não tinha dados de OCR ou não havia empresa no registro para comparar." }, "document_metadata": { "type": "object", "nullable": true, "description": "Metadados extraídos do documento corporativo enviado. Quando a extração de metadados é bem-sucedida, as 16 chaves estão sempre presentes (valores individuais são `null` quando não se aplicam ao tipo de arquivo); o objeto inteiro é `null` quando nada pôde ser extraído. Para PDFs, `overlay_manipulation` contém a análise forense de texto sobreposto.", "properties": { "file_size": { "type": "integer", "nullable": true, "description": "Tamanho do documento." }, "content_type": { "type": "string", "nullable": true, "description": "Tipo de conteúdo do documento." }, "creation_date": { "type": "string", "nullable": true, "description": "Data em que o documento foi criado." }, "modified_date": { "type": "string", "nullable": true, "description": "Data em que o documento foi modificado." }, "creator": { "type": "string", "nullable": true, "description": "Ferramenta/usuário de criação registrado nos metadados do arquivo (`Creator` do PDF)." }, "producer": { "type": "string", "nullable": true, "description": "Software que gerou o arquivo (`Producer` do PDF)." }, "software": { "type": "string", "nullable": true, "description": "Software de edição registrado nos metadados do arquivo." }, "encryption": { "type": "string", "nullable": true, "description": "Esquema de criptografia do arquivo, quando criptografado." }, "is_signed": { "type": "boolean", "nullable": true, "description": "Se o documento tem uma assinatura digital." }, "is_tampered": { "type": "boolean", "nullable": true, "description": "Se a assinatura digital falhou na validação (modificação após a assinatura)." }, "signature_info": { "type": "object", "nullable": true, "description": "Detalhes da(s) assinatura(s) digital(is), quando presentes." }, "exif_original_date": { "type": "string", "nullable": true, "description": "Data de captura original EXIF, para uploads de imagem." }, "exif_digitized_date": { "type": "string", "nullable": true, "description": "Data de digitalização EXIF, para uploads de imagem." }, "processed_by_known_editor": { "type": "boolean", "nullable": true, "description": "Indica se os metadados mostram que o arquivo passou por um editor de imagem/PDF conhecido." }, "has_different_creation_mod_date": { "type": "boolean", "nullable": true, "description": "Indica se as datas de criação e modificação diferem — um possível (mas não conclusivo) sinal de edição." }, "overlay_manipulation": { "type": "object", "nullable": true, "description": "Análise forense de PDF para suspeita de manipulação por texto sobreposto. Null quando nenhuma evidência de manipulação por sobreposição foi encontrada ou o documento não era um PDF.", "properties": { "detected": { "type": "boolean", "description": "Indica se foram detectadas evidências de manipulação por sobreposição de texto." }, "analyzed": { "type": "boolean", "description": "Se foi possível analisar o PDF." }, "signals": { "type": "array", "items": { "type": "string" }, "description": "Sinais forenses acionados, como duplicate_font_subset ou glyph_fragmentation." }, "manipulated_regions": { "type": "array", "description": "Áreas com suspeita de manipulação, em coordenadas de página do 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": "Rótulo ou motivo informado pelo analista para uma solicitação de documento. `null` para envios comuns." }, "is_requested": { "type": "boolean", "description": "True para marcadores de solicitação de documento criados por analistas que aguardam um upload." }, "ocr_data": { "type": "object", "nullable": true }, "is_console_upload": { "type": "boolean", "description": "True para documentos enviados pelo console, e não pelo fluxo do usuário final. Uploads feitos pelo console nunca alteram o status agregado do recurso." }, "is_confirmed": { "type": "boolean", "description": "Uploads feitos pelo console começam como `false` e passam para `true` quando o administrador os confirma; uploads do usuário final são sempre `true`." } } } }, "groups": { "type": "object", "description": "Contadores de progresso por grupo, indexados pelo nome do grupo (por exemplo, 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": "Placeholders solicitados que ainda não têm arquivo enviado." } } } }, "required_groups": { "type": "array", "items": { "type": "string" } }, "warnings": { "type": "array", "items": { "type": "object" } } } } }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "Se a sessão foi criada por uma aplicação de produção (`live`) ou por uma aplicação de sandbox (`sandbox`). Sessões de sandbox são gratuitas, totalmente simuladas e nunca consomem créditos." }, "sandbox_scenario": { "type": "string", "nullable": true, "description": "O cenário de sandbox com o qual a sessão foi criada. `null` para sessões de produção e para sessões de sandbox criadas sem cenário." }, "resubmissions": { "type": "array", "description": "Retornado apenas com `include=resubmissions`, para sessões de usuários e de empresas. Uma entrada por requisição de reenvio, da mais antiga para a mais recente. Cada entrada traz os resultados que as etapas reenviadas retornaram antes da requisição, para que os envios anteriores continuem legíveis. Excluir a sessão exclui todos os envios.", "items": { "type": "object", "properties": { "number": { "type": "integer", "description": "1 para o primeiro reenvio da sessão, 2 para o segundo, e assim por diante." }, "created_at": { "type": "string", "format": "date-time", "description": "Quando o reenvio foi solicitado." }, "previous_status": { "type": "string", "description": "O status da sessão imediatamente antes da requisição." }, "nodes": { "type": "array", "description": "As etapas do fluxo devolvidas ao usuário.", "items": { "type": "object", "properties": { "node_id": { "type": "string" }, "feature": { "type": "string" } } } }, "reasons": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" }, "description": "O motivo informado para cada etapa, indexado por `node_id`." }, "requested_by": { "type": "object", "nullable": true, "description": "Quem solicitou o reenvio.", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "type": { "type": "string" } } }, "results": { "type": "object", "additionalProperties": true, "description": "O que as etapas reenviadas retornaram antes da requisição, com as mesmas chaves e no mesmo formato dos resultados atuais desta 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`; para sessões de empresa, também `document_verifications`). Só aparecem as chaves das etapas que foram devolvidas." } } } }, "biometric_consent": { "type": "object", "nullable": true, "description": "Se a sessão exigiu consentimento biométrico explícito antes de uma captura facial, o motivo e a evidência da resposta. Somente para sessões de Verificação de usuários (KYC); o mesmo objeto está na `decision` dos webhooks de sessão. `null` quando a sessão nunca foi avaliada, por exemplo, um fluxo de verificação (workflow) sem captura facial. Campos sem valor registrado são `null`. Um SDK nativo anterior à versão 4.10.0, ou um que não informa sua versão, não consegue exibir a etapa de consentimento: suas capturas faciais funcionam como antes, e uma sessão que exigiu consentimento passa a informar `status: \"pending\"` com `reason: \"BIOMETRIC_CONSENT_UNSUPPORTED_SDK\"`. Consulte [Consentimento biométrico](/pt-br/getting-started/biometric-consent).", "properties": { "required": { "type": "boolean", "description": "Whether the session must collect explicit biometric consent. Never goes back to `false`." }, "trigger": { "type": "string", "nullable": true, "enum": [ "declared_state", "ip_state", "ip_unknown", "document_issuer", "forced", "customer_collected" ], "description": "Por que o consentimento é obrigatório, ou como ele foi atendido. `declared_state`: você declarou um estado abrangido (`user_state`, ou um endereço nos EUA em `expected_details`). `ip_state`: o IP da pessoa está em um estado abrangido (Illinois, Texas, Colorado). `ip_unknown`: as evidências situam a pessoa nos EUA, mas não é possível determinar o estado (o IP está nos EUA sem estado, ou não pode ser localizado enquanto seus dados ou o documento situam a pessoa nos EUA). `document_issuer`: o documento de identidade foi emitido por um estado abrangido. `forced`: o modo da aplicação é Always. `customer_collected`: você enviou `biometric_consent` ao criar a sessão. `null` enquanto não for obrigatório." }, "status": { "type": "string", "enum": [ "not_required", "pending", "given", "declined" ], "description": "`not_required`; `pending` (obrigatório e não fornecido: a pessoa ainda não respondeu, ou `reason` informa por que não foi coletado); `given`; `declined` (uma recusa foi registrada e a sessão terminou como `Declined`; hoje nenhuma tela da Didit oferece a opção de recusar)." }, "given_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o consentimento foi dado. Para `customer_collected`, o `given_at` que você enviou." }, "declined_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando uma recusa foi registrada." }, "text_version": { "type": "string", "nullable": true, "description": "Id da versão do texto de consentimento que a pessoa respondeu, ou daquela que você enviou." }, "text_hash": { "type": "string", "nullable": true, "description": "SHA-256 (hex) do texto exato de consentimento exibido, no idioma em que foi exibido." }, "locale": { "type": "string", "nullable": true, "description": "Idioma em que o texto de consentimento foi exibido." }, "policy_url": { "type": "string", "format": "uri", "nullable": true, "description": "A política de dados biométricos à qual a etapa de consentimento vinculou." }, "step": { "type": "string", "nullable": true, "description": "Etapa do fluxo em que a sessão estava quando a pessoa respondeu, por exemplo `LIVENESS`." }, "node_id": { "type": "string", "nullable": true, "description": "Nó do grafo do fluxo em que a sessão estava quando a pessoa respondeu." }, "ip_address": { "type": "string", "nullable": true, "description": "IP de origem da resposta." }, "ip_country_code": { "type": "string", "nullable": true, "description": "País do IP da resposta em ISO 3166-1 alpha-2." }, "ip_state": { "type": "string", "nullable": true, "description": "Subdivisão ISO 3166-2 do IP da resposta, por exemplo `US-IL`." }, "ip_city": { "type": "string", "nullable": true, "description": "Cidade do IP da resposta." }, "user_agent": { "type": "string", "nullable": true, "description": "User agent da requisição da resposta." }, "detected_ip_address": { "type": "string", "nullable": true, "description": "O IP da pessoa a partir do qual o requisito foi avaliado pela última vez. Pode ser diferente de `ip_address` quando a pessoa respondeu em outro dispositivo." }, "detected_country_code": { "type": "string", "nullable": true, "description": "País do IP detectado, no formato ISO 3166-1 alpha-2." }, "detected_state": { "type": "string", "nullable": true, "description": "Subdivisão ISO 3166-2 do IP detectado." }, "detected_city": { "type": "string", "nullable": true, "description": "Cidade do IP detectado." }, "declared_state": { "type": "string", "nullable": true, "description": "Subdivisão ISO 3166-2 que você declarou: `user_state` ou o estado de um endereço dos EUA em `expected_details`." }, "document_state": { "type": "string", "nullable": true, "description": "Subdivisão ISO 3166-2 que emitiu o documento de identidade, lida na captura do documento." }, "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Estados dos EUA (códigos USPS, por exemplo `IL`) cuja lei de biometria abrange a pessoa. `US` quando as evidências situam a pessoa nos EUA, mas nenhum estado é conhecido. Vazio quando nenhuma se aplica." }, "retention_months": { "type": "integer", "nullable": true, "description": "O menor limite de retenção biométrica, em meses, entre `jurisdictions`. `null` quando nenhum se aplica." }, "reason": { "type": "string", "nullable": true, "enum": [ "BIOMETRIC_CONSENT_UNSUPPORTED_SDK", "BIOMETRIC_CONSENT_DECLINED" ], "description": "`BIOMETRIC_CONSENT_UNSUPPORTED_SDK`: o consentimento era obrigatório e um SDK nativo anterior à versão 4.10.0, ou que não informou sua versão, capturou um rosto sem a etapa de consentimento; `status` permanece `pending`, ou `given` se a pessoa concordou depois no fluxo hospedado. `BIOMETRIC_CONSENT_DECLINED`: uma recusa foi registrada (ela substitui o motivo do SDK). `null` nos demais casos, e sempre `null` quando a sessão não exigia consentimento." }, "decline_reason": { "type": "string", "nullable": true, "enum": [ "BIOMETRIC_CONSENT_DECLINED" ], "description": "`BIOMETRIC_CONSENT_DECLINED` quando uma recusa registrada encerrou a sessão; caso contrário, `null`." }, "face_data_deleted_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a recusa excluiu as imagens faciais, os vídeos e os templates faciais da sessão. `null` a menos que uma recusa tenha sido registrada." } } }, "investigator": { "$ref": "#/components/schemas/InvestigatorBlock" }, "biometric_retention": { "$ref": "#/components/schemas/BiometricRetention" }, "fraud_check": { "type": "object", "nullable": true, "additionalProperties": true, "description": "O resultado de uma chamada à Fraud Check API. `null` para todas as outras sessões." }, "full_session_video": { "type": "string", "format": "uri", "nullable": true, "description": "URL temporária da gravação da sessão completa. Retornada somente quando sua organização grava vídeo da sessão completa." }, "full_session_video_recorded_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a gravação da sessão completa foi feita. Retornado apenas quando sua organização grava vídeo da sessão completa." } } }, "WorkflowDetail": { "type": "object", "description": "Os campos abaixo são tipados; o objeto também traz todas as outras colunas da configuração do fluxo de verificação (ativação de recursos, limiares, ações de aviso, documentos permitidos, callbacks) como propriedades adicionais. Os campos que não se aplicam ao `workflow_type` são `null`.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador da versão (`settings_uuid`). Cada versão de um fluxo tem o seu próprio." }, "workflow_id": { "type": "string", "format": "uuid", "description": "Identificador estável compartilhado por todas as versões do fluxo. As sessões criadas com ele usam a versão publicada mais recente." }, "workflow_label": { "type": "string", "description": "Nome de exibição do fluxo." }, "workflow_type": { "type": "string", "nullable": true, "enum": [ "kyc", "kyb", "adaptive_age_verification", "biometric_authentication", "address_verification", "questionnaire_verification", "email_verification", "phone_verification", null ], "description": "Modelo do fluxo. `null` para fluxos em grafo criados sem modelo." }, "is_default": { "type": "boolean", "description": "Se este é o fluxo de verificação (workflow) padrão da aplicação." }, "is_archived": { "type": "boolean", "description": "Fluxos arquivados não podem iniciar novas sessões." }, "version": { "type": "integer", "description": "Número da versão dentro do fluxo." }, "status": { "type": "string", "enum": [ "draft", "published" ], "description": "As versões de rascunho são editáveis; as versões publicadas são imutáveis e usadas para novas sessões." }, "published_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando esta versão foi publicada. `null` para rascunhos." }, "is_simple_workflow": { "type": "boolean", "description": "`true` quando o fluxo não tem um `workflow_graph` personalizado." }, "is_editable": { "type": "boolean", "description": "`true` apenas para versões `draft`." }, "workflow_url": { "type": "string", "format": "uri", "description": "URL pública que inicia uma sessão com este fluxo." }, "workflow_graph": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Estrutura de grafo do fluxo (nós e arestas). `null` para fluxos simples." }, "features": { "type": "string", "description": "Recursos ativados unidos por `\" + \"`, por exemplo `\"OCR + LIVENESS\"`." }, "total_price": { "type": "number", "nullable": true, "description": "Preço por sessão; para fluxos em grafo, o caminho mais caro." }, "min_price": { "type": "number", "nullable": true, "description": "Preço do caminho mais barato do fluxo." }, "max_price": { "type": "number", "nullable": true, "description": "Preço do caminho mais caro do fluxo." }, "special_add_on_prices": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Preços de complementos específicos da organização, ou `null` quando nenhum está definido." }, "max_retry_attempts": { "type": "integer", "description": "Novas tentativas permitidas após uma verificação recusada." }, "retry_window_days": { "type": "integer", "nullable": true, "description": "Dias durante os quais as novas tentativas são permitidas." }, "session_expiration_time": { "type": "integer", "description": "Segundos até a expiração de uma sessão não concluída." }, "questionnaire": { "type": "object", "nullable": true, "additionalProperties": true, "description": "O questionário vinculado ao fluxo, ou `null`." }, "kyb_role_settings": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Configurações de verificação por função para as pessoas-chave do KYB." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "signature_availability": { "type": "object", "description": "Quais níveis de Assinatura eletrônica podem assinar neste momento. Verifique antes de definir `signature_level`. Retornado em fluxos `kyc`, `kyb` e de grafo.", "properties": { "simple": { "type": "boolean", "description": "O Simple está sempre disponível." }, "aes": { "type": "boolean", "description": "Indica se a assinatura Avançada (AES) pode assinar agora. Enquanto for `false`, salvar uma nova etapa com `signature_level: \"aes\"` é recusado com `aes_not_available`." }, "qes": { "type": "boolean", "description": "Indica se a assinatura Qualificada (QES) pode assinar agora. É `false` até que um provedor qualificado seja conectado." } } }, "is_bank_verification_enabled": { "type": "boolean", "description": "Indica se um fluxo simples de KYC ou KYB executa a Verificação bancária. Ela é executada após as etapas de contato (e a Verificação de localização) e antes da validação de banco de dados, da AML e da análise de IP. A Verificação bancária ainda não está disponível para todos: ativá-la é recusado onde quer que ela não esteja habilitada." }, "bank_verification_config": { "type": "object", "additionalProperties": true, "description": "Configurações de verificação bancária de um fluxo simples, com as mesmas chaves aceitas por um nó `BANK_VERIFICATION` (por exemplo, `bank_countries` e `bank_method_order`). Chaves desconhecidas são descartadas. Todas as chaves são opcionais e uma chave ausente mantém seu valor padrão, então `{}` significa todos os valores padrão. Consulte [Configurações de verificação bancária](/pt-br/management-api/workflows/feature-configs#verificação-bancária).", "example": {} }, "is_geolocation_enabled": { "type": "boolean", "description": "Indica se um fluxo simples de KYC executa a Verificação de localização. Ela é executada após as etapas de contato e antes da Verificação bancária e da validação de banco de dados. Fluxos de empresas (KYB) não podem executá-la." }, "geolocation_config": { "type": "object", "additionalProperties": true, "description": "Configurações de verificação de localização de um fluxo de verificação (workflow) simples, com as mesmas chaves que um nó `GEOLOCATION` aceita (por exemplo, `is_geolocation_geofencing_enabled` e `geolocation_max_attempts`). Chaves desconhecidas são descartadas. Todas as chaves são opcionais e uma chave ausente mantém seu valor padrão, então `{}` significa todos os valores padrão.", "example": {} } }, "additionalProperties": true }, "UserSessionListItem": { "title": "KYC session row (session_kind: user)", "type": "object", "description": "Linha de resumo de uma sessão de Verificação de usuários (KYC). Os campos de identidade (`full_name`, `country`, `document_type`, `portrait_image`, campos de contato) são preenchidos progressivamente à medida que o usuário conclui as etapas de verificação e ficam `null` até que a etapa correspondente termine. Os campos restringidos pela configuração de atributos de resposta do fluxo também são retornados como `null`.", "required": [ "session_id", "session_kind", "session_number", "session_url", "portrait_image", "document_type", "full_name", "country", "status", "vendor_data", "didit_internal_id", "created_at", "features", "phone_number", "email_address", "additional_details" ], "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Identificador único da sessão de verificação. Use-o com `GET /v3/session/{sessionId}/decision/` para obter o payload completo da decisão.", "example": "5b3720ed-d429-42ef-b67f-37ea805f48ee" }, "session_kind": { "type": "string", "enum": [ "user" ], "description": "Discriminador de linha. Sempre `\"user\"` para linhas de KYC; as linhas de Verificação de empresas (KYB) têm `\"business\"` e uma estrutura diferente.", "example": "user" }, "session_number": { "type": "integer", "description": "Número sequencial de fácil leitura da sessão dentro da sua aplicação. Também é considerado pelo parâmetro `search`.", "example": 720 }, "session_url": { "type": "string", "nullable": true, "description": "URL de verificação hospedada que o usuário final abre para concluir o fluxo. `null` quando a sessão não tem URL hospedada.", "example": "https://verify.didit.me/session/CuXoBYCYVO5Y" }, "portrait_image": { "type": "string", "nullable": true, "description": "URL temporária (pré-assinada) do melhor retrato disponível: a foto do chip NFC quando disponível; caso contrário, o retrato do documento de identidade; caso contrário, a imagem de referência da prova de vida. `null` até que um deles exista. Faça o download imediatamente, pois o link expira.", "example": "https:///portraits/5b3720ed.jpg?X-Amz-Expires=3600&X-Amz-Signature=..." }, "document_type": { "type": "string", "nullable": true, "enum": [ "Passport", "Identity Card", "Driver's License", "Residence Permit", "Health Insurance Card", "Tax Card" ], "description": "Tipo legível do documento de identidade verificado. `null` antes de a verificação do documento ser concluída, e também `null` após a conclusão quando o código verificado não tem um nome de exibição mapeado (`SSC`, `WP`, `VISA`, `PSC`, `BC`, `OTHER`). Observação: o parâmetro de consulta `document_type` filtra por códigos curtos (`P`, `ID`, `DL`, `RP`, ...), não por esses valores de exibição.", "example": "Passport" }, "full_name": { "type": "string", "nullable": true, "description": "Melhor nome completo disponível para a sessão, determinado nesta ordem: OCR do documento de identidade, dados verificados na análise AML, dados verificados na validação de banco de dados, documento de comprovante de endereço e, por fim, os dados esperados informados na criação da sessão. `null` quando nenhum estiver disponível ainda.", "example": "Jane Marie Doe" }, "country": { "type": "string", "nullable": true, "description": "País ISO 3166-1 alpha-3 associado à sessão, definido nesta ordem: estado emissor do documento de identidade, estado emissor da validação de banco de dados, estado emissor do comprovante de endereço, dados esperados e, por fim, o país do telefone verificado. Pode ser diferente da nacionalidade.", "example": "ESP" }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Status geral da sessão. Consulte a página [Status de verificação](/pt-br/integration/verification-statuses) para ver o ciclo de vida.", "example": "Approved" }, "vendor_data": { "type": "string", "nullable": true, "description": "Seu próprio identificador para o usuário final, retornado exatamente como enviado na criação da sessão.", "example": "your-user-id-123" }, "didit_internal_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Identificador interno da Didit para o perfil de usuário verificado associado a esta sessão. É estável entre várias sessões do mesmo usuário e pode ser filtrado pelo parâmetro de consulta `didit_internal_id`.", "example": "d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147" }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp em UTC de quando a sessão foi criada.", "example": "2026-06-09T12:26:54.328364Z" }, "features": { "type": "array", "description": "Status por recurso de cada etapa de verificação configurada no fluxo da sessão, na ordem do fluxo.", "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 do recurso de verificação.", "example": "ID_VERIFICATION" }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Status deste recurso. `Not Finished` até que a etapa seja concluída.", "example": "Approved" } } } }, "phone_number": { "type": "object", "nullable": true, "description": "Telefone associado à sessão: o telefone verificado quando a verificação de telefone foi executada; caso contrário, o telefone de contato informado na criação da sessão. `null` quando nenhum dos dois existe.", "required": [ "number", "is_verified" ], "properties": { "number": { "type": "string", "description": "Número de telefone no formato E.164.", "example": "+14155552671" }, "is_verified": { "type": "boolean", "description": "`true` apenas quando o recurso de verificação de telefone aprovou este número.", "example": true } } }, "email_address": { "type": "object", "nullable": true, "description": "E-mail associado à sessão: o e-mail verificado quando a verificação de e-mail foi executada; caso contrário, o e-mail de contato informado na criação da sessão. `null` quando nenhum dos dois existe.", "required": [ "email", "is_verified" ], "properties": { "email": { "type": "string", "format": "email", "example": "jane@example.com" }, "is_verified": { "type": "boolean", "description": "`true` apenas quando o recurso de verificação de e-mail aprovou este endereço.", "example": true } } }, "additional_details": { "type": "object", "nullable": true, "description": "Dados extras compactos por recurso. Somente os recursos que produziram dados aparecem como chaves; `null` quando nenhum recurso produziu dados extras. Os campos excluídos pela configuração de atributos de resposta do fluxo são omitidos.", "properties": { "aml": { "type": "object", "description": "Presente quando a análise AML foi executada.", "properties": { "total_hits": { "type": "integer", "description": "Número de ocorrências da Análise AML.", "example": 0 }, "entity_type": { "type": "string", "description": "Tipo de entidade analisada.", "example": "person" }, "is_adverse_media_fetched": { "type": "boolean", "example": false }, "screened_data": { "type": "object", "description": "Subconjunto dos dados que foram analisados. Somente chaves não vazias são incluídas.", "properties": { "nationality": { "type": "string", "example": "ESP" }, "document_number": { "type": "string", "example": "XX1234567" }, "date_of_birth": { "type": "string", "example": "1990-05-21" } } } } }, "database_validation": { "type": "object", "description": "Presente quando a validação de banco de dados foi executada.", "properties": { "validation_type": { "type": "string", "example": "DOCUMENT_VALIDATION" }, "match_type": { "type": "string", "example": "FULL_MATCH" }, "identification_number": { "type": "string", "description": "Número fiscal, pessoal ou de documento que foi validado (o primeiro disponível).", "example": "12345678Z" } } }, "poa": { "type": "object", "description": "Presente quando o comprovante de endereço foi executado.", "properties": { "document_type": { "type": "string", "example": "UTILITY_BILL" }, "issuer": { "type": "string", "example": "Energy Co" }, "address": { "type": "string", "example": "Calle Mayor 1, 28013 Madrid" }, "name_on_document": { "type": "string", "example": "Jane Marie Doe" } } }, "liveness": { "type": "object", "description": "Presente quando uma verificação de prova de vida foi executada.", "properties": { "method": { "type": "string", "example": "PASSIVE" }, "score": { "type": "number", "description": "Pontuação de confiança da prova de vida, arredondada para 2 casas decimais.", "example": 0.98 } } }, "face_match": { "type": "object", "description": "Presente quando a correspondência facial foi executada.", "properties": { "score": { "type": "number", "description": "Pontuação de similaridade da correspondência facial, arredondada para 2 casas decimais.", "example": 0.95 }, "source_image": { "type": "string", "description": "URL temporária (pré-assinada) da imagem facial de origem.", "example": "https:///faces/source.jpg?X-Amz-Expires=3600&..." }, "target_image": { "type": "string", "description": "URL temporária (pré-assinada) da imagem facial de destino.", "example": "https:///faces/target.jpg?X-Amz-Expires=3600&..." } } }, "phone_verification": { "type": "object", "description": "Presente quando a verificação de telefone foi executada.", "properties": { "country_code": { "type": "string", "description": "País do número de telefone, no formato ISO 3166-1 alpha-2.", "example": "US" }, "is_temporary": { "type": "boolean", "example": false }, "is_ported": { "type": "boolean", "example": false }, "is_blocked": { "type": "boolean", "example": false } } }, "email_verification": { "type": "object", "description": "Presente quando a verificação de e-mail foi executada.", "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": "O revisor do Console a quem a sessão está atribuída, ou `null` quando ninguém a detém.", "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": "Quando a sessão começou a aguardar revisão. `null`, a menos que a sessão esteja `In Review`." }, "sla_due_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a revisão vence, com base no prazo de revisão definido para sua aplicação no Console. `null`, a menos que a sessão esteja `In Review` e um prazo esteja definido." }, "top_warnings": { "type": "array", "description": "No máximo alguns dos avisos mais importantes da sessão, para uma triagem rápida. A lista completa está na decisão.", "items": { "type": "object", "properties": { "risk": { "type": "string", "description": "Código do aviso, por exemplo `FACE_MATCH_LOW_SIMILARITY`." }, "feature": { "type": "string", "description": "O recurso que o gerou." }, "log_type": { "type": "string", "nullable": true, "description": "`error` ou `warning`; `null` para uma entrada legada." }, "short_description": { "type": "string" } } } }, "warnings_count": { "type": "integer", "description": "Número de avisos na sessão." } } }, "BusinessSessionListItem": { "title": "KYB session row (session_kind: business)", "type": "object", "description": "Linha de resumo de uma sessão de Verificação de empresas (KYB). Retornada somente quando `session_kind` é `business` ou `all`.", "required": [ "session_id", "session_kind", "session_number", "status", "vendor_data", "created_at", "workflow_id", "workflow_type", "workflow_label", "company_name", "registration_number", "country" ], "properties": { "session_id": { "type": "string", "format": "uuid", "description": "Identificador único da sessão de verificação de empresas.", "example": "8a1f63c2-1b9e-4f3a-9c41-2f6a1f0b7d52" }, "session_kind": { "type": "string", "enum": [ "business" ], "description": "Discriminador de linha. Sempre `\"business\"` para linhas de KYB.", "example": "business" }, "session_number": { "type": "integer", "description": "Número sequencial de fácil leitura da sessão de empresa dentro da sua aplicação. Numerado de forma independente das sessões de KYC.", "example": 42 }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Status geral da sessão. Consulte a página [Status de verificação](/pt-br/integration/verification-statuses).", "example": "Approved" }, "vendor_data": { "type": "string", "nullable": true, "description": "Seu próprio identificador para a empresa, retornado exatamente como enviado na criação da sessão.", "example": "your-company-id-77" }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp em UTC de quando a sessão foi criada.", "example": "2026-06-08T09:14:02.118450Z" }, "workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Identificador do fluxo de verificação (workflow) com o qual esta sessão foi criada.", "example": "9f9b1234-aaaa-bbbb-cccc-1234567890ab" }, "workflow_type": { "type": "string", "nullable": true, "description": "Tipo de fluxo. `kyb` para fluxos de empresas.", "example": "kyb" }, "workflow_label": { "type": "string", "nullable": true, "description": "Nome de exibição do fluxo.", "example": "Standard KYB" }, "company_name": { "type": "string", "nullable": true, "description": "Nome da empresa sendo verificada, obtido da empresa do registro vinculada à sessão. `null` até que uma empresa seja selecionada.", "example": "Acme Holdings S.L." }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registro da empresa obtido da empresa do registro vinculada à sessão.", "example": "B12345678" }, "country": { "type": "string", "nullable": true, "description": "Código do país da empresa do registro vinculada à sessão.", "example": "ES" } } }, "TransactionVerificationSessionAction": { "title": "Verification session", "type": "object", "properties": { "type": { "type": "string", "enum": [ "verification_session" ] }, "url": { "type": "string", "format": "uri", "description": "URL de verificação hospedada a ser aberta para o usuário final." }, "session_id": { "type": "string", "format": "uuid", "description": "ID da sessão de verificação." }, "session_token": { "type": "string", "description": "Token da sessão, usado pelos SDKs móveis para iniciar o fluxo de forma nativa." }, "status": { "type": "string", "description": "Status da sessão de verificação." } }, "required": [ "type", "url" ] }, "TransactionWalletOwnershipAction": { "title": "Wallet ownership", "type": "object", "properties": { "type": { "type": "string", "enum": [ "wallet_ownership" ] }, "url": { "type": "string", "format": "uri", "description": "URL do widget hospedado de comprovação de propriedade da carteira. Abra-a em um navegador real: no celular, use SFSafariViewController ou uma Chrome Custom Tab, nunca um webview incorporado." }, "widget_session_id": { "type": "string", "format": "uuid", "description": "ID da sessão do widget de propriedade da carteira." }, "expires_at": { "type": "string", "format": "date-time", "description": "Quando a sessão do widget expira." } }, "required": [ "type", "url" ] }, "TransactionRuleActionAddScore": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "add_score" ] }, "value": { "type": "integer", "description": "Pontos adicionados à pontuação de risco da transação. Pode ser negativo." } }, "description": "Adiciona pontos à pontuação de risco acumulada da transação; o total define o status com base nos limiares de revisão/recusa da aplicação." }, "TransactionRuleActionChangeStatus": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "change_status" ] }, "value": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Status a definir imediatamente, independentemente da pontuação. Chave alternativa: status." }, "workflow_id": { "type": "string", "format": "uuid", "description": "OBRIGATÓRIO quando o valor for AWAITING_USER: o fluxo de verificação que o titular deve concluir. Chave alternativa: remediation_workflow_id. A Didit cria uma sessão de remediação hospedada para o titular quando a regra é acionada." } }, "description": "Define diretamente o status da transação. DECLINED sempre prevalece entre as regras correspondentes." }, "TransactionRuleActionAddTags": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "add_tags" ] }, "tag_uuid": { "type": "string", "format": "uuid", "description": "Tag existente da aplicação a ser associada." }, "tag_name": { "type": "string", "description": "Nome da tag a anexar; criada no primeiro uso (armazenada em maiúsculas). Informe tag_uuid ou tag_name." }, "tag_color": { "type": "string", "description": "Cor hexadecimal usada quando tag_name cria uma nova tag, por exemplo, #007AFE." } }, "description": "Anexe uma tag da aplicação à transação correspondente." }, "TransactionRuleActionAddNote": { "type": "object", "required": [ "type", "note" ], "properties": { "type": { "type": "string", "enum": [ "add_note" ] }, "note": { "type": "string", "description": "Texto da nota anexada à transação (autor: Rule Engine). Chave alternativa: value." } }, "description": "Anexe uma nota automatizada de analista à transação correspondente." }, "TransactionRuleActionAddToList": { "type": "object", "required": [ "type", "list_id" ], "properties": { "type": { "type": "string", "enum": [ "add_to_list" ] }, "list_id": { "type": "string", "format": "uuid", "description": "Lista à qual o vendor_data do sujeito será adicionado." } }, "description": "Adiciona o vendor_data do titular a uma lista de bloqueio, lista de permissões ou lista personalizada." }, "TransactionRuleActionOpenCase": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "open_case" ] }, "blueprint": { "type": "string", "format": "uuid", "description": "UUID do modelo de caso; o padrão é o modelo de caso padrão da aplicação." }, "grouping": { "type": "string", "enum": [ "by_applicant", "by_rule_and_applicant" ], "description": "Indica se correspondências repetidas se agrupam em um caso por solicitante ou em um caso por regra+solicitante." }, "attach_matched_transaction": { "type": "boolean", "description": "Anexe a transação correspondente ao caso." } }, "description": "Abre (ou adiciona a) um caso de investigação. Apenas a primeira ação open_case de uma regra é aplicada." }, "KYBRegistrySearchResults": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "kyb_response_id": { "type": "string", "nullable": true, "description": "Identificador deste candidato: passe-o para `POST /v3/kyb/select/` para obter o perfil completo. É efêmero e restrito a esta busca: não o armazene a longo prazo; faça uma nova busca para obter um novo identificador.", "example": "69aeeb95febb0f1704042259" }, "name": { "type": "string", "nullable": true, "description": "Razão social registrada.", "example": "Tesco PLC" }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registro no registro.", "example": "00445790" }, "status": { "type": "string", "nullable": true, "description": "Status normalizado da empresa no registro (por exemplo, `active`, `dissolved`, `inactive`, `struck off`).", "example": "active" }, "type": { "type": "string", "nullable": true, "description": "Forma jurídica conforme informada pelo registro.", "example": "Public Limited Company" }, "registered_address": { "type": "string", "nullable": true, "description": "Endereço registrado do candidato, quando o registro retorna um. Use-o, junto com o número de registro, para distinguir empresas com o mesmo nome: nos Estados Unidos, um candidato pode estar listado no estado onde a empresa opera, e não no estado pesquisado.", "example": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, AL7 1GA" }, "risk_level": { "type": "string", "nullable": true, "description": "Nível de risco informado pelo registro, quando disponível. Geralmente `null` no momento da pesquisa." }, "fetch_status": { "type": "string", "nullable": true, "description": "Sempre `pending` para candidatos da busca: o perfil completo da empresa só é obtido (e cobrado) quando você seleciona o candidato.", "example": "pending" } } }, "description": "Lista de candidatos sem duplicatas. Vazia enquanto `search_resolved=false` (modo webhook) ou quando nada correspondeu." }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "description": "Número de candidatos retornados." }, "page": { "type": "integer" }, "per_page": { "type": "integer", "example": 25 } } }, "search_status": { "type": "string", "nullable": true, "enum": [ "pending", "resolved" ], "description": "Status do ciclo de vida da pesquisa no registro." }, "search_resolved": { "type": "boolean", "description": "`true` quando a lista de candidatos é final." } } }, "KYBRegistryCandidateRequest": { "type": "object", "required": [ "kyb_response_id" ], "properties": { "kyb_response_id": { "type": "string", "maxLength": 1024, "description": "Identificador do candidato retornado por `POST /v3/kyb/search/` (`kyb_registry.companies[].kyb_response_id`). Efêmero: use-o logo após a busca que o gerou. Os identificadores podem ser longos, então armazene e envie o valor exatamente como retornado, sem cortar nem presumir um tamanho.", "example": "69aeeb95febb0f1704042259" }, "vendor_data": { "type": "string", "description": "Seu identificador para esta empresa; retornado na resposta e armazenado com a sessão da empresa." }, "metadata": { "type": "object", "nullable": true, "description": "JSON livre armazenado com a sessão de empresa e retornado na resposta." }, "save_api_request": { "type": "boolean", "default": true, "description": "Deve ser `true` (o padrão). As seleções de registro KYB são sempre persistidas para que o faturamento e a recuperação possam ser rastreados; `false` retorna `400`." } } }, "WebhookEventEnvelope": { "type": "object", "description": "Campos que a Didit adiciona a toda entrega de webhook assinada, qualquer que seja o tipo de evento. Leia `webhook_type` para saber qual payload você recebeu.", "required": [ "event_id", "webhook_type", "timestamp", "created_at", "application_id", "environment" ], "properties": { "event_id": { "type": "string", "format": "uuid", "description": "Identificador do evento. Todos os destinos recebem o mesmo valor e uma reentrega o mantém, então use-o para eliminar duplicatas." }, "webhook_type": { "$ref": "#/components/schemas/WebhookEvent" }, "timestamp": { "type": "integer", "description": "Horário Unix em segundos em que esta entrega foi assinada. Igual ao cabeçalho `X-Timestamp`; uma reentrega traz um novo valor." }, "created_at": { "type": "integer", "description": "Horário Unix em segundos da alteração que gerou o evento." }, "application_id": { "type": "string", "format": "uuid", "description": "A aplicação à qual o evento pertence." }, "environment": { "type": "string", "enum": [ "live", "sandbox" ], "description": "`sandbox` para sessões de sandbox e aplicações de sandbox; caso contrário, `live`." } } }, "SessionWebhookEventData": { "type": "object", "description": "Campos de sessão de `status.updated` e `data.updated`. Os campos opcionais são omitidos, nunca enviados como `null`, quando não se aplicam. Sessões de empresa (KYB) adicionam `business_session_id`, `session_kind` e `vendor_business_id`.", "required": [ "session_id", "status", "sandbox_scenario" ], "properties": { "session_id": { "type": "string", "format": "uuid", "description": "A sessão de verificação." }, "business_session_id": { "type": "string", "format": "uuid", "description": "Somente sessões de empresas (KYB): o mesmo valor de `session_id`." }, "session_kind": { "type": "string", "enum": [ "business" ], "description": "Somente sessões de empresas (KYB). Os eventos de sessões de usuário (KYC) não trazem `session_kind` no nível superior; leia `decision.session_kind`." }, "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User" ], "description": "Status da sessão após a alteração." }, "trigger": { "type": "string", "description": "Presente quando o evento não foi gerado pelo próprio fluxo de verificação, por exemplo `manual_review`, `manual_step_update`, `ongoing_monitoring`, `webhook_reconciliation` (um `status.updated` reenviado porque o primeiro webhook terminal nunca foi criado, então você pode receber um segundo evento para uma decisão que já recebeu: elimine duplicatas por `session_id` e `status`), `manual_webhook_recovery`, `kyb_registry_change`, `biometric_retention` (um `data.updated` enviado quando os dados biométricos ativos da sessão são excluídos conforme o agendamento) ou uma edição `console_*`, como `console_registry_edit`, `console_key_people_skip` ou `console_key_people_regenerate`." }, "workflow_id": { "type": "string", "format": "uuid", "description": "O fluxo da sessão. Omitido quando a sessão não tem nenhum." }, "workflow_version": { "type": "integer", "description": "Versão do fluxo executado pela sessão. Enviada junto com `workflow_id`." }, "vendor_data": { "type": "string", "description": "Seu `vendor_data` da sessão. Omitido quando vazio." }, "vendor_business_id": { "type": "string", "description": "Somente sessões de empresas (KYB): a empresa à qual a sessão pertence. Omitido quando não há nenhuma." }, "metadata": { "type": "object", "additionalProperties": true, "description": "O `metadata` da sua sessão. Omitido quando vazio." }, "decision": { "$ref": "#/components/schemas/SessionDecision" }, "resubmit_info": { "type": "object", "description": "Somente quando `status` for `Resubmitted`: as etapas que o usuário deve refazer e o motivo.", "required": [ "nodes_to_resubmit", "reasons" ], "properties": { "nodes_to_resubmit": { "type": "array", "items": { "type": "object", "required": [ "node_id", "feature" ], "properties": { "node_id": { "type": "string", "description": "Identificador do nó conforme aparece na definição do fluxo de verificação (workflow) da sessão (por exemplo, `feature_ocr`, `feature_liveness`).", "example": "feature_poa" }, "feature": { "type": "string", "description": "Tipo de recurso do nó, por exemplo `OCR`, `LIVENESS` ou `PROOF_OF_ADDRESS`.", "example": "PROOF_OF_ADDRESS" } } }, "description": "Etapas do fluxo que o usuário precisa refazer. As mesmas entradas `{node_id, feature}` de `nodes_to_resubmit` em [Atualizar status](#patch-/v3/session/-sessionId-/update-status/)." }, "reasons": { "type": "object", "additionalProperties": true, "description": "Motivo por `node_id` em `nodes_to_resubmit`." } } }, "sandbox_scenario": { "type": "string", "nullable": true, "description": "O resultado simulado configurado em uma sessão de sandbox, ou `null`. Sempre `null` para sessões em produção." } } }, "SessionStatusUpdatedEvent": { "description": "Uma sessão de verificação mudou de status. `decision` é enviado apenas para `Approved`, `Declined`, `In Review` e `Abandoned`; tem o formato de `GET /v3/session/{sessionId}/decision/` para destinos na versão 3 do webhook (o padrão) e o formato reduzido mais antigo para destinos na versão 1 ou 2. Sessões de empresas sempre recebem a decisão de empresa da versão 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": "Os dados de uma sessão de verificação mudaram sem mudança de status, por exemplo após uma edição na revisão manual, uma substituição de etapa ou uma nova triagem do monitoramento contínuo. `decision` é enviado apenas para `Approved`, `Declined`, `In Review` e `Abandoned`; ele tem o formato de `GET /v3/session/{sessionId}/decision/` para destinos na versão 3 do webhook (o padrão) e o formato reduzido mais antigo para destinos na versão 1 ou 2. Sessões de empresas sempre recebem a decisão de empresa da versão 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": "Um usuário mudou de status. Não é enviado quando o usuário é criado.", "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": "O usuário a que o evento se refere." }, "vendor_data": { "type": "string", "nullable": true, "description": "Seu `vendor_data` do usuário, ou `null`." }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Status do usuário após a alteração." }, "previous_status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Status antes da alteração." } }, "required": [ "webhook_type", "vendor_user_id", "vendor_data", "status", "previous_status" ] } ] }, "UserDataUpdatedEvent": { "description": "Campos de um usuário foram alterados. Não é enviado quando o usuário é criado. Um único salvamento pode gerar tanto um evento de status quanto um de dados.", "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": "O usuário a que o evento se refere." }, "vendor_data": { "type": "string", "nullable": true, "description": "Seu `vendor_data` do usuário, ou `null`." }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Status do usuário após a alteração." }, "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": "Nomes dos campos que foram alterados." }, "changes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "previous": { "nullable": true, "description": "Valor antes da alteração. Datas são strings ISO 8601." }, "current": { "nullable": true, "description": "Valor após a alteração. Datas são strings ISO 8601." } } }, "description": "Valor anterior e atual de cada campo alterado, indexados pelo nome do campo. Os valores podem ser dados pessoais (nomes, datas de nascimento, links de retratos, e-mails, números de telefone); trate-os de acordo." } }, "required": [ "webhook_type", "vendor_user_id", "vendor_data", "status", "changed_fields", "changes" ] } ] }, "BusinessStatusUpdatedEvent": { "description": "Uma empresa mudou de status. Não é enviado quando a empresa é criada.", "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": "A empresa de que trata o evento." }, "vendor_data": { "type": "string", "nullable": true, "description": "Seu `vendor_data` da empresa, ou `null`." }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Status da empresa após a alteração." }, "previous_status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Status antes da alteração." } }, "required": [ "webhook_type", "vendor_business_id", "vendor_data", "status", "previous_status" ] } ] }, "BusinessDataUpdatedEvent": { "description": "Campos de uma empresa foram alterados. Não é enviado quando a empresa é criada. Um único salvamento pode gerar tanto um evento de status quanto um de dados.", "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": "A empresa de que trata o evento." }, "vendor_data": { "type": "string", "nullable": true, "description": "Seu `vendor_data` da empresa, ou `null`." }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_REVIEW", "FLAGGED", "BLOCKED" ], "description": "Status da empresa após a alteração." }, "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": "Nomes dos campos que foram alterados." }, "changes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "previous": { "nullable": true, "description": "Valor antes da alteração. Datas são strings ISO 8601." }, "current": { "nullable": true, "description": "Valor após a alteração. Datas são strings ISO 8601." } } }, "description": "Valor anterior e atual de cada campo alterado, indexados pelo nome do campo." } }, "required": [ "webhook_type", "vendor_business_id", "vendor_data", "status", "changed_fields", "changes" ] } ] }, "TransactionCreatedEvent": { "description": "Uma transação foi criada e analisada. Enviado apenas para aplicações em produção.", "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 da Didit para a transação." }, "txn_id": { "type": "string", "nullable": true, "description": "O `transaction_id` que você informou na criação, ou `null`." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Status do monitoramento após a alteração." }, "score": { "type": "integer", "description": "Pontuação de risco acumulada pelas regras." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL", null ], "description": "Gravidade do risco, ou `null` até que uma regra ou um provedor a defina." }, "amount": { "type": "string", "description": "Valor da transação como string decimal. Ao contrário da API, não é normalizado, então pode conter zeros à direita (até 18 casas decimais)." }, "currency": { "type": "string", "description": "Código da moeda ou símbolo do criptoativo de `amount`." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Direção em relação ao titular." }, "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": "Ação pendente do usuário final, ou `null`. É o mesmo objeto que `action_required` na transação; `session_token` é uma credencial, portanto nunca o registre em logs." } }, "required": [ "webhook_type", "transaction_id", "txn_id", "status", "score", "severity", "amount", "currency", "direction", "action_required" ] } ] }, "TransactionStatusUpdatedEvent": { "description": "Uma transação mudou de status, por uma regra, uma revisão ou uma ação do usuário final. Enviado apenas para aplicações em produção.", "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 da Didit para a transação." }, "txn_id": { "type": "string", "nullable": true, "description": "O `transaction_id` que você informou na criação, ou `null`." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Status do monitoramento após a alteração." }, "score": { "type": "integer", "description": "Pontuação de risco acumulada pelas regras." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL", null ], "description": "Gravidade do risco, ou `null` até que uma regra ou um provedor a defina." }, "amount": { "type": "string", "description": "Valor da transação como string decimal. Ao contrário da API, não é normalizado, então pode conter zeros à direita (até 18 casas decimais)." }, "currency": { "type": "string", "description": "Código da moeda ou símbolo do criptoativo de `amount`." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Direção em relação ao titular." }, "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": "Ação pendente do usuário final, ou `null`. É o mesmo objeto que `action_required` na transação; `session_token` é uma credencial, portanto nunca o registre em logs." } }, "required": [ "webhook_type", "transaction_id", "txn_id", "status", "score", "severity", "amount", "currency", "direction", "action_required" ] } ] }, "TravelRuleStatusUpdatedEvent": { "description": "Uma troca de Travel Rule mudou de status. Enviado em cada transição até `FINISHED`, `CANCELLED` ou `EXPIRED`, inclusive, e nunca depois. Enviado para aplicações em produção e, no caso de trocas de Travel Rule, também para aplicações de sandbox (`environment: sandbox`). Não há `status` de nível 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": "A transação à qual a troca pertence." }, "txn_id": { "type": "string", "nullable": true, "description": "O `transaction_id` que você informou na criação, ou `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": "Status da troca após a alteração." }, "rail": { "type": "string", "enum": [ "", "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL", "TEST_VASP" ], "description": "Rede em que a troca ocorre, ou uma string vazia quando nenhuma pôde ser identificada. `TEST_VASP` é uma transferência de sandbox respondida pelo Didit Test VASP." }, "test_vasp": { "type": "boolean", "description": "Presente e `true` somente em uma transferência de sandbox respondida pelo Didit Test VASP." }, "test_vasp_scenario": { "type": "string", "description": "Presente somente com `test_vasp`: o cenário de sandbox que decidiu o resultado, ou uma string vazia." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Direção da transferência." } }, "required": [ "webhook_type", "transaction_id", "txn_id", "travel_rule_status", "rail", "direction" ] } ] }, "WorkflowComplianceChangedEvent": { "description": "O status de conformidade de um fluxo publicado mudou após uma reavaliação. Um evento por fluxo. Não há `status` no nível 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": "O fluxo que foi alterado." }, "workflow_version": { "type": "integer", "description": "Versão que foi avaliada." }, "workflow_label": { "type": "string", "nullable": true, "description": "Nome de exibição do fluxo." }, "transition": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "type": "string", "enum": [ "compliant", "gaps_detected", "pending_change", "unknown_coverage", "not_evaluated" ], "description": "Status antes da reavaliação." }, "to": { "type": "string", "enum": [ "compliant", "gaps_detected", "pending_change", "unknown_coverage", "not_evaluated" ], "description": "Status após a reavaliação." } } }, "severity": { "type": "string", "enum": [ "actionable", "indicative", "informative" ], "description": "`actionable` quando foram detectadas lacunas, `indicative` para uma alteração pendente, `informative` quando as lacunas foram resolvidas." }, "kb_version": { "type": "string", "description": "Versão da base de conhecimento regulatório utilizada." } }, "required": [ "webhook_type", "workflow_id", "workflow_version", "workflow_label", "transition", "severity", "kb_version" ] } ] }, "WebhookEventPayload": { "description": "Corpo de uma entrega de webhook assinada, discriminado por `webhook_type`. É possível se inscrever em `activity.created`, mas esse evento não é enviado atualmente. Trate qualquer outro `webhook_type` como um novo tipo de evento e mantenha o corpo bruto.", "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": "Corpo do callback enviado para o `webhook_url` de `POST /v3/kyb/search/` quando a busca no registro é concluída. Ele não é assinado: a requisição traz `X-Didit-Unsigned-Callback: true` e nenhum dos cabeçalhos de assinatura; portanto, confirme-o comparando `request_id` com uma busca que você iniciou. Usa `event_type`, não `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 do callback." }, "event_type": { "type": "string", "enum": [ "kyb.registry_search.resolved" ], "description": "Sempre `kyb.registry_search.resolved`." }, "request_id": { "type": "string", "format": "uuid", "description": "O `request_id` retornado por `POST /v3/kyb/search/`." }, "vendor_data": { "type": "string", "nullable": true, "description": "Eco dos `vendor_data` que você enviou." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Eco do `metadata` que você enviou." }, "search_status": { "type": "string", "description": "Sempre `resolved` atualmente." }, "search_resolved": { "type": "boolean", "description": "`true` quando `search_status` é `resolved`." }, "kyb_registry": { "$ref": "#/components/schemas/KYBRegistrySearchResults" }, "timestamp": { "type": "integer", "description": "Horário Unix em segundos em que o callback foi enfileirado." }, "created_at": { "type": "integer", "description": "Horário Unix em segundos em que o callback foi enfileirado." } } }, "AMLScreening": { "type": "object", "properties": { "node_id": { "type": "string", "description": "Identificador único desta etapa de AML no grafo do fluxo." }, "status": { "type": "string", "description": "Status desta Análise AML no nível do recurso. É independente do `status` de nível superior da sessão: uma sessão pode chegar à decisão geral enquanto um recurso individual permanece `In Review`.", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ] }, "total_hits": { "type": "integer", "description": "Número total de correspondências encontradas" }, "entity_type": { "type": "string", "description": "Tipo de entidade analisada: pessoa ou empresa" }, "hits": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador estável da Didit para o hit: `hit_` seguido de 24 caracteres hexadecimais. A mesma entidade correspondente mantém o mesmo `id` quando o titular é analisado novamente. Passe-o como `hit_id` para os endpoints de revisão de hits AML." }, "url": { "type": "string", "format": "uri", "description": "URL de origem da correspondência" }, "match": { "type": "boolean", "description": "Se esta é uma correspondência confirmada" }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 1, "description": "Pontuação de correspondência ponderada obsoleta, no intervalo de 0 a 1 (por exemplo, `0.73`). Use `match_score` (0-100) em vez dela.", "deprecated": true }, "target": { "type": "boolean", "nullable": true, "description": "Se a entidade correspondente é o alvo direto da listagem (e não uma parte relacionada). `null` quando a fonte não especifica." }, "caption": { "type": "string", "description": "Legenda ou título da correspondê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": "Lista das categorias de conjuntos de dados em que a correspondência foi encontrada. Indica se a entidade apareceu em listas de PEP (com nível), bancos de dados de sanções, mídia adversa, avisos/medidas regulatórias ou outros conjuntos de dados de conformidade. `Other Lists` quando a fonte da entidade não indica nenhuma dessas categorias." }, "features": { "type": "object", "nullable": true, "description": "Características adicionais da correspondência" }, "rca_name": { "type": "string", "description": "Nome do RCA, se aplicável" }, "last_seen": { "type": "string", "format": "date-time", "description": "Data em que a correspondência foi vista pela última vez" }, "risk_view": { "type": "object", "properties": { "crimes": { "type": "object", "properties": { "score": { "type": "integer" }, "weightage": { "type": "integer" }, "risk_level": { "type": "string" }, "risk_scores": { "type": "object" } } }, "countries": { "type": "object", "properties": { "score": { "type": "integer" }, "weightage": { "type": "integer" }, "risk_level": { "type": "string" }, "risk_scores": { "type": "object" } } }, "categories": { "type": "object", "properties": { "score": { "type": "integer" }, "weightage": { "type": "integer" }, "risk_level": { "type": "string" }, "risk_scores": { "type": "object" } } }, "custom_list": { "type": "object" } } }, "first_seen": { "type": "string", "format": "date-time", "description": "Data em que a correspondência foi vista pela primeira vez" }, "properties": { "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" } }, "alias": { "type": "array", "items": { "type": "string" } }, "notes": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string", "nullable": true }, "gender": { "type": "array", "items": { "type": "string" } }, "height": { "type": "string", "nullable": true }, "topics": { "type": "string", "nullable": true }, "weight": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "eyeColor": { "type": "string", "nullable": true }, "keywords": { "type": "string", "nullable": true }, "lastName": { "type": "array", "items": { "type": "string" } }, "position": { "type": "string", "nullable": true }, "religion": { "type": "string", "nullable": true }, "birthDate": { "type": "array", "items": { "type": "string" } }, "education": { "type": "array", "items": { "type": "string" } }, "ethnicity": { "type": "string", "nullable": true }, "firstName": { "type": "array", "items": { "type": "string" } }, "hairColor": { "type": "string", "nullable": true }, "weakAlias": { "type": "string", "nullable": true }, "birthPlace": { "type": "array", "items": { "type": "string" } }, "modifiedAt": { "type": "string", "nullable": true }, "wikidataId": { "type": "string", "nullable": true }, "citizenship": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true } } }, "match_score": { "type": "number", "description": "Pontuação de confiança de identidade ponderada (0-100), calculada a partir da similaridade de nome, da data de nascimento e da correspondência de país. Usada para determinar se a ocorrência é um Falso Positivo ou uma Possível Correspondência.", "format": "float", "nullable": true }, "risk_score": { "type": "number", "description": "Pontuação de risco da entidade (0-100). Usada para determinar o status AML final (Aprovado/Em revisão/Recusado) com base na maior risk_score entre os resultados que não são falsos positivos." }, "review_status": { "type": "string", "description": "Status de revisão deste resultado. Pode ser 'Unreviewed', 'Confirmed Match', 'False Positive' ou 'Inconclusive'.", "enum": [ "Unreviewed", "Confirmed Match", "False Positive", "Inconclusive" ] }, "score_breakdown": { "type": "object", "description": "Detalhamento de como o match_score foi calculado.", "properties": { "name_score": { "type": "integer", "description": "Percentual bruto de similaridade de nome (0-100)." }, "name_weight": { "type": "integer", "description": "Peso original do nome na configuração (0-100)." }, "name_weight_normalized": { "type": "number", "description": "Peso normalizado do nome após a reponderação por dados ausentes (0-100)." }, "name_contribution": { "type": "number", "description": "Pontos com que o nome contribuiu para a pontuação total." }, "dob_score": { "type": "integer", "description": "Pontuação de correspondência da data de nascimento (-100 a 100)." }, "dob_weight": { "type": "integer", "description": "Peso original da data de nascimento na configuração (0-100)." }, "dob_weight_normalized": { "type": "number", "description": "Peso normalizado da data de nascimento após a reponderação por dados ausentes (0-100)." }, "dob_contribution": { "type": "number", "description": "Pontos com que a data de nascimento contribuiu para a pontuação total." }, "country_score": { "type": "integer", "description": "Pontuação de correspondência do país (-100 a 100)." }, "country_weight": { "type": "integer", "description": "Peso original do país na configuração (0-100)." }, "country_weight_normalized": { "type": "number", "description": "Peso normalizado do país após a reponderação por dados ausentes (0-100)." }, "country_contribution": { "type": "number", "description": "Pontos com que o país contribuiu para a pontuação total." }, "document_number_match_type": { "type": "string", "description": "Resultado da avaliação 'Golden Key' do número do documento.", "enum": [ "MATCH", "NEUTRAL", "HARD_MISMATCH" ] }, "document_number_effect": { "type": "string", "description": "Descrição legível do efeito do número do documento na pontuação." }, "total_score": { "type": "integer", "description": "Pontuação de correspondê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": "Lista de correspondências de avisos e medidas regulatórias. Inclui entradas das categorias: Warning, SIP, Warnings and Regulatory Enforcement, Fitness and Probity, SIE e Insolvency.", "items": { "type": "object", "properties": { "list_name": { "type": "string", "description": "Nome do publicador da lista de avisos" }, "matched_name": { "type": "string", "description": "Nome correspondente na lista de avisos" }, "description": { "type": "string", "description": "Descrição da entrada de aviso" }, "publisher": { "type": "string", "description": "Publicador ou fonte do aviso" }, "source_url": { "type": "string", "format": "uri", "description": "URL da fonte do aviso" }, "other_sources": { "type": "array", "items": { "type": "string" }, "description": "URLs de fontes adicionais" }, "countries": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Países associados ao aviso" }, "created_at": { "type": "string", "nullable": true, "description": "Data em que a entrada de aviso foi criada" }, "updated_at": { "type": "string", "nullable": true, "description": "Data em que a entrada de aviso foi atualizada pela última vez" }, "additional_data": { "type": "object", "description": "Dados adicionais da fonte do aviso. Pode conter um objeto `data` com um array `case_details`.", "properties": { "data": { "type": "object", "properties": { "case_details": { "type": "array", "description": "Detalhes dos casos de aviso associados a esta correspondência", "items": { "type": "object", "properties": { "case_type": { "type": "string", "description": "Tipo do caso de aviso", "enum": [ "Accusation", "Arrest", "Bribery", "Criminal", "Fraud", "Illegal Fundraising", "Non-conviction Terror", "Proclaimed Offender", "Regulatory Enforcement", "Terrorism", "Terrorism-related", "Terrorism-related listing" ] } } } } } } } } } } }, "sanction_matches": { "type": "array", "description": "Lista de correspondências em listas de sanções encontradas para esta entidade.", "items": { "type": "object", "properties": { "list_name": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Nome(s) da(s) lista(s) de sanções" }, "matched_name": { "type": "string", "description": "Nome correspondente na lista de sanções" }, "description": { "type": "string", "description": "Descrição da entrada de sanção" }, "reason": { "type": "string", "nullable": true, "description": "Motivo em texto livre pelo qual a entidade foi sancionada. Composto a partir das entradas de motivo da lista de sanções. Exemplos: '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 da fonte da sanção" }, "other_sources": { "type": "array", "items": { "type": "string" }, "description": "URLs de fontes adicionais" }, "details": { "type": "array", "items": { "type": "string" }, "description": "Detalhes adicionais sobre a sanção" }, "legal_basis": { "type": "array", "items": { "type": "string" }, "description": "Base legal da sanção" }, "listed_on": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Data(s) em que a entidade foi incluída na lista" }, "sanction_list": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Identificador(es) da lista de sanções" }, "sanction_program": { "type": "array", "items": { "type": "string" }, "description": "Programa(s) de sanções em que a entidade está listada" }, "sanctioning_authority": { "type": "array", "items": { "type": "string" }, "description": "Autoridade ou autoridades que impuseram a sanção" }, "updated_on": { "type": "array", "items": { "type": "string" }, "description": "Data(s) em que a entrada de sanção foi atualizada pela última vez" }, "additional_data": { "type": "object", "description": "Dados adicionais da fonte da sanção não capturados nos campos principais" } } } }, "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": "Pontuação geral da análise AML — a maior pontuação de risco entre todos os resultados (float, 0-100). `null` até ser calculada." }, "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 se o monitoramento AML contínuo está ativado para esta análise. Quando `true`, a entidade é reanalisada periodicamente e quaisquer novos resultados atualizam o relatório." }, "next_ongoing_monitoring_bill_date": { "type": "string", "format": "date", "nullable": true, "description": "Data (YYYY-MM-DD) em que esta assinatura de monitoramento contínuo será faturada novamente. Calculada como a data do último faturamento do monitoramento contínuo mais 365 dias quando `is_ongoing_monitoring_enabled = true`; caso contrário, `null`. Esta é uma data de faturamento, não uma data de triagem; para isso, use `last_ongoing_screening_at`." }, "last_ongoing_screening_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o monitoramento contínuo concluiu pela última vez uma nova triagem deste registro, tenha o resultado mudado ou não. `null` quando o registro nunca passou por nova triagem; o valor nunca é preenchido retroativamente com a data de ativação ou de faturamento." }, "last_ongoing_screening_datasets_updated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "A data da atualização mais recente do conjunto de dados AML informada pelo provedor no momento daquela triagem. `null` quando o provedor não informou datas do conjunto de dados; nunca é estimada." }, "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": "O recurso que gerou este aviso. O valor identifica o bloco de recurso ao qual o aviso pertence. Em uma Análise AML, normalmente é `AML`, mas o enum acima é a referência oficial para todos os avisos de recursos no payload de decisão." }, "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": "O ID do nó do grafo do fluxo que gerou este aviso" } } } } } }, "MonitoringEvent": { "type": "object", "description": "Um evento de monitoramento armazenado, conforme retornado pelos endpoints de listagem e de linha do tempo do titular. Evidências restritas (payload, contexto do dispositivo, evidências de regras) são retornadas apenas por `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 da Didit para o evento. Use-o como `{event_uuid}` nas chamadas de consulta e exclusão." }, "event_id": { "type": "string", "maxLength": 128, "description": "Seu próprio identificador, a chave de idempotência que você enviou." }, "event_category": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ], "description": "Categoria do evento." }, "action_type": { "type": "string", "maxLength": 128, "description": "O que aconteceu dentro da categoria, como você enviou." }, "occurred_at": { "type": "string", "format": "date-time", "description": "Quando o evento ocorreu do seu lado." }, "received_at": { "type": "string", "format": "date-time", "description": "Quando a Didit aceitou o evento." }, "status": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ], "description": "`ACCEPTED`: armazenado, nenhuma regra correspondente alterou sua situação (a resposta normal para a maioria dos eventos, e sempre a resposta em uma aplicação de sandbox, onde nenhuma regra é executada). `APPROVED`: uma regra correspondeu e a pontuação ficou abaixo do seu limiar de revisão. `IN_REVIEW`: uma regra elevou a pontuação acima do limiar de revisão ou definiu o status. `DECLINED`: uma regra o recusou ou a pontuação ultrapassou seu limiar de recusa." }, "score": { "type": "integer", "description": "Pontuação acumulada das regras. Começa em 0; as ações `add_score` das regras a alteram (variações negativas são permitidas)." }, "subject_vendor_data": { "type": "string", "maxLength": 255, "description": "`subject.vendor_data` do evento: o seu id para o usuário ou a empresa." }, "subject_entity_type": { "type": "string", "description": "`individual` ou `company`: o tipo de titular identificado por `subject_vendor_data`.", "example": "individual" }, "subject_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID do usuário (pessoa física) ou da empresa ao qual o evento foi associado, ou null quando esse registro não existe mais." }, "counterparty_vendor_data": { "type": "string", "nullable": true, "description": "O outro jogador de um evento P2P (promovido a partir de `payload.counterparty_vendor_data`).", "maxLength": 255 }, "session_id": { "type": "string", "nullable": true, "description": "`session.session_id` enviado com o evento.", "maxLength": 255 }, "device_fingerprint": { "type": "string", "nullable": true, "description": "`device_context.fingerprint` enviado com o evento.", "maxLength": 255 }, "ip_address": { "type": "string", "nullable": true, "description": "Endereço IP do evento. No canal do servidor, é o `device_context.network_context.ip_address` exatamente como você o enviou; no canal do dispositivo, é o IP da requisição.", "maxLength": 64 }, "ip_country": { "type": "string", "nullable": true, "description": "Código do país de `ip_address` obtido pelo enriquecimento de IP, ou null quando o endereço não foi enriquecido (ausente, privado ou telemetria de baixo valor cujo endereço ainda não era conhecido).", "example": "ES" }, "amount": { "type": "string", "nullable": true, "description": "Valor como string decimal com 18 casas decimais, obtido de `transaction_context.amount`, `payload.amount` ou `payload.stake_amount`, nessa ordem.", "example": "250.000000000000000000" }, "currency": { "type": "string", "nullable": true, "description": "Moeda de `transaction_context.currency` ou `payload.currency`.", "maxLength": 10 }, "game_id": { "type": "string", "nullable": true, "description": "Promovido a partir de `payload.game_id`.", "maxLength": 128 }, "round_id": { "type": "string", "nullable": true, "description": "Promovido de `payload.round_id`.", "maxLength": 128 }, "bonus_id": { "type": "string", "nullable": true, "description": "Promovido a partir de `payload.bonus_id`.", "maxLength": 128 }, "affiliate_code": { "type": "string", "nullable": true, "description": "Promovido a partir de `payload.affiliate_code`.", "maxLength": 128 }, "payment_reference_id": { "type": "string", "nullable": true, "description": "Referência de pagamento obtida de `transaction_context.payment_reference_id` ou `payload.payment_reference_id`.", "maxLength": 255 }, "retention_class": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ], "description": "Classe de retenção. Eventos de pagamento e de disputa são `monetary_or_compliance`; eventos de segurança e de jogo responsável são `risk_relevant`; `session.page_view`, `session.sdk_heartbeat`, `session.sdk_loaded`, `session.device_seen`, `session.bot_signal_observed`, `bonus.promotion_viewed` e `affiliate.referral_clicked` são `low_value`; todo o resto é `standard`. Um evento correspondido por uma regra ativa é promovido para `risk_relevant` (nunca rebaixado)." }, "rules_matched_count": { "type": "integer", "minimum": 0, "description": "Número de regras que corresponderam ao evento, incluindo regras no modo `TEST` (que registram evidências, mas não aplicam nenhuma ação)." }, "correlation_pending": { "type": "boolean", "description": "`true` enquanto uma regra assíncrona (correlação entre sujeitos, ou uma sequência com mais de 24 horas) ainda precisa ser executada para este evento. Ela é resolvida em minutos, e `status`, `score` e `rules_matched_count` são atualizados no próprio registro." }, "is_droppable": { "type": "boolean", "description": "Indica se um SDK sob contrapressão pode descartar eventos deste tipo. `false` para todo evento `security`, `payment`, `dispute` e `responsible_gambling` e para `gameplay.bet_placed`, `gameplay.bet_settled` e `gameplay.p2p_settlement`." } } }, "MonitoringEventDetail": { "description": "Um evento de monitoramento com seu envelope completo, enriquecimento e evidências das regras. Todos os campos de `MonitoringEvent`, além dos campos abaixo.", "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": "Os campos da categoria que você enviou em `payload`." }, "custom_values": { "type": "object", "additionalProperties": true, "description": "Os `custom_values` escalares que você enviou. A Didit adiciona `vpn_or_proxy_detected: true` ou `is_data_center: true` quando o enriquecimento de IP sinaliza o endereço e você não os definiu." }, "device_context": { "type": "object", "additionalProperties": true, "description": "O contexto do dispositivo conforme armazenado: seu `device_context` (incluindo `fingerprint`, `persistent_device_id` e `bot_score` quando enviados) com `network_context` completado pelo enriquecimento de IP (`ip_country`, `ip_country_code`, `ip_city`, `asn_number`, `asn_organization`, `is_vpn_or_tor`, `is_data_center`, `proxy_type`, `connection_type`) nas chaves que você deixou vazias." }, "field_sources": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "customer", "sdk", "server" ] }, "description": "Caminho do campo até a procedência: `customer` (enviado pelo seu backend), `sdk` (enviado pelo canal do dispositivo) ou `server` (derivado pela Didit, como `received_at` e campos de rede enriquecidos). Verifique-o antes de agir com base em uma correspondência." }, "session_sequence": { "type": "integer", "format": "int64", "nullable": true, "description": "`session.sequence` enviado com o evento." }, "table_id": { "type": "string", "nullable": true, "description": "Promovido de `payload.table_id`.", "maxLength": 128 }, "hand_id": { "type": "string", "nullable": true, "description": "Promovido a partir de `payload.hand_id`.", "maxLength": 128 }, "match_id": { "type": "string", "nullable": true, "description": "Promovido de `payload.match_id`.", "maxLength": 128 }, "market_id": { "type": "string", "nullable": true, "description": "Promovido de `payload.market_id`.", "maxLength": 128 }, "side": { "type": "string", "nullable": true, "description": "Promovido de `payload.side`.", "maxLength": 64 }, "role": { "type": "string", "nullable": true, "description": "Promovido de `payload.role`.", "maxLength": 64 }, "net_result_amount": { "type": "string", "nullable": true, "description": "Promovido de `payload.net_result_amount`, como string decimal com 18 casas decimais.", "example": "-120.000000000000000000" }, "payment_fingerprint": { "type": "string", "nullable": true, "description": "Promovido de `payload.payment_fingerprint`.", "maxLength": 255 }, "instrument_reference_hash": { "type": "string", "nullable": true, "description": "Promovido de `payload.instrument_reference_hash`.", "maxLength": 255 }, "withdrawal_address_hash": { "type": "string", "nullable": true, "description": "Promovido de `payload.withdrawal_address_hash` (ou `payload.destination_reference_hash`).", "maxLength": 255 }, "dispute_id": { "type": "string", "nullable": true, "description": "Promovido a partir de `payload.dispute_id`.", "maxLength": 255 }, "chargeback_id": { "type": "string", "nullable": true, "description": "Promovido a partir de `payload.chargeback_id`.", "maxLength": 255 }, "changed_field": { "type": "string", "nullable": true, "description": "Promovido a partir de `payload.changed_field` (eventos de alteração de segurança).", "maxLength": 128 }, "identity_match_ref": { "type": "string", "nullable": true, "description": "Promovido a partir de `payload.identity_match_ref` (correspondências em registros de jogo responsável).", "maxLength": 255 }, "schema_version": { "type": "integer", "description": "Versão do esquema do envelope do evento. Atualmente `1`.", "example": 1 }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o evento expira conforme sua classe de retenção e é excluído: `occurred_at` mais o período da classe (14, 30 ou 90 dias por padrão, ajustável por aplicação). Nulo para eventos `monetary_or_compliance`, que seguem a retenção de transações." }, "rules_evaluated_count": { "type": "integer", "minimum": 0, "description": "Número de regras de evento avaliadas para este evento." }, "rule_runs": { "type": "array", "description": "Todas as regras que corresponderam ao evento, da mais recente para a mais antiga.", "items": { "$ref": "#/components/schemas/MonitoringEventRuleRun" } }, "ip_enrichment": { "type": "object", "nullable": true, "description": "Enriquecimento do endereço IP do evento, ou null quando o endereço não foi enriquecido. Consulte [Enriquecimento de IP](https://docs.didit.me/pt-br/transaction-monitoring/ip-enrichment).", "properties": { "ip_country_code": { "type": "string", "nullable": true, "description": "Código do país do endereço." }, "ip_city": { "type": "string", "nullable": true, "description": "Cidade do endereço." }, "asn_number": { "type": "integer", "nullable": true, "description": "Número de sistema autônomo." }, "asn_organization": { "type": "string", "nullable": true, "description": "Organização que opera o sistema autônomo." }, "is_vpn_or_tor": { "type": "boolean", "description": "Se o endereço é uma saída conhecida de VPN ou Tor." }, "is_data_center": { "type": "boolean", "description": "Se o endereço pertence a uma rede de hospedagem ou de data center." }, "proxy_type": { "type": "string", "nullable": true, "description": "Classificação de proxy do endereço como string opaca, ou null." }, "last_enriched_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o endereço foi enriquecido pela última vez." } }, "required": [ "ip_country_code", "ip_city", "asn_number", "asn_organization", "is_vpn_or_tor", "is_data_center", "proxy_type", "last_enriched_at" ] }, "subject_profile": { "type": "object", "nullable": true, "description": "Sinais de risco de e-mail e telefone do titular armazenados em cache, ou null quando não existe perfil para o titular.", "properties": { "email_risk_score": { "type": "integer", "nullable": true, "description": "Pontuação de risco do e-mail." }, "email_deliverability": { "type": "string", "nullable": true, "description": "Veredito sobre a entregabilidade do e-mail." }, "email_is_disposable": { "type": "boolean", "nullable": true, "description": "Se o endereço de e-mail é descartável." }, "email_is_breached": { "type": "boolean", "nullable": true, "description": "Se o endereço de e-mail aparece em vazamentos de dados conhecidos." }, "email_social_count": { "type": "integer", "nullable": true, "description": "Número de contas online vinculadas ao endereço de e-mail." }, "email_social_providers": { "type": "array", "items": { "type": "string" }, "description": "Nomes dos serviços online em que foi encontrada uma conta vinculada ao endereço de e-mail." }, "phone_risk_score": { "type": "integer", "nullable": true, "description": "Pontuação de risco do telefone." }, "phone_line_type": { "type": "string", "nullable": true, "description": "Tipo de linha telefônica." }, "phone_carrier": { "type": "string", "nullable": true, "description": "Nome da operadora de telefonia." }, "phone_social_count": { "type": "integer", "nullable": true, "description": "Número de contas online vinculadas ao número de telefone." }, "phone_social_providers": { "type": "array", "items": { "type": "string" }, "description": "Nomes dos serviços online em que foi encontrada uma conta vinculada ao número de telefone." }, "source_provider": { "type": "string", "nullable": true, "description": "Identificador opaco da fonte do perfil." }, "last_enriched_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o perfil foi atualizado pela última vez." } }, "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": "Nomes das tags anexadas ao evento (ações `add_tags` de regras)." } } } ] }, "MonitoringEventRuleRun": { "type": "object", "properties": { "rule_uuid": { "type": "string", "format": "uuid", "description": "UUID da regra de monitoramento de transações." }, "rule_title": { "type": "string", "description": "Título da regra." }, "library_key": { "type": "string", "nullable": true, "description": "Chave da biblioteca quando a regra foi instalada a partir da biblioteca de regras; caso contrário, null." }, "matched": { "type": "boolean", "description": "Sempre `true`: apenas as execuções com correspondência são registradas." }, "mode": { "type": "string", "enum": [ "ACTIVE", "TEST" ], "description": "Modo da regra quando ela foi executada. Uma execução `TEST` registra evidências, mas não aplicou nenhuma ação." }, "is_async": { "type": "boolean", "description": "`true` quando a execução veio da passagem assíncrona de correlação, e não da requisição de ingestão." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL", null ], "description": "Severidade da regra. Nula para execuções `TEST` e para regras sem severidade." }, "score_delta": { "type": "integer", "description": "Quanto esta execução alterou a pontuação do evento (0 para execuções `TEST`)." }, "action_summary": { "type": "string", "nullable": true, "description": "Resumo curto das ações aplicadas, por exemplo `score +40; add_tag:VPN_LOGIN`. Nulo quando nada foi aplicado." }, "matched_payload": { "type": "array", "description": "As condições e agregações que corresponderam. As entradas de condição trazem `field`, `operator`, `expected_value`, `current_value`, `matched`, `group_index`, `group_logic` e `field_source` (`server`, `sdk` ou `customer`); as entradas de agregação trazem `metric`, `field`, `operator`, `expected_value`, `computed_value`, `window`, `filters`, `matched` e `sample_references`.", "items": { "type": "object", "additionalProperties": true } }, "created_at": { "type": "string", "format": "date-time", "description": "Quando a execução da regra foi registrada." } }, "required": [ "rule_uuid", "rule_title", "library_key", "matched", "mode", "is_async", "severity", "score_delta", "action_summary", "matched_payload", "created_at" ] }, "MonitoringEventPage": { "type": "object", "description": "Uma página de eventos de monitoramento, do `occurred_at` mais recente para o mais antigo.", "required": [ "count", "next", "previous", "results" ], "properties": { "count": { "type": "integer", "description": "Número de eventos correspondentes, exato até 100 e limitado a 100 acima disso. Não calcule o número de páginas a partir dele; siga `next` até que seja nulo." }, "next": { "type": "string", "format": "uri", "nullable": true, "description": "URL da próxima página, ou null na última página." }, "previous": { "type": "string", "format": "uri", "nullable": true, "description": "URL da página anterior, ou null na primeira página." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoringEvent" } } } }, "MonitoringEventCreateRequest": { "type": "object", "description": "O envelope do evento, igual para todas as categorias. Aliases em camelCase são aceitos: `eventId`, `eventCategory` (ou `category`), `actionType`, `occurredAt`, `timeZone` (ou `zoneId`), `deviceContext` (ou `device`), `transactionContext`, `customValues` (ou `props`); dentro de `subject`: `vendorData`, `entityType`, `fullName`; dentro de `session`: `sessionId`, `pageUrl`; dentro de `transaction_context`: `paymentReferenceId`.", "required": [ "event_id", "event_category", "action_type", "occurred_at", "subject" ], "properties": { "event_id": { "type": "string", "maxLength": 128, "description": "Seu identificador do evento, único por aplicação. Ele é a chave de idempotência: reenviar os mesmos `event_category`, `action_type`, `occurred_at`, `subject.vendor_data` e `payload` com ele é uma repetição; qualquer diferença é um conflito.", "example": "login-2026-10-17-000001" }, "event_category": { "type": "string", "enum": [ "auth", "session", "gameplay", "bonus", "affiliate", "payment", "dispute", "security", "responsible_gambling", "custom" ], "description": "Categoria do evento.", "example": "auth" }, "action_type": { "type": "string", "minLength": 1, "maxLength": 128, "description": "O que aconteceu dentro da categoria. Vocabulário aberto; as ações gerenciadas listadas em [Ingestão de eventos](https://docs.didit.me/pt-br/transaction-monitoring/events) (por exemplo, `login`, `deposit_completed`, `chargeback_opened`) habilitam validação tipada e campos de regra gerenciados. Os espaços em branco no início e no fim são removidos.", "example": "login" }, "occurred_at": { "type": "string", "format": "date-time", "description": "Quando o evento ocorreu do seu lado, em ISO 8601 (um valor sem deslocamento de fuso horário é interpretado como UTC). Deve estar no máximo 7 dias no passado e no máximo 5 minutos no futuro.", "example": "2026-10-17T09:15:02.481Z" }, "time_zone": { "type": "string", "nullable": true, "maxLength": 64, "description": "Fuso horário da ocorrência do seu lado, por exemplo `Europe/Madrid`. Armazenado com o evento; não é retornado pelos endpoints de leitura." }, "subject": { "type": "object", "description": "O usuário ou a empresa a que o evento pertence. Ele é associado ao usuário (ou à empresa) com este `vendor_data` na sua aplicação; um novo é criado quando não existe nenhum.", "required": [ "vendor_data" ], "properties": { "vendor_data": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Seu ID do sujeito.", "example": "user-42" }, "entity_type": { "type": "string", "maxLength": 32, "default": "individual", "description": "`company` resolve o titular como uma empresa; qualquer outro valor (padrão `individual`) o resolve como uma pessoa física. O mesmo `vendor_data` pode identificar um de cada.", "example": "individual" }, "full_name": { "type": "string", "nullable": true, "maxLength": 512, "description": "Nome de exibição, usado apenas quando este evento cria o usuário ou a empresa." }, "email": { "type": "string", "format": "email", "nullable": true, "description": "Validado como endereço de e-mail; não é armazenado no evento." }, "phone": { "type": "string", "nullable": true, "maxLength": 32, "description": "Validado; não é armazenado no evento." }, "country": { "type": "string", "nullable": true, "maxLength": 3, "description": "Validado; não é armazenado no evento." } } }, "business": { "type": "object", "description": "A empresa à qual o evento pertence, quando difere do sujeito. Apenas `vendor_data` é lido.", "additionalProperties": true, "properties": { "vendor_data": { "type": "string", "maxLength": 255, "description": "Seu ID da empresa. Filtrável como `business_vendor_data`.", "example": "merchant-7" } } }, "session": { "type": "object", "description": "O contexto da sua sessão para o evento.", "properties": { "session_id": { "type": "string", "nullable": true, "maxLength": 255, "description": "Seu identificador de sessão. Filtrável e retornado como `session_id`." }, "sequence": { "type": "integer", "nullable": true, "description": "Posição do evento dentro da sessão. Retornada como `session_sequence`." }, "page_url": { "type": "string", "nullable": true, "maxLength": 2048, "description": "Validado; não é armazenado no evento." }, "referrer": { "type": "string", "nullable": true, "maxLength": 2048, "description": "Validado; não é armazenado no evento." } } }, "device_context": { "type": "object", "additionalProperties": true, "description": "Contexto de dispositivo e rede, armazenado como enviado e retornado por `GET /v3/events/{event_uuid}/`. Nesta via de servidor, a Didit não vê a conexão do usuário final. Por isso, o IP enriquecido e usado pelas regras é `network_context.ip_address`, exatamente como você o envia.", "properties": { "fingerprint": { "type": "string", "maxLength": 255, "description": "Impressão digital do dispositivo. Filtrável como `device_fingerprint`." }, "persistent_device_id": { "type": "string", "maxLength": 255, "description": "Seu identificador persistente do dispositivo." }, "bot_score": { "type": "integer", "description": "Pontuação de bot da sua própria detecção, como número inteiro." }, "network_context": { "type": "object", "additionalProperties": true, "properties": { "ip_address": { "type": "string", "maxLength": 64, "description": "Endereço IP do usuário final. Endereços públicos são enriquecidos uma vez por endereço único.", "example": "203.0.113.42" } } } } }, "transaction_context": { "type": "object", "description": "Contexto monetário. Valores não vazios aqui também atendem às chaves obrigatórias do payload da ação.", "properties": { "amount": { "type": "string", "nullable": true, "description": "Valor como string decimal (um número também é aceito).", "example": "1000.00" }, "currency": { "type": "string", "nullable": true, "maxLength": 10, "description": "Código da moeda." }, "direction": { "type": "string", "nullable": true, "maxLength": 16, "description": "Direção da movimentação de dinheiro, por exemplo `inbound` ou `outbound`." }, "payment_reference_id": { "type": "string", "nullable": true, "maxLength": 255, "description": "Sua referência de pagamento. Filtrável como `payment_reference_id`." } } }, "payload": { "type": "object", "additionalProperties": true, "description": "Os campos de domínio da categoria, com no máximo 16384 bytes após a codificação em JSON. Algumas ações exigem chaves (em `payload` ou `transaction_context`): `gameplay.p2p_settlement` exige `game_id`, `counterparty_vendor_data`, `stake_amount`, `net_result_amount`, `role` e um entre `hand_id`, `round_id`, `match_id`; `gameplay.bet_placed` e `gameplay.bet_settled` exigem `game_id`; `payment.deposit_initiated`, `payment.deposit_completed`, `payment.withdrawal_requested` e `payment.withdrawal_completed` exigem `payment_reference_id`, `amount`, `currency`, `payment_method`, `status`; `payment.withdrawal_address_changed` exige `withdrawal_address_hash`; `dispute.chargeback_opened`, `dispute.chargeback_won` e `dispute.chargeback_lost` exigem `payment_reference_id` e um entre `dispute_id`, `chargeback_id`; `session.bot_signal_observed` exige `telemetry_schema_version` e um entre `bot_score`, `actions_per_minute`, `timing_variance_ms`, `pointer_entropy`, `keystroke_entropy`, `reaction_time_ms_p50`; `responsible_gambling.self_exclusion_match` exige `registry_source`, `exclusion_status`, `identity_match_ref`. Toda ação `security` terminada em `_changed` exige `changed_field`, além de `previous_reference_hash` ou `new_reference_hash` quando o campo é `password`, `mfa_method`, `mfa`, `email`, `phone`, `withdrawal_address`, `payout_method` ou `api_key`. Envie hashes e referências, nunca um número de cartão, um endereço de saque completo, um hash de senha ou um segredo de MFA." }, "custom_values": { "type": "object", "description": "Até 100 chaves próprias, acessíveis nas regras como `custom_values.`. Os valores devem ser escalares (string, número, booleano ou null); objetos aninhados e arrays são rejeitados.", "additionalProperties": { "nullable": true, "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "example": { "event_id": "login-2026-10-17-000001", "event_category": "auth", "action_type": "login", "occurred_at": "2026-10-17T09:15:02.481Z", "time_zone": "Europe/Madrid", "subject": { "vendor_data": "user-42", "entity_type": "individual" }, "session": { "session_id": "web-session-abc", "sequence": 142 }, "device_context": { "fingerprint": "fp-a8c1", "network_context": { "ip_address": "203.0.113.42" } }, "payload": { "method": "password" }, "custom_values": { "vip_tier": "gold" } } }, "MonitoringEventIngestResult": { "type": "object", "description": "Resultado da ingestão de um evento. O mesmo formato é retornado para um evento novo e para uma repetição idempotente.", "required": [ "event_uuid", "event_id", "status", "score", "rules_evaluated_count", "rules_matched_count", "correlation_pending", "retention_class", "expires_at", "idempotent_replay", "rule_matches" ], "properties": { "event_uuid": { "type": "string", "format": "uuid", "description": "Identificador da Didit para o evento armazenado." }, "event_id": { "type": "string", "description": "Seu `event_id`." }, "status": { "type": "string", "enum": [ "ACCEPTED", "APPROVED", "IN_REVIEW", "DECLINED" ], "description": "Status após a execução das regras em tempo real. Consulte `MonitoringEvent.status`." }, "score": { "type": "integer", "description": "Pontuação após a execução das regras em tempo real." }, "rules_evaluated_count": { "type": "integer", "minimum": 0, "description": "Número de regras de evento avaliadas na requisição. 0 em uma aplicação de sandbox, onde nenhuma regra é executada." }, "rules_matched_count": { "type": "integer", "minimum": 0, "description": "Número de regras que corresponderam, incluindo regras no modo `TEST`." }, "correlation_pending": { "type": "boolean", "description": "`true` quando uma regra assíncrona ainda precisa ser executada. Consulte `GET /v3/events/{event_uuid}/` alguns minutos depois para obter o `status` e o `score` finais." }, "retention_class": { "type": "string", "enum": [ "low_value", "standard", "risk_relevant", "monetary_or_compliance" ], "description": "Classe de retenção, após qualquer promoção por uma regra correspondente." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o evento expira conforme sua classe de retenção e é excluído. Nulo para eventos `monetary_or_compliance` (pagamento e contestação)." }, "idempotent_replay": { "type": "boolean", "description": "`true` quando um evento com este `event_id` e o mesmo conteúdo já estava armazenado; os valores são os do evento armazenado e nenhuma regra foi executada novamente." }, "rule_matches": { "type": "array", "description": "Regras que corresponderam ao evento.", "items": { "type": "object", "required": [ "rule_id", "library_key", "mode", "is_async" ], "properties": { "rule_id": { "type": "string", "format": "uuid", "description": "UUID da regra." }, "library_key": { "type": "string", "nullable": true, "description": "Chave da biblioteca quando a regra foi instalada a partir da biblioteca de regras; caso contrário, null." }, "mode": { "type": "string", "enum": [ "ACTIVE", "TEST" ], "description": "Regras `TEST` registram a correspondência, mas não aplicam nenhuma ação." }, "is_async": { "type": "boolean", "description": "`true` quando a correspondência veio da passagem assíncrona." } } } } } }, "ComplianceList": { "type": "object", "description": "Uma lista de bloqueio, lista de permissões ou lista personalizada de uma aplicação.", "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 da lista. Use-o como `list_uuid` nos endpoints de listas e de entradas, e como valor de uma condição de regra de fluxo ou de transação com `value_type: \"list\"`." }, "name": { "type": "string", "maxLength": 255, "description": "Nome da lista, único entre as listas da aplicação." }, "description": { "type": "string", "description": "Descrição em texto livre. String vazia quando não definida." }, "list_type": { "type": "string", "enum": [ "blocklist", "allowlist", "custom" ], "description": "`blocklist`: uma correspondência recusa a sessão ou a transação (somente listas do sistema, uma por tipo de entrada). `allowlist`: os itens correspondentes são considerados confiáveis; por exemplo, uma allowlist de rostos ignora a ação de rosto duplicado; nunca prevalece sobre uma correspondência na lista de bloqueio. `custom`: usada em condições de regras de fluxo e de transação (`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": "O que a lista contém: `face`, `document` (número do documento), `phone`, `email`, `ip_address` (endereço IP ou intervalo CIDR), `device_fingerprint`, `wallet_address`, `bank_account`, `country` (ISO 3166-1 alpha-3), `user` ou `business` (seu `vendor_data`), ou `key` (qualquer string). Define como os valores das entradas são validados e comparados." }, "is_system": { "type": "boolean", "description": "`true` para as listas que a Didit provisiona: uma lista de bloqueio por tipo de entrada (`face`, `document`, `phone`, `email`, `ip_address`, `device_fingerprint`, `wallet_address`, `bank_account`, `user`, `business`), a lista personalizada **High Risk Countries** e as listas de permissão do sistema. As listas do sistema não podem ser renomeadas, editadas nem excluídas; você pode adicionar e excluir as entradas delas." }, "entry_count": { "type": "integer", "minimum": 0, "description": "Número de entradas atualmente na lista." }, "last_entry_added_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a entrada atual mais recente foi adicionada. `null` para uma lista vazia." }, "created_at": { "type": "string", "format": "date-time", "description": "Quando a lista foi criada." }, "updated_at": { "type": "string", "format": "date-time", "description": "Quando a lista foi atualizada pela última vez." } } }, "ComplianceListEntry": { "type": "object", "description": "Um valor em uma lista.", "required": [ "uuid", "value", "display_label", "comment", "added_by", "reference_session_id", "reference_session_number", "reference_session_type", "reference_object_uuid", "metadata", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador da entrada. Use-o como `entry_uuid` em Excluir uma entrada da lista." }, "value": { "type": "string", "description": "O valor listado: um número de telefone em E.164, um endereço de e-mail, um número de documento, um endereço IP ou intervalo CIDR, uma impressão digital de dispositivo, um endereço de carteira, uma conta bancária, um código de país ISO 3166-1 alpha-3, um `vendor_data`, qualquer string em uma lista `key` ou o UUID do rosto armazenado em uma lista de rostos. Os valores que você envia são armazenados em letras minúsculas, exceto números de telefone e códigos de país. A correspondência não diferencia maiúsculas de minúsculas." }, "display_label": { "type": "string", "nullable": true, "maxLength": 512, "description": "Rótulo legível. A Didit o preenche para entradas obtidas de uma sessão (por exemplo, o nome do titular e o número do documento) quando você não envia nenhum." }, "comment": { "type": "string", "description": "Nota em texto livre. String vazia quando não definida." }, "added_by": { "type": "string", "nullable": true, "description": "Quem adicionou a entrada: `api` (uma chave de API), o e-mail de um usuário do console ou `console`, `system` ou `migration` (entradas criadas pela Didit), ou `rule` (uma ação de regra de transação ou de monitoramento)." }, "reference_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Sessão de verificação da qual a entrada foi obtida. `null` quando a entrada foi adicionada por valor." }, "reference_session_number": { "type": "integer", "nullable": true, "description": "Número dessa sessão no escopo da aplicação, como exibido no console." }, "reference_session_type": { "type": "string", "nullable": true, "enum": [ "kyc", "kyb", null ], "description": "`kyc` para uma sessão de verificação de pessoa, `kyb` para uma sessão de verificação de empresa, `null` quando não há sessão." }, "reference_object_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "O registro que a entrada representa: o registro de rosto, documento, telefone ou e-mail lido de uma sessão, o rosto criado por Enviar um rosto para uma lista ou o UUID que você enviou (por exemplo, um UUID de transação ou o `didit_internal_id` de um usuário)." }, "metadata": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Contexto adicional. Contém as chaves definidas pela Didit (listadas aqui) mescladas com qualquer `metadata` que você enviou ao criar a entrada, retornadas como foram armazenadas. `null` quando não há nenhum.", "properties": { "reference_image_url": { "type": "string", "description": "Entradas de rosto: URL assinada de curta duração, emitida novamente a cada chamada; `null` para uma chave de API com escopo sem `media: read`. Ausente quando nenhuma imagem pertence à entrada." }, "front_image_url": { "type": "string", "description": "Entradas de documento que têm uma imagem da frente do documento: URL assinada de curta duração, emitida novamente a cada chamada; `null` para uma chave de API com escopo sem `media: read`." }, "full_name": { "type": "string", "description": "Entradas de documento obtidas de uma sessão: nome completo do titular." }, "issuing_state": { "type": "string", "description": "Entradas de documento obtidas de uma sessão: país emissor no formato ISO 3166-1 alpha-3." }, "document_type": { "type": "string", "description": "Entradas de documento obtidas de uma sessão: código do tipo de documento, por exemplo `P`, `ID` ou `DL`." }, "region": { "type": "string", "description": "Entradas de documento obtidas de uma sessão: estado ou província emissora de um documento emitido regionalmente, vazio quando não se aplica. Não é definido por Adicionar itens da sessão à lista de bloqueio." }, "document_number": { "type": "string", "description": "Entradas de documento obtidas de uma sessão: o número do documento." }, "face_image_source": { "type": "string", "enum": [ "front_image_camera_front", "back_image_camera_front" ], "description": "Entradas de rosto obtidas de uma selfie de captura de documento: qual selfie. Ausente para rostos de prova de vida." }, "reference_node_id": { "type": "string", "nullable": true, "description": "Entradas de rosto obtidas de uma selfie de captura de documento: o nó de Verificação de identidade de onde a selfie veio." }, "fingerprint_tier": { "type": "string", "nullable": true, "enum": [ "persistent_id", "composite_hash", "legacy_fp", "unknown", null ], "description": "Entradas de impressão digital do dispositivo obtidas de uma sessão: como a impressão digital foi derivada. `persistent_id` identifica um único dispositivo; `composite_hash` e `legacy_fp` podem ser compartilhados por dispositivos do mesmo modelo." }, "sandbox": { "type": "boolean", "description": "`true` em uma entrada facial enviada em uma aplicação de sandbox; essa entrada não corresponde a nada." }, "reference_type": { "type": "string", "enum": [ "transaction", "vendor_user", "vendor_business" ], "description": "Definido por você: aquilo para o qual `reference_object_uuid` aponta, para que o console crie um link de volta para ele." }, "reference_id": { "type": "string", "description": "Definido por você: identificador do registro de origem." } } }, "created_at": { "type": "string", "format": "date-time", "description": "Quando a entrada foi adicionada." } } }, "BlocklistedItem": { "type": "object", "description": "Um rosto, documento de identidade, número de telefone ou endereço de e-mail de uma sessão de verificação incluído na lista de bloqueio. Os campos que não se aplicam ao `type` do item são `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": "O que foi incluído na lista de bloqueio." }, "session_id": { "type": "string", "format": "uuid", "description": "Sessão de verificação à qual o item pertence." }, "session_number": { "type": "integer", "nullable": true, "description": "Número dessa sessão no escopo da aplicação, como exibido no console." }, "blocklisted_at": { "type": "string", "format": "date-time", "description": "Quando o item foi adicionado à lista de bloqueio pela última vez." }, "face_image": { "type": "string", "nullable": true, "description": "Itens de rosto: URL assinada de curta duração, emitida novamente a cada chamada; `null` para uma chave de API com escopo sem `media: read`. Também `null` quando nenhuma imagem de referência está armazenada." }, "document_type": { "type": "string", "nullable": true, "description": "Itens de documento: código do tipo de documento, por exemplo `P` (passaporte), `ID` (documento nacional de identidade), `DL` (carteira de motorista) ou `RP` (autorização de residência)." }, "document_number": { "type": "string", "nullable": true, "description": "Itens de documento: o número do documento, ou o número pessoal quando o documento não tem um." }, "front_image": { "type": "string", "nullable": true, "description": "Itens de documento: imagem da frente do documento, URL assinada de curta duração, emitida novamente a cada chamada; `null` para uma chave de API com escopo sem `media: read`." }, "phone_number": { "type": "string", "nullable": true, "description": "Itens de telefone: o número de telefone em E.164." }, "country_code": { "type": "string", "nullable": true, "description": "Itens de telefone: país do número em ISO 3166-1 alpha-2." }, "email": { "type": "string", "nullable": true, "description": "Itens de e-mail: o endereço de e-mail." } } }, "TransactionNote": { "type": "object", "description": "Uma nota na linha do tempo de revisão de uma transação monitorada.", "required": [ "uuid", "note", "actor_email", "actor_name", "metadata", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Identificador da nota." }, "note": { "type": "string", "description": "Corpo da nota em texto simples." }, "actor_email": { "type": "string", "format": "email", "nullable": true, "description": "E-mail do usuário do Console que escreveu a nota ou alterou o status. `null` para notas criadas com uma chave de API e para notas que a Didit adiciona automaticamente." }, "actor_name": { "type": "string", "nullable": true, "description": "Nome de exibição do usuário do Console (o e-mail dele quando não tem nome). `Rule Engine` nas notas que a Didit adiciona automaticamente. `null` para notas criadas com uma chave de API." }, "metadata": { "type": "object", "description": "Distingue os tipos de nota. Notas escritas pela API ou pelo Console trazem `mentioned_emails`. Uma mudança de status feita no Console traz `type: status_change` com `previous_status`, `new_status`, `reason_code` e `reason_label`. Notas adicionadas pela Didit trazem `source`: `rule_action` (com `rule_uuid`) para a ação `add_note` de uma regra, ou `remediation_session` para um problema ao criar a sessão de verificação de ação do usuário.", "properties": { "mentioned_emails": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Membros da organização mencionados, em minúsculas e sem duplicatas. Vazio quando ninguém foi mencionado." }, "type": { "type": "string", "enum": [ "status_change" ], "description": "Presente em notas que registram uma mudança de status feita no Console." }, "previous_status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Status antes da alteração." }, "new_status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Status após a alteração." }, "reason_code": { "type": "string", "nullable": true, "description": "Código do motivo informado com a alteração." }, "reason_label": { "type": "string", "nullable": true, "description": "Rótulo do motivo informado com a alteração." }, "source": { "type": "string", "enum": [ "rule_action", "remediation_session" ], "description": "Presente em notas que a Didit adiciona automaticamente." }, "rule_uuid": { "type": "string", "format": "uuid", "description": "Regra cuja ação `add_note` escreveu a nota (com `source: rule_action`)." } } }, "created_at": { "type": "string", "format": "date-time", "description": "Quando a nota foi armazenada." } } }, "TransactionSummary": { "type": "object", "description": "Resumo de uma transação monitorada, no formato listado por `GET /v3/transactions/`. Chame `GET /v3/transactions/{transaction_id}/` com `uuid` para obter partes, alertas e execuções de regras.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID da transação na Didit. Use-o como `{transaction_id}` nos endpoints de transação." }, "transaction_number": { "type": "integer", "nullable": true, "description": "Número sequencial no escopo da aplicação exibido no Console." }, "txn_id": { "type": "string", "nullable": true, "description": "Seu próprio identificador da chamada de criação. Único por aplicação." }, "transaction_type": { "type": "string", "description": "Categoria conforme armazenada: `finance`, `kyc`, `travelRule`, `userPlatformEvent`, `gamblingBet`, `gamblingLimitChange`, `gamblingBonusChange` ou `auditTrailEvent`." }, "action_type": { "type": "string", "description": "Subtipo dentro da categoria, por exemplo `withdrawal`." }, "status": { "type": "string", "enum": [ "APPROVED", "IN_REVIEW", "DECLINED", "AWAITING_USER" ], "description": "Veredito de monitoramento atual." }, "source": { "type": "string", "enum": [ "LIVE", "IMPORTED" ], "description": "`LIVE` para transações enviadas para monitoramento, `IMPORTED` para importações históricas." }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Direção em relação ao titular." }, "amount": { "type": "string", "description": "Valor como string decimal sem zeros à direita (até 18 casas decimais)." }, "currency": { "type": "string", "description": "Código da moeda ou símbolo do criptoativo de `amount`." }, "currency_type": { "type": "string", "nullable": true, "description": "`fiat` ou `crypto`, quando conhecido." }, "preferred_currency_amount": { "type": "string", "nullable": true, "description": "`amount` convertido para a moeda preferida da aplicação, quando havia uma taxa disponível." }, "preferred_currency_code": { "type": "string", "nullable": true, "description": "Moeda de `preferred_currency_amount`." }, "payment_details": { "type": "string", "nullable": true, "description": "Referência de pagamento em texto livre." }, "txn_date": { "type": "string", "format": "date-time", "description": "Quando a transação ocorreu." }, "created_at": { "type": "string", "format": "date-time", "description": "Quando a Didit o registrou." }, "score": { "type": "integer", "description": "Pontuação de risco. Quanto maior, mais arriscado." }, "severity": { "type": "string", "nullable": true, "enum": [ "UNKNOWN", "LOW", "MEDIUM", "HIGH", "CRITICAL", null ], "description": "Gravidade do risco, `null` até que algo a defina." }, "decision_reason_code": { "type": "string", "nullable": true, "description": "Motivo legível por máquina do `status` atual." }, "decision_reason_label": { "type": "string", "nullable": true, "description": "Rótulo legível de `decision_reason_code`." }, "tags": { "type": "array", "description": "Tags da transação.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string", "description": "Cor hexadecimal, por exemplo, `#F59E0B`." }, "description": { "type": "string", "nullable": true }, "source": { "type": "string", "enum": [ "didit", "custom" ], "description": "Tag predefinida da Didit ou personalizada." } } } }, "subject_name": { "type": "string", "nullable": true, "description": "Nome completo da parte `APPLICANT`." }, "subject_vendor_data": { "type": "string", "nullable": true, "description": "Seu `vendor_data` do solicitante." }, "subject_type": { "type": "string", "nullable": true, "enum": [ "user", "business", null ], "description": "Se o solicitante está vinculado a um usuário ou a uma empresa da Didit; `null` quando não está vinculado a nenhum dos dois." }, "subject_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "UUID do usuário ou da empresa Didit ao qual o solicitante está vinculado." }, "subject_country": { "type": "string", "nullable": true, "description": "Código do país do solicitante." }, "counterparty_name": { "type": "string", "nullable": true, "description": "Nome completo da parte `COUNTERPARTY`, se houver." }, "counterparty_vendor_data": { "type": "string", "nullable": true, "description": "Seu `vendor_data` da contraparte." }, "counterparty_country": { "type": "string", "nullable": true, "description": "Código do país da contraparte." }, "assigned_to_name": { "type": "string", "nullable": true, "description": "Nome do revisor do Console atribuído à transação." }, "travel_rule_status": { "type": "string", "nullable": true, "description": "Status da transferência de Travel Rule da transação, ou `null` quando ela não tem nenhuma." }, "application_id": { "type": "string", "format": "uuid", "description": "Aplicação à qual a transação pertence." }, "application_name": { "type": "string", "nullable": true, "description": "Nome dessa aplicação." }, "organization_id": { "type": "string", "format": "uuid", "description": "Organização proprietária da aplicação." }, "organization_name": { "type": "string", "nullable": true, "description": "Nome dessa organização." } } }, "ApplicationAnalyticsDataPoint": { "type": "object", "description": "Contagens de sessões de um dia, por data de criação (UTC). Cada contagem reflete o status atual da sessão. Os pontos do período anterior contêm pelo menos os campos obrigatórios.", "required": [ "rounded_date", "total", "approved", "declined", "canceled", "pending" ], "properties": { "rounded_date": { "type": "string", "format": "date", "description": "O dia, `YYYY-MM-DD`." }, "total": { "type": "integer", "description": "Sessões criadas naquele dia." }, "approved": { "type": "integer", "description": "Dessas, as sessões `Approved` ou `Kyc Expired`." }, "declined": { "type": "integer", "description": "Sessões `Declined`." }, "canceled": { "type": "integer", "description": "Sessões `Expired` ou `Abandoned`." }, "pending": { "type": "integer", "description": "Sessões `Not Started`, `In Progress` ou `In Review`." }, "in_review": { "type": "integer", "description": "Sessões `In Review`." }, "expired": { "type": "integer", "description": "Sessões `Expired`." }, "abandoned": { "type": "integer", "description": "Sessões `Abandoned`." }, "in_progress": { "type": "integer", "description": "Sessões `In Progress`." }, "not_started": { "type": "integer", "description": "Sessões `Not Started`." }, "manually_approved": { "type": "integer", "description": "Sessões que um revisor aprovou depois que o fluxo deu outro veredito." }, "manually_declined": { "type": "integer", "description": "Sessões que um revisor recusou depois que o fluxo deu outro veredito." } } }, "ApplicationAnalyticsRequestBreakdown": { "type": "object", "description": "Totais por status no intervalo. O detalhamento do período anterior contém pelo menos os campos obrigatórios.", "required": [ "total_approved", "total_in_review", "total_declined", "total_canceled", "total_pending" ], "properties": { "total_approved": { "type": "integer", "description": "Sessões `Approved` ou `Kyc Expired`." }, "total_in_review": { "type": "integer", "description": "Sessões `In Review`." }, "total_declined": { "type": "integer", "description": "Sessões `Declined`." }, "total_canceled": { "type": "integer", "description": "Sessões `Expired` ou `Abandoned`." }, "total_pending": { "type": "integer", "description": "Sessões `Not Started`, `In Progress` ou `In Review` (inclui `total_in_review`)." }, "total_expired": { "type": "integer", "description": "Sessões `Expired`." }, "total_abandoned": { "type": "integer", "description": "Sessões `Abandoned`." }, "total_in_progress": { "type": "integer", "description": "Sessões `In Progress`." }, "total_not_started": { "type": "integer", "description": "Sessões `Not Started`." }, "total_manually_approved": { "type": "integer", "description": "Aprovado por um revisor." }, "total_manually_declined": { "type": "integer", "description": "Recusado por um revisor." } } }, "ApplicationAnalyticsCountryCount": { "type": "object", "properties": { "country": { "type": "string", "description": "Nome do país." }, "country_code": { "type": "string", "description": "Código de país de duas letras." }, "session_count": { "type": "integer", "description": "Sessões daquele país." } } }, "ApplicationAnalyticsLocationStats": { "type": "object", "properties": { "ip_countries": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsCountryCount" }, "description": "Países dos endereços IP dos usuários, do que tem mais sessões para o que tem menos." }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsCountryCount" }, "description": "A mesma lista de `ip_countries`." }, "id_countries": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsCountryCount" }, "description": "Países emissores dos documentos de identidade verificados, começando pelos que têm mais sessões." }, "conversion_by_country": { "type": "array", "description": "Por país emissor do documento: sessões finalizadas (aprovadas, recusadas ou em revisão) e quantas foram aprovadas. As com mais sessões finalizadas aparecem primeiro.", "items": { "type": "object", "properties": { "country": { "type": "string" }, "country_code": { "type": "string" }, "finished": { "type": "integer" }, "approved": { "type": "integer" } } } }, "cities": { "type": "array", "description": "Até 100 cidades de IP, primeiro as que têm mais sessões.", "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": "Sessões por faixa etária segundo o documento de identidade. Vazio quando não há dados.", "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": "Sessões por código de gênero do documento: `M`, `F` ou `U` (desconhecido).", "additionalProperties": { "type": "integer" } } } }, "ApplicationAnalyticsDeviceDetails": { "type": "object", "description": "Os cinco primeiros de cada, do maior para o menor número de sessões.", "properties": { "device_models": { "type": "array", "description": "Marcas de dispositivo: `Apple`, `Android` e `LG`. Todas as demais são agrupadas como `Other`.", "items": { "type": "object", "properties": { "device": { "type": "string" }, "count": { "type": "integer" } } } }, "browsers": { "type": "array", "description": "Navegadores: `Chrome`, `Safari`, `Didit App`, `Firefox`; todos os demais são agrupados como `Other`.", "items": { "type": "object", "properties": { "browser": { "type": "string" }, "count": { "type": "integer" } } } }, "operating_systems": { "type": "array", "description": "Sistemas operacionais.", "items": { "type": "object", "properties": { "os": { "type": "string" }, "count": { "type": "integer" } } } } } }, "ApplicationAnalyticsWorkflowFunnel": { "type": "object", "description": "Indexado por ID do fluxo. `total` são as sessões iniciadas nesse fluxo; `steps` conta as sessões que chegaram a cada etapa (`OCR`, `LIVENESS`, `FACE_MATCH`, `AML`, `POA`, `PHONE`, `EMAIL`, `NFC`, `DATABASE_VALIDATION`, `QUESTIONNAIRE`, `IP_ANALYSIS`, `AGE_ESTIMATION`, `KYB_REGISTRY`, `KYB_DOCUMENTS`, `KYB_KEY_PEOPLE`). Chegar a uma etapa não significa ser aprovado nela.", "additionalProperties": { "type": "object", "properties": { "total": { "type": "integer" }, "steps": { "type": "object", "additionalProperties": { "type": "object", "properties": { "reached": { "type": "integer" } } } } } } }, "ApplicationAnalyticsVerificationTimeStats": { "type": "object", "description": "Tempo ativo que os usuários passaram na verificação, desconsiderando os intervalos de inatividade. Um objeto vazio quando não há dados.", "properties": { "overall_avg_seconds": { "type": "number", "description": "Média por sessão, com uma casa decimal." }, "overall_count": { "type": "integer", "description": "Sessões medidas." }, "per_feature": { "type": "object", "description": "Indexado por recurso, por exemplo `OCR` ou `LIVENESS`.", "additionalProperties": { "type": "object", "properties": { "avg_seconds": { "type": "number" }, "total_seconds": { "type": "number" }, "count": { "type": "integer" } } } }, "per_sub_step": { "type": "object", "description": "Indexado por recurso e depois por subetapa, por exemplo `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": "Sessões concluídas sem reenvio." }, "second": { "type": "integer", "description": "Sessões concluídas reenviadas uma vez." }, "third_plus": { "type": "integer", "description": "Sessões concluídas reenviadas duas ou mais vezes." }, "abandoned": { "type": "integer", "description": "Sessões abandonadas." } } }, "ApplicationAnalyticsOriginalStatusStats": { "type": "object", "description": "O veredito automático do fluxo, antes de qualquer alteração por um revisor.", "properties": { "approved": { "type": "integer" }, "in_review": { "type": "integer" }, "declined": { "type": "integer" } } }, "ApplicationAnalyticsWarningStats": { "type": "object", "description": "Indexado por recurso (`ID_VERIFICATION`, `LIVENESS`, `FACEMATCH`, `AML`, `PROOF_OF_ADDRESS`, `PHONE`, `EMAIL`, `NFC`, `LOCATION`, `DATABASE_VALIDATION`, `QUESTIONNAIRE` e os recursos de KYB). `total` são as sessões que chegaram ao recurso; `risks` conta as sessões por código e nível de aviso.", "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": "Chave do período: `YYYY-MM-DD` para um dia, a segunda-feira de uma semana, ou `YYYY-MM` para um mês, conforme `grouping_mode`." }, "age_distribution": { "type": "object", "additionalProperties": { "type": "integer" } }, "gender_distribution": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "ApplicationAnalyticsDevicePoint": { "type": "object", "properties": { "date": { "type": "string", "description": "Chave do período: `YYYY-MM-DD` para um dia, a segunda-feira de uma semana, ou `YYYY-MM` para um mês, conforme `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": "Chave do período: `YYYY-MM-DD` para um dia, a segunda-feira de uma semana, ou `YYYY-MM` para um mês, conforme `grouping_mode`." }, "overall_avg": { "type": "number", "description": "Média de segundos ativos por sessão." }, "per_feature": { "type": "object", "description": "Média de segundos ativos por recurso.", "additionalProperties": { "type": "number" } } } }, "ApplicationAnalyticsResubmissionPoint": { "type": "object", "properties": { "date": { "type": "string", "description": "Chave do período: `YYYY-MM-DD` para um dia, a segunda-feira de uma semana, ou `YYYY-MM` para um mês, conforme `grouping_mode`." }, "first_pass": { "type": "integer" }, "second": { "type": "integer" }, "third_plus": { "type": "integer" }, "abandoned": { "type": "integer" } } }, "ApplicationAnalyticsOriginalStatusPoint": { "type": "object", "properties": { "date": { "type": "string", "description": "Chave do período: `YYYY-MM-DD` para um dia, a segunda-feira de uma semana, ou `YYYY-MM` para um mês, conforme `grouping_mode`." }, "approved": { "type": "integer" }, "in_review": { "type": "integer" }, "declined": { "type": "integer" } } }, "ApplicationAnalyticsSummary": { "type": "object", "description": "Resumo da verificação de usuários (KYC), retornado quando nem `scope` nem `widget_keys` são enviados.", "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": "Um ponto por dia, do primeiro dia com sessões no intervalo até `end_date`. Sempre diário, independentemente do que `grouping_mode` indicar." }, "request_breakdown": { "$ref": "#/components/schemas/ApplicationAnalyticsRequestBreakdown" }, "previous_data_points": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDataPoint" }, "description": "Pontos diários do período de mesma duração imediatamente anterior a `start_date`." }, "previous_request_breakdown": { "$ref": "#/components/schemas/ApplicationAnalyticsRequestBreakdown" }, "conversion_rate": { "type": "number", "nullable": true, "description": "`total_approved / (total_approved + total_declined + total_in_review) x 100`, com uma casa decimal. `null` quando nada foi concluído." }, "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": "Como as listas `*_time_series` são agrupadas: `day` para até 14 dias, `week` até 90, `month` acima disso. Medido a partir do primeiro dia com sessões no intervalo." }, "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": "Um widget do painel. Todo widget tem `kind` e `title`; os demais campos dependem de `kind`. Os widgets de sessão reutilizam os objetos de resumo (`data_points`, `request_breakdown`, `workflow_funnel_stats` etc.); os widgets de lista colocam suas entradas em `items`; as métricas de transação usam `value`.", "required": [ "kind", "title" ], "properties": { "kind": { "type": "string", "enum": [ "sessions_volume", "workflow_funnel", "average_verification_time", "country_distribution", "warning_insights", "conversion_rate", "conversion_by_country", "resubmission_insights", "original_status_distribution", "database_validation_coverage", "database_validation_latency", "demographics", "device_details", "horizontal_bar", "kyb_registry_coverage", "kyb_registry_data_completeness", "metric", "time_series", "breakdown", "status_time_series", "leaderboard", "histogram" ], "description": "Tipo de widget." }, "title": { "type": "string", "description": "Título de exibição, por exemplo `Verification volume`." }, "grouping_mode": { "type": "string", "enum": [ "day", "week", "month" ], "description": "Como as listas `*_time_series` são agrupadas: `day` para até 14 dias, `week` até 90, `month` acima disso. Medido a partir do primeiro dia com sessões no intervalo." }, "data_points": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDataPoint" } }, "request_breakdown": { "$ref": "#/components/schemas/ApplicationAnalyticsRequestBreakdown" }, "previous_data_points": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDataPoint" } }, "previous_request_breakdown": { "$ref": "#/components/schemas/ApplicationAnalyticsRequestBreakdown" }, "conversion_rate": { "type": "number", "nullable": true }, "workflow_funnel_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsWorkflowFunnel" }, "verification_time_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsVerificationTimeStats" }, "verification_time_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsVerificationTimePoint" } }, "warning_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsWarningStats" }, "resubmission_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsResubmissionStats" }, "resubmission_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsResubmissionPoint" } }, "original_status_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsOriginalStatusStats" }, "original_status_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsOriginalStatusPoint" } }, "demographic_stats": { "$ref": "#/components/schemas/ApplicationAnalyticsDemographicStats" }, "demographic_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDemographicPoint" } }, "device_details": { "$ref": "#/components/schemas/ApplicationAnalyticsDeviceDetails" }, "device_time_series": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAnalyticsDevicePoint" } }, "items": { "type": "array", "description": "Entradas de um widget de lista. `country_distribution` (KYC): `country`, `country_code`, `session_count`. `conversion_by_country`: `country`, `country_code`, `finished`, `approved`. `time_series`: `date`, `value`. `status_time_series`: `date`, `approved`, `declined`, `flagged`. `breakdown`: `transaction_type` ou `action_type` com `count` e `volume`, ou `tag_id`, `tag_name`, `count`. `leaderboard`: `rule_title`, `trigger_count` ou `assignee`, `handled_count`, `average_processing_seconds`, cada um com `approved_percentage`, `declined_percentage`, `flagged_percentage`. `histogram`: `score`, `count`.", "items": { "type": "object", "additionalProperties": {} } }, "previous_items": { "type": "array", "description": "Série temporal de transações do período de mesma duração imediatamente anterior a `start_date`.", "items": { "type": "object", "additionalProperties": {} } }, "value": { "type": "number", "description": "Widgets `metric`: o valor para o período." }, "currency": { "type": "string", "nullable": true, "description": "Widgets de volume e valor de transações: a moeda de transação padrão da aplicação." }, "thresholds": { "type": "object", "description": "Widget `histogram`: os limiares de pontuação de revisão e de recusa da aplicação.", "properties": { "review": { "type": "integer" }, "decline": { "type": "integer" } } }, "search": { "type": "object", "description": "Widget `kyb_registry_coverage`: totais de buscas em registros.", "properties": { "searches_total": { "type": "integer" }, "searches_with_no_candidates": { "type": "integer" } } } } }, "ApplicationAnalyticsWidgetResponse": { "type": "object", "description": "Widgets do painel, retornados quando `scope` ou `widget_keys` é enviado.", "required": [ "scope", "available_widget_keys", "requested_widget_keys", "widgets" ], "properties": { "scope": { "type": "string", "enum": [ "home", "kyc", "kyb", "transactions" ], "description": "Aba do painel." }, "available_widget_keys": { "type": "array", "items": { "type": "string" }, "description": "Todas as chaves de widget que este escopo aceita." }, "requested_widget_keys": { "type": "array", "items": { "type": "string" }, "description": "As chaves do widget respondidas, em ordem: suas `widget_keys` válidas ou os padrões do escopo." }, "widgets": { "type": "object", "description": "Indexado pela chave do widget, na ordem de `requested_widget_keys`.", "additionalProperties": { "$ref": "#/components/schemas/ApplicationAnalyticsWidget" } } } }, "ApplicationAnalyticsToday": { "type": "object", "description": "Verificações de hoje por hora local em comparação com o mesmo dia da semana na semana passada.", "required": [ "time_zone", "date", "current_hour", "previous_date", "hours", "previous_hours", "total", "previous_total_so_far", "outcomes" ], "properties": { "time_zone": { "type": "string", "description": "O fuso horário IANA em que estão o dia e suas horas.", "example": "Europe/Madrid" }, "date": { "type": "string", "format": "date", "description": "Hoje nesse fuso horário.", "example": "2026-10-30" }, "current_hour": { "type": "integer", "minimum": 0, "maximum": 23, "description": "A hora local atual.", "example": 14 }, "previous_date": { "type": "string", "format": "date", "description": "O dia de comparação: o mesmo dia da semana, uma semana antes.", "example": "2026-10-23" }, "hours": { "type": "array", "items": { "type": "integer", "minimum": 0 }, "minItems": 24, "maxItems": 24, "description": "Verificações criadas hoje, por hora local a partir de 00:00. As horas que ainda não chegaram são 0." }, "previous_hours": { "type": "array", "items": { "type": "integer", "minimum": 0 }, "minItems": 24, "maxItems": 24, "description": "Verificações criadas no dia de comparação, por hora local a partir de 00:00." }, "total": { "type": "integer", "minimum": 0, "description": "Verificações criadas hoje até o momento.", "example": 165 }, "previous_total_so_far": { "type": "integer", "minimum": 0, "description": "Verificações criadas no dia de comparação até o mesmo horário local.", "example": 151 }, "outcomes": { "type": "object", "description": "Das verificações de hoje, quantas estão aprovadas, pendentes em revisão e recusadas no momento. As demais ainda não foram concluídas.", "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": "Um destino do webhook conforme listado na configuração de webhooks, sem métricas de entrega. `GET /v3/webhook/destinations/{destination_uuid}/` adiciona o resumo de entrega dele.", "required": [ "uuid", "label", "url", "enabled", "webhook_version", "secret_shared_key", "subscribed_events", "created_at", "updated_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID do destino." }, "label": { "type": "string", "maxLength": 255, "description": "Nome legível." }, "url": { "type": "string", "format": "uri", "maxLength": 2000, "description": "Endpoint HTTPS para o qual a Didit envia os eventos." }, "enabled": { "type": "boolean", "description": "`false` pausa as entregas para este destino." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Versão do payload enviada a este destino." }, "secret_shared_key": { "type": "string", "description": "O segredo de assinatura deste destino (token URL-safe de 43 caracteres). Verifique cada webhook com o segredo do destino para o qual ele foi enviado. Chamadas com chave de API sempre o recebem completo; usuários do Console sem `read:webhooks` recebem uma string vazia." }, "subscribed_events": { "type": "array", "uniqueItems": true, "description": "Tipos de evento entregues a este destino. Vazio quando o destino foi criado sem eventos; nesse caso, ele não recebe nada.", "items": { "$ref": "#/components/schemas/WebhookEvent" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "WebhookConfig": { "type": "object", "description": "Configuração de webhook no nível da aplicação, política de retenção e hosts de retorno da carteira Digital ID, com todos os destinos de webhook.", "required": [ "webhook_url", "webhook_version", "secret_shared_key", "capture_method", "data_retention_months", "face_retention_policy", "face_retention_days", "available_events", "allowed_return_hosts", "endpoints" ], "properties": { "webhook_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL de webhook no nível da aplicação (legado). A Didit envia para ela somente enquanto a aplicação não tiver nenhum destino habilitado e, nesse caso, apenas `status.updated` e `data.updated`. Cada criação, atualização ou exclusão de um destino define essa URL como a do destino habilitado mais antigo, ou como `null` quando nenhum estiver habilitado." }, "webhook_version": { "type": "string", "enum": [ "v1", "v2", "v3" ], "description": "Versão do payload do `webhook_url` legado. Cada destino tem seu próprio `webhook_version`." }, "secret_shared_key": { "type": "string", "description": "Segredo de assinatura no nível da aplicação (token de 43 caracteres seguro para URL). Ele assina apenas as entregas para o `webhook_url` legado; cada destino assina com seu próprio `secret_shared_key`. Chamadores com chave de API sempre o recebem completo; usuários do Console sem `read:webhooks` recebem uma string vazia." }, "capture_method": { "type": "string", "enum": [ "MOBILE", "MOBILE_AND_DESKTOP" ], "description": "Configuração legada da aplicação. O fluxo de verificação não a lê: as opções de captura são configuradas por fluxo." }, "data_retention_months": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 120, "description": "Janela de exclusão automática. Sessões de verificação de usuário criadas há mais desse número de meses (um mês equivale a 30 dias) são excluídas automaticamente, e essa exclusão é irreversível. `null` significa que as sessões nunca são excluídas automaticamente. Consulte [Retenção de dados](https://docs.didit.me/pt-br/console/data-retention)." }, "face_retention_policy": { "type": "string", "enum": [ "delete_with_session", "retain_until_user_deleted" ], "description": "O que acontece com o embedding facial de uma sessão quando a sessão é excluída. `delete_with_session` (padrão) o exclui junto com a sessão. `retain_until_user_deleted` é a [retenção de template biométrico](https://docs.didit.me/pt-br/console/data-retention#retenção-de-template-biométrico) opcional: um template biométrico sem imagem vinculado ao User é gerenciado separadamente até que seu período de retenção termine, o User seja excluído ou você o remova." }, "face_retention_days": { "type": "integer", "nullable": true, "minimum": 1, "maximum": 3650, "description": "Período de retenção, em dias, dos templates biométricos sob `retain_until_user_deleted`. Obrigatório quando essa política estiver definida." }, "biometric_consent_mode": { "type": "string", "enum": [ "auto", "always", "never" ], "description": "Quando o fluxo hospedado e os SDKs nativos pedem à pessoa consentimento biométrico explícito antes de uma captura facial. `auto` (padrão) pede apenas quando um gatilho se aplica: um estado declarado, o IP da pessoa ou o emissor do documento de identidade está em Illinois, Texas ou Colorado, ou a pessoa parece estar nos EUA sem um estado conhecido. `always` pede a toda pessoa cujo fluxo captura um rosto. `never` nunca mostra a etapa, e você mesmo coleta o consentimento antes da selfie. Cada alteração é registrada no registro de auditoria. Veja [Consentimento biométrico](https://docs.didit.me/pt-br/getting-started/biometric-consent)." }, "available_events": { "type": "array", "description": "Todos os tipos de evento que um destino pode assinar, com um rótulo de exibição.", "items": { "type": "object", "required": [ "value", "label" ], "properties": { "value": { "$ref": "#/components/schemas/WebhookEvent" }, "label": { "type": "string", "description": "Rótulo de exibição, por exemplo `Session status updated`." } } } }, "allowed_return_hosts": { "type": "array", "maxItems": 20, "description": "Nomes de host (correspondência exata, somente HTTPS) para os quais uma verificação avulsa de carteira Digital ID pode redirecionar o usuário com seu `return_url`. Seu domínio de marca própria também é sempre permitido. Consulte [Registre seu destino de retorno](https://docs.didit.me/pt-br/standalone-apis/digital-id-wallets#registre-o-seu-destino-de-retorno).", "items": { "type": "string", "maxLength": 253 } }, "endpoints": { "type": "array", "description": "Todos os destinos de webhook da aplicação, do mais antigo para o mais recente, cada um com seu segredo de assinatura. Somente leitura aqui: gerencie os destinos com os endpoints `/v3/webhook/destinations/`.", "items": { "$ref": "#/components/schemas/WebhookConfigDestination" } }, "allowed_domains": { "type": "array", "maxItems": 50, "items": { "type": "string", "maxLength": 300 }, "description": "Origens (por exemplo `https://app.example.com`; `http` apenas para `localhost`) nas quais o fluxo de verificação hospedado pode ser incorporado e para as quais ele pode enviar o usuário de volta com um callback de sessão. Chamadas servidor a servidor não são afetadas. Uma lista vazia significa nenhuma restrição. A Didit armazena cada origem em letras minúsculas, sem porta padrão. Uma entrada inválida falha com `400` em `allowed_domains`.", "example": [ "https://app.example.com" ] } } }, "WebhookDestinationDelivery": { "type": "object", "description": "Uma tentativa de entrega a um destino do webhook. O primeiro envio de um evento, cada nova tentativa automática e cada reenvio são entregas separadas.", "required": [ "uuid", "session_id", "request_url", "response_status", "response_time_ms", "status", "webhook_type", "created_at" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "ID da entrega, para as chamadas de detalhe e reenvio." }, "session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Sessão de verificação de usuário à qual o evento se refere. `null` para eventos de sessão de empresa, usuário, empresa, transação, Travel Rule e fluxo." }, "request_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL para a qual a entrega foi enviada: a URL do destino no momento em que o evento foi gerado." }, "response_status": { "type": "integer", "nullable": true, "description": "Status HTTP que seu endpoint retornou. `null` enquanto a entrega está na fila e ainda não foi tentada. Quando nenhuma resposta HTTP é recebida, a Didit registra um status próprio: `504` quando seu endpoint não respondeu em 5 segundos, `503` para falha de conexão, `400` quando a URL foi recusada como insegura (por exemplo, um endereço privado ou interno) e `404` para qualquer outro erro de requisição. `400` ou acima conta como entrega com falha." }, "response_time_ms": { "type": "integer", "nullable": true, "minimum": 0, "description": "Tempo que a tentativa levou, em milissegundos. `null` enquanto a entrega está na fila." }, "status": { "type": "string", "nullable": true, "description": "Status informado pelo evento quando ele foi gerado: o status da sessão para eventos de sessão (por exemplo, `Approved` ou `In Review`), o status da pessoa ou da empresa para eventos de usuário e de empresa, e o status da transação para eventos de transação. `null` para eventos que não têm status." }, "webhook_type": { "$ref": "#/components/schemas/WebhookEvent" }, "created_at": { "type": "string", "format": "date-time", "description": "Quando a entrega foi criada." } } }, "WebhookDestinationDeliveryDetail": { "type": "object", "description": "Uma tentativa de entrega a um destino do webhook, com os cabeçalhos e o corpo exatos da requisição que a Didit enviou.", "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 da entrega, para as chamadas de detalhe e reenvio." }, "session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Sessão de verificação de usuário à qual o evento se refere. `null` para eventos de sessão de empresa, usuário, empresa, transação, Travel Rule e fluxo." }, "request_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL para a qual a entrega foi enviada: a URL do destino no momento em que o evento foi gerado." }, "response_status": { "type": "integer", "nullable": true, "description": "Status HTTP que seu endpoint retornou. `null` enquanto a entrega está na fila e ainda não foi tentada. Quando nenhuma resposta HTTP é recebida, a Didit registra um status próprio: `504` quando seu endpoint não respondeu em 5 segundos, `503` para falha de conexão, `400` quando a URL foi recusada como insegura (por exemplo, um endereço privado ou interno) e `404` para qualquer outro erro de requisição. `400` ou acima conta como entrega com falha." }, "response_time_ms": { "type": "integer", "nullable": true, "minimum": 0, "description": "Tempo que a tentativa levou, em milissegundos. `null` enquanto a entrega está na fila." }, "status": { "type": "string", "nullable": true, "description": "Status informado pelo evento quando ele foi gerado: o status da sessão para eventos de sessão (por exemplo, `Approved` ou `In Review`), o status da pessoa ou da empresa para eventos de usuário e de empresa, e o status da transação para eventos de transação. `null` para eventos que não têm status." }, "webhook_type": { "$ref": "#/components/schemas/WebhookEvent" }, "created_at": { "type": "string", "format": "date-time", "description": "Quando a entrega foi criada." }, "request_header": { "type": "string", "description": "Texto JSON (uma string) dos cabeçalhos da requisição que a Didit enviou: `Content-Type`, `X-Signature`, `X-Signature-V2`, `X-Signature-Simple`, `X-Timestamp` e `User-Agent`. Analise-o com um parser JSON. Ele contém assinaturas, nunca o segredo de assinatura." }, "request_body": { "type": "string", "description": "Texto JSON (uma string) do payload exato que a Didit enviou, com as chaves ordenadas, incluindo `event_id` e `timestamp`. Analise-o com um parser JSON; consulte [Formato do payload](https://docs.didit.me/pt-br/integration/webhooks#formato-do-payload). Para uma chave com escopo sem `media: read`, as URLs de mídia dentro dele são `null`; sem `sessions: write`, os tokens de sessão e os links de verificação hospedados são `null`. Um corpo alterado dessa forma não corresponde mais às suas assinaturas. A Didit não registra o corpo da resposta que o seu endpoint retornou." } } }, "SessionWebhookDelivery": { "type": "object", "description": "Uma tentativa de entrega de webhook registrada para uma sessão de verificação, com os cabeçalhos e o corpo exatos da requisição que a Didit enviou.", "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 da entrega. Use-o como `{webhook_uuid}` para obter ou reenviar esta entrega." }, "session_id": { "type": "string", "format": "uuid", "description": "A sessão à qual a entrega pertence (a sessão no caminho)." }, "request_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL para a qual a entrega foi enviada." }, "response_status": { "type": "integer", "nullable": true, "description": "Status HTTP que seu endpoint retornou. `null` enquanto a entrega está na fila e ainda não foi tentada. Quando nenhuma resposta HTTP é recebida, a Didit registra um status próprio: `504` quando seu endpoint não respondeu em 5 segundos, `503` para falha de conexão, `400` quando a URL foi recusada como insegura (por exemplo, um endereço privado ou interno) e `404` para qualquer outro erro de requisição. `400` ou acima conta como entrega com falha." }, "status": { "type": "string", "nullable": true, "description": "Status da sessão quando o evento foi gerado, por exemplo `In Progress`, `Approved` ou `Declined`." }, "webhook_type": { "$ref": "#/components/schemas/WebhookEvent" }, "request_header": { "type": "string", "description": "Texto JSON (uma string) dos cabeçalhos da requisição que a Didit enviou: `Content-Type`, `X-Signature`, `X-Signature-V2`, `X-Signature-Simple`, `X-Timestamp` e `User-Agent`. Analise-o com um parser JSON. Ele contém assinaturas, nunca o segredo de assinatura." }, "request_body": { "type": "string", "description": "Texto JSON (uma string) do payload exato que a Didit enviou, com as chaves ordenadas, incluindo `event_id` e `timestamp`. Analise-o com um parser JSON; consulte [Formato do payload](https://docs.didit.me/pt-br/integration/webhooks#formato-do-payload). Para uma chave com escopo sem `media: read`, as URLs de mídia dentro dele são `null`; sem `sessions: write`, os tokens de sessão e os links de verificação hospedados são `null`. Um corpo alterado dessa forma não corresponde mais às suas assinaturas. A Didit não registra o corpo da resposta que o seu endpoint retornou." }, "created_at": { "type": "string", "format": "date-time", "description": "Quando a entrega foi criada." } } }, "SessionEvent": { "type": "object", "description": "Uma entrada da linha do tempo de eventos de uma sessão de verificação.", "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 do evento." }, "event_type": { "type": "string", "enum": [ "SESSION_CREATED", "SESSION_COMPLETED", "SESSION_STATUS_CHANGED", "LINK_OPENED", "FORM_SUBMITTED", "BUTTON_CLICKED", "FILE_UPLOADED", "ATTEMPT_FAILED", "FEATURE_STEP_CHANGED", "STEP_RENDERED", "NOTE_ADDED", "MANUAL_REVIEW_STARTED", "WORKFLOW_BRANCH_EVALUATED", "WORKFLOW_STATUS_NODE_REACHED", "LOG" ], "description": "O que aconteceu. Informados pelo dispositivo durante o fluxo hospedado ou o SDK: `LINK_OPENED`, `STEP_RENDERED`, `BUTTON_CLICKED`, `FORM_SUBMITTED`, `FILE_UPLOADED`, `ATTEMPT_FAILED` e `LOG` (depuração). Registrados pelo 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` e `WORKFLOW_STATUS_NODE_REACHED` (o rastreamento do roteamento do fluxo). `SESSION_COMPLETED`, `NOTE_ADDED` e `MANUAL_REVIEW_STARTED` podem aparecer em sessões mais antigas." }, "created_at": { "type": "string", "format": "date-time", "description": "Quando a Didit armazenou o evento. Os eventos são armazenados de forma assíncrona, alguns segundos após `sent_at`." }, "component": { "type": "string", "nullable": true, "description": "Componente de interface que reportou o evento (somente eventos de dispositivo)." }, "feature_step": { "type": "string", "nullable": true, "enum": [ "OCR", "OCR_BACK", "NFC", "AML", "FACE", "LIVENESS", "FACE_MATCH", "IP_ANALYSIS", "AGE_ESTIMATION", "PROOF_OF_ADDRESS", "PHONE_VERIFICATION", "EMAIL_VERIFICATION", "FACE_SEARCH", "DATABASE_VALIDATION", "QUESTIONNAIRE", "KYB_REGISTRY", "KYB_DOCUMENTS", "KYB_KEY_PEOPLE", "DOCUMENT_AI", "GEOLOCATION", null ], "description": "Recurso de verificação em que a sessão estava quando o evento ocorreu." }, "step": { "type": "string", "nullable": true, "description": "Tela dentro do recurso, por exemplo `DOCUMENT_CAPTURE_FRONT` ou `FACE_PASSIVE_LIVENESS`." }, "details": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Dados específicos do evento. As chaves dependem de `event_type`." }, "ip_address": { "type": "string", "nullable": true, "description": "Endereço IP a partir do qual o dispositivo informou o evento. `null` para eventos registrados pelo servidor." }, "user_agent": { "type": "string", "nullable": true, "description": "User agent do dispositivo. `null` para eventos registrados pelo servidor." }, "device_info": { "type": "object", "nullable": true, "additionalProperties": true, "description": "Detalhes do dispositivo informados pelo SDK ou pelo navegador." }, "file_url": { "type": "string", "format": "uri", "nullable": true, "description": "Link pré-assinado de curta duração para um arquivo anexado ao evento (por exemplo, uma imagem capturada). `null` quando não há nenhum e sempre `null` para uma chave de API com escopo sem `media: read`." }, "sent_at": { "type": "integer", "format": "int64", "description": "Quando o evento ocorreu, como timestamp Unix em milissegundos. Os resultados são ordenados por ele." } } }, "AMLDatasetSourceFreshness": { "type": "object", "description": "Atualidade de uma família de conjuntos de dados AML.", "required": [ "last_updated_at", "oldest_updated_at", "dataset_count", "dated_dataset_count" ], "properties": { "last_updated_at": { "type": "string", "format": "date-time", "description": "Atualização mais recente de qualquer conjunto de dados da família." }, "oldest_updated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Limite de defasagem: todo conjunto de dados da família está pelo menos tão atualizado quanto este valor. `null` quando pelo menos um conjunto de dados da família não informou data de atualização, pois o limite fica desconhecido." }, "dataset_count": { "type": "integer", "description": "Número de conjuntos de dados na família." }, "dated_dataset_count": { "type": "integer", "description": "Número desses conjuntos de dados que informaram uma data de atualização." } } }, "AMLDatasetFreshness": { "type": "object", "description": "Quão atualizados estavam os conjuntos de dados AML quando uma análise foi executada. As datas nunca são estimadas.", "required": [ "captured_at", "provider", "catalog_version", "sources" ], "properties": { "captured_at": { "type": "string", "format": "date-time", "description": "Quando a Didit leu o catálogo de conjuntos de dados de onde vem esta informação de atualização." }, "provider": { "type": "string", "description": "Identificador opaco da fonte de dados AML. Trate-o como uma string opaca; não baseie lógica condicional nele.", "example": "aml_data_source" }, "catalog_version": { "type": "string", "nullable": true, "description": "Identificador de versão do catálogo de conjuntos de dados, quando a fonte informa um." }, "sources": { "type": "object", "description": "Atualidade por família de conjuntos de dados. Uma família cujos conjuntos de dados não informaram data de atualização fica ausente, em vez de ser preenchida com `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": "Uma nova triagem concluída do monitoramento contínuo de uma verificação 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 desta execução da análise." }, "run_id": { "type": "string", "format": "uuid", "description": "A execução de monitoramento à qual esta triagem pertence. Todas as verificações triadas na mesma execução a compartilham." }, "completed_at": { "type": "string", "format": "date-time", "description": "Quando a nova triagem deste titular foi concluída. Os resultados são ordenados por este campo, do mais recente para o mais antigo." }, "started_at": { "type": "string", "format": "date-time", "description": "Quando começou o lote de monitoramento ao qual esta nova triagem pertence." }, "outcome": { "type": "string", "enum": [ "NO_CHANGE", "CHANGED", "FAILED" ], "description": "`NO_CHANGE`: concluída e o resultado não mudou. `CHANGED`: concluída e a pontuação, o status, o número de ocorrências ou as ocorrências mudaram. `FAILED`: não houve resposta utilizável para este titular, então a verificação foi mantida como estava." }, "trigger": { "type": "string", "enum": [ "ONGOING_MONITORING" ], "description": "O que iniciou a análise. Hoje é sempre `ONGOING_MONITORING`." }, "provider": { "type": "string", "description": "Identificador opaco da fonte de dados AML que respondeu. Trate-o como uma string opaca; não baseie lógica condicional nele.", "example": "aml_data_source" }, "status": { "type": "string", "nullable": true, "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested", null ], "description": "Status em que esta execução deixou a verificação AML." }, "score": { "type": "number", "format": "float", "nullable": true, "minimum": 0, "maximum": 100, "description": "Pontuação AML em que esta execução deixou a verificação." }, "total_hits": { "type": "integer", "nullable": true, "description": "Número de ocorrências com que esta execução deixou a verificação." }, "new_hits": { "type": "integer", "nullable": true, "description": "Número de ocorrências encontradas nesta execução que a verificação não tinha antes. `0` quando nada novo foi encontrado; `null` quando a execução falhou ou foi registrada antes de esta contagem existir." }, "entities_screened": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Número de entidades analisadas nesta execução para a verificação: `1` quando o titular foi analisado, `0` quando a execução falhou." }, "dataset_freshness": { "allOf": [ { "$ref": "#/components/schemas/AMLDatasetFreshness" } ], "nullable": true, "description": "Atualidade do conjunto de dados por trás desta execução, ou `null` quando nenhuma data estava disponível." } } }, "KYBKeyPeopleParty": { "type": "object", "description": "Uma parte de pessoas-chave de uma sessão de Verificação de empresas (KYB), com sua verificação filha. A mesma parte aparece em `key_people_checks[].submitted.parties[]` da decisão da sessão da 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 da parte." }, "entity_type": { "type": "string", "enum": [ "person", "company" ], "description": "Se a parte é uma pessoa física ou uma empresa." }, "source": { "type": "string", "enum": [ "REGISTRY", "USER" ], "description": "`REGISTRY`: obtido do registro de empresas. `USER`: informado na tela Pessoas-chave." }, "name": { "type": "string", "description": "Nome de exibição da parte." }, "first_name": { "type": "string", "nullable": true, "description": "Primeiro nome (pessoas físicas)." }, "last_name": { "type": "string", "nullable": true, "description": "Sobrenome (pessoas)." }, "company_name": { "type": "string", "nullable": true, "description": "Nome da empresa (partes do tipo empresa)." }, "registration_number": { "type": "string", "nullable": true, "description": "Número de registro da empresa (partes do tipo empresa)." }, "email": { "type": "string", "format": "email", "nullable": true, "description": "E-mail para o qual o link de verificação é enviado." }, "nationality": { "type": "string", "nullable": true, "description": "Nacionalidade para pessoas, país de constituição para empresas." }, "phone_number": { "type": "string", "nullable": true, "description": "Número de telefone coletado para a parte." }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Data de nascimento (pessoas)." }, "position": { "type": "string", "nullable": true, "description": "Cargo em texto livre (pessoas)." }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Campos personalizados definidos pelo fluxo e coletados para a parte, indexados pela chave do campo." }, "is_active": { "type": "boolean", "description": "Se a parte está ativa." }, "is_skipped": { "type": "boolean", "description": "Se a parte está isenta de verificação. Gerar novamente limpa esse valor." }, "requires_verification": { "type": "boolean", "description": "Se as regras de função e de propriedade exigem uma verificação para esta parte." }, "roles": { "type": "array", "description": "Funções que a parte exerce na empresa.", "items": { "type": "object", "required": [ "role", "ownership_percent", "voting_percent" ], "properties": { "role": { "type": "string", "enum": [ "director", "non_executive_director", "secretary", "chairman", "ubo", "shareholder", "representative", "founder", "legal_advisor", "authorized_signatory", "trustee", "beneficiary", "settlor", "protector", "company_officer", "investor", "other" ], "description": "Código da função." }, "ownership_percent": { "type": "number", "nullable": true, "description": "Percentual de propriedade para esta função, quando conhecido." }, "voting_percent": { "type": "number", "nullable": true, "description": "Percentual de direitos de voto para esta função, quando conhecido." } } } }, "kyc_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Sessão KYC individual filha (pessoas)." }, "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": "Status da sessão de KYC filha. Uma sessão excluída mantém o status que tinha quando foi excluída." }, "kyc_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "Link hospedado da sessão KYC filha. `null` quando ela não existe ou foi excluída, e para uma chave de API com escopo sem `sessions: write`." }, "kyc_session_deleted": { "type": "boolean", "description": "A sessão de KYC filha foi excluída, portanto nunca poderá ser concluída." }, "kyb_sub_session_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Sessão KYB filha (partes que são empresas)." }, "kyb_sub_session_status": { "type": "string", "nullable": true, "enum": [ "Not Started", "In Progress", "Approved", "Declined", "In Review", "Expired", "Abandoned", "Kyc Expired", "Resubmitted", "Awaiting User", null ], "description": "Status da sessão de KYB filha." }, "kyb_sub_session_url": { "type": "string", "format": "uri", "nullable": true, "description": "Link hospedado da sessão KYB filha, com as mesmas regras de `null` que `kyc_session_url`." }, "kyb_sub_session_deleted": { "type": "boolean", "description": "Equivalente de `kyc_session_deleted` para partes do tipo empresa." }, "verification_workflow_type": { "type": "string", "nullable": true, "enum": [ "kyc", "kyb", "adaptive_age_verification", "biometric_authentication", "address_verification", "questionnaire_verification", "email_verification", "phone_verification", null ], "description": "Tipo do fluxo executado pela sessão filha." }, "verification_workflow_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Fluxo executado pela sessão filha." }, "verification_workflow_label": { "type": "string", "nullable": true, "description": "Rótulo desse fluxo." }, "verification_workflow_features": { "type": "array", "nullable": true, "description": "Recursos do fluxo de verificação (workflow) da sessão filha, com o status atual de cada um.", "items": { "type": "object", "required": [ "feature", "status" ], "properties": { "feature": { "type": "string", "description": "Código do recurso, por exemplo `ID_VERIFICATION` ou `LIVENESS`." }, "status": { "type": "string", "description": "Status do recurso, `Not Finished` até ser executado." } } } }, "didit_internal_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Identificador da Didit para a pessoa verificada, quando conhecido." } } }, "TravelRuleDelivery": { "type": "object", "description": "Situação da mensagem mais recente que a transferência deve à outra parte. A Didit contata a contraparte depois que a requisição que criou ou alterou a transferência retorna, então este objeto indica se essa mensagem foi entregue: na fila, em envio, aguardando nova tentativa após um erro, entregue ou com falha. Uma falha da qual a rede ainda pode se recuperar (sem resposta a tempo, falha de conexão, HTTP `408`, `429` ou `5xx`) é tentada novamente após 30 segundos, 2 minutos, 10 minutos, 30 minutos e 1 hora. Quando uma primeira mensagem (`kind: SEND`) falha definitivamente, porque a rede a recusou ou porque a sexta tentativa também falhou, a transferência passa para `COUNTERPARTY_VASP_NOT_REACHABLE` com `last_error` em sua `timeline`; qualquer outra mensagem que falhe definitivamente é registrada na `timeline`. O `status` da transferência continua sendo a fonte da verdade sobre a troca em si.", "required": [ "kind", "status", "rail", "attempts", "last_error", "next_attempt_at", "delivered_at" ], "properties": { "kind": { "type": "string", "enum": [ "SEND", "ANSWER", "TXID", "CANCEL", "POLL" ], "description": "O que a mensagem transporta. `SEND`: a primeira mensagem da transferência para a contraparte (de saída; o canal é escolhido no momento do envio). `ANSWER`: sua aceitação ou recusa, devida à rede que fez a solicitação (de entrada). `TXID`: o hash da transação on-chain, depois que você conclui a transferência. `CANCEL`: o cancelamento, depois que você cancela a transferência. `POLL`: uma consulta de status a uma rede que oferece esse recurso, repetida a cada 5 minutos enquanto a transferência aguarda a contraparte." }, "status": { "type": "string", "enum": [ "QUEUED", "SENDING", "RETRYING", "DELIVERED", "FAILED" ], "description": "`QUEUED`: aguardando envio. `SENDING`: uma tentativa está em andamento. `RETRYING`: uma tentativa falhou e a próxima será executada em `next_attempt_at`. `DELIVERED`: o outro lado recebeu a mensagem. `FAILED`: o outro lado a recusou, ou a última tentativa falhou." }, "rail": { "type": "string", "enum": [ "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL", "" ], "description": "O canal que transporta a mensagem. Fica vazio até que a Didit escolha um para uma primeira mensagem." }, "attempts": { "type": "integer", "minimum": 0, "description": "Tentativas feitas até agora para esta mensagem. Uma mensagem que não seja uma consulta de status é tentada no máximo 6 vezes." }, "last_error": { "type": "string", "description": "O tipo de falha que a última tentativa encontrou, `\"\"` quando não houve nenhuma: por exemplo `email undeliverable`, `trp identity endpoint unreachable` ou `trp transfer inquiry delivery failed`. Nunca inclui a resposta da própria contraparte, que fica na `timeline` da transferência.\nQuando o GTR responde com um erro, o código de status e a mensagem dele são incluídos. Os corpos de resposta nunca são incluídos.", "example": "email undeliverable" }, "next_attempt_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a próxima tentativa é executada enquanto a mensagem está `QUEUED` ou `RETRYING`." }, "delivered_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o outro lado recebeu a mensagem." } } }, "TravelRuleDiscoveryStep": { "type": "object", "description": "Uma etapa da descoberta de contraparte que a Didit executou para uma transferência de saída, na ordem em que as executou. A primeira etapa que identifica um VASP com rota encerra a cadeia.", "properties": { "step": { "type": "string", "enum": [ "internal_address_book", "wallet_attribution", "network_lookup", "customer_hint", "end_user" ], "description": "`internal_address_book`: outro cliente da Didit que comprovou o controle da carteira de destino. `wallet_attribution`: a atribuição da carteira feita por análise de blockchain. `network_lookup`: uma rede capaz de informar qual VASP detém o endereço. `customer_hint`: o nome do VASP, o LEI ou a jurisdição que você enviou em `beneficiary_data`. `end_user`: a contraparte que o usuário final (ou você) escolheu, ou o pedido para escolher uma." }, "outcome": { "type": "string", "enum": [ "match", "miss", "skipped" ], "description": "`match`: a etapa identificou uma contraparte. `miss`: ela foi executada e não encontrou nenhuma. `skipped`: ela não pôde ser executada, e `reason` informa o motivo." }, "reason": { "type": "string", "description": "Motivo legível por máquina, `\"\"` quando há correspondência: `no_proven_internal_wallet`, `attribution_disabled`, `already_attributed`, `no_attributed_entity`, `directory_match_no_route`, `gtr_address_lookup_runs_on_dispatch`, `no_membership`, `network_switched_off`, `no_network_address_lookup`, `no_directory_match`, `awaiting_end_user` ou `picked_member_without_proven_wallet`." }, "vasp": { "type": "string", "format": "uuid", "nullable": true, "description": "O VASP do diretório indicado pela etapa, quando ela indicou um." }, "rail": { "type": "string", "nullable": true, "description": "O canal que alcança essa contraparte, quando a etapa encontrou um." }, "at": { "type": "string", "format": "date-time" } } }, "TravelRuleNextAction": { "type": "object", "description": "Algo que faz avançar uma transferência `COUNTERPARTY_VASP_NOT_FOUND` ou `COUNTERPARTY_VASP_NOT_REACHABLE`. Consulte [Por que uma transferência está parada](/pt-br/transaction-monitoring/travel-rule#por-que-uma-transferência-fica-travada).", "properties": { "action": { "type": "string", "enum": [ "select_counterparty_vasp", "declare_self_hosted", "add_vasp_hint", "update_compliance_email", "resend" ], "description": "`select_counterparty_vasp`: o usuário final escolhe o VASP de destino no widget de propriedade da carteira, ou você faz um PATCH com `action=beneficiary_vasp`. `declare_self_hosted`: o usuário final declara no widget que a carteira é autocustodiada. `add_vasp_hint`: informe à Didit quem é a contraparte, com um nome de VASP, um LEI ou um travel address (por exemplo, um `travel_address` na entrada do catálogo de endereços da carteira de destino) e depois reenvie. `update_compliance_email` e `resend` são valores de `action` de `PATCH /v3/transactions/{transaction_id}/travel-rule/`: informe novamente o e-mail de conformidade da contraparte e execute o roteamento outra vez." }, "url": { "type": "string", "format": "uri", "description": "O link do widget de propriedade da carteira, em `select_counterparty_vasp` e `declare_self_hosted`, enquanto a transferência tiver uma sessão de widget aberta." } }, "required": [ "action" ] }, "TransactionTravelRule": { "type": "object", "description": "A transferência Travel Rule de uma transação, como retornada por `GET /v3/transactions/{transaction_id}/`, pela resposta `201` de `POST /v3/transactions/` e por cada linha de `GET /v3/transactions/`. `direction`, `rail`, `counterparty_vasp`, `delivery`, `discovery`, `reason` e `next_actions` têm o mesmo formato que em `PATCH /v3/transactions/{transaction_id}/travel-rule/`, de modo que uma única leitura de uma transação informa por que a transferência está travada e o que a faz 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": "Parte remetente. Em uma transferência de entrada, os valores da contraparte ficam mascarados até que a propriedade seja confirmada." }, "beneficiary_data": { "type": "object", "description": "Parte beneficiária. Em uma transferência recebida, os valores da contraparte ficam mascarados até que a propriedade seja confirmada." }, "name_match": { "type": "object", "nullable": true, "description": "A comparação de nomes que decidiu a transferência (pontuação e rigor). Nula até que uma seja executada. Os nomes comparados são mascarados junto com as partes." }, "data_match": { "$ref": "#/components/schemas/TravelRuleDataMatch" }, "mismatched_fields": { "type": "array", "items": { "type": "string" }, "description": "Atalho para `data_match.mismatched_fields`. Vazio quando nada difere." }, "data_unmasked": { "$ref": "#/components/schemas/TravelRuleDataUnmasked" }, "data_masked": { "type": "boolean", "description": "True enquanto os dados pessoais da contraparte estão mascarados nesta resposta." }, "metadata": { "type": "object" }, "direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "De qual lado da troca está esta transferência." }, "rail": { "type": "string", "nullable": true, "description": "O canal pelo qual a transferência passou: `INTERNAL`, `TRP`, `GTR`, `TRUST`, `VERIFYVASP`, `SYGNA` ou `EMAIL` (`TEST_VASP` em uma aplicação de sandbox, quando o Didit Test VASP respondeu), ou `null` até que um canal seja escolhido." }, "counterparty_vasp": { "type": "object", "nullable": true, "properties": { "name": { "type": "string" }, "lei": { "type": "string" }, "dd_score": { "type": "integer", "description": "Pontuação de due diligence de 0 a 100, em que valores maiores são melhores. Mesma escala do diretório de VASPs." }, "dd_score_breakdown": { "type": "object", "description": "Contribuições de cada componente para o dd_score, um objeto por componente, como no diretório de VASPs (jurisdiction, verification, protocol, lei, history, essentials, responsiveness), cada um com {points, max, reason, detail}. {} até que a contraparte tenha sido avaliada.", "additionalProperties": { "type": "object", "properties": { "points": { "type": "number", "description": "Pontos atribuídos a este componente." }, "max": { "type": "integer", "description": "Pontuação máxima que este componente pode conceder." }, "reason": { "type": "string", "description": "Código legível por máquina do veredito do componente." }, "detail": { "type": "string", "description": "Motivo legível dos pontos atribuídos." } } } }, "dd_assessed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a avaliação de devida diligência foi executada pela última vez. Nulo até que a contraparte tenha sido avaliada." } }, "description": "A entrada da contraparte no diretório, ou `null` quando a transferência não vincula nenhuma." }, "delivery": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/TravelRuleDelivery" } ], "description": "A mensagem mais recente que a transferência deve a outra parte. `null` quando não deveu nenhuma, por exemplo abaixo de `threshold_amount` ou para uma carteira autocustodiada declarada." }, "discovery": { "type": "array", "description": "Como a Didit procurou a contraparte, com uma entrada por etapa executada. Vazio quando nenhuma descoberta foi executada, por exemplo, em uma transferência de entrada.", "items": { "$ref": "#/components/schemas/TravelRuleDiscoveryStep" } }, "reason": { "type": "string", "description": "Motivo pelo qual uma transferência `COUNTERPARTY_VASP_NOT_FOUND` ou `COUNTERPARTY_VASP_NOT_REACHABLE` está parada; `\"\"` para qualquer outro status. Uma falha de entrega decide primeiro, apenas em `COUNTERPARTY_VASP_NOT_REACHABLE`: `email_undeliverable` (o provedor de e-mail recusou o e-mail de conformidade e não resta nenhum endereço para tentar: no envio, em um lembrete ou como uma devolução permanente informada depois) ou `delivery_failed` (o canal que fazia a entrega falhou definitivamente: um canal de rede recusou a mensagem ou esgotou as novas tentativas, um host de identidade `TRP` não respondeu ou o host `TRP` da contraparte não aceitou a consulta). Caso contrário, o rastro de `discovery` decide: `awaiting_end_user` (nenhuma etapa indicou uma contraparte que a Didit consiga alcançar), `directory_match_no_route` (uma etapa indicou um VASP do diretório que não tem rota), `picked_member_without_proven_wallet` (o usuário final escolheu um cliente da Didit que não comprovou o controle da carteira) ou `no_directory_match` quando o rastro não indica nenhum outro motivo. Um reenvio faz a transferência avançar, e o motivo é então limpo. Veja [Por que uma transferência está parada](/pt-br/transaction-monitoring/travel-rule#por-que-uma-transferência-fica-travada)." }, "next_actions": { "type": "array", "description": "O que faz a transferência avançar; `[]` para qualquer status que não seja `COUNTERPARTY_VASP_NOT_FOUND` ou `COUNTERPARTY_VASP_NOT_REACHABLE`. `email_undeliverable` oferece `update_compliance_email` e depois `resend`. `delivery_failed` oferece `resend`. Um motivo de descoberta oferece `select_counterparty_vasp`, `declare_self_hosted`, `add_vasp_hint` e `resend`.", "items": { "$ref": "#/components/schemas/TravelRuleNextAction" } }, "chain_details": { "$ref": "#/components/schemas/TravelRuleChainDetails" } } }, "NetworkListCounts": { "type": "object", "description": "Contagens de redes para as visualizações e opções de filtro da lista, com cada rede contada uma única vez. Retornado somente quando `summary` não é `false`. `scopes` contam todas as redes visíveis para a aplicação. `views` contam as redes visíveis dentro do `scope` selecionado. `facets` contam as redes no `scope` e na visualização de `status` selecionados (redes descartadas ficam de fora, a menos que `status` as inclua). Os demais filtros da lista não alteram essas contagens.", "properties": { "scopes": { "type": "object", "description": "Redes visíveis por produto.", "properties": { "all": { "type": "integer" }, "identity": { "type": "integer", "description": "Todas as outras redes." }, "transactions": { "type": "integer", "description": "Redes cujos membros são todos partes de transações." } } }, "views": { "type": "object", "description": "Redes visíveis dentro do `scope` selecionado, por status, além de duas visualizações salvas.", "properties": { "all": { "type": "integer" }, "active": { "type": "integer" }, "in_review": { "type": "integer" }, "resolved": { "type": "integer" }, "dismissed": { "type": "integer" }, "mine": { "type": "integer", "description": "Redes atribuídas ao membro do console que fez a chamada. Sempre 0 para uma chave de API." }, "high_risk": { "type": "integer", "description": "Redes com pontuação de risco de 80 ou mais que não foram descartadas." } } }, "facets": { "type": "object", "description": "Contagens de cada opção de filtro, dentro do `scope` selecionado e da visualização de status.", "properties": { "total": { "type": "integer", "description": "Redes no `scope` e na visualização de status selecionados." }, "last_activity_days": { "type": "object", "description": "Redes com atividade nos últimos 7, 30 e 90 dias, indexadas pelo número de dias.", "properties": { "7": { "type": "integer" }, "30": { "type": "integer" }, "90": { "type": "integer" } } }, "risk_min": { "type": "object", "description": "Redes com pontuação de risco de pelo menos 50 e de pelo menos 80, indexadas pelo limiar.", "properties": { "50": { "type": "integer" }, "80": { "type": "integer" } } }, "signal_types": { "type": "object", "description": "Redes com pelo menos um sinal de cada tipo.", "properties": { "ip_address": { "type": "integer" }, "device": { "type": "integer" }, "face": { "type": "integer" }, "document_number": { "type": "integer" }, "phone": { "type": "integer" }, "email": { "type": "integer" }, "address": { "type": "integer" } } }, "priority": { "type": "object", "description": "Redes por prioridade. `none` conta as redes sem prioridade.", "properties": { "low": { "type": "integer" }, "medium": { "type": "integer" }, "high": { "type": "integer" }, "none": { "type": "integer" } } }, "assignee": { "type": "object", "description": "Redes por responsável.", "properties": { "me": { "type": "integer", "description": "Atribuído ao membro do console que fez a chamada. Sempre 0 para uma chave de API." }, "unassigned": { "type": "integer", "description": "Não atribuído a ninguém." }, "users": { "type": "array", "description": "Uma entrada por responsável, do que tem mais redes para o que tem menos.", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "full_name": { "type": "string", "description": "O nome do responsável, ou o e-mail quando nenhum nome está definido." }, "email": { "type": "string" }, "count": { "type": "integer" } } } } } }, "has_case": { "type": "integer", "description": "Redes para as quais esta aplicação abriu um caso." }, "min_size": { "type": "object", "description": "Redes com pelo menos 10 membros, indexadas pelo tamanho mínimo.", "properties": { "10": { "type": "integer" } } } } } } }, "NetworkTag": { "type": "object", "description": "Uma das tags da sua aplicação na rede.", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "O UUID da tag, o mesmo valor que você passa como `tag_uuid`." }, "name": { "type": "string" }, "color": { "type": "string", "description": "Cor hexadecimal, por exemplo, `#6366F1`." }, "source": { "type": "string", "enum": [ "didit", "custom" ], "description": "`didit` para uma tag predefinida da Didit, `custom` para uma tag criada pela sua equipe." }, "added_by": { "type": "string", "nullable": true, "description": "E-mail do membro do console que adicionou a tag. Null quando uma chave de API a adicionou." }, "added_at": { "type": "string", "format": "date-time" } } }, "NetworkOutcomes": { "type": "object", "description": "Situação das pessoas e empresas da rede. Cada membro que você pode ver é contado uma vez, pelo status da sua verificação mais recente que chegou a uma decisão. As partes de transações não são contadas.", "properties": { "approved": { "type": "integer", "description": "Membros cuja verificação decidida mais recente foi aprovada." }, "declined": { "type": "integer", "description": "Membros cuja verificação decidida mais recente foi recusada." }, "in_review": { "type": "integer", "description": "Membros cuja verificação decidida mais recente está em revisão." }, "total": { "type": "integer", "description": "Membros com pelo menos uma verificação, decidida ou não. Um membro cujas verificações estão todas sem decisão (não iniciadas, em andamento, expiradas ou abandonadas) é contado aqui e em nenhuma outra chave." } } }, "NetworkPatternScore": { "type": "object", "description": "Quão semelhante é um tipo de dado dos membros em toda a rede. Um padrão não é um sinal: nenhum valor compartilhado vincula os membros.", "properties": { "type": { "type": "string", "enum": [ "background" ], "description": "`background`: a similaridade média de todos os pares de fundos das selfies dos membros, com a pessoa mascarada. Considera a selfie mais recente de cada pessoa, no máximo as 50 mais recentes, e exclui as sessões de verificação de idade. Abrange toda a rede, não apenas os membros das suas aplicações." }, "score": { "type": "number", "nullable": true, "minimum": 0, "maximum": 1, "description": "De 0 a 1, arredondado para 4 casas decimais. Null quando `reason` está definido." }, "members": { "type": "integer", "nullable": true, "description": "Quantas selfies de membros a pontuação comparou. Uma selfie que não pode ser lida, ou que mostra pouco fundo, não é comparada. Null enquanto `computing`; 0 ou 1 com `not_enough_selfies`." }, "reason": { "type": "string", "enum": [ "computing", "not_enough_selfies" ], "nullable": true, "description": "Por que não há pontuação. `computing`: a pontuação dos membros atuais está sendo calculada; consulte a rede novamente mais tarde. `not_enough_selfies`: menos de dois membros têm uma selfie utilizável. Nulo quando há pontuação." }, "computed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a pontuação foi calculada. Nulo enquanto estiver `computing`." } } }, "NetworkDetailResponse": { "description": "Os detalhes da rede, além do modo de compartilhamento da organização, se os sinais entre organizações se aplicam a ela, as tags da sua aplicação na rede, os resultados dos membros e as pontuações de padrões.", "allOf": [ { "$ref": "#/components/schemas/NetworkDetail" }, { "type": "object", "properties": { "sharing_mode": { "type": "string", "enum": [ "off", "private", "global" ], "description": "O modo de compartilhamento entre organizações da organização. Somente `global` compara redes entre organizações; `private` e `off` as restringem ao histórico da própria organização.", "example": "global" }, "cross_org_available": { "type": "boolean", "description": "Indica se os sinais entre organizações se aplicam a esta organização. Eles exigem tanto o plano Enterprise quanto o modo de compartilhamento `global`.", "example": true }, "cross_org_unavailable_reason": { "type": "string", "enum": [ "plan", "sharing_mode" ], "nullable": true, "description": "Por que os sinais entre organizações não se aplicam, verificados nesta ordem. `plan`: o plano da organização não inclui a rede antifraude entre organizações (ela exige o plano Enterprise), qualquer que seja o modo de compartilhamento. `sharing_mode`: o plano a inclui, mas o modo de compartilhamento é `private` ou `off`. Nulo quando `cross_org_available` é `true`.", "example": null }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTag" }, "description": "As tags da sua aplicação na rede, das mais antigas para as mais recentes. Cada aplicação vê apenas as próprias tags. `fraud_tags` é separado e não muda: as tags que os membros da rede carregam." }, "outcomes": { "$ref": "#/components/schemas/NetworkOutcomes" }, "patterns": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkPatternScore" }, "description": "Pontuações de padrões em toda a rede. Atualmente, um item, `background`." } } } ] }, "NetworkTagRequest": { "type": "object", "required": [ "tag_uuid" ], "properties": { "tag_uuid": { "type": "string", "format": "uuid", "description": "UUID de uma das tags da sua aplicação." } }, "example": { "tag_uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7" } }, "NetworkTimeline": { "title": "Default timeline (no contract)", "type": "object", "description": "Sem `contract`: os eventos da própria rede, do mais antigo ao mais recente, sem paginação.", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTimelineEvent" } } } }, "NetworkTimelinePage": { "title": "Typed timeline page (contract=2)", "type": "object", "description": "Com `contract=2`: uma página de eventos tipados, do mais recente para o mais antigo.", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTypedTimelineEvent" } }, "next_cursor": { "type": "string", "nullable": true, "description": "Passe como `cursor` para ler a próxima página. Nulo na última página." } } }, "NetworkTypedTimelineEvent": { "type": "object", "description": "Um evento tipado da linha do tempo: os quatro campos padrão, mais seu id, quando a Didit o armazenou, a conta de membro e o registro aos quais pertence, e o bloco de detalhes do seu tipo de evento. Os demais blocos de detalhes são null.", "properties": { "id": { "type": "string", "description": "`:`, único dentro da linha do tempo.", "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": "Quando ocorreu." }, "ingested_at": { "type": "string", "format": "date-time", "description": "Quando a Didit o armazenou." }, "label": { "type": "string", "description": "Um rótulo curto em inglês, por exemplo `Verification attempt 2 of 3`." }, "metadata": { "type": "object", "description": "Para os eventos da própria rede, os mesmos metadados da linha do tempo padrão. Vazio nos demais casos." }, "account": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineAccount" } ], "nullable": true, "description": "A conta de membro. Nula para os eventos da própria rede, `case_linked` e `note_added`." }, "source_ref": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineSourceRef" } ], "nullable": true, "description": "O registro de origem. Nulo para os eventos da própria rede e para `note_added`." }, "verification_attempt": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineAttempt" } ], "nullable": true, "description": "Definido em eventos `verification_attempt`." }, "transaction": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineTransaction" } ], "nullable": true, "description": "Definido em eventos `transaction`." }, "login": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineLogin" } ], "nullable": true, "description": "Definido em eventos `login`." }, "rule_hit": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineRuleHit" } ], "nullable": true, "description": "Definido em eventos `rule_hit`." }, "case_linked": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineCaseLinked" } ], "nullable": true, "description": "Definido em eventos `case_linked`." }, "note_added": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineNoteAdded" } ], "nullable": true, "description": "Definido em eventos `note_added`. Nunca é retornado a uma chave de API." } } }, "NetworkTimelineAccount": { "type": "object", "description": "A conta de membro à qual o evento pertence.", "properties": { "node_id": { "type": "string", "description": "`:`, em que kind é `vendor_user`, `vendor_business` ou `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` quando o registro pertence à aplicação que você chamou (no caso de um membro do console, a uma aplicação à qual ele recebeu acesso). `organization` quando pertence a outra aplicação da sua organização." }, "route": { "$ref": "#/components/schemas/NetworkTimelineRoute" } } }, "NetworkTimelineSourceRef": { "type": "object", "description": "O registro do qual o evento foi lido.", "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` quando o registro pertence à aplicação que você chamou (no caso de um membro do console, a uma aplicação à qual ele recebeu acesso). `organization` quando pertence a outra aplicação da sua organização." }, "route": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineRoute" } ], "description": "Ausente para `monitoring_event` e `case`." } } }, "NetworkTimelineRoute": { "type": "object", "description": "Onde o registro começa: seu tipo, seu UUID e a aplicação à qual pertence.", "properties": { "kind": { "type": "string", "description": "`user`, `business` ou `transaction_party` para uma conta; `session`, `business_session` ou `transaction` para um registro de origem." }, "id": { "type": "string", "format": "uuid" }, "application_id": { "type": "string", "format": "uuid" } } }, "NetworkTimelineAttempt": { "type": "object", "description": "Uma sessão de verificação da conta.", "properties": { "session_id": { "type": "string", "format": "uuid", "description": "O UUID da sessão ou, no caso de uma empresa, o UUID da sessão de empresa." }, "session_number": { "type": "integer", "nullable": true }, "attempt": { "type": "integer", "description": "A posição desta sessão entre as sessões da conta, em ordem de criação." }, "attempt_count": { "type": "integer", "description": "Quantas sessões a conta tem." }, "status": { "type": "string", "description": "O status da sessão, por exemplo `Approved` ou `Declined`." }, "status_changed_at": { "type": "string", "format": "date-time", "nullable": true }, "decline_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkTimelineDeclineReason" }, "description": "Somente para uma sessão recusada: seus avisos, do mais antigo para o mais recente, uma vez por aviso. Vazio nos demais casos." } } }, "NetworkTimelineDeclineReason": { "type": "object", "properties": { "risk": { "type": "string", "description": "O código do aviso." }, "feature": { "type": "string", "description": "O recurso que gerou o aviso." }, "short_description": { "type": "string" } } }, "NetworkTimelineTransaction": { "type": "object", "description": "Uma transação da qual uma conta membro participou, datada pela data da transação.", "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": "Nulo quando a transação não tem valor." }, "status": { "type": "string" }, "decision_reason_code": { "type": "string", "nullable": true }, "decision_reason_label": { "type": "string", "nullable": true }, "party_role": { "type": "string", "description": "A função da conta na transação: `APPLICANT`, `REMITTER`, `BENEFICIARY` ou `COUNTERPARTY`." } } }, "NetworkTimelineAmount": { "type": "object", "properties": { "value": { "type": "string", "description": "Valor decimal como string." }, "currency": { "type": "string" }, "direction": { "type": "string", "nullable": true } } }, "NetworkTimelineLogin": { "type": "object", "description": "Um evento de login que você enviou para uma pessoa pela API de eventos.", "properties": { "action": { "type": "string", "description": "`.`: `auth.login` ou `security.login_succeeded` para um login, `auth.login_failed` ou `security.login_failed` para um login que falhou." }, "succeeded": { "type": "boolean" }, "status": { "type": "string", "description": "O status do evento." }, "ip": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineIP" } ], "nullable": true, "description": "Null quando o evento não tem endereço IP." }, "device": { "allOf": [ { "$ref": "#/components/schemas/NetworkTimelineDevice" } ], "nullable": true, "description": "Null quando o evento não tem impressão digital nem contexto do dispositivo." }, "is_first_login": { "type": "boolean", "description": "O primeiro login bem-sucedido registrado da conta." }, "is_new_device": { "type": "boolean", "description": "Um login bem-sucedido a partir de um dispositivo do qual não veio nenhum dos logins bem-sucedidos anteriores da conta. Nunca é true no primeiro login." } } }, "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": "O rótulo do tipo de conexão do endereço, em texto livre." }, "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": "Um rótulo de dispositivo legível, construído a partir do contexto de dispositivo do evento." } } }, "NetworkTimelineRuleHit": { "type": "object", "description": "Uma regra ativa em produção que correspondeu a uma transação ou evento de um membro. Correspondências em modo de teste não são incluídas.", "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": "Um caso aberto para a rede na sua organização. `source_ref.ownership` indica se ele pertence à aplicação que você chamou.", "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": "Uma nota deixada na rede. O texto da nota não é incluído.", "properties": { "note_id": { "type": "string", "format": "uuid" }, "author_email": { "type": "string" } } }, "FeatureStatusOverride": { "type": "object", "description": "Uma substituição do status de uma verificação (recurso) feita com `PATCH /v3/session/{sessionId}/features/{nodeId}/update-status/`: o que ela altera, se foi aplicada ou ainda aguarda a pessoa concluir o fluxo, quem a solicitou e por quê.", "required": [ "id", "node_id", "feature_type", "feature_model", "previous_status", "new_status", "state", "forced", "reason", "requested_by", "requested_at", "applied_at", "cancelled_at", "cancel_reason" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Identificador da substituição. Passe-o para o endpoint de cancelamento.", "example": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }, "node_id": { "type": "string", "description": "O nó do fluxo indicado na requisição (`default` para uma etapa sem nó).", "example": "feature_ocr_1" }, "feature_type": { "type": "string", "description": "O `feature_type` informado na requisição, ou uma string vazia quando nenhum foi informado.", "example": "" }, "feature_model": { "type": "string", "description": "O tipo de verificação que foi sobrescrita, por exemplo `KYC`, `Face`, `AML` ou `GeolocationCheck`.", "example": "KYC" }, "previous_status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "O status da verificação quando a substituição foi solicitada.", "example": "In Review" }, "new_status": { "type": "string", "enum": [ "Approved", "Declined", "In Review" ], "description": "O status que a substituição define.", "example": "Approved" }, "state": { "type": "string", "enum": [ "applied", "pending_until_flow_finishes", "cancelled" ], "description": "`applied`: a verificação está com o novo status. `pending_until_flow_finishes`: a substituição aguarda e é aplicada quando a pessoa conclui o fluxo. `cancelled`: ela aguardou e nunca foi aplicada (veja `cancel_reason`).", "example": "applied" }, "forced": { "type": "boolean", "description": "`true` quando a substituição foi aplicada imediatamente, enquanto a pessoa ainda estava no fluxo.", "example": false }, "reason": { "type": "string", "nullable": true, "description": "O `comment` enviado com a requisição, ou `null`.", "example": "Document manually verified by compliance." }, "requested_by": { "type": "object", "nullable": true, "description": "Quem solicitou a substituição, ou `null` quando isso não é conhecido.", "properties": { "email": { "type": "string", "format": "email", "nullable": true, "description": "E-mail do usuário do console, ou `null` para chaves de API e para o sistema.", "example": "reviewer@example.com" }, "name": { "type": "string", "nullable": true, "description": "Nome de exibição do solicitante, ou `null`.", "example": "Alex Reviewer" }, "type": { "type": "string", "enum": [ "CONSOLE_USER", "API_KEY", "SYSTEM" ], "description": "Quem fez a requisição: um usuário do console, uma chave de API ou a própria Didit.", "example": "CONSOLE_USER" } } }, "requested_at": { "type": "string", "format": "date-time", "description": "Quando a substituição foi solicitada.", "example": "2026-10-13T09:15:00Z" }, "applied_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a verificação assumiu o novo status, ou `null` enquanto ela aguarda ou depois de cancelada.", "example": "2026-10-13T09:15:00Z" }, "cancelled_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando uma substituição pendente foi cancelada, ou `null`.", "example": null }, "cancel_reason": { "type": "string", "nullable": true, "enum": [ "cancelled_by_reviewer", "replaced", "check_changed", "session_closed", null ], "description": "Por que uma substituição em espera nunca foi aplicada, ou `null`. `cancelled_by_reviewer`: cancelada com o endpoint de cancelamento. `replaced`: uma substituição mais recente na mesma verificação a substituiu. `check_changed`: a pessoa refez a verificação antes de concluir o fluxo. `session_closed`: a sessão saiu do fluxo antes de a pessoa concluí-lo (abandonada, expirada ou decidida no meio do fluxo).", "example": null } } }, "SandboxSimulateRequest": { "type": "object", "description": "Força o status de uma sessão de sandbox. Todos os campos são opcionais, mas pelo menos um entre `new_status`, `scenario` ou `risk` é obrigatório.", "properties": { "new_status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Abandoned" ], "description": "O status a definir. Quando você o omite, o padrão é o status padrão do caso de risco (`risk`, ou o primeiro risco que os valores mágicos do cenário carregam); caso contrário, o status padrão do cenário.", "example": "Declined" }, "comment": { "type": "string", "maxLength": 500, "description": "Nota adicionada à entrada de atividade que registra a mudança de status.", "example": "Testing the decline path" }, "scenario": { "type": "string", "maxLength": 100, "description": "Um slug de cenário do catálogo (`GET /v1/sandbox/scenarios/`). Ele fornece o status padrão e, sem `risk`, o aviso associado aos seus valores mágicos. Um slug desconhecido retorna `400`.", "example": "decline_aml_hit" }, "risk": { "type": "string", "maxLength": 128, "description": "Um caso de risco do catálogo. O aviso dele é adicionado à sessão, com um tipo de log que segue `new_status`. Um valor desconhecido retorna `400`.", "example": "POSSIBLE_MATCH_FOUND" }, "node_id": { "type": "string", "maxLength": 128, "description": "Nó do fluxo ao qual o aviso de risco está vinculado. O padrão é o nó atual da sessão.", "example": "feature_aml_1" }, "send_webhooks": { "type": "boolean", "default": true, "description": "`true` envia exatamente os webhooks que uma mudança de status real envia aos destinos da aplicação de sandbox: `status.updated`, além dos eventos `user.status.updated` / `user.data.updated` (ou `business.status.updated` / `business.data.updated`) que a mudança causa, para os destinos inscritos neles. `false` muda o status sem registrar nem enviar nenhum webhook: a recuperação de webhooks perdidos nunca reenvia essa decisão, o console continua sendo atualizado em tempo real e a próxima mudança de status da sessão envia webhooks normalmente.", "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": "O status da sessão antes da simulação.", "example": "In Progress" }, "status": { "type": "string", "enum": [ "Approved", "Declined", "In Review", "Expired", "Abandoned" ], "description": "O status que a simulação definiu.", "example": "Declined" }, "scenario": { "type": "string", "nullable": true, "description": "O slug do cenário que você informou, ou `null`.", "example": "decline_aml_hit" }, "risk": { "type": "string", "nullable": true, "description": "O caso de risco aplicado (`risk`, ou o obtido do cenário), ou `null` quando não há nenhum.", "example": "POSSIBLE_MATCH_FOUND" }, "send_webhooks": { "type": "boolean", "description": "O valor de `send_webhooks` aplicado pela simulação.", "example": false } } }, "CaseTeamSummary": { "type": "object", "nullable": true, "description": "A equipe de revisão responsável pelo caso, ou null quando nenhuma equipe é responsável por ele. O roteamento o define quando uma regra de roteamento atribui o caso a uma de suas equipes. Altere ou remova com `PATCH .../cases/{case_uuid}/` (`team`).", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "CaseChecker": { "type": "object", "nullable": true, "description": "O membro designado para aprovar ou rejeitar a resolução pendente. Definido apenas enquanto uma resolução de quatro olhos aguarda um verificador designado. Nulo quando não há nada pendente, enquanto a resolução pendente aguarda na fila de verificadores e depois que a resolução é aprovada, rejeitada ou devolvida para uma nova revisão porque as evidências mudaram.", "properties": { "member_uuid": { "type": "string", "format": "uuid", "description": "O uuid de usuário do membro: o valor que você passa como `checker` ao resolver o caso." }, "name": { "type": "string", "nullable": true, "description": "O nome completo do membro, ou nulo quando não é conhecido." }, "email": { "type": "string", "format": "email" } } }, "ServiceStatusFeed": { "type": "object", "description": "Status público dos serviços: o estado de cada serviço da Didit, o estado geral e os incidentes em andamento ou resolvidos nos últimos 7 dias.", "required": [ "status", "updated_at", "services", "incidents" ], "properties": { "status": { "type": "string", "enum": [ "operational", "degraded", "down" ], "description": "O pior estado de qualquer serviço neste momento, determinado apenas pelos incidentes em andamento.", "example": "degraded" }, "updated_at": { "type": "string", "format": "date-time", "description": "Quando a Didit gerou esta resposta (ISO 8601, UTC). As respostas ficam em cache por 30 segundos, então ela pode ter até 30 segundos de idade.", "example": "2026-10-13T09:41:07.512345Z" }, "services": { "type": "array", "description": "Uma entrada por serviço; todos os serviços sempre aparecem na lista.", "items": { "$ref": "#/components/schemas/ServiceStatusService" } }, "incidents": { "type": "array", "description": "Os de `started_at` mais recente primeiro. Todos os incidentes em andamento, mais os incidentes resolvidos nos últimos 7 dias (no máximo 50 incidentes resolvidos). Vazio quando nada aconteceu nesse período.", "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": "Chave de serviço estável. Faça a correspondência por esta chave, nunca pelo nome de exibição. `service_id_verification`: Verificação de identidade, `service_liveness_face_match`: Prova de vida e correspondência facial, `service_aml_screening`: Análise AML, `service_kyb_registries`: Registros KYB, `service_database_validation`: Validação de banco de dados, `service_phone_delivery`: Entrega da verificação de telefone, `service_email_delivery`: Entrega da verificação de e-mail, `service_transaction_monitoring`: Monitoramento de transações.", "example": "service_database_validation" }, "name": { "type": "string", "description": "Nome de exibição em inglês do serviço.", "example": "Database validation" }, "status": { "type": "string", "enum": [ "operational", "degraded", "down" ], "description": "`operational` quando não há nenhum incidente em andamento para o serviço; caso contrário, o pior estado entre os incidentes em andamento.", "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 do incidente.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "service": { "type": "string", "enum": [ "service_id_verification", "service_liveness_face_match", "service_aml_screening", "service_kyb_registries", "service_database_validation", "service_phone_delivery", "service_email_delivery", "service_transaction_monitoring" ], "description": "Chave do serviço afetado (consulte `services[].key`).", "example": "service_database_validation" }, "service_name": { "type": "string", "description": "Nome de exibição em inglês do serviço afetado.", "example": "Database validation" }, "state": { "type": "string", "enum": [ "degraded", "down" ], "description": "Como o serviço é afetado. Um incidente resolvido mantém o último estado que teve.", "example": "degraded" }, "status": { "type": "string", "enum": [ "ongoing", "resolved" ], "description": "`ongoing` até o serviço se recuperar; depois, `resolved`.", "example": "ongoing" }, "title": { "type": "string", "description": "Título em inglês. Para traduzi-lo, monte seu próprio texto a partir de `service`, `state` e `country_name`.", "example": "Database validation is degraded in Brazil." }, "body": { "type": "string", "description": "Linha de detalhe em inglês: desde quando as verificações podem estar lentas ou falhar, ou quando o serviço se recuperou.", "example": "Checks against Brazil (CPF) may be slow or fail since 08:55 UTC." }, "affected": { "type": "string", "description": "Países ou registros afetados, por exemplo `Brazil (CPF)`. Vazio quando o incidente não está vinculado a um país ou registro.", "example": "Brazil (CPF)" }, "country_name": { "type": "string", "description": "País afetado, em inglês. Vazio quando o incidente não está vinculado a um país.", "example": "Brazil" }, "started_at": { "type": "string", "format": "date-time", "description": "Quando o incidente começou (ISO 8601, UTC).", "example": "2026-10-13T08:55:00Z" }, "resolved_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o serviço se recuperou (ISO 8601, UTC). `null` enquanto o incidente está em andamento." }, "duration_minutes": { "type": "integer", "nullable": true, "description": "Minutos inteiros de `started_at` a `resolved_at`. `null` enquanto o incidente estiver em andamento." } } }, "TravelRuleJoinInvitation": { "type": "object", "description": "O que a página de entrada exibe antes de qualquer digitação.", "properties": { "email": { "type": "string", "format": "email", "description": "O endereço para o qual o convite foi enviado." }, "vasp_name": { "type": "string" }, "source": { "type": "string", "description": "A origem do convite, por exemplo `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": "Deve ser o endereço para o qual o convite foi enviado." }, "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": "O código de 6 caracteres enviado por e-mail após o cadastro." } } }, "TravelRuleJoinCredentials": { "type": "object", "description": "A nova organização gratuita e as credenciais com as quais a aplicação dela chama a 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": "Envie como o cabeçalho `x-api-key` nos endpoints do workspace." } } }, "TravelRuleWorkspaceClaimRequest": { "type": "object", "required": [ "vasp_id" ], "properties": { "vasp_id": { "type": "string", "format": "uuid", "description": "A entrada do diretório que corresponde a este espaço de trabalho. Leia os ids em `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": "Somente `true` é aceito: o faturamento de saída não pode ser desativado novamente pela 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": "O registro TXT a ser publicado para a prova por DNS. Fica vazio até que uma prova seja iniciada.", "properties": { "host": { "type": "string", "example": "didit-tr-verify.example.com" }, "value": { "type": "string" } } }, "TravelRuleWorkspace": { "type": "object", "description": "O espaço de trabalho gratuito de Travel Rule de uma aplicação que aderiu gratuitamente.", "properties": { "joined_free": { "type": "boolean" }, "work_email": { "type": "string", "format": "email" }, "joined_at": { "type": "string", "format": "date-time", "nullable": true }, "claim": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "unclaimed", "pending_review", "claimed", "rejected" ] }, "proved_by_domain": { "type": "boolean" }, "claimed_at": { "type": "string", "format": "date-time", "nullable": true }, "reviewed_at": { "type": "string", "format": "date-time", "nullable": true }, "review_note": { "type": "string" }, "vasp_id": { "type": "string", "format": "uuid", "nullable": true }, "vasp_name": { "type": "string" } } }, "prefill": { "type": "object", "description": "Valores do perfil obtidos da entrada do diretório: `vasp_id`, `legal_name`, `lei`, `jurisdiction`, `compliance_email`, `domains`. Nada é gravado até que a reivindicação seja feita." }, "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": "Receber dados da Travel Rule é gratuito. O envio só é cobrado depois que o faturamento é ativado." }, "billing_enabled_at": { "type": "string", "format": "date-time", "nullable": true }, "didit_network": { "type": "object", "description": "Indica se a rede Didit lista este VASP e, caso não liste, cada condição que ainda falta cumprir." }, "settings": { "$ref": "#/components/schemas/TravelRuleSettingsDetail" } } }, "InvestigatorDecision": { "type": "object", "description": "Como o item saiu da fila do Investigator. `decided_by`, `original_outcome` e `overrides` são retornados pelos endpoints de aceitação e de substituição e pelo relatório; o bloco `investigator` de uma decisão de sessão traz os demais campos.", "properties": { "outcome": { "type": "string", "enum": [ "accepted", "edited", "overridden", "decided_elsewhere", "automated" ], "description": "`accepted` ou `edited` seguiu a recomendação (`edited` com uma narrativa reescrita), `overridden` tomou outra ação, `decided_elsewhere` é uma decisão tomada fora do Investigator enquanto o relatório estava aberto, `automated` é uma decisão que o Investigator tomou por conta própria." }, "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": "O status do item após a decisão." }, "agreed": { "type": "boolean", "description": "Se a decisão coincidiu com a recomendação.", "nullable": true }, "decided_at": { "type": "string", "format": "date-time" }, "billed": { "type": "boolean", "description": "A revisão foi cobrada." }, "decided_by": { "type": "string", "enum": [ "investigator", "member" ] }, "original_outcome": { "type": "object", "description": "A decisão que o Investigator tomou por conta própria, sem alteração por substituições posteriores. Nulo para uma decisão tomada pela equipe.", "properties": { "action": { "type": "string" }, "final_status": { "type": "string" }, "decided_at": { "type": "string", "format": "date-time" } }, "nullable": true }, "overrides": { "type": "array", "description": "Todas as substituições de uma decisão que o Investigator tomou por conta própria, da mais antiga para a mais recente.", "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": "A revisão mais recente do item no Investigator, ou null quando ele nunca teve uma. Incluída na decisão da sessão V3 e da sessão de empresa (e, portanto, nos webhooks `status.updated`).", "properties": { "run_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "running", "completed", "failed" ] }, "stage": { "type": "string", "enum": [ "shadow", "live" ] }, "queue": { "type": "string", "enum": [ "kyc", "kyb", "aml", "transactions", "cases" ] }, "is_open": { "type": "boolean" }, "recommendation": { "type": "string", "enum": [ "approve", "decline", "escalate", "request" ], "nullable": true }, "recommendation_detail": { "type": "string", "nullable": true }, "confidence": { "type": "string", "enum": [ "high", "moderate", "low" ], "nullable": true }, "summary": { "type": "string", "nullable": true }, "ready_to_accept": { "type": "boolean" }, "prepared_at": { "type": "string", "format": "date-time", "nullable": true }, "automated": { "type": "boolean", "description": "O Investigator decidiu por conta própria, mesmo que a decisão tenha sido revertida posteriormente." }, "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": "O item em revisão: `id`, `number`, `status`, `name` e, dependendo do tipo, `country`, `workflow`, `vendor_data`, `txn_id`, `amount`, `currency`, `direction`, `title` ou `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": "As proteções bloqueadas que retêm este item, se houver." }, "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": "Quantas seções e registros vinculados foram lidos." }, "duration_ms": { "type": "integer", "nullable": true }, "agent_version": { "type": "string" }, "prepared_before_opened": { "type": "boolean", "nullable": true }, "report": { "type": "object", "additionalProperties": true, "description": "O relatório: raciocínio, pontos de evidência com seu veredito (`ok`, `risk`, `look`, `explained`, `context`) e fontes citadas, vereditos dos resultados da triagem (`same`, `not_same`, `unclear`) e próximos passos sugeridos." }, "trail": { "description": "O que verifiquei: a visão geral, as seções e os registros lidos, em ordem." }, "decision": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/InvestigatorDecision" } ], "type": "object" }, "autonomy": { "type": "object", "additionalProperties": true, "description": "O que a autonomia concluiu do relatório (`result`, `reason`, `tier`, `policy_version`, `rule`, `agreement`, `decisions`, `threshold`, `at`). Nulo quando a fila não é automatizada.", "nullable": true } } } ] }, "InvestigatorAcceptRequest": { "type": "object", "properties": { "narrative": { "type": "string", "maxLength": 4000, "description": "Uma narrativa reescrita. Enviá-la registra a decisão como editada e aceita." }, "send_email": { "type": "boolean", "default": false, "description": "Enviar à pessoa um e-mail sobre a decisão." }, "email_address": { "type": "string", "format": "email", "description": "Obrigatório quando `send_email` for 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": "Enviar à pessoa um e-mail sobre a decisão." }, "email_address": { "type": "string", "format": "email", "description": "Obrigatório quando `send_email` for 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": "Limite mensal na sua moeda de faturamento, de 0.01 a 1,000,000. Null o desativa.", "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": "O preço de cada relatório em produção em aberto, retido porque aceitá-lo gera a cobrança." }, "currency": { "type": "string" }, "paused": { "type": "boolean", "description": "No limite: nenhuma nova revisão é iniciada." } } } } }, "TravelRuleUtxoEntry": { "type": "object", "description": "Uma entrada ou saída de uma transação UTXO, conforme registrada na blockchain.", "required": [ "address" ], "properties": { "address": { "type": "string", "maxLength": 128 }, "amount": { "type": "string", "nullable": true, "description": "String decimal na própria unidade da moeda (BTC, não satoshis). Opcional.", "example": "0.0125" }, "txid": { "type": "string", "maxLength": 128, "description": "Opcional. A transação que uma entrada gasta." }, "vout": { "type": "integer", "nullable": true, "minimum": 0, "description": "Opcional. O índice da saída que uma entrada gasta." } } }, "TravelRuleUtxo": { "type": "object", "description": "As entradas e saídas de uma transferência UTXO (BTC, LTC, BCH, DOGE). Aceitas somente nessas blockchains: em qualquer outra blockchain, é retornado `400`. A partir delas, a Didit infere a carteira do remetente (a declarada; caso contrário, o endereço de entrada que mais contribuiu) e a saída do beneficiário (a declarada; caso contrário, a única saída que não devolve valor a um endereço de entrada como troco; caso contrário, a única saída que paga o valor da transferência). O resultado fica em `chain_details` da transferência.", "required": [ "outputs" ], "properties": { "inputs": { "type": "array", "maxItems": 1000, "items": { "$ref": "#/components/schemas/TravelRuleUtxoEntry" }, "description": "Opcional. Sem entradas, nenhum remetente é inferido e nenhuma saída de troco é reconhecida." }, "outputs": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "$ref": "#/components/schemas/TravelRuleUtxoEntry" } } } }, "TravelRuleChainSide": { "type": "object", "description": "A carteira de uma das partes, conforme a Didit a resolveu a partir dos dados da blockchain.", "properties": { "address": { "type": "string", "description": "A carteira. Em uma rede com memo, o endereço clássico (um X-address da XRP é dividido em endereço clássico e tag); na Lightning, o ID do nó do beneficiário ou o Lightning Address." }, "memo": { "type": "string", "description": "A destination tag ou o memo que faz parte da carteira; `\"\"` para nenhum." }, "source": { "type": "string", "enum": [ "declared", "x_address", "largest_input", "only_non_change_output", "amount_match", "invoice_payee", "updated" ], "description": "Origem da carteira: `declared` (sua requisição), `x_address` (extraída de um X-address do XRP), `largest_input` (o endereço de entrada UTXO que mais contribuiu), `only_non_change_output` (a única saída UTXO que não é troco), `amount_match` (a única saída UTXO que paga o valor da transferência), `invoice_payee` (o beneficiário indicado em uma solicitação de pagamento Lightning), `updated` (definida posteriormente com `action: update_originator_wallet`)." } } }, "TravelRuleChainDetails": { "type": "object", "description": "Como a blockchain da transferência identifica suas duas carteiras, quando isso vai além de um endereço pagando a outro. Vazio (`{}`) para uma transferência em blockchain baseada em contas (EVM, Solana, Tron), em que os dois endereços são as próprias carteiras. A correspondência, o roteamento e o catálogo de endereços leem as carteiras primeiro a partir daqui.", "properties": { "chain": { "type": "string", "description": "Blockchain canônica, por exemplo, `BTC`, `XRP` ou `LIGHTNING` para uma transferência Lightning." }, "shape": { "type": "string", "enum": [ "utxo", "memo", "lightning" ] }, "originator": { "$ref": "#/components/schemas/TravelRuleChainSide" }, "beneficiary": { "$ref": "#/components/schemas/TravelRuleChainSide" }, "utxo": { "type": "object", "description": "Em uma transferência UTXO: as entradas e saídas conforme armazenadas (valores como strings decimais) e como a Didit interpretou cada saída.", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleUtxoEntry" } }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleUtxoEntry" } }, "change_output_indexes": { "type": "array", "items": { "type": "integer" }, "description": "Saídas que pagam de volta a um endereço de entrada." }, "beneficiary_output_index": { "type": "integer", "nullable": true, "description": "A saída que paga o beneficiário; null quando nenhuma pôde ser distinguida." } } }, "lightning": { "type": "object", "description": "Em uma transferência Lightning: o que a requisição de pagamento informa. Sempre `kind` (`bolt11`, `bolt12_offer`, `bolt12_invoice`, `bolt12_invoice_request`, `lnurl`, `lightning_address`, `node_id` ou `unknown`); uma fatura BOLT11 acrescenta `network`, `payee_node_id`, `payment_hash`, `amount_msat`, `created_at` e `expires_at`; uma string BOLT12, `blinded_paths` e `payee_node_id`; uma LNURL ou um Lightning Address, o respectivo `domain`. Nada é resolvido pela rede: a requisição é apenas decodificada.", "additionalProperties": true }, "warnings": { "type": "array", "items": { "type": "string", "enum": [ "declared_originator_not_an_input", "declared_beneficiary_not_an_output", "beneficiary_output_ambiguous", "beneficiary_output_amount_differs" ] }, "description": "Inconsistências de UTXO que merecem atenção: o remetente declarado não é uma entrada, o beneficiário declarado não é uma saída, não foi possível distinguir uma única saída do beneficiário, ou a saída do beneficiário paga um valor diferente do informado na transação." }, "not_applicable_reason": { "type": "string", "enum": [ "LIGHTNING_NO_PAYEE_IDENTIFIER", "LIGHTNING_BOLT12_BLINDED_PAYEE", "LIGHTNING_LNURL_NAMES_NO_PAYEE" ], "description": "Em uma transferência Lightning de saída cuja requisição de pagamento não indica nenhum beneficiário: o motivo pelo qual a transferência é `NOT_APPLICABLE`. `LIGHTNING_NO_PAYEE_IDENTIFIER` (a requisição não indica nenhum nó beneficiário ou não pôde ser decodificada), `LIGHTNING_BOLT12_BLINDED_PAYEE` (a oferta oculta o beneficiário atrás de blinded paths), `LIGHTNING_LNURL_NAMES_NO_PAYEE` (uma LNURL indica um serviço, não um beneficiário). O mesmo código abre a última entrada de `timeline` da transferência." } } }, "WalletAddressImportRow": { "type": "object", "description": "Uma carteira a importar: pelo seu `address`, pelo seu `address_hash` ou por ambos. As formas em camelCase desses campos também são aceitas, assim como `walletAddress`, `walletAddressHash`, `destinationTag` e `externalUserId`.", "properties": { "address": { "type": "string", "maxLength": 128, "description": "O endereço da carteira. Alias: `walletAddress`." }, "address_hash": { "type": "string", "description": "SHA-256 do endereço em minúsculas, como 64 caracteres hexadecimais ou 44 caracteres base64. Envie-o sozinho para registrar uma carteira sem revelar o endereço; se enviado com `address`, deve ser o hash desse endereço. Alias: `walletAddressHash`." }, "chain": { "type": "string", "maxLength": 32 }, "memo": { "type": "string", "maxLength": 256, "description": "A destination tag ou o memo. XRP: uma destination tag, um número inteiro de 0 a 4294967295 (um número JSON é aceito). XLM: um memo de texto de até 28 bytes, um id de 64 bits ou um hash de 32 bytes em hexadecimal. EOS: até 256 bytes. ATOM: até 256 caracteres. HBAR: até 100 bytes. Carteiras Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin e Lightning não aceitam memo: enviar um nelas resulta em `400`." }, "holder_name": { "type": "string", "maxLength": 255 }, "holder_vendor_data": { "type": "string", "maxLength": 255, "description": "Seu identificador interno para o titular. Alias: `externalUserId`." }, "entity_type": { "type": "string", "enum": [ "individual", "company" ], "default": "individual" }, "label": { "type": "string", "maxLength": 255 }, "owner_type": { "type": "string", "enum": [ "customer", "internal", "vasp" ], "default": "customer" }, "travel_address": { "type": "string", "maxLength": 512 }, "self_declared": { "type": "boolean", "default": false, "description": "Cria a entrada já verificada por meio de uma autodeclaração, quando suas configurações permitirem." } } }, "WalletAddressImportReport": { "type": "object", "description": "O que aconteceu com cada linha de uma importação, na ordem em que foram enviadas.", "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": "O número da linha, a partir de 1." }, "status": { "type": "string", "enum": [ "created", "existing", "duplicate", "failed" ], "description": "`created`: adicionada ao catálogo. `existing`: a carteira já está no catálogo e não foi alterada. `duplicate`: repete uma linha anterior desta importação. `failed`: consulte `errors`." }, "entry_id": { "type": "string", "format": "uuid", "nullable": true, "description": "A entrada do catálogo de endereços que a linha criou ou encontrou." }, "errors": { "type": "object", "description": "Erros de campo de uma linha `failed`; vazio nos demais casos." }, "duplicate_of_row": { "type": "integer", "nullable": true, "description": "Em uma linha `duplicate`, a linha que ela repete." } } } } } }, "TravelRuleCounterpartyContact": { "type": "object", "description": "Um endereço de conformidade para o qual o canal EMAIL escreve, referente a uma entrada do diretório.", "properties": { "uuid": { "type": "string", "format": "uuid" }, "counterparty": { "type": "string", "format": "uuid", "description": "O `id` da entrada do diretório, conforme exibido por GET /v3/travel-rule/vasps/." }, "counterparty_name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string", "description": "Rótulo opcional, por exemplo o nome da equipe." }, "source": { "type": "string", "enum": [ "staff", "application", "learned" ], "description": "staff: curado pela Didit. learned: um endereço em um dos próprios domínios do VASP que respondeu a uma requisição pelo link de resposta. application: adicionado pela sua aplicação." }, "scope": { "type": "string", "enum": [ "platform", "application" ], "description": "platform: curado pela Didit ou aprendido a partir de uma resposta verificada, usado para todos os clientes da Didit, somente leitura para você. application: privado da sua aplicação." }, "created_by": { "type": "string", "description": "Vazio para contatos da plataforma e para contatos adicionados por uma chave de API." }, "verified_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando este endereço respondeu pela última vez a uma requisição por meio do seu link de resposta." }, "is_invalid": { "type": "boolean", "description": "true depois que o endereço gerou bounce ou reclamação; o canal EMAIL o ignora." }, "invalid_reason": { "type": "string", "enum": [ "", "hard_bounce", "soft_bounce", "spam_complaint", "suppressed" ] }, "invalid_detail": { "type": "string", "description": "O motivo informado pelo servidor de e-mail destinatário, quando houver." }, "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": "O `id` da entrada do diretório." }, "email": { "type": "string", "format": "email", "maxLength": 254 }, "name": { "type": "string", "description": "Rótulo opcional.", "maxLength": 255 } } }, "TravelRuleNameMatch": { "type": "object", "nullable": true, "description": "A comparação de nomes que decidiu a transferência, ou nula até que uma seja executada. Enquanto as partes estão mascaradas, e na cópia do outro cliente de uma troca INTERNAL, `transfer_name`, `compared_name`, `matched_names` e `mismatched_names` ficam ocultos. `score` e `matched` podem divergir: `matched` segue o rigor, enquanto `score` é a similaridade entre os dois nomes completos.", "properties": { "score": { "type": "integer", "minimum": 0, "maximum": 100, "description": "Similaridade entre os dois nomes completos, de 0 a 100. É 0 quando qualquer um dos nomes está em branco." }, "matched": { "type": "boolean", "description": "Se os nomes atendem a `strictness`. O resultado da transferência segue `data_match`, que compara todos os campos, então uma transferência pode ser COUNTERPARTY_MISMATCHED_DATA mesmo quando este valor é verdadeiro." }, "method": { "type": "string", "enum": [ "none", "exact_token", "token_subset", "token_containment", "sequence_ratio" ], "description": "Como `matched` foi decidido: none (`NONE`), exact_token (`STRICT`), token_subset (`DEFAULT`), token_containment (`CONTAINS`) ou sequence_ratio (`FUZZY`)." }, "strictness": { "type": "string", "enum": [ "NONE", "STRICT", "CONTAINS", "DEFAULT", "FUZZY" ] }, "compared_with": { "type": "string", "enum": [ "wallet_holder", "counterparty_vasp" ], "description": "wallet_holder: o titular registrado para a carteira. counterparty_vasp: o nome que a contraparte informou na página de resposta por e-mail, ou a resposta do Didit Test VASP no sandbox." }, "transfer_name": { "type": "string", "description": "O nome na transferência." }, "compared_name": { "type": "string", "description": "O nome com o qual ele foi comparado." }, "matched_names": { "type": "array", "items": { "type": "string" }, "description": "Palavras de `transfer_name` encontradas em `compared_name`." }, "mismatched_names": { "type": "array", "items": { "type": "string" }, "description": "Palavras de `transfer_name` ausentes em `compared_name` e, em seguida, palavras de `compared_name` ausentes em `transfer_name`." } } }, "TravelRuleTransferRow": { "type": "object", "description": "Uma transferência Travel Rule como aparece na lista de transferências: apenas nomes de VASP, carteiras e memorandos, nunca os dados pessoais do remetente ou do beneficiário.", "properties": { "id": { "type": "string", "format": "uuid", "description": "O id da transferência." }, "transaction_id": { "type": "string", "format": "uuid", "description": "A transação da Didit à qual a transferência pertence." }, "txn_id": { "type": "string", "nullable": true, "description": "Seu próprio id para a transação. As transferências que a Didit registra para você, como uma transferência de entrada do Didit Test VASP, recebem um id gerado." }, "txn_date": { "type": "string", "format": "date-time" }, "kind": { "type": "string", "enum": [ "withdrawal", "deposit", "message" ], "description": "withdrawal: de saída. message: uma transferência de entrada que um canal criou a partir de uma mensagem da contraparte (uma consulta TRP, a ponta INTERNAL de entrada ou uma mensagem GTR, VerifyVASP ou Sygna Bridge). deposit: qualquer outra transferência de entrada." }, "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": "Motivo pelo qual uma transferência `COUNTERPARTY_VASP_NOT_FOUND` ou `COUNTERPARTY_VASP_NOT_REACHABLE` está parada, com o mesmo valor do `reason` da própria transferência, para que a lista diferencie um e-mail de conformidade devolvido de uma contraparte sem rota sem precisar abrir cada transferência. `\"\"` para qualquer outro status. Veja [Por que uma transferência está parada](/pt-br/transaction-monitoring/travel-rule#por-que-uma-transferência-fica-travada)." }, "rail": { "type": "string", "nullable": true, "enum": [ "INTERNAL", "TRP", "GTR", "TRUST", "VERIFYVASP", "SYGNA", "EMAIL", "TEST_VASP", null ] }, "asset": { "type": "string", "description": "A moeda da transação." }, "amount": { "type": "string", "description": "O valor como decimal simples, por exemplo \"1.25\"." }, "originator_vasp": { "type": "string", "description": "Saída: a razão social do seu VASP. Entrada: o nome da contraparte, obtido da sua entrada no diretório, do membro da rede Didit, do remetente TRP, do Didit Test VASP ou do nome declarado na transferência. Vazio quando nenhum nome é conhecido." }, "beneficiary_vasp": { "type": "string", "description": "Saída: o nome da contraparte, determinado da mesma forma. Entrada: a razão social do seu VASP." }, "originator_wallet": { "type": "string" }, "beneficiary_wallet": { "type": "string" }, "originator_memo": { "type": "string", "description": "Memo ou tag de destino, vazio em blockchains que não têm um." }, "beneficiary_memo": { "type": "string" }, "originator_wallet_type": { "type": "string", "enum": [ "vasp", "self_hosted", "own" ], "description": "vasp, self_hosted (declarada como não custodiada) ou own (uma carteira que seu catálogo de endereços registra como sua). O seu próprio lado é sempre vasp." }, "beneficiary_wallet_type": { "type": "string", "enum": [ "vasp", "self_hosted", "own" ] }, "matched_transaction_id": { "type": "string", "format": "uuid", "nullable": true, "description": "O outro lado de um depósito que você associou manualmente a uma transferência anunciada." }, "deadline_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a transferência expira, se ainda estiver aguardando a contraparte. Definido em toda transferência que você cria com `POST /v3/transactions/` e que exige uma troca, seja de saída ou de entrada. Nulo abaixo do limiar, em um pagamento Lightning ao qual a Travel Rule não se aplica e em transferências de entrada que a Didit cria quando uma contraparte entra em contato com você (uma consulta TRP de entrada, uma mensagem de rede ou a etapa de entrada INTERNAL)." }, "created_at": { "type": "string", "format": "date-time" } } }, "BankAccountCheckHolder": { "description": "O nome com o qual a conta é verificada. Envie exatamente um entre `full_name` e `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": "O país da conta, como código ISO 3166-1 alfa-3, por exemplo `GBR`. Letras minúsculas são aceitas.", "example": "GBR" }, "account": { "type": "object", "description": "A conta no formato usado pelo país dela: um `iban`, ou um `account_number` com o código de banco ou de agência que o país exige (`sort_code`, `routing_number`, `transit_institution`, `bsb`, `ifsc`, `bank_code` ou `bic`). O México usa uma `clabe` e a Argentina um `cbu_cvu`, que já identificam o banco. Uma conta empresarial inclui um `registration_id` quando o país exige. Espaços, hifens e pontos são ignorados. Chaves que a verificação do país não usa são ignoradas. Uma chave exigida que não é enviada resulta em um `400` que a identifica.", "properties": { "iban": { "type": "string", "maxLength": 64, "description": "O IBAN, em um país que usa IBANs. Ele deve pertencer a `country`." }, "account_number": { "type": "string", "maxLength": 64, "description": "O número da conta, em um país que escreve a conta com um código de banco ou de agência separado." }, "sort_code": { "type": "string", "maxLength": 64, "description": "Reino Unido: o sort code de 6 dígitos." }, "routing_number": { "type": "string", "maxLength": 64, "description": "Estados Unidos: o número de roteamento ABA de 9 dígitos." }, "transit_institution": { "type": "string", "maxLength": 64, "description": "Canadá: o número de trânsito e instituição de 8 dígitos." }, "bsb": { "type": "string", "maxLength": 64, "description": "Austrália: o BSB de 6 dígitos." }, "ifsc": { "type": "string", "maxLength": 64, "description": "Índia: o IFSC de 11 caracteres." }, "bank_code": { "type": "string", "maxLength": 64, "description": "O código do banco, quando o país exige um, por exemplo na Nigéria." }, "bic": { "type": "string", "maxLength": 64, "description": "O BIC do banco, quando a verificação do país exige um." }, "clabe": { "type": "string", "maxLength": 64, "description": "México: a CLABE de 18 dígitos. Ela já identifica o banco." }, "cbu_cvu": { "type": "string", "maxLength": 64, "description": "Argentina: o CBU ou CVU de 22 dígitos. Ele já identifica o banco." }, "registration_id": { "type": "string", "maxLength": 64, "description": "O número de registro de uma conta empresarial, quando o país exige um." } }, "additionalProperties": { "type": "string", "maxLength": 64 }, "example": { "sort_code": "20-45-67", "account_number": "31926819" } }, "holder": { "$ref": "#/components/schemas/BankAccountCheckHolder" }, "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação, retornada sem alterações.", "example": "payout_20481" } } }, "BankAccountCheckResponse": { "type": "object", "required": [ "request_id", "result", "holder_name", "account", "vendor_data", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "O ID desta verificação." }, "result": { "type": "string", "enum": [ "match", "close_match", "no_match", "cannot_verify" ], "description": "`match`: o banco mantém a conta no nome que você enviou. `close_match`: em um nome parecido, por exemplo sem o nome do meio ou com um erro de digitação. `no_match`: em outro nome, ou essa conta não existe. `cannot_verify`: o banco respondeu sem comparar o nome, por exemplo no caso de uma conta bloqueada ou encerrada." }, "holder_name": { "type": "string", "nullable": true, "description": "Somente em um `close_match`, e somente quando o banco o retornou: o nome na conta, conforme registrado pelo banco. `null` caso contrário." }, "account": { "type": "string", "description": "A conta, mascarada até os 4 últimos caracteres." }, "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência, conforme você a enviou." }, "created_at": { "type": "string", "format": "date-time", "description": "Quando a verificação foi executada, em UTC." } } }, "BankAccountCheckError": { "type": "object", "required": [ "detail" ], "properties": { "detail": { "type": "string", "description": "O que deu errado, em inglês." }, "code": { "type": "string", "description": "Um código estável para ramificar sua lógica. Ausente em `401` e `403`." }, "field": { "type": "string", "description": "Somente `400`: o campo do corpo a corrigir, como caminho com pontos, por exemplo `account.sort_code`." }, "reason": { "type": "string", "enum": [ "required", "length", "format", "checksum", "country_mismatch", "rejected" ], "description": "Somente `400`: por que o campo foi recusado. `required`, `length`, `format`, `checksum` e `country_mismatch` (um IBAN de outro país) são verificações da própria Didit; `rejected` significa que o banco recusou a conta como enviada." } } }, "BankVerificationResult": { "type": "object", "description": "O resultado de uma etapa de Verificação bancária, para Verificação de usuários e Verificação de empresas. `method` indica como a conta foi verificada, e `none` indica que a pessoa continuou sem banco antes que qualquer tentativa fosse avaliada. `continued_without_bank` indica que a pessoa continuou sem banco, inclusive após uma tentativa avaliada. Consulte [Métodos de verificação bancária](/pt-br/core-technology/bank-verification/verification-methods) e [Quando a pessoa não consegue verificar seu banco](/pt-br/core-technology/bank-verification/fallbacks).", "properties": { "schema_version": { "type": "integer", "description": "Versão do formato deste resultado. Atualmente `1`." }, "bank_verification_id": { "type": "string", "format": "uuid", "description": "O ID deste resultado." }, "node_id": { "type": "string", "description": "O nó do fluxo ao qual este resultado pertence." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Expired" ], "description": "O veredito da etapa, após suas ações e regras de status." }, "original_status": { "type": "string", "nullable": true, "description": "O primeiro veredito a que a etapa chegou, antes de qualquer alteração posterior, como uma revisão manual." }, "method": { "type": "string", "nullable": true, "enum": [ "open_banking", "account_lookup", "microdeposits", "statement", "none" ], "description": "Como a conta foi verificada: `open_banking` (login no banco: a pessoa entrou na conta pelo banco), `account_lookup` (verificação de conta: a pessoa digitou os dados da conta e o banco confirmou o nome), `microdeposits` ou `statement` (envio de extrato). `none` quando a pessoa continuou sem um banco antes que qualquer tentativa fosse avaliada, portanto nenhuma conta foi verificada. Após uma tentativa avaliada, permanece o método dessa tentativa. `null` até que uma conta seja avaliada e quando o fluxo restringe os dados que retorna. As regras do fluxo leem o mesmo valor como `bank.method`." }, "provider": { "type": "string", "nullable": true, "description": "A chave da rota que executou a conexão. Leia `method`, e não esta chave, para saber como a conta foi verificada." }, "credential_source": { "type": "string", "nullable": true, "enum": [ "native", "byok" ], "description": "`native`: a rota própria da Didit, cobrada do seu saldo Didit. `byok`: um provedor do marketplace que você conectou com suas próprias credenciais." }, "route": { "type": "object", "nullable": true, "description": "A rota escolhida antes do consentimento. Ela nunca muda depois.", "properties": { "provider_key": { "type": "string", "nullable": true, "description": "A chave da rota." }, "credential_source": { "type": "string", "enum": [ "native", "byok" ] }, "is_fallback": { "type": "boolean", "description": "Indica se a rota própria da Didit substituiu um provedor do marketplace que não conseguiu se conectar." }, "provider_connection_id": { "type": "string", "nullable": true, "description": "A conexão de marketplace utilizada, para `byok`." }, "requested_scopes": { "type": "array", "items": { "type": "string" }, "description": "Os dados que a conexão solicitou, por exemplo `ownership` ou `balances`." } } }, "connection": { "type": "object", "nullable": true, "description": "A conexão da tentativa mais recente. `null` antes da primeira tentativa.", "properties": { "status": { "type": "string", "enum": [ "pending", "connected", "cancelled", "timeout", "failed", "unsupported", "revoked", "expired" ] }, "institution_id": { "type": "string", "nullable": true, "description": "O ID do banco. `null` para uma verificação de conta, em que nenhum banco é escolhido." }, "institution_name": { "type": "string", "nullable": true, "description": "O nome do banco. `null` para uma verificação de conta." }, "institution_country": { "type": "string", "nullable": true, "description": "O país da conta, em ISO 3166-1 alfa-3." }, "oauth": { "type": "boolean", "nullable": true, "description": "Se o login no banco foi feito por OAuth ou app-to-app. `null` para uma verificação de conta." }, "connected_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a conexão foi bem-sucedida." }, "consent_expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o consentimento bancário termina, para login bancário." }, "last_refreshed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando os dados financeiros foram lidos novamente pela última vez." }, "attempts": { "type": "integer", "description": "As tentativas que a pessoa usou nesta etapa, somando todos os métodos." }, "reason_code": { "type": "string", "nullable": true, "description": "Por que a conexão não está simplesmente `connected`, por exemplo `USER_CANCELLED`, `INSTITUTION_DOWN`, `ACCOUNT_NOT_FOUND`, `REFERENCE_IDENTITY_MISSING` ou `VERIFICATION_COMPLETED`." } } }, "account": { "type": "object", "nullable": true, "description": "A conta avaliada. `null` até que uma conta seja avaliada.", "properties": { "account_id_masked": { "type": "string", "nullable": true, "description": "O número da conta, mascarado." }, "iban_masked": { "type": "string", "nullable": true, "description": "O IBAN, mascarado." }, "sort_code": { "type": "string", "nullable": true, "description": "O código de agência (sort code), no Reino Unido." }, "routing_number_masked": { "type": "string", "nullable": true, "description": "O número de roteamento, mascarado." }, "type": { "type": "string", "nullable": true, "enum": [ "checking", "current", "savings", "business", "other" ] }, "subtype": { "type": "string", "nullable": true, "description": "O subtipo de conta próprio do banco." }, "currency": { "type": "string", "nullable": true, "description": "Moeda ISO 4217 da conta." }, "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": "Como o titular da conta se compara com a identidade verificada. `null` até que uma conta seja avaliada.", "properties": { "result": { "type": "string", "enum": [ "match", "partial_match", "no_match", "unknown", "not_verifiable" ], "description": "`partial_match` é uma correspondência próxima. `not_verifiable`: o banco respondeu sem um titular para comparar. `unknown`: não foi possível ler a evidência, ou não havia identidade para comparar." }, "reference_identity_source": { "type": "string", "nullable": true, "description": "A etapa com cuja identidade o titular foi comparado: `kyc`, `database_validation`, `expected_details`, `questionnaire`, `document_ai` ou `kyb`." }, "name_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "Pontuação da Didit para o nome do titular." }, "provider_name_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "A pontuação própria do banco para o nome do titular, quando ele retornou uma." }, "address_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "A pontuação do endereço do titular, quando a correspondência de endereço foi executada." }, "email_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "A pontuação do e-mail do titular, quando a correspondência de e-mail foi executada." }, "phone_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "A pontuação do telefone do titular, quando a correspondência de telefone foi executada." }, "dob_score": { "type": "integer", "minimum": 0, "maximum": 100, "nullable": true, "description": "A pontuação da data de nascimento do titular, quando o banco compartilhou uma." }, "close_match": { "type": "boolean", "nullable": true, "description": "Se o nome ficou na faixa de correspondência próxima." }, "holder_confirmation": { "type": "string", "nullable": true, "enum": [ "pending", "confirmed", "rejected" ], "description": "A resposta da pessoa quando solicitada a confirmar um nome com correspondência aproximada. `null` quando isso nunca foi solicitado." }, "method": { "type": "string", "nullable": true, "enum": [ "exact", "token_set", "nickname", "transliteration", "fuzzy", "provider_only", "microdeposits" ], "description": "Qual comparação de nomes gerou a pontuação. Este não é o método de verificação: para isso, leia o `method` de nível superior." }, "matched_holder_index": { "type": "integer", "nullable": true }, "holders": { "type": "array", "items": { "type": "object" }, "description": "Cada titular listado pelo banco, com suas pontuações." }, "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": "Quando o veredito foi calculado." } } }, "financial_data": { "type": "object", "description": "Os dados financeiros que a etapa leu. Apenas o login bancário os lê.", "properties": { "balances": { "type": "object", "nullable": true, "description": "Com o escopo `balances`." }, "transactions": { "type": "object", "nullable": true, "description": "Com o escopo `transactions`." }, "income": { "type": "object", "nullable": true, "description": "Com o escopo `income`." }, "categorization": { "type": "object", "nullable": true, "description": "Categorização da Didit das transações lidas. `null` quando não há transações." }, "not_collected": { "type": "array", "items": { "type": "string", "enum": [ "balances", "income", "transactions" ] }, "description": "Os dados que a etapa solicitou e que o método que verificou a conta não coleta. Saldos, transações e renda vêm apenas do login bancário, então uma conta verificada por verificação de conta os lista aqui. Nunca é uma falha. Vazio caso contrário." } } }, "billing": { "type": "object", "nullable": true, "properties": { "route": { "type": "string", "enum": [ "native", "byok" ] }, "billed": { "type": "boolean" }, "marketplace_fee": { "type": "string", "nullable": true, "description": "A taxa de plataforma do marketplace cobrada, para `byok`." }, "usage_type": { "type": "string", "nullable": true, "description": "A linha de uso em que a cobrança foi lançada: `bank_verification` para um login bancário ou uma verificação de conta, `bank_statement_upload` para um envio de extrato sem uma tentativa bancária cobrada antes dele, e `bank_byok_fee` para a taxa do marketplace sobre o seu próprio provedor. `null` quando nada foi cobrado." } } }, "reference_identity": { "type": "object", "nullable": true, "description": "A identidade com a qual o titular foi comparado, com sua origem." }, "signals": { "type": "object", "nullable": true, "description": "Sinais da conta lidos do histórico de transações, quando a etapa leu algum." }, "connection_abandoned": { "type": "boolean", "nullable": true, "description": "Se a etapa terminou sem correspondência depois que a pessoa saiu no banco dela." }, "not_covered": { "type": "boolean", "nullable": true, "description": "Se não foi possível acessar o banco ou o país da pessoa nesta etapa. Também é `true` quando a pessoa continuou sem um banco porque nenhum método conseguia verificar o país ou o banco dela." }, "continued_without_bank": { "type": "boolean", "description": "Se a pessoa saiu da etapa com **Continue without your bank**. Nesse caso, `continuation` informa o motivo. `method` é `none` quando nenhuma tentativa foi avaliada antes de ela continuar. Após uma tentativa avaliada, como um titular que não corresponde, `method` continua sendo o método dessa tentativa, e seu veredito e seus códigos de motivo permanecem válidos. Retornado mesmo quando o fluxo de verificação (workflow) restringe os dados que retorna." }, "continuation": { "type": "object", "nullable": true, "description": "Como a pessoa continuou sem um banco. `null` quando ela não fez isso. Quando o fluxo restringe os dados que retorna, `reason` ainda é retornado e todas as outras chaves são `null`.", "properties": { "reason": { "type": "string", "enum": [ "no_route", "institution_unsupported", "attempts_exhausted", "person_choice" ], "description": "O motivo, conforme determinado pela Didit quando a pessoa continuou: `no_route` (nenhum login bancário ou verificação de conta atende o país dela), `institution_unsupported` (o banco escolhido não pode ser usado nesta etapa), `attempts_exhausted` (todas as tentativas já tinham sido usadas e nenhuma estava em andamento) ou `person_choice` (havia uma forma de verificar e a pessoa optou por continuar, inclusive quando o banco dela não podia ser acessado naquele momento). `no_route` e `institution_unsupported` seguem `bank_unsupported_action`, `attempts_exhausted` segue `bank_attempts_exhausted_action` e `person_choice` segue `bank_skipped_action`, a menos que uma tentativa avaliada já tenha decidido a etapa." }, "country": { "type": "string", "nullable": true, "description": "O país em que a pessoa estava fazendo a verificação, em ISO 3166-1 alfa-3. `null` quando ela continuou antes de escolher um." }, "offered": { "type": "array", "items": { "type": "string", "enum": [ "statement", "microdeposits" ] }, "nullable": true, "description": "As outras formas de verificação que esse país ofereceu à pessoa quando ela continuou, na ordem em que foram oferecidas: `statement` (envio de um extrato) e depois `microdeposits`. Vazio quando nenhuma foi oferecida." }, "institution_id": { "type": "string", "nullable": true, "description": "Para `institution_unsupported`, o ID do banco que a pessoa não conseguiu usar: o banco que ela escolheu ou o banco em que sua última tentativa terminou. A Didit obtém esse ID da sua própria lista de bancos, nunca do dispositivo da pessoa; por isso, um banco que não está nessa lista é `null`. `null` para todos os outros motivos." }, "institution_name": { "type": "string", "nullable": true, "description": "Para `institution_unsupported`, o nome desse banco, da mesma lista que `institution_id`. `null` quando essa lista não tem o banco e para todos os outros motivos." }, "continued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a pessoa continuou." } } }, "evidence_purged_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando as evidências bancárias foram excluídas conforme `bank_evidence_retention_days`. `null` caso contrário." }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Códigos informativos, por exemplo `holder_declared`. Um aviso nunca altera o status por si só." }, "reason_codes": { "type": "array", "items": { "type": "string" }, "description": "Por que o veredito saiu como saiu, por exemplo `OWNER_NAME_PARTIAL`. Mais de um pode se aplicar. `NOT_COVERED`: a pessoa continuou sem banco porque nenhum método conseguia verificar o país ou o banco dela. `SKIPPED`: a pessoa optou por continuar sem banco quando havia uma forma de verificar. Nenhum dos dois é adicionado quando uma tentativa avaliada já decidiu a etapa." }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "BankAccountCheckPersonHolder": { "type": "object", "description": "A pessoa que deve ser a titular da conta.", "required": [ "full_name" ], "properties": { "full_name": { "type": "string", "maxLength": 255, "description": "O nome completo da pessoa que deve ser titular da conta.", "example": "Maria Oliveira" } } }, "BankAccountCheckBusinessHolder": { "type": "object", "description": "A empresa que deve ser a titular da conta. Verifica uma conta empresarial.", "required": [ "business_name" ], "properties": { "business_name": { "type": "string", "maxLength": 255, "description": "O nome da empresa que deve ser titular da conta. Verifica uma conta empresarial." } } }, "BankVerificationPricing": { "type": "object", "description": "Preços de tabela públicos da Verificação bancária: o envio do extrato, a taxa pelo uso da própria chave do provedor e os métodos de cada país.", "required": [ "currency", "statement_upload", "own_provider_fee_usd", "countries" ], "properties": { "currency": { "type": "string", "enum": [ "USD" ], "description": "Moeda de todos os preços na resposta.", "example": "USD" }, "statement_upload": { "$ref": "#/components/schemas/BankStatementUploadPricing" }, "own_provider_fee_usd": { "type": "string", "description": "Tarifa por cada verificação de propriedade faturável em uma rota que usa seu próprio contrato com o provedor em vez do contrato da Didit, cobrada independentemente do resultado. Uma conexão cancelada, expirada por tempo limite ou abandonada não é cobrada. String decimal com 4 casas decimais, em USD.", "example": "0.0200" }, "countries": { "type": "object", "description": "Todos os países, indexados pelo código ISO 3166-1 alfa-3.", "additionalProperties": { "$ref": "#/components/schemas/BankVerificationPricingCountry" } } } }, "BankStatementUploadPricing": { "type": "object", "description": "Como o envio de extrato bancário é precificado.", "required": [ "price_usd", "included_after_charged_bank_attempt", "standalone_available" ], "properties": { "price_usd": { "type": "string", "description": "Preço do envio de um extrato após uma tentativa bancária cobrada. String decimal com 4 casas decimais, em USD.", "example": "0.0000" }, "included_after_charged_bank_attempt": { "type": "boolean", "description": "`true` quando o upload está incluído sem custo adicional após uma tentativa bancária cobrada na mesma sessão.", "example": true }, "standalone_available": { "type": "boolean", "description": "`true` quando o envio de extrato pode ser executado sozinho, sem uma tentativa bancária antes. `false` em produção; sessões de sandbox podem testá-lo sem faturamento.", "example": false } } }, "BankVerificationPricingCountry": { "type": "object", "description": "Os métodos de verificação bancária de um país e seus preços de tabela.", "required": [ "name", "methods" ], "properties": { "name": { "type": "string", "description": "Nome do país em inglês.", "example": "United Kingdom" }, "methods": { "$ref": "#/components/schemas/BankVerificationPricingMethods" } } }, "BankVerificationPricingMethods": { "type": "object", "description": "Os dois métodos de verificação bancária em um país.", "required": [ "open_banking", "account_lookup" ], "properties": { "open_banking": { "$ref": "#/components/schemas/BankSignInPricing" }, "account_lookup": { "$ref": "#/components/schemas/BankAccountCheckPricing" } } }, "BankSignInPricing": { "type": "object", "description": "Login no banco: a pessoa faz login no próprio banco. O preço é definido por mercado e é o mesmo para todos os bancos desse mercado.", "required": [ "available", "market", "price_usd", "add_ons" ], "properties": { "available": { "type": "boolean", "description": "`true` apenas onde a Didit oferece login bancário neste país em produção.", "example": true }, "market": { "type": "string", "nullable": true, "description": "O mercado cujo preço se aplica. `null` quando não disponível.", "example": "UK and EEA" }, "price_usd": { "type": "string", "nullable": true, "description": "Preço de tabela de um login bancário. `null` quando não disponível. String decimal com 4 casas decimais, em USD.", "example": "0.7900" }, "add_ons": { "type": "object", "description": "Complementos com preço neste país, cada um como string decimal com 4 casas decimais em USD, somados ao preço do login bancário. Somente os complementos oferecidos no país são listados; fica vazio quando o login bancário não está disponível.", "properties": { "balance": { "type": "string", "description": "Complemento de saldo da conta.", "example": "0.3500" }, "transactions": { "type": "string", "description": "Complemento de transações.", "example": "1.3000" } } } } }, "BankAccountCheckPricing": { "type": "object", "description": "Verificação de conta: a pessoa digita o número da conta e a Didit o confere junto ao banco. Preço definido por país.", "required": [ "available", "price_usd" ], "properties": { "available": { "type": "boolean", "description": "`true` apenas onde a Didit oferece a checagem de conta neste país em produção.", "example": true }, "price_usd": { "type": "string", "nullable": true, "description": "Preço de tabela de uma verificação de conta respondida pelo banco. `null` quando não disponível. String decimal com 4 casas decimais, em 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`: a Didit lista os registros com a chave. `api_ids`: envie os IDs dos registros de uma exportação. `export_file`: envie uma exportação no formato da 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": "Um job de importação de qualquer tipo, no formato que a gaveta de jobs de importação do console lê.", "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": "O estado da tarefa conforme exibido no console; `errors` é uma tarefa concluída com linhas rejeitadas." }, "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": "Um relatório regulatório finalizado que impede a exclusão solicitada.", "required": [ "uuid", "report_number", "report_type", "case_uuid" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID do relatório." }, "report_number": { "type": "string", "description": "Número do relatório exibido no Console (por exemplo, SAR-0001)." }, "report_type": { "type": "string", "enum": [ "SAR", "STR", "CTR", "TTR", "UTR", "IFT", "CBR", "TFR" ], "description": "Tipo de relatório regulatório." }, "case_uuid": { "type": "string", "format": "uuid", "description": "Caso ao qual o relatório pertence." } } }, "FiledReportTransaction": { "type": "object", "description": "Uma transação que não pode ser excluída porque um relatório regulatório finalizado a inclui.", "required": [ "uuid", "transaction_id", "reports" ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "UUID da transação na Didit." }, "transaction_id": { "type": "string", "description": "O identificador da transação informado quando a transação foi criada." }, "reports": { "type": "array", "items": { "$ref": "#/components/schemas/FiledRegulatoryReport" }, "description": "Relatórios finalizados que incluem esta transação." } } }, "InFiledReportError": { "type": "object", "description": "A exclusão é recusada porque os dados selecionados estão em um relatório regulatório finalizado. Nada é excluído. Exclua o relatório e repita a requisição.", "required": [ "detail", "code" ], "properties": { "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "in_filed_report" ], "description": "Código de erro estável para uma exclusão bloqueada por um relatório regulatório finalizado." }, "reports": { "type": "array", "items": { "$ref": "#/components/schemas/FiledRegulatoryReport" }, "description": "Relatórios que bloqueiam a exclusão de uma pessoa, empresa, caso ou sessão." }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/FiledReportTransaction" }, "description": "Transações que impedem a exclusão de uma transação, cada uma com os relatórios que a listam." } } }, "TravelRuleNetworkParticipantSummary": { "type": "object", "nullable": true, "description": "O participante próprio desta aplicação na rede, ou null quando não houver.", "properties": { "mode": { "type": "string", "enum": [ "platform", "own" ], "description": "platform: operado pela associação da Didit; own: com onboarding feito sob a associação própria da aplicação." }, "status": { "type": "string", "enum": [ "not_requested", "questionnaire_pending", "submitted_to_network", "active", "suspended", "rejected" ], "description": "not_requested: nunca solicitado, ou a rede recusou a primeira requisição (veja last_error); questionnaire_pending: aguardando a aprovação do questionário de due diligence; submitted_to_network: encaminhado ao onboarding da rede; active: a rede atribuiu a esta aplicação seu próprio código de participante; suspended / rejected: a Didit suspendeu ou rejeitou." }, "participant_code": { "type": "string", "description": "O código que a rede atribuiu a esta aplicação (no GTR, o código VASP dela). As mensagens enviadas levam este código, nunca o da própria Didit." }, "requested_at": { "type": "string", "format": "date-time", "nullable": true }, "activated_at": { "type": "string", "format": "date-time", "nullable": true }, "last_error": { "type": "string", "description": "A resposta da rede quando ela recusou o registro; vazio nos demais casos." } } }, "TravelRuleNetworkState": { "type": "object", "description": "Como as mensagens da Travel Rule em uma rede seriam enviadas para esta aplicação e por que não podem ser. É o status da configuração, não uma verificação em tempo real de funcionamento ou de entrega.", "properties": { "rail": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA" ] }, "mode": { "type": "string", "enum": [ "own", "didit", "off", "unavailable" ], "description": "own: é usada a associação conectada da aplicação; didit: a associação da Didit inclui a aplicação como participante ativo próprio; off: roteamento pela plataforma desativado em disabled_networks, sem associação própria; unavailable: nada pode enviar por esta rede ainda (veja state e 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: sua associação conectada envia; live_through_didit: seu próprio participante na associação da Didit envia; off: você desativou o roteamento pela plataforma; didit_onboarding: a associação da própria Didit nesta rede ainda não está ativa, então não pode atender ninguém; questionnaire_needed / questionnaire_in_review: o questionário de due diligence precisa ser enviado ou está com a Didit; request_access: o questionário foi aprovado, solicite a rede; request_sent: seu participante está passando pelo onboarding; unavailable: veja reason; error: veja 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": "Detalhe legível por máquina do estado. own_membership_only: a Didit não registra aplicações nesta rede (TRUST), conecte sua própria associação; sandbox_application: transferências de sandbox nunca chegam a uma rede; provisioning_failed: a rede recusou o registro, o last_error do participante informa o motivo e solicitar a rede novamente faz uma nova tentativa." }, "platform_available": { "type": "boolean", "description": "Indica se a associação da própria Didit a esta rede está configurada; não é uma verificação de integridade em tempo real." }, "connected": { "type": "boolean", "description": "Indica se existe uma associação de cliente conectada. As credenciais são validadas localmente; a validação na rede ocorre em uma troca real." }, "participant": { "$ref": "#/components/schemas/TravelRuleNetworkParticipantSummary" }, "vasps_reachable": { "type": "integer", "description": "VASPs do diretório acessíveis nesta rede." }, "routed_30d": { "type": "integer", "description": "As transferências desta aplicação realizadas nesta rede nos últimos 30 dias." } } }, "TravelRuleNetworkQuestionnaireAnswers": { "type": "object", "description": "Questionário de due diligence da rede da Didit. Os salvamentos são parciais: cada salvamento mantém todas as respostas que não menciona. O envio exige todos os campos, exceto lei e data_protection_contact_email, e as três declarações como true.", "properties": { "legal_name": { "type": "string", "maxLength": 255 }, "registration_number": { "type": "string", "maxLength": 255 }, "incorporation_country": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Código de país ISO 3166-1 alpha-2." }, "registered_address": { "type": "string", "maxLength": 1000 }, "website": { "type": "string", "format": "uri", "maxLength": 500 }, "lei": { "type": "string", "maxLength": 20, "description": "Opcional. Um LEI ISO 17442 válido, quando informado." }, "licences": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "regulator", "jurisdiction", "licence_type", "licence_number" ], "properties": { "regulator": { "type": "string", "maxLength": 255 }, "jurisdiction": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Código de país ISO 3166-1 alpha-2." }, "licence_type": { "type": "string", "maxLength": 255 }, "licence_number": { "type": "string", "maxLength": 255 } } }, "description": "Todas as licenças ou registros que o VASP possui." }, "operating_jurisdictions": { "type": "array", "minItems": 1, "maxItems": 250, "items": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Código de país ISO 3166-1 alpha-2." } }, "compliance_officer_name": { "type": "string", "maxLength": 255 }, "compliance_officer_email": { "type": "string", "format": "email" }, "aml_ctf_policy_attested": { "type": "boolean", "description": "Deve ser true para enviar." }, "sanctions_screening_attested": { "type": "boolean", "description": "Deve ser true para enviar." }, "data_protection_attested": { "type": "boolean", "description": "Deve ser true para enviar." }, "data_protection_contact_email": { "type": "string", "format": "email", "description": "Opcional." }, "expected_monthly_transfers": { "type": "integer", "minimum": 0 }, "expected_monthly_volume_usd": { "type": "string", "format": "decimal", "description": "Volume mensal esperado em USD, com até 2 casas decimais. Retornado como string." }, "assets": { "type": "array", "minItems": 1, "maxItems": 200, "items": { "type": "string", "maxLength": 32 }, "description": "Tickers dos ativos, armazenados em maiúsculas, ordenados e sem duplicatas." } } }, "TravelRuleNetworkQuestionnaire": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "draft", "submitted", "changes_requested", "approved", "rejected" ], "description": "As respostas podem ser salvas enquanto o status for draft ou changes_requested. Somente a Didit pode mudar o status para submitted, approved e 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": "Observação da Didit sobre a sua última decisão, por exemplo, o que alterar." }, "history": { "type": "array", "readOnly": true, "description": "Todas as mudanças de status, da mais antiga para a mais recente.", "items": { "type": "object", "properties": { "at": { "type": "string", "format": "date-time" }, "from": { "type": "string" }, "to": { "type": "string" }, "note": { "type": "string", "description": "Nota de revisão ou a resposta da rede, quando houver." } } } }, "updated_at": { "type": "string", "format": "date-time", "nullable": true } } }, "TravelRuleNetworkParticipant": { "type": "object", "description": "O participante próprio desta aplicação em uma rede.", "properties": { "network": { "type": "string", "enum": [ "gtr", "trust", "verifyvasp", "sygna" ] }, "rail": { "type": "string", "enum": [ "GTR", "TRUST", "VERIFYVASP", "SYGNA" ] }, "mode": { "type": "string", "enum": [ "platform", "own" ] }, "status": { "type": "string", "enum": [ "not_requested", "questionnaire_pending", "submitted_to_network", "active", "suspended", "rejected" ], "description": "not_requested: nunca solicitado, ou a rede recusou a primeira requisição (veja last_error); questionnaire_pending: aguardando a aprovação do questionário de due diligence; submitted_to_network: encaminhado ao onboarding da rede; active: a rede atribuiu a esta aplicação seu próprio código de participante; suspended / rejected: a Didit suspendeu ou rejeitou." }, "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": "A resposta da rede quando ela recusou o registro; vazio nos demais casos." }, "history": { "type": "array", "readOnly": true, "description": "Todas as mudanças de status, da mais antiga para a mais recente.", "items": { "type": "object", "properties": { "at": { "type": "string", "format": "date-time" }, "from": { "type": "string" }, "to": { "type": "string" }, "note": { "type": "string", "description": "Nota de revisão ou a resposta da rede, quando houver." } } } } } }, "TravelRuleNetworksOverview": { "type": "object", "properties": { "platform_networks_enabled": { "type": "boolean", "description": "Indica se o acesso à rede por meio da associação da Didit está aberto. Enquanto for false, salvamentos de questionários, envios e requisições à rede respondem 403." }, "questionnaire": { "$ref": "#/components/schemas/TravelRuleNetworkQuestionnaire" }, "participants": { "type": "array", "items": { "$ref": "#/components/schemas/TravelRuleNetworkParticipant" } }, "networks": { "type": "object", "readOnly": true, "description": "Por rede, como esta aplicação faria o envio e por que não consegue. Nenhuma rede, incluindo a GTR, é incluída por padrão: uma rede fica acessível por meio da sua própria associação conectada, ou por meio da associação da Didit assim que a associação da Didit a essa rede estiver ativa e o seu próprio participante nela estiver ativo. Não é uma verificação em tempo real de funcionamento ou de entrega.", "properties": { "gtr": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "trust": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "verifyvasp": { "$ref": "#/components/schemas/TravelRuleNetworkState" }, "sygna": { "$ref": "#/components/schemas/TravelRuleNetworkState" } } } } }, "AddressValidationResult": { "type": "object", "description": "O resultado de uma Address Validation: se o endereço existe e sua forma normalizada. Ela confirma apenas o endereço; nunca vincula o endereço a uma pessoa.", "required": [ "status", "verification_level", "address", "formatted_address", "latitude", "longitude" ], "properties": { "status": { "type": "string", "enum": [ "verified", "partially_verified", "not_verified", "unavailable" ], "description": "`verified`: o endereço foi confirmado até o nível do edifício (ou do apartamento ou da caixa postal). `partially_verified`: foi confirmado apenas até a rua, ou até o nível mais preciso que os dados postais de referência têm para aquele local. `not_verified`: apenas a região ou a cidade corresponderam, ou nada correspondeu. `unavailable`: a validação não pôde ser executada (por exemplo, o serviço de referência não respondeu); ela não é cobrada e nunca afeta uma verificação." }, "verification_level": { "type": "string", "nullable": true, "enum": [ "administrative_area", "locality", "thoroughfare", "premise", "delivery_point", null ], "description": "O nível mais preciso em que o endereço foi correspondido. `null` quando nada correspondeu ou `status` é `unavailable`." }, "address": { "type": "object", "nullable": true, "description": "O endereço normalizado. `null` quando `status` é `unavailable`.", "properties": { "address_line_1": { "type": "string", "nullable": true, "description": "Primeira linha de entrega, escrita da forma usada no país.", "example": "1600 Amphitheatre Pkwy" }, "address_line_2": { "type": "string", "nullable": true, "description": "Segunda linha de entrega (apartamento, edifício ou bairro), quando o endereço tiver uma." }, "city": { "type": "string", "nullable": true, "example": "Mountain View" }, "region": { "type": "string", "nullable": true, "description": "Estado, província ou região.", "example": "CA" }, "postal_code": { "type": "string", "nullable": true, "example": "94043-1351" }, "country": { "type": "string", "nullable": true, "description": "Código de país ISO 3166-1 alpha-2.", "example": "US" } } }, "formatted_address": { "type": "string", "nullable": true, "description": "O endereço normalizado em uma linha.", "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": "Um endereço: em uma única linha (`address`) ou como campos estruturados com pelo menos `address_line_1`, nunca ambos.", "properties": { "address": { "type": "string", "maxLength": 500, "description": "O endereço completo em uma linha.", "example": "Paseo de la Castellana 259, 28046 Madrid" }, "address_line_1": { "type": "string", "maxLength": 255, "description": "Logradouro e número.", "example": "1600 Amphitheatre Pkwy" }, "address_line_2": { "type": "string", "maxLength": 255, "description": "Apartamento, sala, andar ou edifício." }, "city": { "type": "string", "maxLength": 128, "description": "Cidade ou localidade.", "example": "Mountain View" }, "region": { "type": "string", "maxLength": 128, "description": "Estado, província ou região.", "example": "CA" }, "postal_code": { "type": "string", "maxLength": 32, "example": "94043" }, "country": { "type": "string", "maxLength": 3, "description": "Código ISO 3166-1 alpha-2 ou alpha-3 do país do endereço.", "example": "US" } } }, "AddressValidationResponse": { "type": "object", "required": [ "request_id", "address_validation", "created_at" ], "properties": { "request_id": { "type": "string", "format": "uuid", "description": "Identificador desta requisição; informe-o ao suporte. Nenhuma sessão é criada." }, "address_validation": { "$ref": "#/components/schemas/AddressValidationResult" }, "created_at": { "type": "string", "format": "date-time" } } }, "TravelRuleWalletProofFailureReason": { "type": "string", "enum": [ "", "SIGNATURE_INVALID", "SIGNATURE_UNSUPPORTED_SCHEME", "DEPOSIT_NOT_FOUND", "DEPOSIT_UNCONFIRMED", "DEPOSIT_LOOKUP_FAILED", "DEPOSIT_MISMATCH", "DEPOSIT_STALE", "TXID_REUSED", "CHAIN_UNSUPPORTED", "WINDOW_EXPIRED", "OWNERSHIP_CHANGED", "METHOD_SWITCHED", "REVIEW_REJECTED", "ABANDONED" ], "description": "Por que uma prova de propriedade de carteira, ou sua última tentativa, não chegou a VERIFIED. Vazio quando nada falhou. Uma prova PENDING pode ter um motivo: a última tentativa falhou e o usuário final pode tentar novamente. DEPOSIT_MISMATCH, DEPOSIT_STALE, TXID_REUSED e REVIEW_REJECTED encerram a prova como REJECTED. SIGNATURE_INVALID: a assinatura não corresponde à carteira e ao desafio. SIGNATURE_UNSUPPORTED_SCHEME: a carteira assinou em um formato que a Didit não verifica. DEPOSIT_NOT_FOUND, DEPOSIT_UNCONFIRMED, DEPOSIT_LOOKUP_FAILED: o depósito de teste não pode ser lido ou ainda não foi confirmado; a Didit continua verificando-o até a janela de teste fechar. DEPOSIT_MISMATCH: a transação não envia o valor esperado da carteira para o endereço de depósito. DEPOSIT_STALE: a transação é anterior ao desafio. TXID_REUSED: a transação já comprovou outra carteira. CHAIN_UNSUPPORTED: o método não está disponível nesta blockchain. WINDOW_EXPIRED: a janela de teste fechou. OWNERSHIP_CHANGED: o titular da carteira mudou, ou a carteira foi excluída do seu catálogo de endereços, depois que a sessão do widget foi criada. METHOD_SWITCHED: o usuário final escolheu outro método antes de concluir este. REVIEW_REJECTED: seu revisor rejeitou a captura de tela. ABANDONED: a sessão do widget expirou antes de o usuário final concluir." }, "TravelRuleWidgetProofError": { "type": "object", "properties": { "detail": { "type": "string", "description": "Mensagem legível em inglês." }, "code": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleWalletProofFailureReason" } ], "description": "Motivo legível por máquina, para que um cliente possa exibir sua própria mensagem traduzida." }, "status": { "type": "string", "enum": [ "PENDING", "VERIFIED", "REJECTED", "EXPIRED" ], "description": "Presente quando a prova está encerrada: REJECTED pelo depósito que acabou de ser enviado (400), ou REJECTED ou EXPIRED quando evidências são enviadas para uma prova que já está encerrada (409)." }, "proof_id": { "type": "string", "format": "uuid", "description": "Presente com status: a prova encerrada." }, "method": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SATOSHI_TEST", "SCREENSHOT", "SELF_DECLARATION" ], "description": "Presente com status: o método da prova encerrada." }, "max_attempts": { "type": "integer", "description": "Presente com status: provas de carteira recusadas que esta sessão permite." }, "attempts_used": { "type": "integer", "description": "Presente com status: provas recusadas até o momento." }, "attempts_remaining": { "type": "integer", "description": "Presente com status: quando for 0, iniciar outra prova retorna 409 e você gera uma nova sessão do widget." } } }, "TravelRuleWidgetProofCreate": { "type": "object", "required": [ "method" ], "properties": { "method": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SATOSHI_TEST", "SCREENSHOT", "SELF_DECLARATION" ], "description": "O método de comprovação que o usuário final escolheu. Deve ser um dos allowed_methods do contexto." }, "wallet_address": { "type": "string", "maxLength": 128, "description": "O padrão é o wallet_address da sessão. Deve corresponder à carteira da transferência quando a sessão estiver vinculada a uma transferência." }, "chain": { "type": "string", "maxLength": 32, "description": "O padrão é a blockchain da sessão." } } }, "TravelRuleWidgetProofVerifyResult": { "type": "object", "properties": { "proof_id": { "type": "string", "format": "uuid" }, "method": { "type": "string", "enum": [ "MESSAGE_SIGNING", "SATOSHI_TEST", "SCREENSHOT", "SELF_DECLARATION" ] }, "status": { "type": "string", "enum": [ "PENDING", "VERIFIED", "REJECTED", "EXPIRED" ] }, "is_ownership_verified": { "type": "boolean", "description": "Presente quando a prova está VERIFIED: a entrada do catálogo de endereços agora tem a propriedade verificada." }, "transfer_status": { "type": "string", "nullable": true, "description": "Presente quando a prova está VERIFIED: o status da transferência vinculada, null quando não há uma." }, "detail": { "type": "string", "description": "Presente enquanto a prova permanece PENDING: uma captura de tela enviada aguardando revisão, ou um depósito de teste ainda não confirmado." }, "code": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleWalletProofFailureReason" } ], "description": "Presente em um depósito de teste pendente: o motivo pelo qual ele ainda não foi confirmado." } } }, "TravelRuleWalletProofReview": { "type": "object", "properties": { "proof_id": { "type": "string", "format": "uuid" }, "method": { "type": "string", "enum": [ "SCREENSHOT" ] }, "status": { "type": "string", "enum": [ "PENDING", "VERIFIED", "REJECTED", "EXPIRED" ] }, "wallet_address": { "type": "string" }, "chain": { "type": "string", "description": "Identificador canônico da blockchain, por exemplo, ETH, BTC, SOL, TRX." }, "holder_name": { "type": "string" }, "is_ownership_verified": { "type": "boolean", "description": "Se a entrada do catálogo de endereços tem a propriedade verificada, por esta prova ou por outra." }, "transaction_id": { "type": "string", "format": "uuid", "nullable": true, "description": "A transação para cuja transferência da Travel Rule a sessão do widget foi criada. Null para uma sessão criada sem um transaction_id." }, "file_name": { "type": "string", "nullable": true }, "content_type": { "type": "string", "nullable": true }, "screenshot_url": { "type": "string", "nullable": true, "description": "Link com tempo limitado para a captura de tela enviada. Liste a fila novamente para obter um link novo." }, "attempts": { "type": "integer", "description": "Quantos arquivos o usuário final enviou para esta comprovação." }, "failure_reason": { "allOf": [ { "$ref": "#/components/schemas/TravelRuleWalletProofFailureReason" } ], "description": "REVIEW_REJECTED após uma rejeição, OWNERSHIP_CHANGED quando a carteira mudou de titular ou foi excluída antes de uma decisão. Vazio nos demais casos." }, "method_chosen_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o usuário final escolheu o método de captura de tela." }, "decided_at": { "type": "string", "format": "date-time", "nullable": true }, "decided_by": { "type": "string", "description": "Quem encerrou o comprovante: review: para um revisor do console, review para uma decisão via chave de API, widget ou sweeper quando a Didit o encerrou automaticamente. Vazio enquanto PENDING." }, "review_note": { "type": "string", "description": "A nota enviada com a decisão. Vazia quando não há nenhuma." }, "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. Mantido junto com a comprovação e retornado como review_note." } } }, "DigitalIdWalletApiWalletDigitalCredentialsRequest": { "type": "object", "properties": { "protocol": { "type": "string", "description": "openid4vp-v1-signed." }, "request": { "type": "object", "additionalProperties": {}, "description": "Passe sem alterações: navigator.credentials.get({digital: request}) no navegador, ou JSON.stringify(request) como requestJson de GetDigitalCredentialOption no Android. Assinado pela Didit para a sua aplicação." } }, "required": [ "protocol", "request" ] }, "DigitalIdWalletApiGoogleWalletWalletVerificationStartRequest": { "type": "object", "description": "Inicie uma verificação com Google Wallet (USA, GBR, BRA, SGP, TWN).", "properties": { "vendor_data": { "type": "string", "nullable": true, "description": "Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks." }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks." }, "sandbox_scenario": { "type": "string", "minLength": 1, "description": "Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/." }, "country": { "allOf": [ { "$ref": "#/components/schemas/DigitalIdWalletApiGoogleWalletWalletVerificationStartCountryEnum" } ], "description": "País ISO 3166-1 alpha-3 da identidade do Google Wallet.\n\n* `USA` - USA\n* `GBR` - GBR\n* `BRA` - BRA\n* `SGP` - SGP\n* `TWN` - TWN" }, "origin": { "type": "string", "minLength": 1, "description": "Onde sua página ou app fará a requisição à carteira: a origem https da sua página (o host dela deve estar em allowed_return_hosts da aplicação ou ser o domínio de marca própria da aplicação), por exemplo https://app.example.com, ou android:apk-key-hash:. A carteira recusa a requisição em qualquer outro lugar.", "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": "O que a carteira respondeu à sua página ou aplicativo, em uma verificação ``request_digital_credential``.", "properties": { "response": { "type": "object", "additionalProperties": {}, "description": "Exatamente o que a carteira retornou: {protocol, data} da DigitalCredential de navigator.credentials.get, ou o credentialJson analisado da DigitalCredential do Android. Criptografado para a Didit; não o altere." } }, "required": [ "response" ] }, "SessionFilesExport": { "type": "object", "description": "Um ZIP com todos os arquivos de uma sessão, em qualidade 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 da exportação. Informe-o em `GET /v3/session/{sessionId}/files-export/{exportId}/`." }, "session_id": { "type": "string", "format": "uuid", "description": "A sessão de onde vêm os arquivos." }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "READY", "FAILED", "EXPIRED" ], "description": "`PENDING` e `PROCESSING` enquanto o ZIP é preparado, `READY` quando ele já pode ser baixado, `FAILED` quando não foi possível prepará-lo (solicite uma nova exportação), `EXPIRED` depois que o ZIP foi excluído." }, "file_count": { "type": "integer", "nullable": true, "description": "Arquivos no ZIP. Definido apenas enquanto `status` for `READY`." }, "size_bytes": { "type": "integer", "format": "int64", "nullable": true, "description": "Tamanho do ZIP em bytes. Definido apenas enquanto `status` é `READY`." }, "download_url": { "type": "string", "format": "uri", "nullable": true, "description": "URL assinada do ZIP, válida por pouco tempo. Definida somente enquanto `status` for `READY`; leia a exportação novamente para obter uma nova." }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o ZIP é excluído, 24 horas depois de ficar pronto. Definido apenas enquanto `status` for `READY`." }, "error": { "type": "string", "nullable": true, "description": "Por que a exportação falhou, quando `status` é `FAILED`." }, "created_at": { "type": "string", "format": "date-time", "description": "Quando a exportação foi solicitada." }, "completed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o ZIP ficou pronto ou a exportação falhou." } } }, "TransactionRuleSuggestionsCreatedEvent": { "description": "Uma execução de sugestão de regras de transação propôs novas alterações de regras para sua aplicação. Enviado quando as configurações de sugestão de regras têm as notificações por webhook ativadas. Não há `status` de nível 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": "A execução de sugestões que gerou as novas sugestões." }, "open_count": { "type": "integer", "description": "Número de sugestões que continuam abertas após esta execução, incluindo as novas." }, "suggestions": { "type": "array", "description": "As sugestões criadas por esta execução.", "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` propõe uma nova regra, `TWEAK` altera uma existente, `DISABLE` desativa uma." }, "title": { "type": "string" }, "rule_id": { "type": "string", "format": "uuid", "nullable": true, "description": "A regra à qual uma sugestão `TWEAK` ou `DISABLE` se aplica; `null` para `ADD`." }, "expected_impact": { "type": "object", "additionalProperties": true, "description": "O que a alteração faria, conforme a sugestão a exibe no Console." } } } } }, "required": [ "webhook_type", "run_id", "open_count", "suggestions" ] } ] }, "GeolocationCheck": { "type": "object", "description": "Um resultado de verificação de localização: a tentativa aceita de um nó do fluxo. Medição, incerteza e autenticidade são chaves separadas, de modo que uma localização precisa sem atestação é interpretada de forma diferente de uma localização imprecisa com atestação.", "properties": { "node_id": { "type": "string", "nullable": true, "description": "Nó do fluxo que gerou este resultado, para que um fluxo com duas etapas de verificação de localização continue legível." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Status desta etapa de verificação de localização no nível do recurso, determinado a partir dos seus avisos. É independente do `status` da sessão." }, "outcome": { "type": "string", "nullable": true, "description": "O que aconteceu nesta tentativa.", "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": "O que o sistema operacional ou o navegador concedeu. `not_requested` significa que a etapa usa apenas a localização por IP da conexão, de modo que nunca é solicitada uma permissão à pessoa.", "enum": [ "granted_precise", "granted_approximate", "denied", "restricted", "unavailable", "timeout", "dismissed", "not_requested", null ] }, "latitude": { "type": "number", "nullable": true, "description": "Latitude WGS84 da posição obtida. `null` quando não há posição.", "format": "double" }, "longitude": { "type": "number", "nullable": true, "description": "Longitude WGS84 da posição obtida. `null` quando não há posição.", "format": "double" }, "accuracy_m": { "type": "number", "nullable": true, "description": "Raio de incerteza em metros, no nível de confiança indicado em `accuracy_confidence`.", "format": "double" }, "accuracy_confidence": { "type": "string", "nullable": true, "description": "Nível de confiança que a plataforma associa a `accuracy_m`: `p95` (navegadores), `p68` (Android) ou `unspecified` (iOS).", "enum": [ "p95", "p68", "unspecified", null ] }, "measured_at": { "type": "string", "nullable": true, "description": "Quando o dispositivo obteve a localização, segundo o próprio relógio.", "format": "date-time" }, "age_seconds": { "type": "integer", "nullable": true, "description": "Segundos entre o momento em que o dispositivo obtém a localização e o momento em que a Didit a recebe." }, "source": { "type": "string", "nullable": true, "description": "A origem da posição obtida, quando a plataforma informa. `ip` significa que a posição é a localização do IP da conexão.", "enum": [ "gps", "fused", "network", "wifi", "cell", "browser", "unknown", "ip", null ] }, "platform": { "type": "string", "nullable": true, "description": "O cliente que gerou a leitura de localização (fix).", "enum": [ "web", "ios", "android", "react_native", "flutter", null ] }, "sdk_version": { "type": "string", "nullable": true, "description": "Versão do SDK que gerou a localização." }, "is_mock": { "type": "boolean", "nullable": true, "description": "`true` quando o dispositivo informa que a localização veio de um provedor de localização simulada ou de um software de simulação. `null` quando a plataforma não informa isso (navegadores não conseguem detectar); `null` não equivale a `false`." }, "produced_by_accessory": { "type": "boolean", "nullable": true, "description": "Somente iOS: `true` quando a posição veio de um acessório externo. `null` nos demais casos." }, "integrity": { "type": "string", "enum": [ "attested", "not_attested", "failed", "unsupported", "not_determined" ], "description": "Indica se a atestação do dispositivo respalda a localização obtida. `unsupported` é o que os navegadores informam, porque a web não tem mecanismo de atestação; não é uma falha." }, "country_code": { "type": "string", "nullable": true, "description": "País em que a localização foi obtida, no formato ISO 3166-1 alpha-2." }, "region_code": { "type": "string", "nullable": true, "description": "Subdivisão ISO 3166-2 em que a localização se encontra." }, "city": { "type": "string", "nullable": true, "description": "Localidade povoada mais próxima, um rótulo para os revisores." }, "geofence": { "type": "object", "description": "Resultado das regras de país e área da etapa.", "properties": { "enabled": { "type": "boolean", "description": "Se a etapa aplica alguma regra de país ou de área." }, "result": { "type": "string", "nullable": true, "description": "Onde a posição se situa em relação às regras. `undetermined` significa que o círculo de precisão cruza a fronteira ou que a posição não correspondeu a nenhum país; não é evidência de estar fora.", "enum": [ "inside", "outside", "undetermined", null ] } } }, "inside_geofence": { "type": "boolean", "nullable": true, "description": "`true` quando `geofence.result` é `inside`, `false` quando é `outside` e `null` nos demais casos." }, "geofence_basis": { "type": "string", "nullable": true, "description": "A partir de qual posição o resultado da área foi avaliado: a posição do `device` ou a localização do `ip` da conexão.", "enum": [ "device", "ip", null ] }, "inside_areas": { "type": "array", "items": { "type": "string" }, "description": "IDs das áreas permitidas configuradas dentro das quais a posição está." }, "blocked_areas": { "type": "array", "items": { "type": "string" }, "description": "IDs das áreas bloqueadas configuradas em que a posição está." }, "position_source": { "type": "string", "nullable": true, "description": "De onde a etapa obtém a posição, conforme configurado: o dispositivo comparado com a localização do IP, apenas o dispositivo ou apenas a localização do IP.", "enum": [ "device_and_ip", "device_only", "ip_only", null ] }, "anonymizers": { "type": "object", "nullable": true, "description": "Como são a conexão e o dispositivo, cada um `true`, `false` ou `null` quando a fonte não consegue 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 até a localização do IP da sessão depois de subtraídos os dois raios de incerteza; `0` quando eles se sobrepõem.", "format": "double" }, "ip_distance_uncertainty_km": { "type": "number", "nullable": true, "description": "Raio combinado que foi subtraído: o raio da localização do IP mais a precisão desta posição.", "format": "double" }, "ip_consistent": { "type": "boolean", "nullable": true, "description": "Indica se `ip_distance_km` está dentro da distância configurada na etapa. `null` quando qualquer um dos lados é desconhecido." }, "document_distance_km": { "type": "number", "nullable": true, "description": "Distância até o endereço geocodificado no documento de identidade ou no comprovante de endereço. `null` quando não há endereço registrado.", "format": "double" }, "travel_excused": { "type": "boolean", "nullable": true, "description": "Se a tolerância de deslocamento da etapa justificou a distância em relação ao endereço. `null` quando a tolerância está desativada." }, "consecutive_mismatches": { "type": "integer", "nullable": true, "description": "Na última tentativa: esta verificação mais as divergências anteriores consecutivas da mesma pessoa." }, "attempts": { "type": "integer", "description": "Número desta tentativa dentro do nó, começando em 1." }, "consent": { "type": "object", "nullable": true, "description": "O consentimento que a pessoa deu antes do prompt do sistema, registrado com a versão do texto e o idioma que ela viu.", "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": "O recurso que gerou este aviso. O valor identifica o bloco de recurso ao qual o aviso pertence. O array de avisos de cada módulo normalmente usa o valor correspondente ao seu módulo (por exemplo, `PHONE` dentro de `phone_verifications[].warnings`), mas o enum acima é a referência oficial para todos os avisos de recursos no payload de decisão." }, "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": "O ID do nó do grafo do fluxo que gerou este aviso" } } }, "description": "Avisos gerados por esta etapa de verificação de localização, com `feature` definido como `GEOLOCATION`. Os códigos de aviso começam com `LOCATION_`." } } }, "GeolocationAttempt": { "type": "object", "description": "Uma tentativa de uma etapa de verificação de localização: as mesmas chaves de `geolocation_checks[]`, exceto `warnings`, além do momento em que a Didit a recebeu.", "properties": { "node_id": { "type": "string", "nullable": true, "description": "Nó do fluxo que gerou este resultado, para que um fluxo com duas etapas de verificação de localização continue legível." }, "status": { "type": "string", "enum": [ "Not Finished", "Approved", "Declined", "In Review", "Resub Requested" ], "description": "Status desta etapa de verificação de localização no nível do recurso, determinado a partir dos seus avisos. É independente do `status` da sessão." }, "outcome": { "type": "string", "nullable": true, "description": "O que aconteceu nesta tentativa.", "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": "O que o sistema operacional ou o navegador concedeu. `not_requested` significa que a etapa usa apenas a localização por IP da conexão, de modo que nunca é solicitada uma permissão à pessoa.", "enum": [ "granted_precise", "granted_approximate", "denied", "restricted", "unavailable", "timeout", "dismissed", "not_requested", null ] }, "latitude": { "type": "number", "nullable": true, "description": "Latitude WGS84 da posição obtida. `null` quando não há posição.", "format": "double" }, "longitude": { "type": "number", "nullable": true, "description": "Longitude WGS84 da posição obtida. `null` quando não há posição.", "format": "double" }, "accuracy_m": { "type": "number", "nullable": true, "description": "Raio de incerteza em metros, no nível de confiança indicado em `accuracy_confidence`.", "format": "double" }, "accuracy_confidence": { "type": "string", "nullable": true, "description": "Nível de confiança que a plataforma associa a `accuracy_m`: `p95` (navegadores), `p68` (Android) ou `unspecified` (iOS).", "enum": [ "p95", "p68", "unspecified", null ] }, "measured_at": { "type": "string", "nullable": true, "description": "Quando o dispositivo obteve a localização, segundo o próprio relógio.", "format": "date-time" }, "age_seconds": { "type": "integer", "nullable": true, "description": "Segundos entre o momento em que o dispositivo obtém a localização e o momento em que a Didit a recebe." }, "source": { "type": "string", "nullable": true, "description": "A origem da posição obtida, quando a plataforma informa. `ip` significa que a posição é a localização do IP da conexão.", "enum": [ "gps", "fused", "network", "wifi", "cell", "browser", "unknown", "ip", null ] }, "platform": { "type": "string", "nullable": true, "description": "O cliente que gerou a leitura de localização (fix).", "enum": [ "web", "ios", "android", "react_native", "flutter", null ] }, "sdk_version": { "type": "string", "nullable": true, "description": "Versão do SDK que gerou a localização." }, "is_mock": { "type": "boolean", "nullable": true, "description": "`true` quando o dispositivo informa que a localização veio de um provedor de localização simulada ou de um software de simulação. `null` quando a plataforma não informa isso (navegadores não conseguem detectar); `null` não equivale a `false`." }, "produced_by_accessory": { "type": "boolean", "nullable": true, "description": "Somente iOS: `true` quando a posição veio de um acessório externo. `null` nos demais casos." }, "integrity": { "type": "string", "enum": [ "attested", "not_attested", "failed", "unsupported", "not_determined" ], "description": "Indica se a atestação do dispositivo respalda a localização obtida. `unsupported` é o que os navegadores informam, porque a web não tem mecanismo de atestação; não é uma falha." }, "country_code": { "type": "string", "nullable": true, "description": "País em que a localização foi obtida, no formato ISO 3166-1 alpha-2." }, "region_code": { "type": "string", "nullable": true, "description": "Subdivisão ISO 3166-2 em que a localização se encontra." }, "city": { "type": "string", "nullable": true, "description": "Localidade povoada mais próxima, um rótulo para os revisores." }, "geofence": { "type": "object", "description": "Resultado das regras de país e área da etapa.", "properties": { "enabled": { "type": "boolean", "description": "Se a etapa aplica alguma regra de país ou de área." }, "result": { "type": "string", "nullable": true, "description": "Onde a posição se situa em relação às regras. `undetermined` significa que o círculo de precisão cruza a fronteira ou que a posição não correspondeu a nenhum país; não é evidência de estar fora.", "enum": [ "inside", "outside", "undetermined", null ] } } }, "inside_geofence": { "type": "boolean", "nullable": true, "description": "`true` quando `geofence.result` é `inside`, `false` quando é `outside` e `null` nos demais casos." }, "geofence_basis": { "type": "string", "nullable": true, "description": "A partir de qual posição o resultado da área foi avaliado: a posição do `device` ou a localização do `ip` da conexão.", "enum": [ "device", "ip", null ] }, "inside_areas": { "type": "array", "items": { "type": "string" }, "description": "IDs das áreas permitidas configuradas dentro das quais a posição está." }, "blocked_areas": { "type": "array", "items": { "type": "string" }, "description": "IDs das áreas bloqueadas configuradas em que a posição está." }, "position_source": { "type": "string", "nullable": true, "description": "De onde a etapa obtém a posição, conforme configurado: o dispositivo comparado com a localização do IP, apenas o dispositivo ou apenas a localização do IP.", "enum": [ "device_and_ip", "device_only", "ip_only", null ] }, "anonymizers": { "type": "object", "nullable": true, "description": "Como são a conexão e o dispositivo, cada um `true`, `false` ou `null` quando a fonte não consegue 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 até a localização do IP da sessão depois de subtraídos os dois raios de incerteza; `0` quando eles se sobrepõem.", "format": "double" }, "ip_distance_uncertainty_km": { "type": "number", "nullable": true, "description": "Raio combinado que foi subtraído: o raio da localização do IP mais a precisão desta posição.", "format": "double" }, "ip_consistent": { "type": "boolean", "nullable": true, "description": "Indica se `ip_distance_km` está dentro da distância configurada na etapa. `null` quando qualquer um dos lados é desconhecido." }, "document_distance_km": { "type": "number", "nullable": true, "description": "Distância até o endereço geocodificado no documento de identidade ou no comprovante de endereço. `null` quando não há endereço registrado.", "format": "double" }, "travel_excused": { "type": "boolean", "nullable": true, "description": "Se a tolerância de deslocamento da etapa justificou a distância em relação ao endereço. `null` quando a tolerância está desativada." }, "consecutive_mismatches": { "type": "integer", "nullable": true, "description": "Na última tentativa: esta verificação mais as divergências anteriores consecutivas da mesma pessoa." }, "attempts": { "type": "integer", "description": "Número desta tentativa dentro do nó, começando em 1." }, "consent": { "type": "object", "nullable": true, "description": "O consentimento que a pessoa deu antes do prompt do sistema, registrado com a versão do texto e o idioma que ela viu.", "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": "Quando a Didit recebeu a tentativa.", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" } } }, "BiometricRetention": { "type": "object", "description": "Quando os dados biométricos ao vivo desta sessão são excluídos.", "required": [ "jurisdictions", "deletes_at" ], "properties": { "jurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Códigos dos estados dos EUA cujas regras biométricas definem um prazo de exclusão para esta pessoa (`US` quando o estado é desconhecido). Vazio quando nenhuma se aplica." }, "deletes_at": { "type": "string", "format": "date-time", "nullable": true, "description": "A data em que os dados biométricos ao vivo (imagens faciais e templates) desta sessão são excluídos, com base na configuração de retenção da sua aplicação e, quando houver, no limite legal da jurisdição da pessoa. `null` quando ainda não há data aplicável." } } }, "TravelRuleManualMatchRequest": { "type": "object", "required": [ "transaction_id" ], "properties": { "transaction_id": { "type": "string", "format": "uuid", "description": "O `transaction_id` da mensagem de Travel Rule recebida (uma linha com `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": "Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys." }, "TransactionTokenAuth": { "type": "apiKey", "in": "header", "name": "X-Transaction-Token", "description": "Token com escopo e de curta duração emitido pelo seu backend via POST /v3/transactions/sdk-token/. Usado pelos SDKs da Didit nos endpoints /v1/transactions/ voltados ao dispositivo." }, "SessionTokenAuth": { "type": "apiKey", "in": "header", "name": "Session-Token", "description": "Token de curta duração retornado no campo `session_token` de POST /v3/session/. Usado pelo fluxo de verificação hospedado (e por interfaces de sandbox personalizadas) para chamar endpoints com escopo de sessão em nome do usuário em verificação, sem a sua chave de API do lado do servidor." }, "BearerAuth": { "type": "http", "scheme": "bearer", "description": "O token de acesso de client credentials da aplicação." }, "CaseRequestToken": { "type": "apiKey", "in": "header", "name": "X-Case-Request-Token", "description": "Credencial específica da requisição, obtida do link seguro. Concede acesso somente a esta requisição." } }, "responses": { "Unauthorized": { "description": "Não autorizado", "content": { "application/json": { "examples": { "Invalid API Key": { "summary": "Chave de API inválida", "value": { "detail": "Invalid API Key." } } } } } }, "Forbidden": { "description": "Proibido", "content": { "application/json": { "examples": { "No Permission": { "summary": "Sem permissão", "value": { "detail": "You do not have permission to perform this action." } }, "Not Enough Credits": { "summary": "Créditos insuficientes", "value": { "error": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" } } } } } }, "NotFound": { "description": "Não encontrado", "content": { "application/json": { "examples": { "Not Found": { "summary": "Não encontrado", "value": { "detail": "Resource not found." } } } } } }, "PhoneRiskValidationError": { "description": "A validação da requisição falhou.", "content": { "application/json": { "examples": { "Missing phone number": { "summary": "Número de telefone ausente", "value": { "phone_number": [ "This field is required." ] } }, "Invalid phone number": { "summary": "Número de telefone inválido", "value": { "phone_number": [ "Invalid phone number provided." ] } }, "Invalid signal IP": { "summary": "IP de sinal inválido", "value": { "signals": { "ip": [ "Enter a valid IPv4 or IPv6 address." ] } } } } } } }, "EmailRiskValidationError": { "description": "A validação da requisição falhou.", "content": { "application/json": { "examples": { "Missing email": { "summary": "E-mail ausente", "value": { "email": [ "This field is required." ] } }, "Invalid email": { "summary": "E-mail inválido", "value": { "email": [ "Enter a valid email address." ] } }, "Invalid country hint": { "summary": "Indicação de país inválida", "value": { "country_code": [ "Ensure this field has no more than 3 characters." ] } } } } } }, "IPRiskValidationError": { "description": "A validação da requisição falhou.", "content": { "application/json": { "examples": { "Missing IP address": { "summary": "Endereço IP ausente", "value": { "ip_address": [ "This field is required." ] } }, "Invalid IP address": { "summary": "Endereço IP inválido", "value": { "ip_address": [ "Enter a valid IPv4 or IPv6 address." ] } }, "Country hint too long": { "summary": "Indicação de país muito longa", "value": { "claimed_country": [ "Ensure this field has no more than 3 characters." ] } } } } } }, "RiskPermissionDenied": { "description": "A chave de API está ausente ou é inválida, ou a organização não consegue cobrir a consulta em tempo real. Esta API nunca retorna `401`.", "content": { "application/json": { "examples": { "Missing or invalid API key": { "summary": "Nenhum cabeçalho `x-api-key`, ou a chave é inválida ou foi revogada", "value": { "detail": "You do not have permission to perform this action." } }, "Not enough credits": { "summary": "O saldo da organização não cobre o preço da consulta", "value": { "error": "You don't have enough credits to perform this request." } } } } } }, "RateLimitedWrite": { "description": "O limite compartilhado de escrita de 300 requisições por minuto por chave de API foi excedido. Respeite `Retry-After` antes de tentar novamente.", "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": "O corpo da requisição é inválido: `country` ausente ou desconhecido, nenhum endereço, ou tanto `address` quanto os campos estruturados.", "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": "A chave de API está ausente ou é inválida, uma chave com escopo não tem acesso de escrita a `sessions`, ou a organização não consegue cobrir a validação. Esta API nunca 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" } } } } } } }, "parameters": { "WebhookSignature": { "name": "X-Signature", "in": "header", "required": true, "schema": { "type": "string" }, "description": "HMAC-SHA256 em hexadecimal minúsculo, usando como chave o segredo do destino, do corpo bruto exato da requisição." }, "WebhookSignatureV2": { "name": "X-Signature-V2", "in": "header", "required": true, "schema": { "type": "string" }, "description": "HMAC-SHA256 em hexadecimal minúsculo, usando como chave o segredo do destino, do JSON canônico do corpo (chaves ordenadas, sem espaços em branco, caracteres não ASCII sem escape). Recomendado, pois resiste a middlewares que recodificam o corpo." }, "WebhookSignatureSimple": { "name": "X-Signature-Simple", "in": "header", "required": true, "deprecated": true, "schema": { "type": "string" }, "description": "HMAC-SHA256 em hexadecimal minúsculo, usando como chave o segredo do destino, de `{timestamp}:{session_id}:{status}:{webhook_type}` (campos ausentes como strings vazias). Cobre apenas o envelope, nunca o payload." }, "WebhookTimestamp": { "name": "X-Timestamp", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Horário Unix em segundos, igual ao `timestamp` do corpo. Rejeite entregas com mais de alguns minutos." } } }, "x-webhooks": { "status.updated": { "post": { "summary": "Status da sessão alterado", "description": "Uma sessão de verificação mudou de status. `decision` é enviado apenas para `Approved`, `Declined`, `In Review` e `Abandoned`; tem o formato de `GET /v3/session/{sessionId}/decision/` para destinos na versão 3 do webhook (o padrão) e o formato reduzido mais antigo para destinos na versão 1 ou 2. Sessões de empresas sempre recebem a decisão de empresa da versão 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": "Qualquer resposta 2xx confirma a entrega. Outras respostas e timeouts geram novas tentativas. Veja https://docs.didit.me/integration/webhooks." } } } }, "data.updated": { "post": { "summary": "Dados da sessão alterados", "description": "Os dados de uma sessão de verificação mudaram sem mudança de status, por exemplo após uma edição na revisão manual, uma substituição de etapa ou uma nova triagem do monitoramento contínuo. `decision` é enviado apenas para `Approved`, `Declined`, `In Review` e `Abandoned`; ele tem o formato de `GET /v3/session/{sessionId}/decision/` para destinos na versão 3 do webhook (o padrão) e o formato reduzido mais antigo para destinos na versão 1 ou 2. Sessões de empresas sempre recebem a decisão de empresa da versão 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": "Qualquer resposta 2xx confirma a entrega. Outras respostas e timeouts geram novas tentativas. Veja https://docs.didit.me/integration/webhooks." } } } }, "user.status.updated": { "post": { "summary": "Status do usuário alterado", "description": "Um usuário mudou de status. Não é enviado quando o usuário é criado.", "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": "Qualquer resposta 2xx confirma a entrega. Outras respostas e timeouts geram novas tentativas. Veja https://docs.didit.me/integration/webhooks." } } } }, "user.data.updated": { "post": { "summary": "Dados do usuário alterados", "description": "Campos de um usuário foram alterados. Não é enviado quando o usuário é criado. Um único salvamento pode gerar tanto um evento de status quanto um de dados.", "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": "Qualquer resposta 2xx confirma a entrega. Outras respostas e timeouts geram novas tentativas. Veja https://docs.didit.me/integration/webhooks." } } } }, "business.status.updated": { "post": { "summary": "Status da empresa alterado", "description": "Uma empresa mudou de status. Não é enviado quando a empresa é criada.", "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": "Qualquer resposta 2xx confirma a entrega. Outras respostas e timeouts geram novas tentativas. Veja https://docs.didit.me/integration/webhooks." } } } }, "business.data.updated": { "post": { "summary": "Dados da empresa alterados", "description": "Campos de uma empresa foram alterados. Não é enviado quando a empresa é criada. Um único salvamento pode gerar tanto um evento de status quanto um de dados.", "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": "Qualquer resposta 2xx confirma a entrega. Outras respostas e timeouts geram novas tentativas. Veja https://docs.didit.me/integration/webhooks." } } } }, "transaction.created": { "post": { "summary": "Transação criada", "description": "Uma transação foi criada e analisada. Enviado apenas para aplicações em produção.", "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": "Qualquer resposta 2xx confirma a entrega. Outras respostas e timeouts geram novas tentativas. Veja https://docs.didit.me/integration/webhooks." } } } }, "transaction.status.updated": { "post": { "summary": "Status da transação alterado", "description": "Uma transação mudou de status, por uma regra, uma revisão ou uma ação do usuário final. Enviado apenas para aplicações em produção.", "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": "Qualquer resposta 2xx confirma a entrega. Outras respostas e timeouts geram novas tentativas. Veja https://docs.didit.me/integration/webhooks." } } } }, "travel_rule.status.updated": { "post": { "summary": "Status da Travel Rule alterado", "description": "Uma troca de Travel Rule mudou de status. Enviado em cada transição até `FINISHED`, `CANCELLED` ou `EXPIRED`, inclusive, e nunca depois. Enviado para aplicações em produção e, no caso de trocas de Travel Rule, também para aplicações de sandbox (`environment: sandbox`). Não há `status` de nível 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": "Qualquer resposta 2xx confirma a entrega. Outras respostas e timeouts geram novas tentativas. Veja https://docs.didit.me/integration/webhooks." } } } }, "workflow.compliance_changed": { "post": { "summary": "Conformidade do fluxo alterada", "description": "O status de conformidade de um fluxo publicado mudou após uma reavaliação. Um evento por fluxo. Não há `status` no nível 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": "Qualquer resposta 2xx confirma a entrega. Outras respostas e timeouts geram novas tentativas. Veja https://docs.didit.me/integration/webhooks." } } } }, "kyb.registry_search.resolved": { "post": { "summary": "Busca de empresa resolvida (callback sem assinatura)", "description": "Corpo do callback enviado para o `webhook_url` de `POST /v3/kyb/search/` quando a busca no registro é concluída. Ele não é assinado: a requisição traz `X-Didit-Unsigned-Callback: true` e nenhum dos cabeçalhos de assinatura; portanto, confirme-o comparando `request_id` com uma busca que você iniciou. Usa `event_type`, não `webhook_type`.", "tags": [ "Webhook" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KYBRegistrySearchResolvedCallback" } } } }, "responses": { "2XX": { "description": "Qualquer resposta 2xx confirma a entrega. Outras respostas e timeouts geram novas tentativas. Veja https://docs.didit.me/integration/webhooks." } } } }, "transaction_rule_suggestions.created": { "post": { "summary": "Sugestões de regras de transação criadas", "description": "Uma execução de sugestão de regras de transação propôs novas alterações de regras para sua aplicação. Enviado quando as configurações de sugestão de regras têm as notificações por webhook ativadas. Não há `status` de nível 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": "Qualquer resposta 2xx confirma a entrega. Outras respostas e timeouts geram novas tentativas. Veja https://docs.didit.me/integration/webhooks." } } } } } }