> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# शेयर्ड सेशन इंपोर्ट API: पुनः प्रयोज्य KYC और KYB
> Didit के POST /v3/session/import-shared/ से पार्टनर शेयर token द्वारा KYC या KYB सत्र इंपोर्ट करें। पुनः सत्यापन नहीं, प्रति कॉल भुगतान।
साझा सत्र आयात करने का प्रॉम्प्ट
प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें
\
\`Import a verification session shared by a partner application (Reusable KYC / KYB).
Endpoint:
POST https://verification.didit.me/v3/session/import-shared/
Authentication:
Use the x-api-key header with the receiving application's Didit API key. Privilege: write:sessions.
Request body:
\- share_token (string, required) — JWT minted by the partner via POST /v3/session/{id}/share/. Didit decodes it, reads the embedded session_kind, and clones the matching kind.
\- workflow_id (string, UUID, required) — Workflow in YOUR application to attach the imported session to. KYC token → pass a KYC workflow_id. KYB token → pass a KYB workflow_id.
\- vendor_data (string, optional) — Your stable identifier for the entity. Auto-creates a User or Business entity if it does not already exist.
\- trust_review (boolean, optional, default false) — false → imported session lands in "In Review" so your team can re-review. true → imported session preserves the original status (e.g. "Approved"). Use true only when you fully trust the sharing partner's decision.
curl example:
curl -X POST https://verification.didit.me/v3/session/import-shared/ \
-H "x-api-key: " \
-H "Content-Type: application/json" \
-d '{
"share_token": "",
"workflow_id": "",
"vendor_data": "partner-user-42",
"trust_review": false
}'
Response (201 Created):
\- session_id (UUID) — NEW UUID minted in your application.
\- session_kind ("user" | "business") — same as the original.
\- session_number — fresh sequence in your application.
\- status — original status (if trust_review=true) or "In Review" (if trust_review=false).
\- shared_from_session — pointer to the original session in the source application.
\- vendor_data, workflow_id — what you sent.
\- All cloned feature arrays: KYC tokens clone id_verifications + liveness_checks + face_matches + face + AML + location + POA + phone + email + database_validations + logs; KYB tokens clone registry_checks + key_people_checks + document_verifications + AML + phone + email + location + questionnaire + logs.
Backward compatibility:
Tokens minted before the unified-sharing rollout (no session_kind field) default to "user" when decoded.
Idempotency:
Importing the same share_token twice into the same application is rejected with 403, for user and business sessions alike.
Failure modes:
\- 400 - { "share_token": ["Invalid share token."] } when the token is malformed or was not issued by Didit.
\- 400 - { "share_token": ["Share token has expired."] } when its exp has passed.
\- 400 - { "share_token": ["This token is not valid for this application."] } when the token was issued for another application.
\- 400 - { "share_token": ["Original session does not exist."] } when the shared session was deleted.
\- 403 - { "detail": "This session has already been shared with your application." } when the session was already imported into this application.
\- 404 - { "detail": "Workflow does not exist for this application." } when workflow_id is not a workflow of your application.
When to call:
\- Cross-organization Reusable KYC (bank → fintech, marketplace → payment provider, etc.).
\- Promoting a verified user from your sandbox application to your production application.
\- Group-company sharing across sibling applications.
After import:
\- The new session works like any other session — fetch with GET /v3/session/{session_id}/decision/ (see /sessions-api/retrieve-session) and react to status / data webhooks.
For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`
\
यहाँ पेस्ट करें
## KYC और KYB समर्थनDidit share token को डिकोड करता है, उसमें एम्बेड किया गया `session_kind` पढ़ता है, और उसी प्रकार के सत्र का क्लोन बनाता है:- `session_kind: "user"`: उपयोगकर्ता सत्र के साथ उससे जुड़ी पहचान, चेहरा, लाइवनेस, चेहरा मिलान, AML, स्थान, POA, फ़ोन, ईमेल, डेटाबेस सत्यापन और लॉग पंक्तियों का क्लोन बनाता है।
- `session_kind: "business"`: व्यवसाय सत्र के साथ उससे जुड़ी रजिस्ट्री जाँच, प्रमुख व्यक्तियों के रिकॉर्ड, दस्तावेज़, AML स्क्रीनिंग, फ़ोन, ईमेल, स्थान, प्रश्नावली और लॉग पंक्तियों का क्लोन बनाता है।यदि token एकीकृत साझाकरण रोलआउट से पहले का है और उसमें `session_kind` फ़ील्ड नहीं है, तो पिछली संगतता के लिए Didit डिफ़ॉल्ट रूप से `"user"` मान लेता है।## क्या बनाया जाता है- आपके एप्लिकेशन में उसी प्रकार का एक **नया सत्र**, जिसमें नए `session_id`, `session_number` और `session_url` होंगे।
- नए सत्र का `shared_from_session` फ़ील्ड स्रोत एप्लिकेशन के मूल सत्र की ओर इंगित करता है।
- नए सत्र की स्थिति या तो मूल स्थिति होगी (`trust_review: true`) या `IN_REVIEW` (`trust_review: false`)।
- यदि `vendor_data` के लिए कोई इकाई (उपयोगकर्ता या व्यवसाय) मौजूद नहीं है, तो वह अपने-आप बना दी जाती है।## उदाहरण> [tab] उपयोगकर्ता सत्यापन (KYC) सत्र आयात करें
>
> ```bash theme={null}
> curl -X POST https://verification.didit.me/v3/session/import-shared/ \
> -H "x-api-key: YOUR_API_KEY" \
> -H "Content-Type: application/json" \
> -d '{
> "share_token": "eyJhbGciOiJIUzI1NiJ9...",
> "workflow_id": "your-kyc-workflow-id",
> "vendor_data": "partner-user-42",
> "trust_review": false
> }'
> ```
>
> **रिस्पॉन्स (201 बनाया गया):**
>
> ```json theme={null}
> {
> "session_id": "new-uuid",
> "session_kind": "user",
> "shared_from_session": "original-uuid",
> "status": "In Review",
> "vendor_data": "partner-user-42",
> "id_verifications": [...],
> "liveness_checks": [...],
> "...": "..."
> }
> ```> [tab] व्यवसाय सत्यापन (KYB) सत्र आयात करें
>
> ```bash theme={null}
> curl -X POST https://verification.didit.me/v3/session/import-shared/ \
> -H "x-api-key: YOUR_API_KEY" \
> -H "Content-Type: application/json" \
> -d '{
> "share_token": "eyJhbGciOiJIUzI1NiJ9...",
> "workflow_id": "your-kyb-workflow-id",
> "vendor_data": "partner-biz-acme",
> "trust_review": true
> }'
> ```
>
> **रिस्पॉन्स (201 बनाया गया):**
>
> ```json theme={null}
> {
> "session_id": "new-uuid",
> "session_kind": "business",
> "shared_from_session": "original-uuid",
> "status": "Approved",
> "vendor_data": "partner-biz-acme",
> "registry_checks": [...],
> "key_people_checks": [...],
> "document_verifications": [...],
> "...": "..."
> }
> ```## `trust_review` पैरामीटर| मान | प्रभाव |
| - | - |
| `true` | आयात किया गया सत्र मूल स्थिति (जैसे `APPROVED`) बनाए रखता है। इसका उपयोग तभी करें जब आप साझा करने वाले पार्टनर के निर्णय पर पूरा भरोसा करते हों। |
| `false` | आयात किया गया सत्र `IN_REVIEW` में चला जाता है, ताकि कोई कार्रवाई करने से पहले आपकी टीम फिर से समीक्षा कर सके। बाहरी पार्टनर के लिए यह सुरक्षित डिफ़ॉल्ट है। |## त्रुटियाँ| स्थिति | कारण |
| - | - |
| `400` | `share_token` अमान्य है, समय-सीमा समाप्त हो चुका है, किसी दूसरे एप्लिकेशन के लिए जारी किया गया है, या ऐसे सत्र की ओर इंगित करता है जिसे हटा दिया गया है। संदेश `share_token` कुंजी के अंतर्गत होता है। |
| `403` | सत्र पहले ही आपके एप्लिकेशन में आयात किया जा चुका है। |
| `404` | `workflow_id` आपके एप्लिकेशन का वर्कफ़्लो नहीं है। |## आइडेम्पोटेंसीएक ही एप्लिकेशन में एक ही `share_token` को दो बार आयात करने का प्रयास `403` के साथ अस्वीकार कर दिया जाता है, चाहे वह उपयोगकर्ता सत्र हो या व्यवसाय सत्र।## संबंधित- [सत्र साझा करें](https://docs.didit.me/hi/sessions-api/share-session/share.md)
- [पुनः प्रयोज्य KYC गाइड](https://docs.didit.me/hi/core-technology/reusable-kyc/share-kyc-via-api.md)
- [सत्रों का अवलोकन](https://docs.didit.me/hi/sessions-api/overview.md)
## OpenAPI
````yaml hi/openapi-25.json POST /v3/session/import-shared/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: पहचान सत्यापन API। x-api-key हेडर के साथ प्रमाणीकृत करें।
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/session/import-shared/:
post:
tags:
- Sessions
summary: >-
सत्यापन सत्र को अपने एप्लिकेशन में क्लोन करने के लिए एक शेयर token रिडीम
करें
description: >-
कॉल करने वाले एप्लिकेशन में एक नए `session_id` के साथ KYC या KYB सत्र को
क्लोन करने के लिए एक शेयर token को रिडीम करें। आइडेम्पोटेंट नहीं है — एक
token प्रति प्राप्तकर्ता केवल एक बार रिडीम होता है।
operationId: post_v3_session_import_shared
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- share_token
- trust_review
- workflow_id
properties:
share_token:
type: string
description: >-
[`POST
/v3/session/{sessionId}/share/`](/sessions-api/share-session)
द्वारा जारी किया गया JWT शेयर टोकन।
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
trust_review:
type: boolean
description: >-
यदि `true` है, तो क्लोन किया गया सत्र स्रोत की अंतिम
`status` बनाए रखता है। यदि `false` है, तो इसे `In Review`
में डाल दिया जाता है।
example: false
workflow_id:
type: string
format: uuid
description: >-
कॉल करने वाले एप्लिकेशन में किसी वर्कफ़्लो का UUID।
क्रॉस-एप्लिकेशन ID को `404` के साथ अस्वीकार कर दिया जाता है।
example: 9f9b1234-aaaa-bbbb-cccc-1234567890ab
vendor_data:
type: string
nullable: true
description: क्लोन किए गए सत्र के `vendor_data` के लिए वैकल्पिक ओवरराइड।
example: user-1
example:
share_token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
trust_review: false
workflow_id: 9f9b1234-aaaa-bbbb-cccc-1234567890ab
vendor_data: user-1
responses:
'201':
description: >-
सत्र क्लोन किया गया। बॉडी दोनों प्रकारों के लिए V3 निर्णय payload
है, जिसे `session_kind` द्वारा अलग किया गया है: `id_verifications`,
`liveness_checks`, `aml_screenings` जैसे सूची-आधारित सुविधा ब्लॉकों
के साथ `"user"` (KYC); `registry_checks` और `key_people_checks` जैसे
ब्लॉकों के साथ `"business"` (KYB)। दोनों में `shared_from_session`
शामिल है — स्रोत एप्लिकेशन में मूल सत्र का `session_id`।
`trust_review: false` के साथ क्लोन किए गए सत्र का `status` जबरन `In
Review` पर सेट किया जाता है।
content:
application/json:
schema:
$ref: '#/components/schemas/SessionDecision'
examples:
User session imported:
summary: >-
क्लोन किया गया KYC सत्र (संक्षिप्त — वास्तव में पूर्ण V3
निर्णय payload)
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: >-
क्लोन किया गया KYB सत्र (संक्षिप्त — वास्तव में पूर्ण V3 KYB
निर्णय payload)
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: >-
सत्यापन त्रुटि (token अमान्य, समय-सीमा समाप्त, गलत लक्ष्य, या किसी
ऐसे सत्र को संदर्भित करता है जो अब मौजूद नहीं है)।
content:
application/json:
examples:
Invalid Share Token:
summary: अमान्य JWT
value:
share_token:
- Invalid share token.
Expired Share Token:
summary: Token `exp` से आगे निकल चुका है
value:
share_token:
- Share token has expired.
Wrong audience:
summary: Token इस एप्लिकेशन से संबद्ध नहीं है
value:
share_token:
- This token is not valid for this application.
Original missing:
summary: स्रोत सत्र हटा दिया गया था
value:
share_token:
- Original session does not exist.
'403':
description: >-
API कुंजी मौजूद नहीं है (गलत, निरस्त या समय-सीमा समाप्त कुंजी पर
`401` मिलता है), या यह स्रोत सत्र पहले ही कॉल करने वाले एप्लिकेशन
में इंपोर्ट किया जा चुका है (प्रति प्राप्तकर्ता एक रिडीम)।
content:
application/json:
examples:
Forbidden:
summary: निषिद्ध
value:
detail: You do not have permission to perform this action.
Already imported:
summary: स्रोत पहले ही एक बार इंपोर्ट किया जा चुका है
value:
detail: >-
This session has already been shared with your
application.
'404':
description: '`workflow_id` कॉल करने वाले एप्लिकेशन से संबंधित नहीं है।'
content:
application/json:
examples:
Workflow not found:
summary: वर्कफ़्लो अज्ञात
value:
detail: Workflow does not exist for this application.
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: curl
source: |-
curl -X POST \
https://verification.didit.me/v3/session/import-shared/ \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"share_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"trust_review": false,
"workflow_id": "9f9b1234-aaaa-bbbb-cccc-1234567890ab",
"vendor_data": "user-1"
}'
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.sessions.import_shared(
share_token="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
trust_review=False,
workflow_id="9f9b1234-aaaa-bbbb-cccc-1234567890ab",
vendor_data="user-1",
)
print(result)
- lang: javascript
label: Node.js
source: |-
import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.sessions.importShared({
share_token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
trust_review: false,
workflow_id: "9f9b1234-aaaa-bbbb-cccc-1234567890ab",
vendor_data: "user-1",
});
console.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;
import me.didit.types.SessionsImportSharedParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result =
client.sessions().importShared(SessionsImportSharedParams.builder()
.shareToken("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...")
.trustReview(false)
.workflowId("9f9b1234-aaaa-bbbb-cccc-1234567890ab")
.vendorData("user-1")
.build());
System.out.println(result);
- lang: php
label: PHP
source: |-
sessions->importShared([
'share_token' => 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...',
'trust_review' => false,
'workflow_id' => '9f9b1234-aaaa-bbbb-cccc-1234567890ab',
'vendor_data' => 'user-1',
]);
print_r($result->toArray());
- lang: ruby
label: Ruby
source: |-
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.sessions.import_shared(
share_token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
trust_review: false,
workflow_id: "9f9b1234-aaaa-bbbb-cccc-1234567890ab",
vendor_data: "user-1"
)
puts result.to_h
- lang: csharp
label: .NET
source: >-
using System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Sessions.ImportSharedAsync(new
SessionsImportSharedParams
{
ShareToken = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
TrustReview = false,
WorkflowId = "9f9b1234-aaaa-bbbb-cccc-1234567890ab",
VendorData = "user-1",
});
Console.WriteLine(JsonSerializer.Serialize(result));
components:
schemas:
SessionDecision:
type: object
properties:
session_id:
type: string
format: uuid
description: सत्र का विशिष्ट पहचानकर्ता।
session_kind:
type: string
enum:
- user
- business
description: >-
यह इंगित करने वाला डिस्क्रिमिनेटर कि यह उपयोगकर्ता सत्यापन (KYC)
सत्र है या व्यवसाय सत्यापन (KYB) सत्र। जब `user` हो, तो KYC फ़ीचर
ऐरे (`id_verifications`, `nfc_verifications`, `liveness_checks`,
`face_matches`, `poa_verifications`, `document_ai_documents`,
`database_validations`, ...) लागू होते हैं और व्यावसायिक ऐरे
अनुपस्थित होते हैं। जब `business` हो, तो payload में
`registry_checks`, `document_verifications`, `key_people_checks` के
साथ-साथ साझा ऐरे (`aml_screenings`, `phone_verifications`,
`email_verifications`, `ip_analyses`, `questionnaire_responses`)
शामिल होते हैं। **`include=events` पास होने पर छोड़ दिया जाता है** —
events संरचना केवल उपयोगकर्ता सत्रों के लिए मौजूद होती है, इसलिए उस
वेरिएंट से डिस्क्रिमिनेटर हटा दिया जाता है।
shared_from_session:
type: string
format: uuid
nullable: true
description: >-
`POST /v3/session/import-shared/` के साथ क्लोन किए गए सत्र के लिए:
स्रोत एप्लिकेशन में मूल सत्र का `session_id`। अन्य सभी सत्रों के लिए
`null`। `include=events` पास किए जाने पर छोड़ दिया जाता है।
shared_from_session_number:
type: integer
nullable: true
description: >-
स्रोत सत्र का `session_number` जब इस सत्र को आपके संगठन के किसी अन्य
एप्लिकेशन से इंपोर्ट किया गया था। अन्यथा `null`।
session_number:
type: integer
description: सत्र की संख्या।
nullable: true
session_url:
type: string
format: uri
description: सत्र का URL।
nullable: true
status:
type: string
enum:
- Not Started
- In Progress
- Awaiting User
- In Review
- Approved
- Declined
- Resubmitted
- Expired
- Kyc Expired
- Abandoned
description: >-
सत्र की समग्र जीवनचक्र स्थिति — समेकित वर्कफ़्लो परिणाम। अंतिम मान
`Approved`, `Declined`, `In Review`, `Expired`, `Kyc Expired`, और
`Abandoned` हैं; `Not Started`, `In Progress`, `Awaiting User`, और
`Resubmitted` इंगित करते हैं कि सत्र अभी भी वर्कफ़्लो से गुज़र रहा
है।
status_override:
type: object
nullable: true
description: >-
समीक्षक द्वारा मैन्युअल रूप से `status` सेट किए जाने पर मौजूद होता
है। स्थिति स्वचालित होने पर `null` होता है। इसका उपयोग मैन्युअल
स्वीकृति को स्वचालित स्वीकृति से अलग पहचानने के लिए करें।
properties:
overridden_at:
type: string
format: date-time
nullable: true
automatic_status:
type: string
nullable: true
description: >-
वह स्थिति जो प्लेटफ़ॉर्म की अपनी जाँचों से निष्कर्ष के रूप में
निकलती है।
decision_trace:
type: object
description: >-
स्थिति तक कैसे पहुँचा गया: इसे किसने सेट किया और किन चेतावनियों ने
ऐसा किया।
properties:
status:
type: string
description: सत्र की स्थिति।
decided_by:
type: string
nullable: true
enum:
- manual
- automatic
- investigator
- null
description: >-
स्थिति किसने निर्धारित की। जब तक सत्र का निर्णय नहीं हो जाता, तब
तक `null`।
decided_at:
type: string
format: date-time
nullable: true
automatic_status:
type: string
nullable: true
description: >-
प्लेटफ़ॉर्म की अपनी जाँचें क्या निष्कर्ष निकालती हैं, जो
मैन्युअल निर्णय के बाद `status` से भिन्न होता है।
terminal_node_id:
type: string
nullable: true
description: वर्कफ़्लो स्थिति नोड जिसने सत्र समाप्त किया, यदि ऐसा कोई नोड था।
actor:
type: object
nullable: true
description: मैन्युअल निर्णय के पीछे का समीक्षक।
properties:
user:
type: string
nullable: true
actor_type:
type: string
nullable: true
warning_counts:
type: object
description: >-
प्रति `log_type` (`error`, `warning`, `information`) और `total`
चेतावनियाँ।
additionalProperties:
type: integer
status_warnings:
type: array
description: वे चेतावनियां जो `Declined` या `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: >-
वह payload सूची जिससे चेतावनी आई है, उदाहरण के लिए
`id_verifications`।
short_description:
type: string
nullable: true
linked_records:
type: object
nullable: true
description: >-
सत्र से जुड़े अन्य रिकॉर्ड का सारांश। दिखाने के लिए कुछ न होने पर,
और उन वर्कफ़्लो के लिए जो आयु आश्वासन मानक घोषित करते हैं, `null`
होता है।
properties:
same_face:
type: object
nullable: true
description: अन्य लोग जिनका चेहरा इस सत्र की किसी चेहरा खोज से मेल खाता है।
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: >-
वर्कफ़्लो समूह का स्थिर पहचानकर्ता जिसने यह सत्र बनाया। वर्कफ़्लो
संस्करणित होते हैं — यह मान विशिष्ट संस्करण की नहीं, बल्कि स्वयं
वर्कफ़्लो की पहचान करता है।
nullable: true
features:
type: array
items:
type: string
description: सत्र की सुविधा।
description: >-
इस सत्र के लिए कॉन्फ़िगर की गई सत्यापन सुविधाओं की सूची, प्रदर्शन
नामों के रूप में: `ID_VERIFICATION`, `NFC`, `LIVENESS`,
`FACE_MATCH`, `POA`, `PHONE`, `EMAIL_VERIFICATION`, `AML`,
`IP_ANALYSIS`, `DATABASE_VALIDATION`, `QUESTIONNAIRE`,
`AGE_ESTIMATION`, `FACE_SEARCH`, `GEOLOCATION` (स्थान सत्यापन)
(व्यवसाय सत्यापन सत्र KYB सुविधा सेट का उपयोग करते हैं:
`KYB_REGISTRY`, `KYB_DOCUMENTS`, `KYB_KEY_PEOPLE`, `AML`, `PHONE`,
`EMAIL_VERIFICATION`, `IP_ANALYSIS`, `QUESTIONNAIRE`)।
`include=events` के साथ प्रत्येक प्रविष्टि एक सादे स्ट्रिंग के बजाय
एक ऑब्जेक्ट `{feature, node_id}` बन जाती है, और ईमेल सुविधा का नाम
बदल दिया जाता है: यह यहाँ उपयोग किए गए `EMAIL_VERIFICATION` के बजाय
इवेंट मोड में `EMAIL` के रूप में दिखाई देती है।
vendor_data:
type: string
description: सत्र का वेंडर डेटा।
nullable: true
metadata:
type: object
description: सत्र का मेटाडेटा।
nullable: true
expected_details:
type: object
description: >-
सत्र निर्माण के समय दिए गए अपेक्षित विवरण — निकाले गए डेटा (KYC) के
विरुद्ध क्रॉस-सत्यापन के लिए या कंपनी रजिस्ट्री खोज (KYB) को पहले से
भरने के लिए उपयोग किए जाते हैं। जो कुंजियाँ प्रदान की गई थीं, उन्हें
ठीक वैसे ही लौटाता है; कोई प्रदान न किए जाने पर `null`। KYC सत्रों
में व्यक्ति के फ़ील्ड होते हैं; व्यवसाय (KYB) सत्रों में
`company_name`, `registry_country` और `registration_number` होते
हैं।
properties:
first_name:
type: string
description: उपयोगकर्ता का पहला नाम। उदाहरण के लिए, `John`।
last_name:
type: string
description: उपयोगकर्ता का अंतिम नाम। उदाहरण के लिए, `Doe`।
date_of_birth:
type: string
format: date
description: >-
उपयोगकर्ता की जन्म तिथि, प्रारूप: YYYY-MM-DD। उदाहरण के लिए,
`1990-05-15`।
gender:
type: string
nullable: true
enum:
- M
- F
default: null
description: उपयोगकर्ता का लिंग। 'M', 'F', या null होना चाहिए।
nationality:
type: string
description: >-
आवेदक के मूल देश का प्रतिनिधित्व करने वाला ISO 3166-1 alpha-3
देश कोड। उदाहरण के लिए, `USA`।
country:
type: string
description: >-
पते का प्रमाण दस्तावेज़ के देश, या आवेदक के ID दस्तावेज़ के देश
का प्रतिनिधित्व करने वाला ISO 3166-1 alpha-3 देश कोड, जो
राष्ट्रीयता से भिन्न हो सकता है। उदाहरण के लिए, `GBR`।
address:
type: string
description: >-
मानव पठनीय प्रारूप में पता, जिसमें यथासंभव अधिक जानकारी शामिल
हो। उदाहरण के लिए, `123 Main St, San Francisco, CA 94105, USA`।
identification_number:
type: string
description: >-
उपयोगकर्ता का दस्तावेज़ नंबर, व्यक्तिगत नंबर, या कर नंबर। उदाहरण
के लिए, `123456789`।
ip_address:
type: string
format: ipv4
description: >-
सत्र के लिए अपेक्षित IP पता। यदि वास्तविक IP पता इस मान से भिन्न
है, तो एक चेतावनी लॉग की जाएगी। उदाहरण के लिए, `192.168.1.100`।
expected_document_types:
type: array
description: >-
सत्र निर्माण के समय वे दस्तावेज़ प्रकार जिन पर पहचान सत्यापन चरण
को प्रतिबंधित किया गया था। खाली/अनसेट का अर्थ है कोई प्रतिबंध
नहीं। कोड: `P` (पासपोर्ट), `ID` (राष्ट्रीय पहचान पत्र), `DL`
(ड्राइविंग लाइसेंस), `RP` (निवास परमिट), `HIC` (स्वास्थ्य बीमा
कार्ड), `TC` (टैक्स कार्ड), `SSC` (सोशल सिक्योरिटी कार्ड)।
items:
type: string
enum:
- P
- ID
- DL
- RP
- HIC
- TC
- SSC
id_country:
type: string
nullable: true
description: >-
अपेक्षित पहचान-दस्तावेज़ जारीकर्ता देश (ISO 3166-1 alpha-3), यदि
निर्माण के समय प्रतिबंधित किया गया हो।
example: ESP
poa_country:
type: string
nullable: true
description: >-
अपेक्षित पते का प्रमाण दस्तावेज़ देश (ISO 3166-1 alpha-3), यदि
निर्माण के समय प्रतिबंधित किया गया हो।
example: ESP
company_name:
type: string
description: व्यवसाय का अपेक्षित कानूनी नाम। केवल व्यवसाय (KYB) सत्र।
registry_country:
type: string
description: >-
अपेक्षित रजिस्ट्री देश `XX` या `XX-YY` के रूप में (ISO 3166-1
alpha-2, वैकल्पिक रूप से राज्य-स्तरीय रजिस्ट्रियों के लिए ISO
3166-2 उपविभाजन के साथ, जैसे `US-CA`)। केवल व्यवसाय (KYB) सत्र।
registration_number:
type: string
description: अपेक्षित कंपनी पंजीकरण संख्या। केवल व्यवसाय (KYB) सत्र।
nullable: true
contact_details:
type: object
description: >-
सत्र बनाते समय प्रदान किए गए संपर्क विवरण (अधिसूचना ईमेल, पहले से
भरे फ़ोन/ईमेल सत्यापन और संचार भाषा के लिए उपयोग किए जाते हैं)। जब न
तो कोई ईमेल और न ही कोई फ़ोन नंबर प्रदान किया गया था, तब `null` होता
है।
properties:
email:
type: string
description: >-
उपयोगकर्ता का ईमेल पता (उदा. "john.doe@example.com") जिसका उपयोग
ईमेल सत्यापन चरण के दौरान किया जाएगा। यदि प्रदान नहीं किया गया
है, तो उपयोगकर्ता को इसे सत्यापन प्रवाह के दौरान प्रदान करना
होगा।
email_lang:
type: string
description: >-
ईमेल सूचनाओं के लिए भाषा कोड (ISO 639-1)। सभी ईमेल संचारों की
भाषा को नियंत्रित करता है (उदा. "en", "es", "fr")।
send_notification_emails:
type: boolean
default: false
description: >-
यदि true है और एक ईमेल प्रदान किया गया है, तो उपयोगकर्ता सत्यापन
(KYC) या व्यवसाय सत्यापन (KYB) सत्र बनाए जाने पर Didit
एसिंक्रोनस रूप से प्रारंभिक "Verify your identity" ईमेल भेजता
है। Didit दिए गए ईमेल पते पर मैन्युअल समीक्षा की आवश्यकता वाले
सत्रों के लिए सत्यापन स्थिति सूचनाएं भी भेजता है।
phone:
type: string
nullable: true
description: >-
उपलब्ध होने पर E.164 प्रारूप में उपयोगकर्ता का फ़ोन नंबर (उदा.,
+14155552671)। सत्र निर्माण के समय केवल ईमेल दिए जाने पर `null`।
नोट: यह फ़ील्ड सत्र निर्माण के दौरान प्रदान किया गया मूल फ़ोन
नंबर लौटाता है। यदि नंबर अमान्य था, तो हो सकता है कि यह E.164
प्रारूप में न हो।
nullable: true
callback:
type: string
format: uri
description: सत्र का कॉलबैक URL।
nullable: true
id_verifications:
type: array
nullable: true
description: >-
वर्कफ़्लो ग्राफ़ में पहचान-दस्तावेज़ चरणों द्वारा निर्मित **पहचान
सत्यापन (OCR) रिपोर्टों की ऐरे**। हमेशा एक JSON ऐरे —
`id_verifications[0]` पढ़ें और पुनरावृति करें यदि आपका वर्कफ़्लो एक
से अधिक पहचान जाँच चला सकता है (उदाहरण के लिए प्राथमिक जाँच और साथ
ही स्टेप-अप)। तब तक `null` जब तक कम से कम एक पहचान चरण ने डेटा
उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें `node_id`,
सुविधा-स्तरीय `status`, निकाले गए दस्तावेज़ फ़ील्ड, छवि URLs,
गुणवत्ता स्कोर, MRZ, पता पार्सिंग, क्रॉस-सत्र मिलान, और `warnings[]`
शामिल हैं।
items:
type: object
description: >-
एक पहचान सत्यापन रिपोर्ट - एकल पहचान सत्यापन चरण के लिए पूरी
रिपोर्ट। `verification_method` बताता है कि तीनों विधियों में से
किसने इसे तैयार किया है (दस्तावेज़ कैप्चर, गैर-दस्तावेज़ लुकअप या
वॉलेट साइन-इन) और विधि-विशिष्ट साक्ष्य ब्लॉक तदनुसार भरा जाता है।
properties:
node_id:
type: string
description: >-
इस रिपोर्ट को तैयार करने वाले OCR चरण का वर्कफ़्लो ग्राफ़ नोड
id।
verification_method:
type: string
enum:
- document
- id_lookup
- wallet
description: >-
किस पहचान सत्यापन विधि ने यह रिपोर्ट जनरेट की। `document` -
उपयोगकर्ता ने भौतिक आईडी की फ़ोटो ली (डिफ़ॉल्ट, और अन्य
विधियों के आने से पहले बनाए गए प्रत्येक सत्र का मान)।
`id_lookup` - उपयोगकर्ता ने अपना राष्ट्रीय आईडी नंबर टाइप किया
और उस देश के सरकारी रजिस्टर या किसी अन्य आधिकारिक स्रोत से
इसका मिलान किया गया (`id_lookup.source` बताता है कि कौन सा)।
`wallet` - उपयोगकर्ता ने सरकारी या बैंक डिजिटल पहचान के साथ
साइन इन किया।
assurance:
type: string
enum:
- documentary
- data_match
- cryptographic
description: >-
`verification_method` से प्राप्त एश्योरेंस स्तर: कैप्चर और
जाँचे गए दस्तावेज़ के लिए `documentary`, क्वेरी किए गए स्रोत
द्वारा रखे गए रिकॉर्ड से मेल खाने वाले विवरणों के लिए
`data_match`, पहचान प्रदाता द्वारा प्रमाणित और हस्ताक्षरित
विशेषताओं के लिए `cryptographic`।
wallet_provider:
type: string
nullable: true
description: >-
जब `verification_method`, `wallet` हो तो कैटलॉग वॉलेट id
(`mitid`, `bankid_se`, `itsme`, ...)। अन्यथा `null`।
fallback_from:
type: object
nullable: true
description: >-
गैर-दस्तावेज़ पद्धति ने ID चरण को समाप्त क्यों नहीं किया।
लुकअप या वॉलेट साइन-इन विफल होने पर सेट किया जाता है: उस
दस्तावेज़ सत्यापन पर जिसे उपयोगकर्ता ने जारी रखा जब देश का
फ़ॉलबैक स्विच `fallback_to_document` था (`action`,
`fallback_to_document` है), या अस्वीकृत रिपोर्ट पर जब यह
`decline` था। अन्यथा `null`।
properties:
method:
type: string
enum:
- id_lookup
- wallet
description: वह विधि जो विफल रही।
reason:
type: string
description: >-
वह परिणाम जिसने इसे समाप्त किया, उदाहरण के लिए `no_match`,
`provider_error`, `cancelled`, `timeout`।
action:
type: string
enum:
- fallback_to_document
- decline
description: >-
कॉन्फ़िगर की गई कार्रवाई जो की गई थी:
`fallback_to_document` या `decline`।
id_lookup:
type: object
nullable: true
description: >-
रजिस्ट्री साक्ष्य। केवल तभी मौजूद होता है जब
`verification_method` का मान `id_lookup` हो; अन्यथा `null`।
properties:
source:
type: string
description: >-
क्वेरी किए गए स्रोत का ग्राहक-सामना करने वाला नाम, उदा.
`Department of Home Affairs` (एक सरकारी रजिस्टर) या `UK
credit bureau and financial services records` (सरकारी
रजिस्टर नहीं)। यह लुकअप के स्रोत का एकमात्र विवरण है; इसे
सरकारी स्रोत न मानें।
checked_at:
type: string
format: date-time
nullable: true
description: रजिस्टर ने कब उत्तर दिया।
attempts:
type: integer
description: 1-आधारित प्रयास संख्या जिससे यह रिपोर्ट आई है।
max_attempts:
type: integer
description: >-
देश के लिए कॉन्फ़िगर किया गया प्रयास बजट (1 से 5, डिफ़ॉल्ट
1)।
outcome:
type: string
enum:
- match
- partial_match
- no_match
- provider_error
- format_rejected
nullable: true
description: >-
रजिस्टर ने क्या उत्तर दिया। केवल `match`, `partial_match`
और `no_match` ही प्रयास बजट और बिलिंग में गिने जाते हैं।
comparison:
type: array
description: >-
स्रोत द्वारा उत्तर दिए गए प्रत्येक तुलनीय फ़ील्ड के लिए एक
पंक्ति, साथ ही प्रति स्रोत त्रुटि एक पंक्ति। तुलना
पंक्तियाँ देश की अनुरोध फ़ील्ड कुंजियों के बजाय नीचे दिए
गए सामान्यीकृत फ़ील्ड नामों का उपयोग करती हैं, क्योंकि कई
अनुरोध फ़ील्ड (पहला और अंतिम नाम, या कोई भी पहचानकर्ता
उपनाम) एक ही तुलना में संक्षिप्त हो जाते हैं। जो स्रोत
विफल रहा, वह `field: "provider"` और `result: "error"` के
साथ एक पंक्ति जोड़ता है, इसलिए किसी पंक्ति को फ़ील्ड
निर्णय मानने से पहले `result` पढ़ें।
items:
type: object
required:
- field
- label
- provided
- record
- result
properties:
field:
type: string
enum:
- identification_number
- full_name
- date_of_birth
- address
- provider
description: >-
सामान्यीकृत तुलना फ़ील्ड। `provider` कोई उपयोगकर्ता
फ़ील्ड नहीं है: यह स्रोत त्रुटि पंक्ति को चिह्नित
करता है।
label:
type: string
description: >-
पंक्ति के लिए डिस्प्ले लेबल, उदाहरण के लिए `ID
number`, `Full name`, `Provider`।
provided:
type: string
nullable: true
description: >-
उपयोगकर्ता ने क्या टाइप किया। `provider` त्रुटि
पंक्ति पर `null`।
record:
type: string
nullable: true
description: >-
स्रोत के पास क्या था। `provider` त्रुटि पंक्ति पर यह
इसके बजाय त्रुटि संदेश दिखाता है।
result:
type: string
enum:
- match
- partial
- no_match
- error
description: >-
प्रति-फ़ील्ड तुलना परिणाम। `error` केवल `provider`
पंक्ति पर दिखाई देता है और इसका अर्थ है कि उस स्रोत
ने उत्तर नहीं दिया; इसे क्वेरी के संबंध में साक्ष्य
मानें, कभी भी फ़ील्ड बेमेल के रूप में नहीं।
registry_portrait:
type: string
format: uri
nullable: true
description: >-
स्रोत द्वारा लौटाए गए पोर्ट्रेट का अल्पकालिक प्रीसाइन्ड
URL। केवल वे चार सरकारी रजिस्टर जो इसे लौटाते हैं (दक्षिण
अफ्रीका, नाइजीरिया, अर्जेंटीना, पनामा)।
face_match_score:
type: number
nullable: true
description: >-
रजिस्ट्री पोर्ट्रेट के विरुद्ध सेल्फ़ी, 0-100। केवल वहीं
जहाँ रजिस्टर एक पोर्ट्रेट लौटाता है।
wallet_verification:
type: object
nullable: true
description: >-
क्रेडेंशियल साक्ष्य। केवल तभी मौजूद होता है जब
`verification_method`, `wallet` हो; अन्यथा `null`।
properties:
provider:
type: string
description: कैटलॉग वॉलेट id, उदा. `mitid`।
provider_name:
type: string
nullable: true
description: >-
वॉलेट का नाम जैसा कि अंतिम उपयोगकर्ता इसे जानता है, उदा.
`MitID`।
issuing_authority:
type: string
nullable: true
description: >-
वॉलेट के पीछे का प्राधिकरण, उदा. `Danish Agency for
Digital Government`।
issuing_country:
type: string
description: ISO 3166-1 alpha-3 देश जिसमें वॉलेट की पेशकश की गई थी।
credential_type:
type: string
nullable: true
description: >-
वॉलेट द्वारा प्रस्तुत क्रेडेंशियल, उदाहरण के लिए
`person_identification`।
level_of_assurance:
type: string
enum:
- low
- substantial
- high
nullable: true
description: >-
वॉलेट द्वारा दावा किया गया एश्योरेंस स्तर। अनुरोधित स्तर
से कम का दावा करने वाला साइन-इन डाउनग्रेड होने के बजाय
विफल हो जाता है।
verified_at:
type: string
format: date-time
nullable: true
description: वॉलेट के प्रमाणीकरण का समय।
signature_valid:
type: boolean
nullable: true
description: क्या वॉलेट द्वारा लौटाया गया हस्ताक्षरित असर्शन मान्य हुआ।
attributes:
type: object
additionalProperties: true
description: >-
वॉलेट द्वारा साझा की गई विशेषताएँ, जिन्हें वॉलेट की कैटलॉग
प्रविष्टि की सूची के अनुसार कीड किया गया है।
portrait:
type: string
format: uri
nullable: true
description: >-
वॉलेट द्वारा साझा किए गए पोर्ट्रेट का अल्पकालिक प्रीसाइन्ड
URL, जहाँ यह एक साझा करता है।
face_match_score:
type: number
nullable: true
description: >-
वॉलेट पोर्ट्रेट के विरुद्ध सेल्फ़ी, 0-100, जहाँ वॉलेट इसे
साझा करता है।
status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Expired
description: >-
इस पहचान सत्यापन चरण की सुविधा-स्तरीय स्थिति। शीर्ष-स्तरीय
सत्र `status` से स्वतंत्र — एक सत्र अपने समग्र निर्णय तक पहुँच
सकता है जबकि एक अलग सुविधा `In Review` रह सकती है।
document_type:
type: string
description: पहचान दस्तावेज़ का प्रकार
document_subtype:
type: string
nullable: true
description: >-
वर्कफ़्लो दस्तावेज़ सेटिंग्स से स्वीकृत दस्तावेज़ उप-प्रकार
कोड, जिसमें लागू होने पर दस्तावेज़ क्षेत्र शामिल है। उदाहरण:
`ID_CARD_GENERIC`, `QUEENSLAND_DRIVER_LICENSE_GENERIC`।
document_number:
type: string
description: दस्तावेज़ पहचान संख्या
personal_number:
type: string
description: व्यक्तिगत पहचान संख्या
portrait_image:
type: string
format: uri
description: पोर्ट्रेट छवि का URL
front_image:
type: string
format: uri
description: दस्तावेज़ के सामने के भाग की छवि का URL
front_video:
type: string
format: uri
description: दस्तावेज़ के सामने के भाग के वीडियो का URL
back_image:
type: string
format: uri
description: दस्तावेज़ के पिछले हिस्से की छवि का URL
back_video:
type: string
format: uri
description: दस्तावेज़ के पिछले भाग के वीडियो का URL
full_front_image:
type: string
format: uri
description: दस्तावेज़ के सामने के भाग की पूर्ण छवि का URL
full_back_image:
type: string
format: uri
description: दस्तावेज़ के पिछले भाग की पूर्ण छवि का URL
front_image_camera_front:
type: string
format: uri
description: >-
सामने वाले कैमरे से कैप्चर की गई दस्तावेज़ के अग्र भाग की छवि
का URL
back_image_camera_front:
type: string
format: uri
description: >-
सामने वाले कैमरे से कैप्चर की गई दस्तावेज़ के पिछले भाग की छवि
का URL
date_of_birth:
type: string
format: date
description: दस्तावेज़ से जन्म तिथि
age:
type: integer
description: जन्म तिथि से परिकलित आयु
expiration_date:
type: string
format: date
description: दस्तावेज़ की समाप्ति तिथि
date_of_issue:
type: string
format: date
description: दस्तावेज़ जारी करने की तिथि
issuing_state:
type: string
description: जारीकर्ता राज्य का ISO कोड
issuing_state_name:
type: string
description: जारीकर्ता राज्य का पूरा नाम
first_name:
type: string
description: दस्तावेज़ से पहला नाम
last_name:
type: string
description: दस्तावेज़ से अंतिम नाम
full_name:
type: string
description: दस्तावेज़ से पूरा नाम
gender:
type: string
description: दस्तावेज़ से लिंग
address:
type: string
description: दस्तावेज़ से प्राप्त रॉ पता
formatted_address:
type: string
description: फ़ॉर्मेट किया गया पूरा पता
place_of_birth:
type: string
description: दस्तावेज़ से जन्म स्थान
marital_status:
type: string
description: दस्तावेज़ से वैवाहिक स्थिति
nationality:
type: string
description: ISO राष्ट्रीयता कोड
extra_fields:
type: object
description: >-
अतिरिक्त दस्तावेज़ फ़ील्ड। इसमें दस्तावेज़-विशिष्ट विशेषताएँ
शामिल हैं (उदा. `dl_categories`, `blood_group`, `sponsor`,
`employer`, `dl_class_code_b_from`, `dl_class_code_b_to`)।
ड्राइविंग लाइसेंस श्रेणी की वैधता तिथियां
`dl_class_code__from` और `dl_class_code__to` के
रूप में लौटाई जाती हैं, और प्रति-श्रेणी प्रतिबंध/सूचना कोड
(उदा. UK लाइसेंस का कॉलम 12) `dl_class_code__notes` के
रूप में लौटाए जाते हैं। जब दस्तावेज़ में नाम, पता या जन्म
स्थान एकाधिक लिपियों में होते हैं, तो इस ऑब्जेक्ट में उन
फ़ील्ड के वैकल्पिक-लिपि संस्करण भी शामिल होते हैं। वर्कफ़्लो
सेटिंग `preferred_characters` (`latin` या `non_latin`) यह
नियंत्रित करती है कि कौन सी लिपि शीर्ष-स्तरीय फ़ील्ड
(`first_name`, `last_name`, `full_name`, `address`,
`place_of_birth`) को पॉप्युलेट करती है; विपरीत लिपि यहाँ
`first_name_non_latin` / `last_name_non_latin` /
`full_name_non_latin` / `middle_name_non_latin` /
`address_non_latin` / `place_of_birth_non_latin` के रूप में
(जब `preferred_characters`, `latin` हो) या `_latin` प्रत्यय के
साथ (जब `preferred_characters`, `non_latin` हो) दिखाई देती है।
कुंजियाँ केवल तभी दिखाई देती हैं जब OCR वास्तव में एक वास्तविक
वैकल्पिक-लिपि मान निकालता है — ऐसा फ़ील्ड जिसका वैकल्पिक मान
पसंदीदा सेट के समान लिपि में है (उदाहरण के लिए, एक
सिरिलिक-लेबल वाला फ़ील्ड जिसका OCR मान लैटिन होमोग्लिफ़ में
वापस आया था) छोड़ दिया जाता है। जब `preferred_characters`,
`latin` हो लेकिन दस्तावेज़ में केवल गैर-लैटिन टेक्स्ट हो, तो
Didit निकाले गए मानों का लिप्यंतरण करता है और फ़ॉलबैक के रूप
में `first_name_latin` / `last_name_latin` / आदि दिखाता है।
additionalProperties: true
properties:
dl_categories:
type: array
items:
type: string
blood_group:
type: string
nullable: true
first_name_non_latin:
type: string
description: >-
गैर-लैटिन लिपि में पहला नाम जब
`preferred_characters=latin` हो और दस्तावेज़ पर गैर-लैटिन
संस्करण मौजूद हो (उदा. किर्गिज़ ID के लिए `Айна`)।
last_name_non_latin:
type: string
description: >-
गैर-लैटिन लिपि में उपनाम जब `preferred_characters=latin`
हो और दस्तावेज़ पर एक गैर-लैटिन संस्करण मौजूद हो।
middle_name_non_latin:
type: string
description: >-
गैर-लैटिन लिपि में मध्य नाम / पैतृक नाम जब
`preferred_characters=latin` हो और दस्तावेज़ पर एक
गैर-लैटिन संस्करण मौजूद हो।
full_name_non_latin:
type: string
description: >-
गैर-Latin लिपि में बना पूरा नाम। जब प्रथम और अंतिम दोनों
नाम उपलब्ध होते हैं, तो अलग-अलग घटकों से पुनर्निर्मित किया
जाता है।
address_non_latin:
type: string
description: >-
गैर-लैटिन लिपि में पता जब `preferred_characters=latin` हो
और दस्तावेज़ पर गैर-लैटिन संस्करण मौजूद हो।
place_of_birth_non_latin:
type: string
description: >-
`preferred_characters=latin` होने पर और दस्तावेज़ में
गैर-लैटिन संस्करण मौजूद होने पर गैर-लैटिन लिपि में जन्म
स्थान।
first_name_latin:
type: string
description: >-
लैटिन लिपि में पहला नाम। यह तब भरा जाता है जब
`preferred_characters=non_latin` हो और दस्तावेज़ पर लैटिन
संस्करण मौजूद हो, या — लिप्यंतरण फ़ॉलबैक के रूप में — जब
`preferred_characters=latin` हो लेकिन दस्तावेज़ में केवल
गैर-लैटिन पाठ हो।
last_name_latin:
type: string
description: लैटिन लिपि में उपनाम। `first_name_latin` के समान नियम।
middle_name_latin:
type: string
description: >-
लैटिन लिपि में मध्य नाम / पैतृक नाम। `first_name_latin`
जैसे ही नियम।
full_name_latin:
type: string
description: >-
Latin लिपि में बना पूरा नाम। जब प्रथम और अंतिम दोनों नाम
उपलब्ध होते हैं, तो हमेशा अलग-अलग घटकों से पुनर्निर्मित
किया जाता है।
address_latin:
type: string
description: लैटिन लिपि में पता। `first_name_latin` के समान नियम।
place_of_birth_latin:
type: string
description: >-
लैटिन लिपि में जन्म स्थान। `first_name_latin` के समान
नियम।
mrz:
type: object
nullable: true
description: >-
दस्तावेज़ से निकाले गए मशीन-रीडेबल ज़ोन (MRZ) के पार्स किए गए
फ़ील्ड। यदि कोई MRZ नहीं मिला तो `null`।
properties:
surname:
type: string
example: MARTINEZ-
सामने के दस्तावेज़ की छवि से निकाले गए पोर्ट्रेट और सामने वाले
कैमरे की छवि के बीच चेहरा मिलान स्कोर
back_image_camera_front_face_match_score:
type: number
nullable: true
description: >-
पीछे के दस्तावेज़ की छवि से निकाले गए पोर्ट्रेट और सामने वाले
कैमरे की छवि के बीच चेहरा मिलान स्कोर
document_selfie_face_matches:
type: array
description: >-
पिछले सत्र या चेहरा ब्लॉकलिस्ट प्रविष्टियाँ जिनका चेहरा
दस्तावेज़ कैप्चर के दौरान फ्रंट कैमरे द्वारा ली गई सेल्फ़ी से
मेल खाता है (साइलेंट कैप्चर चेहरा खोज)।
`liveness_checks[].matches` के समान प्रविष्टि प्रारूप। इस
फ़ील्ड के मौजूद होने से पहले बनाए गए सत्रों के लिए या जब खोज
नहीं चली तो `null`; जब यह चली और कुछ नहीं मिला तो एक खाली ऐरे।
`match_image_url` एक प्री-साइन किया गया URL है जो समाप्त हो
जाता है।
items:
type: object
properties:
session_id:
type: string
format: uuid
nullable: true
description: >-
मिलान वाले चेहरे का सत्र ID। `source` के `imported`,
`list_entry`, या `retained_template` होने पर `null`।
session_number:
type: integer
nullable: true
similarity_percentage:
type: number
description: दोनों छवियों के बीच चेहरे की समानता, 0–100 तक सीमित।
vendor_data:
type: string
nullable: true
description: >-
आयातित और बनाए रखे गए टेम्पलेट चेहरों के लिए मिलान वाले
सत्र या लिंक किए गए User का `vendor_data`।
vendor_user_id:
type: string
format: uuid
nullable: true
description: >-
`imported` और `retained_template` मिलानों के लिए और
उपयोगकर्ता से जुड़े सत्र मिलानों के लिए लिंक की गई
उपयोगकर्ता id। सूची प्रविष्टियों और बिना उपयोगकर्ता वाले
सत्रों के लिए `null`।
biometric_template_id:
type: string
format: uuid
nullable: true
description: >-
प्रतिधारित बायोमेट्रिक टेम्पलेट का Id। केवल तभी सेट किया
जाता है जब `source`, `retained_template` हो; अन्यथा
`null`।
verification_date:
type: string
format: date-time
nullable: true
description: >-
मिलान वाला चेहरा कब कैप्चर किया गया था, या प्रतिधारित
टेम्पलेट कब बनाया गया था। सूची प्रविष्टियों के लिए
`null`।
user_details:
type: object
nullable: true
description: >-
मिलान करने वाले सत्र या इंपोर्ट की गई उपयोगकर्ता
प्रोफ़ाइल से पहचान डेटा। `retained_template` और
`list_entry` मिलानों के लिए हमेशा `null`।
properties:
full_name:
type: string
nullable: true
document_type:
type: string
nullable: true
document_number:
type: string
nullable: true
match_image_url:
type: string
format: uri
nullable: true
description: >-
इमेज-समर्थित मिलानों के लिए संदर्भ छवि।
`retained_template` मिलानों के लिए हमेशा `null` क्योंकि
बनाए रखे गए टेम्पलेट्स में कोई छवि नहीं होती है।
status:
type: string
nullable: true
description: >-
मिलान वाले सत्र की लाइफ़साइकिल स्थिति। गैर-सत्र स्रोतों
के लिए `null`।
is_blocklisted:
type: boolean
description: क्या मिलान करने वाला चेहरा किसी ब्लॉकलिस्ट में है।
is_allowlisted:
type: boolean
description: क्या मिलान करने वाला चेहरा किसी अलाउलिस्ट में है।
api_service:
type: string
nullable: true
description: >-
मिलान वाले सत्र की स्टैंडअलोन API सेवा (उदा.
`PASSIVE_LIVENESS`, `FACE_MATCH`); वर्कफ़्लो सत्रों और
गैर-सत्र स्रोतों के लिए `null`।
source:
type: string
enum:
- session
- imported
- list_entry
- retained_template
description: >-
मिलान वाले चेहरे का ऑरिजिन: `session`, `imported`
(उपयोगकर्ता द्वारा चेहरा अपलोड), `list_entry`
(अनुमति/ब्लॉक सूची), या `retained_template` (उपयोगकर्ता
पर संग्रहीत एक छवि-रहित बायोमेट्रिक टेम्पलेट, जो
`/v3/biometric-templates/` के अंतर्गत सूचीबद्ध है)।
nullable: true
front_image_quality_score:
type: object
nullable: true
description: >-
दस्तावेज़ की सामने की छवि के लिए गुणवत्ता मेट्रिक्स। प्रत्येक
उप-स्कोर 0 से 100 तक होता है।
properties:
focus_score:
type: number
description: >-
शीर्ष-10% स्थानीय लैप्लसियन विचरण (Laplacian variance) के
माध्यम से मापी गई छवि की तीक्ष्णता (शार्पनेस)। बड़े एकसमान
पृष्ठभूमि वाले दस्तावेज़ों के लिए सुदृढ़। उच्च मान एक
तीक्ष्ण, कम धुंधली छवि को इंगित करते हैं।
brightness_score:
type: number
description: >-
छवि में रोशनी कितनी अच्छी है। बहुत अधिक अंधेरी या
ओवरएक्सपोज़्ड छवियों पर पेनल्टी लगाता है, जिसमें
मध्य-श्रेणी के आसपास की चमक आदर्श होती है।
brightness_issue:
type: string
enum:
- ok
- too_dark
- too_bright
description: >-
जब brightness_score कम हो तो ब्राइटनेस की समस्या की दिशा
इंगित करता है। 'ok' का अर्थ है कि ब्राइटनेस स्वीकार्य है,
'too_dark' का अर्थ है कि इमेज अंडरएक्स्पोज़्ड है,
'too_bright' का अर्थ है कि इमेज ओवरएक्स्पोज़्ड है।
is_document_fully_visible:
type: boolean
nullable: true
description: >-
यदि दस्तावेज़ के चारों कोने इमेज फ्रेम के अंदर पूरी तरह से
दिखाई दे रहे हैं तो true, यदि कोई कोना कटा हुआ है तो
false। कोने के निर्देशांक अनुपलब्ध होने पर Null।
resolution_score:
type: number
description: कुल पिक्सेल गणना के आधार पर छवि का प्रभावी रिज़ॉल्यूशन।
overall_score:
type: number
description: >-
उप-स्कोर का भारित संयुक्त स्कोर (फ़ोकस 45%, ब्राइटनेस 30%,
रिज़ॉल्यूशन 25%)।
back_image_quality_score:
type: object
nullable: true
description: >-
दस्तावेज़ की पिछली छवि के लिए गुणवत्ता मेट्रिक्स।
front_image_quality_score के समान संरचना।
properties:
focus_score:
type: number
description: >-
शीर्ष-10% स्थानीय लैप्लसियन विचरण (Laplacian variance) के
माध्यम से मापी गई छवि की तीक्ष्णता (शार्पनेस)। बड़े एकसमान
पृष्ठभूमि वाले दस्तावेज़ों के लिए सुदृढ़। उच्च मान एक
तीक्ष्ण, कम धुंधली छवि को इंगित करते हैं।
brightness_score:
type: number
description: >-
छवि में रोशनी कितनी अच्छी है। बहुत अधिक अंधेरी या
ओवरएक्सपोज़्ड छवियों पर पेनल्टी लगाता है, जिसमें
मध्य-श्रेणी के आसपास की चमक आदर्श होती है।
brightness_issue:
type: string
enum:
- ok
- too_dark
- too_bright
description: >-
जब brightness_score कम हो तो ब्राइटनेस की समस्या की दिशा
इंगित करता है। 'ok' का अर्थ है कि ब्राइटनेस स्वीकार्य है,
'too_dark' का अर्थ है कि इमेज अंडरएक्स्पोज़्ड है,
'too_bright' का अर्थ है कि इमेज ओवरएक्स्पोज़्ड है।
is_document_fully_visible:
type: boolean
nullable: true
description: >-
यदि दस्तावेज़ के चारों कोने इमेज फ्रेम के अंदर पूरी तरह से
दिखाई दे रहे हैं तो true, यदि कोई कोना कटा हुआ है तो
false। कोने के निर्देशांक अनुपलब्ध होने पर Null।
resolution_score:
type: number
description: कुल पिक्सेल गणना के आधार पर छवि का प्रभावी रिज़ॉल्यूशन।
overall_score:
type: number
description: >-
उप-स्कोर का भारित संयुक्त स्कोर (फ़ोकस 45%, ब्राइटनेस 30%,
रिज़ॉल्यूशन 25%)।
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: >-
वह सुविधा जिसने यह चेतावनी उत्पन्न की (उदाहरण के लिए,
`ID_VERIFICATION`, `NFC`, `LIVENESS`)। यह मान उस सुविधा
ब्लॉक की पहचान करता है जिससे चेतावनी संबंधित है।
प्रत्येक मॉड्यूल का चेतावनी ऐरे आमतौर पर अपने मॉड्यूल से
मेल खाने वाले मान का उपयोग करता है, लेकिन ऊपर दिया गया
enum निर्णय payload पर सभी सुविधा चेतावनियों में
आधिकारिक है।
risk:
type: string
additional_data:
type: object
nullable: true
description: चेतावनी के बारे में अतिरिक्त प्रासंगिक डेटा
log_type:
type: string
description: 'लॉग का प्रकार: जानकारी, चेतावनी, या त्रुटि'
short_description:
type: string
long_description:
type: string
node_id:
type: string
description: >-
वर्कफ़्लो ग्राफ़ नोड ID जिसने यह चेतावनी उत्पन्न की
(ग्राफ़-आधारित वर्कफ़्लो के लिए)
description: दस्तावेज़ सत्यापन चेतावनियाँ
matches:
type: array
description: >-
डुप्लिकेट/ब्लॉकलिस्ट डिटेक्शन के दौरान पाए गए मिलान दस्तावेज़
(अधिकतम 5 मिलान)
items:
type: object
properties:
session_id:
type: string
format: uuid
description: मिलान वाले दस्तावेज़ का सत्र ID
session_number:
type: integer
description: मिलान वाले दस्तावेज़ की सत्र संख्या
vendor_data:
type: string
nullable: true
description: मिलान वाले सत्र से संबद्ध वेंडर डेटा
verification_date:
type: string
format: date-time
description: तारीख जब मिलान करने वाले सत्र को सत्यापित किया गया था
user_details:
type: object
properties:
name:
type: string
description: मिलान वाले दस्तावेज़ से पूरा नाम
document_type:
type: string
description: मिलान वाले दस्तावेज़ का प्रकार
document_number:
type: string
description: मिलान वाले दस्तावेज़ की दस्तावेज़ संख्या
status:
type: string
description: मिलान सत्र की स्थिति
is_blocklisted:
type: boolean
description: क्या मिलान करने वाला दस्तावेज़ ब्लॉकलिस्ट में है
api_service:
type: string
nullable: true
description: मिलान वाले सत्र का API सेवा प्रकार
front_image_url:
type: string
format: uri
nullable: true
description: मिलान वाले दस्तावेज़ के सामने के भाग की छवि का URL
document_liveness:
type: object
nullable: true
description: >-
प्रति धोखाधड़ी प्रकार दस्तावेज़-लाइवनेस स्कोर, चेतावनी ट्रिगर
हुई हो या नहीं, दोनों स्थितियों में रिपोर्ट किए जाते हैं, ताकि
स्वीकृत दस्तावेज़ का भी ऑडिट किया जा सके। जब जाँच नहीं चली तो
`null`।
properties:
portrait_replace:
type: object
nullable: true
properties:
score:
type: number
nullable: true
description: >-
इस धोखाधड़ी प्रकार के लिए दस्तावेज़ के वास्तविक होने
की संभावना, 0-100 (उच्चतर = अधिक वास्तविक होने की
संभावना)। दोनों पक्षों में से सबसे कम - वह मान जिसका
निर्णय में उपयोग किया गया था। जब किसी भी पक्ष ने उपयोग
योग्य स्कोर उत्पन्न नहीं किया तो `null`।
front:
type: number
nullable: true
description: >-
सामने के हिस्से का स्कोर; कैप्चर न होने पर या स्कोर
हटा दिए जाने पर `null`।
back:
type: number
nullable: true
description: >-
पिछले हिस्से का स्कोर; कैप्चर न होने पर या स्कोर हटा
दिए जाने पर `null`।
decline_threshold:
type: number
nullable: true
description: >-
इस दस्तावेज़ का मूल्यांकन करते समय सहेजा गया अस्वीकृति
थ्रेशोल्ड। बाद के वर्कफ़्लो संपादन इसे नहीं बदलते हैं।
ऐतिहासिक मूल्यांकन साक्ष्य अनुपलब्ध होने पर null।
review_threshold:
type: number
nullable: true
description: >-
इस दस्तावेज़ का मूल्यांकन करते समय सहेजा गया समीक्षा
थ्रेशोल्ड। बाद के वर्कफ़्लो संपादन इसे नहीं बदलते हैं।
ऐतिहासिक मूल्यांकन साक्ष्य अनुपलब्ध होने पर Null।
bucket:
type: string
nullable: true
enum:
- approve
- review
- decline
- null
description: >-
मूल्यांकन के समय सहेजा गया धोखाधड़ी-प्रकार का बकेट। जब
कोई उपयोग योग्य स्कोर नहीं होता है, जाँच लागू नहीं की
गई थी, या ऐतिहासिक मूल्यांकन साक्ष्य अनुपलब्ध होते
हैं, तो यह null होता है। बाद के वर्कफ़्लो संपादन इसे
नहीं बदलते हैं।
printed_copy:
type: object
nullable: true
properties:
score:
type: number
nullable: true
description: >-
इस धोखाधड़ी प्रकार के लिए दस्तावेज़ के वास्तविक होने
की संभावना, 0-100 (उच्चतर = अधिक वास्तविक होने की
संभावना)। दोनों पक्षों में से सबसे कम - वह मान जिसका
निर्णय में उपयोग किया गया था। जब किसी भी पक्ष ने उपयोग
योग्य स्कोर उत्पन्न नहीं किया तो `null`।
front:
type: number
nullable: true
description: >-
सामने के हिस्से का स्कोर; कैप्चर न होने पर या स्कोर
हटा दिए जाने पर `null`।
back:
type: number
nullable: true
description: >-
पिछले हिस्से का स्कोर; कैप्चर न होने पर या स्कोर हटा
दिए जाने पर `null`।
decline_threshold:
type: number
nullable: true
description: >-
इस दस्तावेज़ का मूल्यांकन करते समय सहेजा गया अस्वीकृति
थ्रेशोल्ड। बाद के वर्कफ़्लो संपादन इसे नहीं बदलते हैं।
ऐतिहासिक मूल्यांकन साक्ष्य अनुपलब्ध होने पर null।
review_threshold:
type: number
nullable: true
description: >-
इस दस्तावेज़ का मूल्यांकन करते समय सहेजा गया समीक्षा
थ्रेशोल्ड। बाद के वर्कफ़्लो संपादन इसे नहीं बदलते हैं।
ऐतिहासिक मूल्यांकन साक्ष्य अनुपलब्ध होने पर Null।
bucket:
type: string
nullable: true
enum:
- approve
- review
- decline
- null
description: >-
मूल्यांकन के समय सहेजा गया धोखाधड़ी-प्रकार का बकेट। जब
कोई उपयोग योग्य स्कोर नहीं होता है, जाँच लागू नहीं की
गई थी, या ऐतिहासिक मूल्यांकन साक्ष्य अनुपलब्ध होते
हैं, तो यह null होता है। बाद के वर्कफ़्लो संपादन इसे
नहीं बदलते हैं।
screen_replay:
type: object
nullable: true
properties:
score:
type: number
nullable: true
description: >-
इस धोखाधड़ी प्रकार के लिए दस्तावेज़ के वास्तविक होने
की संभावना, 0-100 (उच्चतर = अधिक वास्तविक होने की
संभावना)। दोनों पक्षों में से सबसे कम - वह मान जिसका
निर्णय में उपयोग किया गया था। जब किसी भी पक्ष ने उपयोग
योग्य स्कोर उत्पन्न नहीं किया तो `null`।
front:
type: number
nullable: true
description: >-
सामने के हिस्से का स्कोर; कैप्चर न होने पर या स्कोर
हटा दिए जाने पर `null`।
back:
type: number
nullable: true
description: >-
पिछले हिस्से का स्कोर; कैप्चर न होने पर या स्कोर हटा
दिए जाने पर `null`।
decline_threshold:
type: number
nullable: true
description: >-
इस दस्तावेज़ का मूल्यांकन करते समय सहेजा गया अस्वीकृति
थ्रेशोल्ड। बाद के वर्कफ़्लो संपादन इसे नहीं बदलते हैं।
ऐतिहासिक मूल्यांकन साक्ष्य अनुपलब्ध होने पर null।
review_threshold:
type: number
nullable: true
description: >-
इस दस्तावेज़ का मूल्यांकन करते समय सहेजा गया समीक्षा
थ्रेशोल्ड। बाद के वर्कफ़्लो संपादन इसे नहीं बदलते हैं।
ऐतिहासिक मूल्यांकन साक्ष्य अनुपलब्ध होने पर Null।
bucket:
type: string
nullable: true
enum:
- approve
- review
- decline
- null
description: >-
मूल्यांकन के समय सहेजा गया धोखाधड़ी-प्रकार का बकेट। जब
कोई उपयोग योग्य स्कोर नहीं होता है, जाँच लागू नहीं की
गई थी, या ऐतिहासिक मूल्यांकन साक्ष्य अनुपलब्ध होते
हैं, तो यह null होता है। बाद के वर्कफ़्लो संपादन इसे
नहीं बदलते हैं।
address_validation:
allOf:
- $ref: '#/components/schemas/AddressValidationResult'
nullable: true
description: >-
इस दस्तावेज़ पर मुद्रित पते का पता सत्यापन: क्या यह मौजूद है
और इसका सामान्यीकृत रूप, जैसा कि दस्तावेज़ ने इसे पढ़ा है (बाद
में `address` का सुधार इसे फिर से नहीं चलाता है)। तब उपस्थित
होता है जब इस पहचान सत्यापन चरण में पता सत्यापन ऐड-ऑन सक्षम
हो; अन्यथा `null`।
region:
type: string
nullable: true
description: >-
दस्तावेज़ जारीकर्ता देश का क्षेत्र या राज्य जहाँ दस्तावेज़
किसी एक की पहचान करता है।
extracted_data:
type: object
nullable: true
additionalProperties: true
description: >-
दस्तावेज़ से निकाले गए डेटा का स्नैपशॉट जिसे व्यक्ति को
समीक्षा के लिए दिखाया गया था, पुष्टि किए गए मानों के बगल में
रखा जाता है ताकि आप तुलना कर सकें कि क्या पढ़ा गया था और
व्यक्ति ने किसकी पुष्टि की थी। जब व्यक्ति से समीक्षा करने के
लिए नहीं कहा गया था, तब `null`।
barcodes:
type: array
items:
type: object
additionalProperties: true
description: >-
दस्तावेज़ के बारकोड से पढ़ा गया डेटा। जब दस्तावेज़ में कोई
बारकोड नहीं होता या कोई पढ़ा नहीं गया हो, तो खाली होता है।
nfc_skip_reason:
type: string
nullable: true
enum:
- USER_SKIPPED
- DOCUMENT_WITHOUT_CHIP
- CHIP_CERTIFICATE_UNAVAILABLE
- DEVICE_WITHOUT_NFC
- INTEGRATION_WITHOUT_NFC_ACCESS
- MRZ_KEY_UNAVAILABLE
- JPKI_UNAVAILABLE
description: >-
NFC चिप सत्यापन क्यों नहीं चला, जब भी वर्कफ़्लो में NFC चरण शामिल
होता है तब पॉप्युलेट होता है। NFC लंबित रहने या चिप वास्तव में पढ़े
जाने पर `null`। मान: `USER_SKIPPED` - उपयोगकर्ता ने NFC-सक्षम डिवाइस
पर छोड़ना चुना (`allow_nfc_skip` द्वारा अनुमत);
`DOCUMENT_WITHOUT_CHIP` - दस्तावेज़ में कोई पठनीय NFC चिप नहीं है
(ICAO 9303 इलेक्ट्रॉनिक दस्तावेज़ नहीं है);
`CHIP_CERTIFICATE_UNAVAILABLE` - दस्तावेज़ की जारी अवधि को कवर करने
वाला जारीकर्ता देश का हस्ताक्षर प्रमाणपत्र (CSCA) अनुपलब्ध है, इसलिए
चिप हस्ताक्षर सत्यापित नहीं किया जा सकता; `DEVICE_WITHOUT_NFC` -
डिवाइस ने कोई NFC रीडर रिपोर्ट नहीं किया;
`INTEGRATION_WITHOUT_NFC_ACCESS` - सत्यापन मूल SDK के बिना चला (उदा.
वेब ब्राउज़र में), जिसके पास फ़ोन के NFC रीडर तक कोई पहुँच नहीं है;
`MRZ_KEY_UNAVAILABLE` - चिप एक्सेस कुंजी दस्तावेज़ के MRZ से प्राप्त
नहीं की जा सकी; `JPKI_UNAVAILABLE` - दस्तावेज़ जापान का माय नंबर
कार्ड है, जिसकी चिप JPKI के माध्यम से पढ़ी जाती है, और इस सत्यापन के
लिए JPKI उपलब्ध नहीं था: यह सक्षम नहीं है, या ऐप का मूल SDK माय नंबर
कार्ड नहीं पढ़ सकता है।
nfc_verifications:
type: array
nullable: true
description: >-
वर्कफ़्लो ग्राफ़ में NFC चरणों द्वारा निर्मित **NFC / ePassport
रिपोर्टों का Array**। **यह हमेशा एक JSON array होता है, कभी भी एकल
`nfc` ऑब्जेक्ट नहीं** — `nfc_verifications[0]` पढ़ें और पुनरावृति
(iterate) करें यदि आपका वर्कफ़्लो NFC को एक से अधिक बार चला सकता है।
तब तक `null` जब तक कम से कम एक NFC चरण ने डेटा उत्पन्न न किया हो।
प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें `node_id`, सुविधा-स्तरीय
`status`, `chip_protocol`, `chip_data`, `authenticity` (SOD + DG
अखंडता), `certificate_summary`, और `warnings[]` शामिल हैं। जापान माय
नंबर कार्ड को ICAO 9303 के बजाय JPKI के माध्यम से पढ़ा जाता है: इसके
आइटम में `chip_protocol: "jpki"` होता है, यह अपने साक्ष्य `jpki` के
तहत रखता है, और ICAO फ़ील्ड को `null` छोड़ता है। जब NFC चरण को ऑफ़र
किए जाने से पहले ही बायपास कर दिया गया था (चिप रहित दस्तावेज़,
अनुपलब्ध प्रमाणपत्र, कोई NFC क्षमता रिपोर्ट नहीं की गई, अपठनीय MRZ
कुंजी, माय नंबर कार्ड के लिए JPKI अनुपलब्ध), तो यह `null` रहता है और
`nfc_skip_reason` बताता है कि ऐसा क्यों हुआ; चरण में ही छोड़ दिया
जाना (उपयोगकर्ता ने स्किप टैप किया, या स्कैन के समय रीडर अनुपलब्ध
निकला) फिर भी `is_nfc_skipped: true` के साथ एक रिपोर्ट उत्पन्न करता
है।
items:
type: object
description: >-
एक NFC रिपोर्ट: एकल चिप रीड के लिए पूरी रिपोर्ट (एक ICAO 9303
ePassport या eID चिप, या JPKI के माध्यम से पढ़ा गया जापान माई नंबर
कार्ड)।
properties:
node_id:
type: string
description: >-
इस रिपोर्ट को तैयार करने वाले NFC चरण का वर्कफ़्लो ग्राफ़ नोड
id। रिपोर्ट को वर्कफ़्लो परिभाषा के साथ सहसंबंधित करने के लिए
इसका उपयोग करें।
status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
description: >-
इस NFC चरण की सुविधा-स्तरीय स्थिति। शीर्ष-स्तरीय सत्र `status`
से स्वतंत्र — एक सत्र अपने समग्र निर्णय तक पहुँच सकता है जबकि
एक अलग सुविधा `In Review` रह सकती है।
is_nfc_skipped:
type: boolean
description: >-
`true` जब इस NFC चरण को पढ़ने के बजाय स्पष्ट रूप से छोड़ दिया
गया था; `skip_reason` कारण बताता है।
skip_reason:
type: string
nullable: true
enum:
- USER_SKIPPED
- DOCUMENT_WITHOUT_CHIP
- CHIP_CERTIFICATE_UNAVAILABLE
- DEVICE_WITHOUT_NFC
- INTEGRATION_WITHOUT_NFC_ACCESS
- MRZ_KEY_UNAVAILABLE
- JPKI_UNAVAILABLE
description: >-
यह NFC चरण क्यों छोड़ दिया गया। केवल तब सेट होता है जब
`is_nfc_skipped`, `true` हो। सत्र-स्तरीय `nfc_skip_reason` के
समान टैक्सोनॉमी, जो अतिरिक्त रूप से उन मामलों को कवर करती है
जहाँ NFC ने कभी कोई रिपोर्ट तैयार ही नहीं की।
chip_protocol:
type: string
enum:
- icao
- jpki
description: >-
NFC चरण चिप को कैसे पढ़ता है। `icao`: ICAO 9303 ePassport या
eID चिप, जिसे MRZ से एक्सेस कुंजी के साथ खोला जाता है। `jpki`:
जापान माय नंबर कार्ड, जहाँ धारक द्वारा मूल SDK में कार्ड पिन
दर्ज करने के बाद कार्ड एक बार के चैलेंज पर हस्ताक्षर करता है;
परिणाम `jpki` के अंतर्गत होता है। छोड़े गए चरणों पर भी सेट
किया जाता है, ताकि आप छोड़े गए माय नंबर कार्ड पठन को अलग पहचान
सकें।
jpki:
type: object
nullable: true
description: >-
JPKI के माध्यम से पढ़े गए Japan My Number Card ने क्या
प्रमाणित किया। तभी मौजूद होता है जब `chip_protocol` `jpki` हो
और कार्ड पढ़ा गया हो। ICAO चिप्स, छोड़े गए चरणों के लिए, और जब
NFC चरण बिना किसी कार्ड पढ़े बंद हो गया हो (वह मामला
`JPKI_SIGNATURE_INVALID` उठाता है) के लिए `null`। कभी भी
प्रमाणपत्र, उनके सीरियल नंबर, हस्ताक्षर या 12-अंकों का My
Number नहीं ले जाता है।
properties:
certificate_types:
type: array
items:
type: string
enum:
- user_authentication
- signature
description: >-
कार्ड से पढ़े गए प्रमाणपत्र। `user_authentication`
(4-अंकीय PIN) हमेशा पढ़ा जाता है; `signature` (हस्ताक्षर
PIN) तब पढ़ा जाता है जब NFC नोड की
`jpki_request_attributes` सेटिंग चालू होती है।
chain_valid:
type: boolean
description: >-
`true` जब पढ़ा गया प्रत्येक प्रमाणपत्र JPKI प्रमाणन
प्राधिकरण से जुड़ा हो, अपनी वैधता अवधि के भीतर हो और अपने
प्रकार का My Number Card प्रमाणपत्र हो।
signature_valid:
type: boolean
description: >-
`true` जब वन-टाइम चैलेंज पर कार्ड द्वारा किया गया प्रत्येक
हस्ताक्षर सत्यापित हो जाता है। कार्ड केवल अपना PIN दर्ज
किए जाने के बाद ही हस्ताक्षर करता है, इसलिए यह कार्ड पर
कब्ज़ा और PIN की जानकारी साबित करता है।
revocation_status:
type: string
enum:
- good
- revoked
- unchecked
description: >-
`good` जब रिवोकेशन जांच ने पुष्टि की हो कि प्रत्येक
प्रमाणपत्र मान्य है, `revoked` जब कोई भी प्रमाणपत्र रिवोक
किया गया हो (उदाहरण के लिए खोया हुआ रिपोर्ट किया गया
कार्ड), `unchecked` जब कोई रिवोकेशन उत्तर उपलब्ध न था।
`unchecked` को कभी भी `good` नहीं माना जाता है: NFC नोड का
`jpki_revocation_unchecked_action` परिणाम तय करता है
(डिफ़ॉल्ट `REVIEW`)।
ca_generation:
type: string
nullable: true
description: >-
प्रमाणपत्र जारी करने वाले JPKI प्रमाणन प्राधिकरण की
जनरेशन, उदाहरण के लिए `2023`। जब कोई प्रमाणपत्र किसी से भी
शृंखलाबद्ध नहीं होता, तब `null`।
certificate_expires_at:
type: string
format: date-time
nullable: true
description: रीड किए गए प्रमाणपत्रों में सबसे प्रारंभिक समाप्ति तिथि।
certificates:
type: array
items:
type: object
description: >-
कार्ड से पढ़े गए एक प्रमाणपत्र ने क्या प्रमाणित किया।
कभी भी स्वयं प्रमाणपत्र या उसका सीरियल नंबर नहीं।
properties:
type:
type: string
enum:
- user_authentication
- signature
description: यह प्रविष्टि किस कार्ड प्रमाणपत्र का वर्णन करती है।
chain_valid:
type: boolean
description: >-
`true` जब प्रमाणपत्र अपने प्रकार के JPKI प्रमाणन
प्राधिकरण से जुड़ा हो, अपनी वैधता अवधि के भीतर हो और
उस प्रकार का My Number Card प्रमाणपत्र हो।
signature_valid:
type: boolean
description: >-
`true` जब वन-टाइम चैलेंज पर कार्ड का हस्ताक्षर इस
प्रमाणपत्र के विरुद्ध सत्यापित हो जाता है।
ca_generation:
type: string
nullable: true
description: >-
प्रमाणपत्र जारी करने वाले JPKI प्रमाणन प्राधिकरण की
जनरेशन, उदाहरण के लिए `2023`। कोई विश्वसनीय
जारीकर्ता नहीं मिलने पर `null`।
not_valid_before:
type: string
format: date-time
nullable: true
description: >-
प्रमाणपत्र की वैधता अवधि की शुरुआत। `null` जब
प्रमाणपत्र पढ़ा नहीं जा सका।
not_valid_after:
type: string
format: date-time
nullable: true
description: >-
प्रमाणपत्र की वैधता अवधि की समाप्ति। `null` जब
प्रमाणपत्र पढ़ा नहीं जा सका।
failure:
type: string
nullable: true
enum:
- unreadable_certificate
- untrusted_issuer
- expired
- not_yet_valid
- wrong_policy
- key_usage
- null
description: >-
`chain_valid`, `false` क्यों है:
`unreadable_certificate`, `untrusted_issuer` (इसके
प्रकार के JPKI प्रमाणन प्राधिकरण द्वारा जारी नहीं
किया गया), `expired`, `not_yet_valid`,
`wrong_policy` (उस प्रकार का माय नंबर कार्ड
प्रमाणपत्र नहीं है) या `key_usage` (कुंजी हस्ताक्षर
नहीं कर सकती)। चेन मान्य होने पर `null`।
description: >-
प्रति-प्रमाणपत्र परिणाम, पढ़े गए प्रत्येक प्रमाणपत्र के
लिए एक प्रविष्टि।
attributes:
type: object
nullable: true
description: >-
हस्ताक्षर प्रमाणपत्र से धारक का डेटा, जब उसकी चेन मान्य हो
जाती है। `null` जब हस्ताक्षर प्रमाणपत्र का अनुरोध नहीं
किया गया था या उसकी JPKI प्रमाणन प्राधिकरण से चेन स्थापित
नहीं हुई थी।
properties:
full_name:
type: string
nullable: true
description: पंजीकृत नाम, आमतौर पर जापानी लिपि में।
date_of_birth:
type: string
format: date
nullable: true
description: >-
जन्म तिथि, `YYYY-MM-DD`। जब पंजीकृत तारीख अधूरी हो तो
`null`।
gender:
type: string
nullable: true
enum:
- M
- F
- null
description: पंजीकृत न होने पर `M`, `F`, या `null`।
address:
type: string
nullable: true
description: पंजीकृत पता।
name_substitute_characters:
type: string
nullable: true
description: >-
`full_name` के उन वर्णों को चिह्नित करने वाली स्थिति
स्ट्रिंग जिन्हें किसी प्रतिस्थापन वर्ण से बदला गया था
क्योंकि मूल वर्ण मानक वर्ण सेट से बाहर है। कोई भी वर्ण
न बदले जाने पर `null`।
address_substitute_characters:
type: string
nullable: true
description: >-
`address` में प्रतिस्थापित वर्णों को चिह्नित करने वाली
स्थिति स्ट्रिंग, जैसा कि `name_substitute_characters`
के लिए है।
attributes_match_ocr:
type: boolean
nullable: true
description: >-
`true` जब एट्रिब्यूट उसी कार्ड के फ़ोटो से पढ़े गए डेटा से
मेल खाते हैं, `false` जब कोई एट्रिब्यूट भिन्न होता है
(`JPKI_AND_OCR_DATA_NOT_SAME`), `null` जब किसी चीज़ की
तुलना नहीं की जा सकी, जिसमें वह स्थिति भी शामिल है जब
`attributes` `null` हो।
mismatched_attributes:
type: array
items:
type: string
enum:
- full_name
- date_of_birth
- gender
- address
description: >-
फ़ोटो डेटा से भिन्न एट्रिब्यूट्स के नाम, उनके मान कभी
नहीं। तुलना की गई सभी चीज़ों के मेल खाने पर खाली।
portrait_image:
type: string
format: uri
nullable: true
description: >-
चिप से पढ़े गए पोर्ट्रेट का प्री-साइन किया गया URL (ICAO DG2)।
JPKI रीड (`chip_protocol: "jpki"`) और छोड़े गए चरणों के लिए
`null`।
signature_image:
type: string
format: uri
nullable: true
description: >-
चिप से पढ़े गए धारक के हस्ताक्षर की छवि का प्री-साइन किया गया
URL (ICAO DG7), जब चिप में यह संग्रहीत हो। JPKI रीड
(`chip_protocol: "jpki"`) और छोड़े गए चरणों के लिए `null`।
chip_data:
type: object
nullable: true
description: >-
ICAO चिप के डेटा समूहों से पार्स किया गया व्यक्तिगत डेटा। JPKI
रीड (`chip_protocol: "jpki"`) और छोड़े गए चरणों के लिए `null`।
properties:
document_type:
type: string
issuing_country:
type: string
document_number:
type: string
expiration_date:
type: string
format: date
first_name:
type: string
last_name:
type: string
birth_date:
type: string
format: date
gender:
type: string
nationality:
type: string
address:
type: string
place_of_birth:
type: string
authenticity:
type: object
nullable: true
description: >-
ICAO पैसिव प्रमाणीकरण: SOD हस्ताक्षर (`sod_integrity`) और Data
Group हैश (`dg_integrity`)। JPKI रीड के लिए `null`, जो अपने
प्रमाण की रिपोर्ट `jpki` के तहत करता है।
properties:
sod_integrity:
type: boolean
dg_integrity:
type: boolean
certificate_summary:
type: object
nullable: true
description: >-
ICAO दस्तावेज़ हस्ताक्षरकर्ता प्रमाणपत्र का सारांश। JPKI पढ़ने
(`chip_protocol: "jpki"`) और छोड़े गए चरणों के लिए `null`।
properties:
issuer:
type: string
subject:
type: string
serial_number:
type: string
not_valid_after:
type: string
format: date-time
not_valid_before:
type: string
format: date-time
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: >-
वह सुविधा जिसने यह चेतावनी उत्पन्न की। यह मान उस सुविधा
ब्लॉक की पहचान करता है जिससे चेतावनी संबंधित है।
प्रत्येक मॉड्यूल का चेतावनी ऐरे आमतौर पर अपने मॉड्यूल से
मेल खाने वाले मान का उपयोग करता है (उदाहरण के लिए,
`phone_verifications[].warnings` के अंदर `PHONE`), लेकिन
ऊपर दिया गया enum निर्णय payload पर सभी सुविधा
चेतावनियों में आधिकारिक है।
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: वर्कफ़्लो ग्राफ़ नोड ID जिसने यह चेतावनी उत्पन्न की
liveness_checks:
type: array
nullable: true
description: >-
वर्कफ़्लो ग्राफ़ में लाइवनेस चरणों द्वारा निर्मित **लाइवनेस
रिपोर्टों का ऐरे**। हमेशा एक JSON ऐरे — कभी भी एकल `liveness`
ऑब्जेक्ट नहीं। तब तक `null` जब तक कम से कम एक लाइवनेस चरण ने डेटा
उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें `node_id`,
सुविधा-स्तरीय `status`, `method`, `score`, `reference_image`,
`video_url`, वैकल्पिक `age_estimation`, क्रॉस-सत्र `matches[]`, और
`warnings[]` शामिल हैं।
items:
type: object
description: एक लाइवनेस रिपोर्ट — एकल लाइवनेस पास के लिए पूर्ण रिपोर्ट।
properties:
node_id:
type: string
description: >-
इस रिपोर्ट को तैयार करने वाले लाइवनेस चरण का वर्कफ़्लो ग्राफ़
नोड id।
status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
description: >-
इस लाइवनेस डिटेक्शन चरण की सुविधा-स्तरीय स्थिति। शीर्ष-स्तरीय
सत्र `status` से स्वतंत्र — एक सत्र अपने समग्र निर्णय तक पहुँच
सकता है जबकि एक अलग सुविधा `In Review` रह सकती है।
method:
type: string
description: लाइवनेस डिटेक्शन के लिए उपयोग की जाने वाली विधि
score:
type: number
description: लाइवनेस जांच का विश्वास स्कोर
reference_image:
type: string
format: uri
description: उपयोग की गई संदर्भ छवि का URL
video_url:
type: string
format: uri
description: लाइवनेस डिटेक्शन वीडियो का URL
age_estimation:
type: number
description: व्यक्ति की अनुमानित आयु
matches:
type: array
description: >-
डुप्लिकेट-फ़ेस खोज द्वारा पाए गए समान चेहरे (शीर्ष मिलान,
ब्लॉकलिस्ट/अनुमति-सूची प्रविष्टियाँ पहले)। प्रत्येक प्रविष्टि
का `source` आपको बताता है कि मिलान करने वाला चेहरा कहाँ से
आया: `session` (अन्य सत्यापन सत्र), `imported` (वेंडर
उपयोगकर्ता के विरुद्ध अपलोड किया गया चेहरा), `list_entry`
(संगठन द्वारा प्रबंधित अनुमति/ब्लॉक सूची में मौजूद चेहरा), या
`retained_template` (किसी User पर संग्रहीत एक छवि-मुक्त
बायोमेट्रिक टेम्पलेट, जो `/v3/biometric-templates/` के अंतर्गत
सूचीबद्ध है)। गैर-सत्र स्रोतों के लिए `session_id`,
`session_number`, `status` और `api_service` का मान `null` होता
है। `imported` मिलान अभी भी वेंडर-उपयोगकर्ता रिकॉर्ड से
`vendor_data`, `verification_date` और — जब वेंडर उपयोगकर्ता के
फ़ाइल में नाम मौजूद हो — `user_details` (केवल `full_name` के
साथ) भरते हैं; `retained_template` मिलान `vendor_user_id`,
`vendor_data`, `biometric_template_id` और `verification_date`
भरते हैं, जबकि उनके छवि और पहचान फ़ील्ड `null` होते हैं;
`list_entry` मिलान इन सभी को `null` के रूप में लौटाते हैं।
items:
type: object
properties:
session_id:
type: string
format: uuid
nullable: true
description: >-
मिलान वाले चेहरे का सत्र ID। `source` के `imported`,
`list_entry`, या `retained_template` होने पर `null`।
session_number:
type: integer
nullable: true
similarity_percentage:
type: number
description: दोनों छवियों के बीच चेहरे की समानता, 0–100 तक सीमित।
vendor_data:
type: string
nullable: true
description: >-
आयातित और बनाए रखे गए टेम्पलेट चेहरों के लिए मिलान वाले
सत्र या लिंक किए गए User का `vendor_data`।
vendor_user_id:
type: string
format: uuid
nullable: true
description: >-
`imported` और `retained_template` मिलानों के लिए और
उपयोगकर्ता से जुड़े सत्र मिलानों के लिए लिंक की गई
उपयोगकर्ता id। सूची प्रविष्टियों और बिना उपयोगकर्ता वाले
सत्रों के लिए `null`।
biometric_template_id:
type: string
format: uuid
nullable: true
description: >-
प्रतिधारित बायोमेट्रिक टेम्पलेट का Id। केवल तभी सेट किया
जाता है जब `source`, `retained_template` हो; अन्यथा
`null`।
verification_date:
type: string
format: date-time
nullable: true
description: >-
मिलान वाला चेहरा कब कैप्चर किया गया था, या प्रतिधारित
टेम्पलेट कब बनाया गया था। सूची प्रविष्टियों के लिए
`null`।
user_details:
type: object
nullable: true
description: >-
मिलान करने वाले सत्र या इंपोर्ट की गई उपयोगकर्ता
प्रोफ़ाइल से पहचान डेटा। `retained_template` और
`list_entry` मिलानों के लिए हमेशा `null`।
properties:
full_name:
type: string
nullable: true
document_type:
type: string
nullable: true
document_number:
type: string
nullable: true
match_image_url:
type: string
format: uri
nullable: true
description: >-
इमेज-समर्थित मिलानों के लिए संदर्भ छवि।
`retained_template` मिलानों के लिए हमेशा `null` क्योंकि
बनाए रखे गए टेम्पलेट्स में कोई छवि नहीं होती है।
status:
type: string
nullable: true
description: >-
मिलान वाले सत्र की लाइफ़साइकिल स्थिति। गैर-सत्र स्रोतों
के लिए `null`।
is_blocklisted:
type: boolean
description: क्या मिलान करने वाला चेहरा किसी ब्लॉकलिस्ट में है।
is_allowlisted:
type: boolean
description: क्या मिलान करने वाला चेहरा किसी अलाउलिस्ट में है।
api_service:
type: string
nullable: true
description: >-
मिलान वाले सत्र की स्टैंडअलोन API सेवा (उदा.
`PASSIVE_LIVENESS`, `FACE_MATCH`); वर्कफ़्लो सत्रों और
गैर-सत्र स्रोतों के लिए `null`।
source:
type: string
enum:
- session
- imported
- list_entry
- retained_template
description: >-
मिलान वाले चेहरे का ऑरिजिन: `session`, `imported`
(उपयोगकर्ता द्वारा चेहरा अपलोड), `list_entry`
(अनुमति/ब्लॉक सूची), या `retained_template` (उपयोगकर्ता
पर संग्रहीत एक छवि-रहित बायोमेट्रिक टेम्पलेट, जो
`/v3/biometric-templates/` के अंतर्गत सूचीबद्ध है)।
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: >-
वह सुविधा जिसने यह चेतावनी उत्पन्न की। यह मान उस सुविधा
ब्लॉक की पहचान करता है जिससे चेतावनी संबंधित है।
प्रत्येक मॉड्यूल का चेतावनी ऐरे आमतौर पर अपने मॉड्यूल से
मेल खाने वाले मान का उपयोग करता है (उदाहरण के लिए,
`phone_verifications[].warnings` के अंदर `PHONE`), लेकिन
ऊपर दिया गया enum निर्णय payload पर सभी सुविधा
चेतावनियों में आधिकारिक है।
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: वर्कफ़्लो ग्राफ़ नोड ID जिसने यह चेतावनी उत्पन्न की
face_quality:
type: number
nullable: true
description: >-
चेहरे की छवि गुणवत्ता स्कोर (0-100%)। केवल पैसिव लाइवनेस के
लिए उपलब्ध।
face_luminance:
type: number
nullable: true
description: >-
फ़ेस ल्यूमिनेन्स/ब्राइटनेस स्कोर (0-100%)। केवल पैसिव लाइवनेस
के लिए उपलब्ध है।
face_matches:
type: array
nullable: true
description: >-
वर्कफ़्लो ग्राफ़ में चेहरा मिलान चरणों द्वारा निर्मित **चेहरा मिलान
रिपोर्टों की ऐरे**। हमेशा एक JSON ऐरे — कभी भी एकल `face_match`
ऑब्जेक्ट नहीं। तब तक `null` जब तक कम से कम एक चेहरा मिलान चरण ने
डेटा उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें
`node_id`, सुविधा-स्तरीय `status`, समानता `score`, `source_image`,
`target_image`, और `warnings[]` शामिल हैं।
items:
type: object
description: एक चेहरा मिलान रिपोर्ट — पूर्ण रिपोर्ट।
properties:
node_id:
type: string
description: >-
इस रिपोर्ट को तैयार करने वाले चेहरा मिलान चरण का वर्कफ़्लो
ग्राफ़ नोड id।
status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
description: >-
इस चेहरा मिलान चरण की सुविधा-स्तरीय स्थिति। शीर्ष-स्तरीय सत्र
`status` से स्वतंत्र — एक सत्र अपने समग्र निर्णय तक पहुँच सकता
है जबकि एक अलग सुविधा `In Review` रह सकती है।
score:
type: number
description: चेहरा मिलान का विश्वास स्कोर
source_image_session_id:
type: string
format: uuid
nullable: true
description: >-
सत्र id जिसके तहत स्रोत (संदर्भ) पोर्ट्रेट संग्रहीत है।
बायोमेट्रिक प्रमाणीकरण फ़्लो में यह सत्र का अपना id होता है
(सबमिट किया गया पोर्ट्रेट नए सत्र के तहत संग्रहीत होता है)। जब
स्रोत छवि उसी सत्र का दस्तावेज़ पोर्ट्रेट हो तो `null`।
source_image:
type: string
format: uri
description: तुलना के लिए उपयोग की गई स्रोत छवि का URL
target_image:
type: string
format: uri
description: तुलना के लिए उपयोग की गई लक्षित छवि का URL
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: >-
वह सुविधा जिसने यह चेतावनी उत्पन्न की। यह मान उस सुविधा
ब्लॉक की पहचान करता है जिससे चेतावनी संबंधित है।
प्रत्येक मॉड्यूल का चेतावनी ऐरे आमतौर पर अपने मॉड्यूल से
मेल खाने वाले मान का उपयोग करता है (उदाहरण के लिए,
`phone_verifications[].warnings` के अंदर `PHONE`), लेकिन
ऊपर दिया गया enum निर्णय payload पर सभी सुविधा
चेतावनियों में आधिकारिक है।
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: वर्कफ़्लो ग्राफ़ नोड ID जिसने यह चेतावनी उत्पन्न की
description: चेहरा मिलान सत्यापन चेतावनियाँ
face_coverage:
type: object
nullable: true
description: >-
क्या कैप्चर की गई छवि में आँखें, मुँह और चेहरा ढके हुए हैं।
केवल `GET /v3/session/{sessionId}/decision/` द्वारा लौटाया
जाता है; यह webhook payload का हिस्सा नहीं है। `null` जब कोई
कवरेज रीडिंग मौजूद नहीं होती है।
properties:
eyes:
type: object
properties:
covered:
type: boolean
nullable: true
calibrated:
type: boolean
nullable: true
description: >-
`false` का अर्थ है कि रीडिंग केवल शैडो साक्ष्य है और
कोई चेतावनी इस पर कार्रवाई नहीं करती है।
visibility_score:
type: number
nullable: true
mouth:
type: object
properties:
covered:
type: boolean
nullable: true
calibrated:
type: boolean
nullable: true
description: >-
`false` का अर्थ है कि रीडिंग केवल शैडो साक्ष्य है और
कोई चेतावनी इस पर कार्रवाई नहीं करती है।
visibility_score:
type: number
nullable: true
face:
type: object
properties:
covered:
type: boolean
nullable: true
calibrated:
type: boolean
nullable: true
description: >-
`false` का अर्थ है कि रीडिंग केवल शैडो साक्ष्य है और
कोई चेतावनी इस पर कार्रवाई नहीं करती है।
visibility_score:
type: number
nullable: true
phone_verifications:
type: array
nullable: true
description: >-
**फ़ोन सत्यापन रिपोर्टों की ऐरे** — हमेशा एक JSON ऐरे, कभी भी एकल
`phone` ऑब्जेक्ट नहीं। तब तक `null` जब तक कम से कम एक फ़ोन चरण ने
डेटा उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें
`node_id`, सुविधा-स्तरीय `status`, फ़ोन नंबर और देश का मेटाडेटा,
`lifecycle[]`, `matches[]`, और `warnings[]` शामिल हैं।
items:
type: object
properties:
node_id:
type: string
description: वर्कफ़्लो ग्राफ़ में इस फ़ोन चरण के लिए विशिष्ट पहचानकर्ता।
status:
type: string
description: >-
इस फ़ोन सत्यापन चरण की सुविधा-स्तरीय स्थिति। शीर्ष-स्तरीय सत्र
`status` से स्वतंत्र — एक सत्र अपने समग्र निर्णय तक पहुँच सकता
है जबकि एक अलग सुविधा `In Review` रह सकती है।
enum:
- Not Finished
- Approved
- Declined
- In Review
- Expired
phone_number_prefix:
type: string
description: देश का कॉलिंग कोड प्रीफ़िक्स
phone_number:
type: string
description: देश के प्रीफ़िक्स के बिना फ़ोन नंबर
full_number:
type: string
description: देश के प्रीफ़िक्स के साथ पूरा फ़ोन नंबर
country_code:
type: string
description: दो अक्षरों वाला देश कोड (ISO 3166-1 alpha-2)
country_name:
type: string
description: देश का पूरा नाम
carrier:
type: object
properties:
name:
type: string
description: फ़ोन कैरियर का नाम
type:
type: string
description: फ़ोन लाइन का प्रकार (मोबाइल, लैंडलाइन, आदि)
is_disposable:
type: boolean
description: क्या फ़ोन नंबर किसी डिस्पोजेबल सेवा से है
is_virtual:
type: boolean
description: क्या फ़ोन नंबर वर्चुअल है
verification_method:
type: string
description: फ़ोन नंबर सत्यापित करने के लिए उपयोग की जाने वाली विधि
verification_attempts:
type: integer
description: किए गए सत्यापन प्रयासों की संख्या
verified_at:
type: string
format: date-time
description: फ़ोन सत्यापित होने का टाइमस्टैम्प
lifecycle:
type: array
description: फ़ोन सत्यापन जीवनचक्र में घटनाओं की कालानुक्रमिक सूची।
items:
type: object
properties:
type:
type: string
timestamp:
type: string
format: date-time
details:
type: object
nullable: true
description: >-
इवेंट-विशिष्ट payload। भेजने वाले इवेंट्स में `status`,
`reason`, `channel`, `actual_channel` शामिल होते हैं;
डिलीवरी इवेंट्स में `channel`, `status` शामिल होते हैं;
code-check इवेंट्स में `code_tried`, `status` शामिल होते
हैं; अंतिम स्थिति इवेंट्स में `reason` शामिल होता है —
या `null` जब रिपोर्ट करने के लिए कोई कारण नहीं होता है
(उदा. `PHONE_VERIFICATION_APPROVED`)।
properties:
status:
type: string
reason:
type: string
nullable: true
channel:
type: string
nullable: true
actual_channel:
type: string
nullable: true
code_tried:
type: string
fee:
type: number
warnings:
type: array
description: फ़ोन सत्यापन से संबंधित चेतावनियों की सूची
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: >-
वह सुविधा जिसने यह चेतावनी उत्पन्न की। यह मान उस सुविधा
ब्लॉक की पहचान करता है जिससे चेतावनी संबंधित है।
प्रत्येक मॉड्यूल का चेतावनी ऐरे आमतौर पर अपने मॉड्यूल से
मेल खाने वाले मान का उपयोग करता है (उदाहरण के लिए,
`phone_verifications[].warnings` के अंदर `PHONE`), लेकिन
ऊपर दिया गया enum निर्णय payload पर सभी सुविधा
चेतावनियों में आधिकारिक है।
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: वर्कफ़्लो ग्राफ़ नोड ID जिसने यह चेतावनी उत्पन्न की
matches:
type: array
description: >-
इस फ़ोन नंबर के लिए मिले मिलान। प्रत्येक मिलान में एक `source`
होता है: `session` (आपके एप्लिकेशन में किसी अन्य सत्यापन सत्र
का उसी नंबर से मिलान हुआ, जिसे
`session_id`/`session_number`/`vendor_data`/`verification_date`
के साथ लौटाया जाता है) या `list_entry` (नंबर संगठन-प्रबंधित
अनुमति/ब्लॉकलिस्ट पर है — `/management-api/lists/overview`
देखें)। क्रॉस-सत्र मिलान अलग-अलग `vendor_data` का उपयोग करते
हैं और अधिकतम 5 तक सीमित हैं।
items:
type: object
properties:
session_id:
type: string
format: uuid
nullable: true
session_number:
type: integer
nullable: true
vendor_data:
type: string
nullable: true
verification_date:
type: string
format: date-time
nullable: true
phone_number:
type: string
status:
type: string
nullable: true
is_blocklisted:
type: boolean
api_service:
type: string
nullable: true
source:
type: string
enum:
- session
- list_entry
description: >-
यह मिलान कहाँ से आया है। `session` का अर्थ है कि आपके
एप्लिकेशन में किसी अन्य सत्यापन सत्र का इस मान पर मिलान
हुआ। `list_entry` का अर्थ है कि यह मान संगठन द्वारा
प्रबंधित सूची (अनुमति सूची/ब्लॉकलिस्ट) से टकराया है — उन
सूचियों को प्रबंधित करने के तरीके के लिए
`/management-api/lists/overview` पर प्रबंधन API सूचियों
का अवलोकन देखें।
phone_intelligence:
allOf:
- $ref: '#/components/schemas/PhoneIntelligence'
description: >-
फ़ोन इंटेलिजेंस सिग्नल। केवल तभी मौजूद होते हैं जब इस नंबर के
लिए फ़ोन इंटेलिजेंस ऐड-ऑन चला हो।
phone_social:
allOf:
- $ref: '#/components/schemas/PhoneSocialFootprint'
description: >-
नंबर का सोशल फ़ुटप्रिंट। केवल तभी मौजूद होता है जब इस नंबर के
लिए सोशल फ़ुटप्रिंट ऐड-ऑन चला हो।
email_verifications:
type: array
nullable: true
description: >-
**ईमेल सत्यापन रिपोर्टों की ऐरे** — हमेशा एक JSON ऐरे, कभी भी एकल
`email` ऑब्जेक्ट नहीं। तब तक `null` जब तक कम से कम एक ईमेल चरण ने
डेटा उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें
`node_id`, सुविधा-स्तरीय `status`, ईमेल पता, ब्रीच डेटा,
`lifecycle[]`, `matches[]`, और `warnings[]` शामिल हैं।
items:
type: object
properties:
node_id:
type: string
description: वर्कफ़्लो ग्राफ़ में इस ईमेल चरण के लिए विशिष्ट पहचानकर्ता।
status:
type: string
description: >-
इस ईमेल सत्यापन चरण की सुविधा-स्तरीय स्थिति। शीर्ष-स्तरीय सत्र
`status` से स्वतंत्र — एक सत्र अपने समग्र निर्णय तक पहुँच सकता
है जबकि एक अलग सुविधा `In Review` रह सकती है।
enum:
- Not Finished
- Approved
- Declined
- In Review
- Expired
email:
type: string
description: सत्यापित किया जा रहा ईमेल पता
is_breached:
type: boolean
description: >-
इंगित करता है कि क्या ईमेल ज्ञात डेटा उल्लंघनों में पाया गया
था
breaches:
type: array
description: ज्ञात उल्लंघनों की सूची जिनमें यह ईमेल पाया गया था
items:
type: object
properties:
name:
type: string
description: उल्लंघन का नाम
domain:
type: string
description: उल्लंघन से प्रभावित डोमेन
logo_path:
type: string
description: उल्लंघित सेवा के लोगो का URL
breach_date:
type: string
format: date
description: तारीख जब उल्लंघन हुआ था
description:
type: string
description: उल्लंघन का विवरण
is_verified:
type: boolean
description: क्या उल्लंघन सत्यापित है
data_classes:
type: array
description: डेटा उल्लंघन में उजागर डेटा के प्रकार
items:
type: string
breach_emails_count:
type: integer
description: डेटा ब्रीच में प्रभावित ईमेल पतों की संख्या
is_disposable:
type: boolean
description: इंगित करता है कि क्या ईमेल किसी डिस्पोज़ेबल प्रदाता का है
is_undeliverable:
type: boolean
description: इंगित करता है कि क्या ईमेल पता डिलीवर न होने योग्य है
verification_attempts:
type: integer
description: इस ईमेल के लिए सत्यापन प्रयासों की संख्या
verified_at:
type: string
format: date-time
description: ईमेल सत्यापित होने का टाइमस्टैम्प
warnings:
type: array
description: ईमेल सत्यापन से संबंधित चेतावनियों की सूची
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: >-
वह सुविधा जिसने यह चेतावनी उत्पन्न की। यह मान उस सुविधा
ब्लॉक की पहचान करता है जिससे चेतावनी संबंधित है।
प्रत्येक मॉड्यूल का चेतावनी ऐरे आमतौर पर अपने मॉड्यूल से
मेल खाने वाले मान का उपयोग करता है (उदाहरण के लिए,
`phone_verifications[].warnings` के अंदर `PHONE`), लेकिन
ऊपर दिया गया enum निर्णय payload पर सभी सुविधा
चेतावनियों में आधिकारिक है।
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: वर्कफ़्लो ग्राफ़ नोड ID जिसने यह चेतावनी उत्पन्न की
lifecycle:
type: array
description: ईमेल सत्यापन जीवनचक्र में घटनाओं की कालानुक्रमिक सूची।
items:
type: object
properties:
type:
type: string
timestamp:
type: string
format: date-time
details:
type: object
nullable: true
description: >-
इवेंट-विशिष्ट payload। भेजने वाले इवेंट्स `status`,
`reason` ले जाते हैं; code-check इवेंट्स `code_tried`,
`status` ले जाते हैं; अंतिम स्थिति इवेंट्स `reason` ले
जाते हैं — या `null` जब रिपोर्ट करने के लिए कोई कारण
नहीं होता है (उदा. `EMAIL_VERIFICATION_APPROVED`)।
properties:
status:
type: string
reason:
type: string
nullable: true
code_tried:
type: string
fee:
type: number
matches:
type: array
description: >-
इस ईमेल पते के लिए मिले मिलान। प्रत्येक मिलान में एक `source`
होता है: `session` (आपके एप्लिकेशन में किसी अन्य सत्यापन सत्र
का उसी ईमेल से मिलान हुआ, जिसे
`session_id`/`session_number`/`vendor_data`/`verification_date`
के साथ लौटाया जाता है) या `list_entry` (ईमेल संगठन-प्रबंधित
अनुमति/ब्लॉकलिस्ट पर है — `/management-api/lists/overview`
देखें)। क्रॉस-सत्र मिलान अलग-अलग `vendor_data` का उपयोग करते
हैं और अधिकतम 5 तक सीमित हैं।
items:
type: object
properties:
session_id:
type: string
format: uuid
nullable: true
session_number:
type: integer
nullable: true
vendor_data:
type: string
nullable: true
verification_date:
type: string
format: date-time
nullable: true
email:
type: string
format: email
status:
type: string
nullable: true
is_blocklisted:
type: boolean
api_service:
type: string
nullable: true
source:
type: string
enum:
- session
- list_entry
description: >-
यह मिलान कहाँ से आया है। `session` का अर्थ है कि आपके
एप्लिकेशन में किसी अन्य सत्यापन सत्र का इस मान पर मिलान
हुआ। `list_entry` का अर्थ है कि यह मान संगठन द्वारा
प्रबंधित सूची (अनुमति सूची/ब्लॉकलिस्ट) से टकराया है — उन
सूचियों को प्रबंधित करने के तरीके के लिए
`/management-api/lists/overview` पर प्रबंधन API सूचियों
का अवलोकन देखें।
email_intelligence:
allOf:
- $ref: '#/components/schemas/EmailIntelligence'
description: >-
ईमेल इंटेलिजेंस संकेत। केवल तभी मौजूद होते हैं जब इस पते के
लिए ईमेल इंटेलिजेंस ऐड-ऑन चला हो।
email_social:
allOf:
- $ref: '#/components/schemas/EmailSocialFootprint'
description: >-
पते का सोशल फ़ुटप्रिंट। केवल तभी मौजूद होता है जब इस पते के
लिए सोशल फ़ुटप्रिंट ऐड-ऑन चला हो।
poa_verifications:
type: array
nullable: true
description: >-
**पते का प्रमाण (POA) रिपोर्टों की ऐरे** — हमेशा एक JSON ऐरे, कभी भी
एकल `poa` ऑब्जेक्ट नहीं। तब तक `null` जब तक कम से कम एक POA चरण ने
डेटा उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें
`node_id`, सुविधा-स्तरीय `status`, दस्तावेज़ फ़ाइल URL, जारीकर्ता,
तिथियाँ, पार्स किया गया पता, और `warnings[]` शामिल हैं।
items:
type: object
properties:
node_id:
type: string
description: वर्कफ़्लो ग्राफ़ में इस POA चरण के लिए विशिष्ट पहचानकर्ता।
status:
type: string
description: >-
इस पते के प्रमाण चरण की सुविधा-स्तरीय स्थिति। शीर्ष-स्तरीय
सत्र `status` से स्वतंत्र — एक सत्र अपने समग्र निर्णय तक पहुँच
सकता है जबकि एक अलग सुविधा `In Review` रह सकती है।
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
document_file:
type: string
format: uri
description: पते का प्रमाण दस्तावेज़ का URL
issuing_state:
type: string
description: जारीकर्ता राज्य का दो अक्षरों वाला देश कोड
document_type:
type: string
description: पते के प्रमाण दस्तावेज़ का प्रकार
document_subtype:
type: string
nullable: true
description: >-
इसके `document_type` के भीतर POA दस्तावेज़ का अधिक विशिष्ट
वर्गीकरण, जब कोई पहचाना गया हो। अन्यथा `null`।
document_language:
type: string
description: दस्तावेज़ का भाषा कोड
document_metadata:
type: object
properties:
file_size:
type: integer
description: दस्तावेज़ का आकार
content_type:
type: string
description: दस्तावेज़ का कंटेंट प्रकार
creation_date:
type: string
format: date
description: तारीख जब दस्तावेज़ बनाया गया था
modified_date:
type: string
format: date
description: तारीख जब दस्तावेज़ संशोधित किया गया था
overlay_manipulation:
type: object
nullable: true
description: >-
संदिग्ध ओवरले-टेक्स्ट हेरफेर के लिए PDF फोरेंसिक विश्लेषण।
जब कोई ओवरले हेरफेर का सबूत नहीं मिला हो या दस्तावेज़ PDF
नहीं था, तो Null।
properties:
detected:
type: boolean
description: क्या ओवरले-टेक्स्ट हेरफेर के साक्ष्य का पता चला था।
analyzed:
type: boolean
description: क्या PDF का विश्लेषण किया जा सका।
analysis_incomplete:
type: boolean
description: >-
जब फ़ाइल को पूरी तरह जाँचा नहीं जा सका, तब यह मौजूद
होता है और केवल तभी सत्य होता है। जितना हिस्सा जाँचा
जा सका, उसके निष्कर्ष जहाँ संभव हो वहीं रखे जाते हैं,
और दस्तावेज़ अप्रमाणित टेक्स्ट प्रतिस्थापन चेतावनी
दिखाता है।
signals:
type: array
items:
type: string
description: >-
फ़ॉरेंसिक सिग्नल जो ट्रिगर हुए, जैसे
duplicate_font_subset या glyph_fragmentation।
manipulated_regions:
type: array
description: >-
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
creator:
type: string
nullable: true
description: दस्तावेज़ मेटाडेटा में रिकॉर्ड किया गया क्रिएटर एप्लिकेशन।
producer:
type: string
nullable: true
description: PDF मेटाडेटा में रिकॉर्ड किया गया निर्माता सॉफ़्टवेयर।
software:
type: string
nullable: true
description: >-
फ़ाइल मेटाडेटा में रिकॉर्ड किया गया संपादन/प्रोसेसिंग
सॉफ़्टवेयर।
encryption:
type: string
nullable: true
description: दस्तावेज़ की एन्क्रिप्शन स्कीम, जब एन्क्रिप्टेड हो।
is_signed:
type: boolean
nullable: true
description: क्या PDF में डिजिटल हस्ताक्षर मौजूद है।
is_tampered:
type: boolean
nullable: true
description: >-
क्या हस्ताक्षर सत्यापन इंगित करता है कि हस्ताक्षर करने के
बाद फ़ाइल को संशोधित किया गया था।
signature_info:
type: object
nullable: true
description: डिजिटल हस्ताक्षर का विवरण, यदि मौजूद हो।
exif_original_date:
type: string
nullable: true
description: छवि अपलोड के लिए EXIF मूल कैप्चर तिथि।
exif_digitized_date:
type: string
nullable: true
description: छवि अपलोड के लिए EXIF डिजिटलीकरण तिथि।
processed_by_known_editor:
type: boolean
nullable: true
description: >-
क्या फ़ाइल मेटाडेटा किसी ज्ञात दस्तावेज़ संपादक द्वारा
प्रोसेसिंग को इंगित करता है।
has_different_creation_mod_date:
type: boolean
nullable: true
description: >-
क्या निर्माण और संशोधन तिथियाँ भिन्न हैं — एक सामान्य
हेरफेर सिग्नल।
description: >-
अपलोड किए गए POA दस्तावेज़ से निकाला गया फ़ाइल-फोरेंसिक
मेटाडेटा। इसमें हमेशा नीचे दी गई कुंजियाँ होती हैं (लागू न
होने पर मान `null` होते हैं, जैसे PDF के लिए EXIF तिथियाँ)।
कोई मेटाडेटा न निकाले जाने पर `null`।
nullable: true
issuer:
type: string
description: दस्तावेज़ जारीकर्ता का नाम
issue_date:
type: string
format: date
description: तारीख जब दस्तावेज़ जारी किया गया था
expiration_date:
type: string
format: date
nullable: true
description: दस्तावेज़ की समाप्ति तिथि, यदि उपलब्ध हो
poa_address:
type: string
description: पते का प्रमाण दस्तावेज़ से प्राप्त रॉ पता
poa_formatted_address:
type: string
description: पते का प्रमाण दस्तावेज़ से फ़ॉर्मेट किया गया पता
poa_parsed_address:
type: object
properties:
address_type:
type: string
description: पते का प्रकार (स्ट्रीट, एवेन्यू, आदि)
street_1:
type: string
description: प्राथमिक सड़क का पता
street_2:
type: string
nullable: true
description: द्वितीयक सड़क का पता
city:
type: string
description: शहर का नाम
region:
type: string
description: क्षेत्र या राज्य का नाम
country:
type: string
description: दो अक्षरों वाला देश कोड
postal_code:
type: string
description: डाक कोड
document_location:
type: object
properties:
latitude:
type: number
description: अक्षांश निर्देशांक
longitude:
type: number
description: देशांतर निर्देशांक
name_on_document:
type: string
nullable: true
description: >-
POA दस्तावेज़ से निकाला गया खाताधारक / प्राप्तकर्ता का नाम,
जिसका उपयोग नाम मिलान के लिए किया जाता है। कोई नाम न निकाले
जाने पर `null`।
name_match_score_expected_details:
type: number
nullable: true
description: >-
`name_on_document` और सत्र निर्माण के समय प्रदान किए गए
अपेक्षित नाम के बीच समानता स्कोर (0-100)। किसी भी पक्ष के
अनुपस्थित होने पर `null`।
name_match_score_id_verification:
type: number
nullable: true
description: >-
`name_on_document` और पहचान सत्यापन चरण द्वारा निकाले गए नाम
के बीच समानता स्कोर (0-100)। किसी भी पक्ष के अनुपस्थित होने पर
`null`।
expected_details_address:
type: string
nullable: true
description: सत्यापन के लिए अपेक्षित मूल पता
expected_details_formatted_address:
type: string
nullable: true
description: सत्यापन के लिए अपेक्षित स्वरूपित पता
expected_details_parsed_address:
type: object
description: सत्यापन के लिए अपेक्षित पार्स किए गए पते का विवरण
extra_fields:
type: object
description: दस्तावेज़ से निकाले गए अतिरिक्त बैंकिंग और संपर्क विवरण।
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
additional_names:
type: array
items:
type: string
extra_files:
type: array
items:
type: string
format: uri
description: पते के प्रमाण की अतिरिक्त फ़ाइलें
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: >-
वह सुविधा जिसने यह चेतावनी उत्पन्न की। यह मान उस सुविधा
ब्लॉक की पहचान करता है जिससे चेतावनी संबंधित है।
प्रत्येक मॉड्यूल का चेतावनी ऐरे आमतौर पर अपने मॉड्यूल से
मेल खाने वाले मान का उपयोग करता है (उदाहरण के लिए,
`phone_verifications[].warnings` के अंदर `PHONE`), लेकिन
ऊपर दिया गया enum निर्णय payload पर सभी सुविधा
चेतावनियों में आधिकारिक है।
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: वर्कफ़्लो ग्राफ़ नोड ID जिसने यह चेतावनी उत्पन्न की
detected_codes:
type: array
description: >-
दस्तावेज़ के प्रत्येक संसाधित पृष्ठ पर पहचाने गए QR कोड और
बारकोड। कोई न मिलने पर खाली। पहचाना गया लेकिन डिकोड न किया जा
सकने वाला QR कोड `parsed_payload: null` रखता है।
items:
$ref: '#/components/schemas/DocumentAIDetectedCode'
address_validation:
allOf:
- $ref: '#/components/schemas/AddressValidationResult'
nullable: true
description: >-
इस पते के प्रमाण पर पते का सत्यापन: क्या यह मौजूद है और इसका
सामान्यीकृत रूप, जैसा कि दस्तावेज़ ने इसे पढ़ा है (बाद में
`poa_address` का सुधार इसे फिर से नहीं चलाता है)। तब उपस्थित
होता है जब इस पते का प्रमाण चरण में पता सत्यापन ऐड-ऑन सक्षम हो
और अपलोड दस्तावेज़ जांच में सफल रहा हो; अन्यथा `null`।
document_ai_documents:
type: array
nullable: true
description: >-
**वर्कफ़्लो नोड द्वारा समूहीकृत Document AI रिपोर्टें** — हमेशा एक
JSON ऐरे, कभी भी एकल ऑब्जेक्ट नहीं। तब तक `null` जब तक कि कम से कम
एक Document AI चरण ने डेटा उत्पन्न न किया हो। केवल तभी मौजूद होता है
जब `session_kind = user` हो। प्रत्येक आइटम एक नोड समूह होता है
जिसमें एक समग्र `status`, `node_id`, प्रति-दस्तावेज़ परिणामों
(कॉन्फ़िगर की गई फ़ील्ड कुंजी द्वारा अनुक्रमित निष्कर्षण डेटा) का एक
`items[]` ऐरे, और `warnings` शामिल होते हैं।
items:
type: object
description: वर्कफ़्लो नोड द्वारा समूहीकृत Document AI परिणाम।
properties:
status:
type: string
description: >-
इस नोड के लिए समग्र Document AI स्थिति, इसके `items[]` से
एकत्रित की गई।
enum:
- Approved
- Declined
- In Review
- Not Finished
node_id:
type: string
nullable: true
description: >-
वर्कफ़्लो ग्राफ़ में इस Document AI चरण के लिए विशिष्ट
पहचानकर्ता।
items:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
node_id:
type: string
nullable: true
description: वर्कफ़्लो ग्राफ़ नोड जिसने यह दस्तावेज़ तैयार किया।
document_key:
type: string
description: >-
कॉन्फ़िगर किए गए Document AI दस्तावेज़ की कुंजी जिससे यह
फ़ाइल मेल खाती है।
original_filename:
type: string
nullable: true
description: फ़ाइल नाम जैसा कि उपयोगकर्ता द्वारा अपलोड किया गया था।
file_size:
type: integer
nullable: true
description: बाइट्स में फ़ाइल का आकार।
file_url:
type: string
format: uri
nullable: true
description: अपलोड की गई फ़ाइल का अल्पकालिक प्रीसाइन्ड लिंक।
status:
type: string
enum:
- Approved
- Declined
- In Review
- Not Finished
description: प्रति-दस्तावेज़ Document AI स्थिति।
extracted_data:
type: object
additionalProperties: true
nullable: true
description: >-
Document AI द्वारा निकाले गए मान, कॉन्फ़िगर किए गए
फ़ील्ड `key` के अनुसार कुंजीबद्ध। प्रत्येक मान एक
स्ट्रिंग, संख्या, या `null` है।
detected_codes:
type: array
description: >-
प्रत्येक संसाधित पृष्ठ पर पहचाने गए QR कोड और बारकोड।
कोई न मिलने पर खाली। पहचाना गया लेकिन डिकोड न किया जा
सकने वाला QR कोड `parsed_payload: null` रखता है।
items:
$ref: '#/components/schemas/DocumentAIDetectedCode'
fields:
type: array
description: इस दस्तावेज़ के लिए कॉन्फ़िगर किए गए निष्कर्षण फ़ील्ड।
items:
type: object
properties:
key:
type: string
description: >-
`extracted_data` में कुंजी के रूप में उपयोग की
जाने वाली स्थिर फ़ील्ड कुंजी।
name:
type: string
description: मानव-पठनीय फ़ील्ड नाम।
instruction:
type: string
description: मॉडल को दिखाया जाने वाला निष्कर्षण निर्देश।
type:
type: string
enum:
- text
- number
- date
description: निकाले गए फ़ील्ड का अपेक्षित मान प्रकार।
required:
type: boolean
description: Whether this field is required.
document_metadata:
type: object
nullable: true
description: >-
अपलोड किए गए दस्तावेज़ से निकाला गया फ़ाइल-फोरेंसिक
मेटाडेटा (उदा. `is_tampered`)। कुछ भी न निकाले जाने पर
`null`।
cross_check_result:
type: object
nullable: true
description: >-
अन्य सत्र डेटा के विरुद्ध निकाले गए दस्तावेज़ फ़ील्ड का
क्रॉस-रेफ़रंस। `null` जब कोई क्रॉस-चेक नहीं किया गया था।
created_at:
type: string
format: date-time
warnings:
type: array
nullable: true
items:
type: object
description: इस Document AI नोड के लिए उठाए गए चेतावनी लॉग।
questionnaire_responses:
type: array
nullable: true
description: >-
**प्रश्नावली प्रतिक्रिया रिपोर्टों की ऐरे** — हमेशा एक JSON ऐरे, कभी
भी एकल `questionnaire` ऑब्जेक्ट नहीं। तब तक `null` जब तक कम से कम एक
प्रश्नावली चरण ने डेटा उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण
रिपोर्ट है, जिसमें `node_id`, प्रश्नावली मेटाडेटा, फ़ॉर्म तत्वों
वाले अनुभाग, और उपयोगकर्ता के उत्तर शामिल हैं।
items:
type: object
properties:
node_id:
type: string
description: >-
वर्कफ़्लो ग्राफ़ में इस प्रश्नावली चरण के लिए विशिष्ट
पहचानकर्ता।
questionnaire_id:
type: string
description: प्रश्नावली के लिए विशिष्ट पहचानकर्ता
title:
type: string
description: प्रश्नावली का शीर्षक
description:
type: string
description: प्रश्नावली का विवरण
languages:
type: array
items:
type: string
description: समर्थित भाषाएँ
default_language:
type: string
description: डिफ़ॉल्ट भाषा
is_active:
type: boolean
description: क्या प्रश्नावली सक्रिय है
is_simple_questionnaire:
type: boolean
description: >-
क्या प्रश्नावली एक सरल लीनियर फ़ॉर्म है (कोई ब्रांचिंग ग्राफ़
नहीं)।
questionnaire_group_id:
type: string
format: uuid
nullable: true
description: संस्करणों में प्रश्नावली समूह का स्थिर पहचानकर्ता।
version:
type: integer
nullable: true
description: उत्तर दी गई प्रश्नावली की संस्करण संख्या।
published_at:
type: string
format: date-time
nullable: true
description: इस प्रश्नावली संस्करण के प्रकाशित होने का टाइमस्टैम्प।
sections:
type: array
items:
type: object
properties:
title:
type: string
nullable: true
description: अनुभाग शीर्षक
description:
type: string
nullable: true
description: अनुभाग विवरण
items:
type: array
items:
type: object
properties:
uuid:
type: string
description: आइटम के लिए विशिष्ट पहचानकर्ता
value:
type: string
nullable: true
description: >-
प्रश्नावली ग्राफ़ के भीतर इस फ़ॉर्म तत्व का स्थिर
नोड पहचानकर्ता।
element_type:
type: string
description: प्रश्नावली तत्व का प्रकार
is_required:
type: boolean
description: क्या आइटम आवश्यक है
title:
type: string
description: आइटम का शीर्षक
description:
type: string
nullable: true
description: आइटम का विवरण
placeholder:
type: string
nullable: true
description: प्लेसहोल्डर टेक्स्ट
choices:
type: array
nullable: true
items:
type: object
properties:
label:
type: string
value:
type: string
requires_text_input:
type: boolean
description: >-
क्या इस विकल्प के लिए अतिरिक्त टेक्स्ट इनपुट
की आवश्यकता है
nullable: true
required:
- label
- value
description: ड्रॉपडाउन या एकल विकल्प तत्वों के लिए विकल्प
max_files:
type: integer
description: अनुमत फ़ाइलों की अधिकतम संख्या
nullable: true
answer:
type: object
description: आइटम के लिए प्रदान किया गया उत्तर
properties:
value:
type: string
nullable: true
text:
type: string
nullable: true
files:
type: array
items:
type: string
nullable: true
required_if:
type: object
nullable: true
description: >-
सशर्त-आवश्यकता नियम, जब तत्व केवल कुछ उत्तरों के
लिए आवश्यक होता है।
repeatable_config:
type: object
nullable: true
description: >-
लागू होने पर दोहराए जाने योग्य तत्व समूहों के लिए
कॉन्फ़िगरेशन।
required:
- uuid
- value
- element_type
- is_required
- title
status:
type: string
description: प्रश्नावली की स्थिति
bank_verifications:
type: array
nullable: true
description: >-
उपयोगकर्ता और व्यवसाय सत्यापन के लिए, प्रति बैंक सत्यापन चरण एक आइटम
के साथ बैंक सत्यापन परिणाम। जब तक कोई चरण परिणाम नहीं देता, तब तक
`null`। प्रत्येक आइटम की `method` बताती है कि खाते का सत्यापन कैसे
किया गया था: `open_banking` (बैंक साइन-इन) या `account_lookup` (खाता
जाँच), या `statement` अथवा `microdeposits` फ़ॉलबैक, और `none` जब
किसी प्रयास का मूल्यांकन होने से पहले व्यक्ति बैंक के बिना आगे बढ़
गया (`continued_without_bank`)। देखें [बैंक सत्यापन
विधियाँ](/hi/core-technology/bank-verification/verification-methods)।
items:
$ref: '#/components/schemas/BankVerificationResult'
signatures:
type: array
description: >-
उपयोगकर्ता और व्यवसाय सत्यापन के लिए प्रति हस्ताक्षरकर्ता और
हस्ताक्षर चरण एक आइटम के साथ ई-हस्ताक्षर परिणाम। केवल तभी मौजूद होता
है जब वर्कफ़्लो में ई-हस्ताक्षर चरण हो; हस्ताक्षरकर्ता के उस चरण तक
पहुँचने तक एक खाली ऐरे। [ई-हस्ताक्षर
रिपोर्ट](/hi/core-technology/electronic-signature/report-electronic-signature)
देखें।
items:
$ref: '#/components/schemas/SignatureResult'
aml_screenings:
type: array
nullable: true
description: >-
**AML स्क्रीनिंग रिपोर्टों की ऐरे** — हमेशा एक JSON ऐरे, कभी भी एकल
`aml` ऑब्जेक्ट नहीं। तब तक `null` जब तक कम से कम एक AML चरण ने डेटा
तैयार न किया हो। प्रत्येक आइटम पूरी रिपोर्ट है, जिसमें `node_id`,
फ़ीचर-स्तरीय `status`, `total_hits`, `entity_type`, `hits[]`,
`score`, `screened_data`, `is_ongoing_monitoring_enabled`, और
`warnings[]` शामिल हैं।
items:
$ref: '#/components/schemas/AMLScreening'
ip_analyses:
type: array
nullable: true
description: >-
**डिवाइस और IP विश्लेषण रिपोर्टों की ऐरे** — हमेशा एक JSON ऐरे, कभी
भी एकल `ip_analysis` ऑब्जेक्ट नहीं। तब तक `null` जब तक कम से कम एक
IP-विश्लेषण चरण ने डेटा उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण
रिपोर्ट है, जिसमें `node_id`, सुविधा-स्तरीय `status`, IP और
जियोलोकेशन डेटा, डिवाइस फ़िंगरप्रिंट, और `warnings[]` शामिल हैं।
डुप्लिकेट `(node_id, ip_address, device_fingerprint)` वाली
प्रविष्टियों को सर्वर-साइड पर डिडुप्लिकेट किया जाता है।
items:
type: object
properties:
node_id:
type: string
description: >-
वर्कफ़्लो ग्राफ़ में इस डिवाइस और IP विश्लेषण चरण के लिए
विशिष्ट पहचानकर्ता।
status:
type: string
description: >-
इस डिवाइस और IP विश्लेषण प्रविष्टि की सुविधा-स्तरीय स्थिति।
शीर्ष-स्तरीय सत्र `status` से स्वतंत्र — एक सत्र अपने समग्र
निर्णय तक पहुँच सकता है जबकि एक अलग सुविधा `In Review` रह सकती
है।
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
device_brand:
type: string
description: उपयोग किए गए डिवाइस का ब्रांड
device_model:
type: string
description: उपयोग किए गए डिवाइस का मॉडल
browser_family:
type: string
description: उपयोग की गई ब्राउज़र फ़ैमिली
os_family:
type: string
description: ऑपरेटिंग सिस्टम फ़ैमिली
platform:
type: string
description: प्लेटफ़ॉर्म प्रकार (mobile, desktop, आदि)
device_fingerprint:
type: string
nullable: true
description: विशिष्ट डिवाइस फ़िंगरप्रिंट पहचानकर्ता
ip_country:
type: string
description: IP से पता लगाया गया देश
ip_country_code:
type: string
description: IP से दो अक्षरों वाला देश कोड
ip_state:
type: string
description: IP से पहचाना गया राज्य/क्षेत्र
ip_city:
type: string
description: IP से पहचाना गया शहर
latitude:
type: number
description: IP स्थान का अक्षांश निर्देशांक
longitude:
type: number
description: IP स्थान का देशांतर निर्देशांक
ip_address:
type: string
description: IP पता
isp:
type: string
nullable: true
description: इंटरनेट सेवा प्रदाता
organization:
type: string
nullable: true
description: IP से जुड़ा संगठन
is_vpn_or_tor:
type: boolean
description: क्या IP VPN या Tor नेटवर्क से है
is_data_center:
type: boolean
description: क्या IP डेटा सेंटर से है
time_zone:
type: string
description: IP से पहचाना गया टाइम ज़ोन
time_zone_offset:
type: string
description: टाइम ज़ोन ऑफ़सेट
ip:
type: object
description: >-
इस प्रविष्टि का IP जियोलोकेशन और पहचान दस्तावेज़ के पते तथा
POA दस्तावेज़ के पते की ग्रेट-सर्कल दूरियाँ (km)। जब किसी भी
तरफ़ का कोई समाधान योग्य स्थान नहीं होता है तो दूरियाँ `null`
होती हैं।
properties:
location:
type: object
nullable: true
properties:
latitude:
type: number
example: 41.2706327
longitude:
type: number
example: 1.9770097
description: निर्देशांक, या अनुपलब्ध होने पर `null`।
distance_from_id_document:
type: number
nullable: true
example: 23.4
distance_from_poa_document:
type: number
nullable: true
example: 12.3
id_document:
type: object
description: >-
पहचान दस्तावेज़ के पते से निकाला गया स्थान और IP जियोलोकेशन और
POA दस्तावेज़ पते की दूरियां (किमी)। जब किसी दस्तावेज़ पते को
जियोकोड नहीं किया जा सका, तो `location` `null` होता है।
properties:
location:
type: object
nullable: true
properties:
latitude:
type: number
example: 41.2706327
longitude:
type: number
example: 1.9770097
description: निर्देशांक, या अनुपलब्ध होने पर `null`।
distance_from_ip:
type: number
nullable: true
example: 23.4
distance_from_poa_document:
type: number
nullable: true
example: 18.7
poa_document:
type: object
description: >-
पते का प्रमाण दस्तावेज़ से निकाला गया स्थान और IP जियोलोकेशन
तथा पहचान दस्तावेज़ पते की दूरियां (किमी)। `location` तब
`null` होता है जब सत्र में कोई POA चरण नहीं होता है या पते को
जियोकोड नहीं किया जा सका।
properties:
location:
type: object
nullable: true
properties:
latitude:
type: number
example: 41.2706327
longitude:
type: number
example: 1.9770097
description: निर्देशांक, या अनुपलब्ध होने पर `null`।
distance_from_ip:
type: number
nullable: true
example: 12.3
distance_from_id_document:
type: number
nullable: true
example: 18.7
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: >-
वह सुविधा जिसने यह चेतावनी उत्पन्न की। यह मान उस सुविधा
ब्लॉक की पहचान करता है जिससे चेतावनी संबंधित है।
प्रत्येक मॉड्यूल का चेतावनी ऐरे आमतौर पर अपने मॉड्यूल से
मेल खाने वाले मान का उपयोग करता है (उदाहरण के लिए,
`phone_verifications[].warnings` के अंदर `PHONE`), लेकिन
ऊपर दिया गया enum निर्णय payload पर सभी सुविधा
चेतावनियों में आधिकारिक है।
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: वर्कफ़्लो ग्राफ़ नोड ID जिसने यह चेतावनी उत्पन्न की
matches:
type: array
description: >-
इस प्रविष्टि के IP पते या डिवाइस पहचान के लिए पाए गए
क्रॉस-सत्र मिलान। प्रत्येक मिलान आपके एप्लिकेशन में एक अन्य
सत्यापन सत्र है (`source` हमेशा `session` होता है) जो समान मान
साझा करता है, जो हमेशा वर्तमान सत्र से भिन्न वेंडर उपयोगकर्ता
/ `vendor_data` से संबंधित होता है, प्रति कलेक्टर 5 तक सीमित
(`device_fingerprint` दो स्वतंत्र रूप से सीमित कलेक्टरों का
योग करता है, इसलिए 10 प्रविष्टियाँ तक संभव हैं)। प्रत्येक आइटम
में `match_source`, `confidence`, `match_mode`, `device_info`
और `location_info` शामिल होते हैं; `recovery_similarity`,
`tls_ja4_corroborated` और `recovery_gate_reason` कुंजियाँ केवल
तभी मौजूद होती हैं जब `match_source`, `recovered_high` हो।
items:
type: object
additionalProperties: false
properties:
session_id:
type: string
format: uuid
description: मिलान वाले सत्र का सत्र ID।
session_number:
type: integer
description: मिलान वाले सत्र की अनुक्रमिक संख्या।
vendor_data:
type: string
nullable: true
description: >-
मिलान वाले सत्र का `vendor_data` — हमेशा वर्तमान सत्र के
वेंडर उपयोगकर्ता से भिन्न।
verification_date:
type: string
format: date-time
nullable: true
description: >-
मेल खाने वाले सत्र की निर्माण तिथि
(`YYYY-MM-DDTHH:MM:SSZ`)।
match_type:
type: string
enum:
- ip_address
- device_fingerprint
description: क्या मिलान IP पते पर था या डिवाइस फ़िंगरप्रिंट पर
match_source:
type: string
enum:
- ip_address
- persistent_id
- legacy_fp
- recovered_high
description: >-
यह मिलान कैसे प्राप्त हुआ: `ip_address` (साझा IP पता —
नेटवर्क को-लोकेशन, डिवाइस-पहचान दावा नहीं),
`persistent_id` (सटीक संग्रहीत पर्सिस्टेंट डिवाइस
पहचानकर्ता), `legacy_fp` (लीगेसी `didit-fp-*`
डिवाइस-फ़िंगरप्रिंट हैश), या `recovered_high`
(उच्च-विश्वास फ़ज़ी फ़िंगरप्रिंट-पुनर्प्राप्ति हिट)।
कम-विश्वास वाले पुनर्प्राप्ति उम्मीदवार केवल जोखिम
चेतावनियों के रूप में सामने आते हैं, इस सरणी में कभी
नहीं।
matched_value:
type: string
nullable: true
description: >-
वह मान जो मेल खाता है: साझा IP पता, स्थायी डिवाइस
पहचानकर्ता या लेगेसी फ़िंगरप्रिंट हैश, या —
`recovered_high` के लिए — पुनर्प्राप्त डिवाइस का UUID।
status:
type: string
description: मिलान वाले सत्र की लाइफ़साइकिल स्थिति।
is_blocklisted:
type: boolean
description: >-
क्या मिलान किया गया मान किसी ब्लॉकलिस्ट में है।
डिवाइस/IP मिलानों के लिए वर्तमान में हमेशा `false`।
api_service:
type: string
nullable: true
description: >-
मिलान वाले सत्र की स्टैंडअलोन API सेवा; वर्कफ़्लो सत्रों
के लिए `null`।
source:
type: string
enum:
- session
description: >-
डिवाइस/IP मिलानों के लिए हमेशा `session` — प्रत्येक
मिलान आपके एप्लिकेशन में एक अन्य सत्यापन सत्र है।
device_info:
type: object
description: मिलान सत्र पर देखे गए डिवाइस विवरण।
properties:
device_brand:
type: string
nullable: true
device_model:
type: string
nullable: true
browser_family:
type: string
nullable: true
os_family:
type: string
nullable: true
platform:
type: string
nullable: true
device_fingerprint:
type: string
nullable: true
location_info:
type: object
description: मिलान वाले सत्र पर देखे गए नेटवर्क और जियोलोकेशन विवरण।
properties:
ip_address:
type: string
nullable: true
ip_country:
type: string
nullable: true
ip_country_code:
type: string
nullable: true
ip_state:
type: string
nullable: true
ip_city:
type: string
nullable: true
is_vpn_or_tor:
type: boolean
is_data_center:
type: boolean
confidence:
type: number
minimum: 0
maximum: 1
description: >-
सर्वर-साइड पहचान का विश्वास स्कोर, जिसकी गणना `1 -
P(false positive)` के रूप में की जाती है: नियतात्मक
मिलानों (`persistent_id`, या हार्डवेयर-आधारित
`recovered_high`) के लिए `1.0`, `legacy_fp` के लिए
`0.5`, `ip_address` (केवल सह-स्थान) के लिए `0.0`, और
संभाव्य पुनर्प्राप्त मिलानों के लिए `1.0` से कम एक
संपुष्टि-समायोजित मान (जब TLS JA4 फ़िंगरप्रिंट और IP देश
स्वतंत्र रूप से सहमत हों तो अधिक)।
match_mode:
type: string
enum:
- deterministic
- probabilistic
- co_occurrence
description: >-
मिलान का साक्ष्य वर्ग: `deterministic` (सटीक संग्रहीत या
हार्डवेयर-आधारित पहचानकर्ता जो भौतिक डिवाइसों के बीच कभी
टकरा नहीं सकता), `probabilistic` (फ़ज़ी फ़िंगरप्रिंट
साक्ष्य), या `co_occurrence` (केवल साझा नेटवर्क, कोई
डिवाइस-पहचान का दावा नहीं)।
recovery_similarity:
type: number
description: >-
फ़िंगरप्रिंट-पुनर्प्राप्ति मिलान की कोसाइन समानता, 4
दशमलव स्थानों तक राउंड की गई। केवल तभी मौजूद होती है जब
`match_source` `recovered_high` हो।
tls_ja4_corroborated:
type: boolean
description: >-
क्या दोनों अवलोकनों के TLS JA4 फ़िंगरप्रिंट मेल खाते हैं
— एक सर्वर-अवलोकित सिग्नल जिसे ब्राउज़र स्पूफ़ नहीं कर
सकता। केवल तभी मौजूद होता है जब `match_source`
`recovered_high` हो।
recovery_gate_reason:
type: string
description: >-
रिकवरी मिलान ने फ़ॉल्स पॉज़िटिव हार्ड गेट को क्यों पास
किया: `hardware_root_match` (हार्डवेयर-रूटेड डिवाइस
पहचानकर्ता बिल्कुल मेल खा गया) या, केवल-जांच साक्ष्य
स्वीकार करने वाले कॉन्फ़िगरेशन पर,
`exact_composite_plus__families` /
`very_high_similarity_plus__families`। केवल तब मौजूद
होता है जब `match_source`, `recovered_high` हो।
browser_version:
type: string
nullable: true
os_version:
type: string
nullable: true
user_agent:
type: string
nullable: true
description: ब्राउज़र की यूज़र एजेंट स्ट्रिंग।
accept_language:
type: string
nullable: true
description: ब्राउज़र द्वारा भेजा गया `Accept-Language` हेडर।
session_identifier:
type: string
nullable: true
description: उस ब्राउज़िंग सत्र का पहचानकर्ता जिसमें सत्यापन चलाया गया था।
session_age_ms:
type: integer
nullable: true
description: चरण चलने के समय उस ब्राउज़िंग सत्र की आयु मिलीसेकंड में।
coords_accuracy:
type: number
nullable: true
description: >-
डिवाइस द्वारा रिपोर्ट किए गए निर्देशांकों की सटीकता त्रिज्या
(मीटर में)।
raw_device_data:
type: object
nullable: true
additionalProperties: true
description: चरण के लिए एकत्र किए गए रॉ डिवाइस सिग्नल।
geolocation_checks:
type: array
nullable: true
description: >-
**स्थान सत्यापन परिणामों का Array**, प्रति स्थान सत्यापन चरण एक: उस
चरण का स्वीकृत प्रयास। तब तक `null` जब तक कि किसी स्थान सत्यापन चरण
ने डेटा उत्पन्न न किया हो। उसी चरण के पिछले प्रयास
`geolocation_attempts` में हैं।
items:
$ref: '#/components/schemas/GeolocationCheck'
geolocation_attempts:
type: array
nullable: true
description: >-
इस सत्र के प्रत्येक स्थान सत्यापन चरण का प्रत्येक प्रयास, सबसे
पुराना पहले। पुनः सबमिशन द्वारा प्रतिस्थापित किए गए प्रयासों को छोड़
दिया गया है। एक वर्कफ़्लो जो अपनी रिस्पॉन्स विशेषताओं के माध्यम से
`geolocation_checks` को रोकता है, वह इस सूची को भी रोकता है।
items:
$ref: '#/components/schemas/GeolocationAttempt'
database_validations:
type: array
nullable: true
description: >-
**डेटाबेस सत्यापन रिपोर्टों की Array** — हमेशा एक JSON array, कभी भी
एकल `database_validation` ऑब्जेक्ट नहीं। `null` जब तक कि कम से कम एक
DB सत्यापन चरण ने डेटा जनरेट न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट
है, जिसमें `node_id`, सुविधा-स्तरीय `status`, `screened_data`,
प्रति-सेवा `validations[]` (प्रत्येक अपने रजिस्ट्री `source_data` के
साथ), और `warnings[]` शामिल हैं। `screened_data` और `source_data`
फ़ील्ड देश के अनुसार भिन्न होते हैं:
**ARG (अर्जेंटीना)**: 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}। RENAPER
बायोमेट्रिक चेहरा मिलान सत्यापन का उपयोग करता है। दस्तावेज़ में
मौजूद न होने पर (उदा. ड्राइविंग लाइसेंस) लिंग का स्वचालित रूप से
चेहरे के विश्लेषण या दिए गए नाम से अनुमान लगाया जाता है
**BOL (बोलीविया)**: 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}
**BRA (ब्राज़ील)**: screened_data: {tax_number, first_name,
last_name, date_of_birth}. सफल CPF मिलानों के लिए source_data में
हमेशा {identification_number, first_name, last_name, date_of_birth,
lgpd_minor, minor_under_18, minor_under_16} शामिल होता है। सफल वयस्क
लुकअप उन फ़्लैग्स को false पर सेट करते हैं। Receita Federal Consulta
CPF सेवा LGPD-रोके गए डेटा के साथ HTTP 422 (18 वर्ष से कम उम्र का
नाबालिग) या 451 (16 वर्ष से कम उम्र) लौटा सकती है; ऐसे मामलों में
source_data नाबालिग फ़्लैग्स को आवश्यकतानुसार true पर सेट करता है,
अपस्ट्रीम HTTP स्थिति शामिल करता है, और फ़ील्ड-स्तरीय सत्यापन
no_match होता है। पूर्ण कोड सूची के लिए डेटाबेस सत्यापन परिणाम कोड
संदर्भ का ब्राज़ील अनुभाग देखें।
**CHL (चिली)**: screened_data: {personal_number, first_name,
last_name, date_of_birth}. source_data: {identification_number,
first_name, last_name, date_of_birth, gender}
**COL (कोलंबिया)**: 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}
**CRI (कोस्टा रिका)**: screened_data: {personal_number, first_name,
last_name}. source_data: {identification_number, first_name,
last_name, full_name}
**DOM (डोमिनिकन गणराज्य)**: screened_data: {personal_number}.
source_data: {identification_number} (केवल valid/invalid लौटाता है)
**ECU (इक्वाडोर)**: 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}
**ESP (स्पेन)**: 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}
**GTM (ग्वाटेमाला)**: screened_data: {document_number, first_name,
last_name}. source_data: {identification_number, first_name,
last_name, full_name}
**HND (होंडुरास)**: screened_data: {document_number, first_name,
last_name}. source_data: {identification_number, first_name,
last_name, full_name}
**MEX (मेक्सिको)**: 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}। RENAPO सिविल रजिस्ट्री का उपयोग
करता है। एक अतिरिक्त एक-एक करके सत्यापन के रूप में MEX के लिए एक अलग
INE वैधता-जाँच सेवा भी उपलब्ध है।
**PAN (पनामा)**: screened_data: {personal_number, selfie}.
source_data: {identification_number}। SIB बायोमेट्रिक सत्यापन का
उपयोग करता है
**PER (पेरू)**: screened_data: {personal_number (DNI), first_name,
last_name}. source_data: {identification_number, first_name,
last_name, paternal_name, maternal_name, verification_number,
verification_letter}
**PRY (पैराग्वे)**: screened_data: {document_number, first_name,
last_name}. source_data: {identification_number, first_name,
last_name, full_name}
**SLV (अल सल्वाडोर)**: screened_data: {document_number,
date_of_birth, first_name, last_name}. source_data:
{identification_number, first_name, last_name, full_name}
**URY (उरुग्वे)**: screened_data: {personal_number, date_of_birth,
first_name, last_name}. source_data: {identification_number,
first_name, last_name, full_name}
**VEN (वेनेजुएला)**: 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: >-
वर्कफ़्लो ग्राफ़ में इस डेटाबेस सत्यापन चरण के लिए विशिष्ट
पहचानकर्ता।
issuing_state:
type: string
description: >-
उस देश का ISO 3166-1 alpha-3 कोड जिसके सरकारी/रजिस्ट्री
स्रोतों से क्वेरी की गई थी (उदा. `BRA`, `MEX`, `ESP`, `NGA`,
`IDN`)। डेटाबेस सत्यापन अमेरिका, यूरोप, अफ्रीका, मध्य पूर्व और
एशिया-प्रशांत के 60+ देशों के साथ-साथ वैश्विक बहु-देशीय
स्रोतों को कवर करता है — कवरेज का नियमित रूप से विस्तार होता
है, इसलिए इस मान को एक निश्चित enum के बजाय एक ओपन सेट के रूप
में मानें।
validation_type:
type: string
enum:
- one_by_one
- two_by_two
- not_enabled
description: >-
परिणाम की पुष्टि कैसे की गई: `one_by_one` (एकल-सेवा परिणाम),
`two_by_two` (दो या अधिक विशिष्ट सेवाओं ने स्वतंत्र रूप से
पहचान संख्या का पूर्ण मिलान किया), या `not_enabled` (तब सहेजा
जाता है जब किसी भी सेवा ने उपयोगी मिलान नहीं दिया)। मान कभी भी
`null` नहीं होता है। समर्पित बायोमेट्रिक 2x2 सत्यापन मोड
वर्तमान में `ECU` और `PER` के लिए उपलब्ध हैं।
screened_data:
type: object
description: >-
सत्यापन के लिए उपयोग किया गया इनपुट डेटा। फ़ील्ड देश के अनुसार
भिन्न होते हैं — देश-विशिष्ट प्रारूपों के लिए डेटाबेस सत्यापन
दस्तावेज़ (`/core-technology/database-validation/overview`)
देखें।
properties:
last_name:
type: string
first_name:
type: string
tax_number:
type: string
description: 'ब्राजील: CPF (11 अंक)'
personal_number:
type: string
description: >-
चिली: RUT, DOM: Cédula (11 अंक), ECU: Cédula (10 अंक),
ESP: DNI/NIE, MEX: CURP (18 वर्ण), PER: DNI (8 अंक), 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: ESP के लिए आवश्यक
validations:
type: array
description: >-
वैलिडेशन payload लौटाने वाली प्रति रजिस्ट्री सेवा एक
प्रविष्टि। प्रत्येक प्रविष्टि सेवा (`service_id`,
`service_name`) की पहचान करती है और प्रति-फ़ील्ड `validation`
तुलना, रिपोर्ट किए जाने पर सेवा `outcome_code` /
`outcome_detail`, और `source_data` में सामान्यीकृत रजिस्ट्री
रिकॉर्ड ले जाती है।
items:
type: object
properties:
service_id:
type: string
description: >-
इस सत्यापन परिणाम को उत्पन्न करने वाली रजिस्ट्री सेवा का
पहचानकर्ता।
example: bra_cpf
service_name:
type: string
description: रजिस्ट्री सेवा का मानव-पठनीय नाम।
example: Brazil - CPF status check
validation:
type: object
description: फ़ील्ड सत्यापन के परिणाम।
properties:
full_name:
type: string
description: >-
पूरे नाम के लिए मिलान परिणाम (उदा., 'full_match',
'partial_match', 'no_match')।
date_of_birth:
type: string
description: जन्म तिथि के लिए मिलान परिणाम।
identification_number:
type: string
description: पहचान संख्या के लिए मिलान परिणाम।
outcome_code:
type: string
nullable: true
description: >-
रजिस्ट्री लुकअप का मशीन-पठनीय परिणाम (उदा. `MATCH`,
`NO_MATCH`, `PARTIAL_MATCH`, `INCONCLUSIVE`,
स्रोत-विशिष्ट कोड)। सेवा द्वारा रिपोर्ट किए जाने पर
मौजूद होता है।
outcome_detail:
type: string
nullable: true
description: >-
सेवा द्वारा प्रदान किए जाने पर, `outcome_code` का
मानव-पठनीय स्पष्टीकरण।
source_data:
type: object
description: >-
सरकारी डेटाबेस से लौटाया गया डेटा। सामान्य फ़ील्ड:
identification_number, first_name, last_name, full_name,
date_of_birth, gender। देश के अनुसार अतिरिक्त फ़ील्ड:
BRA में सफल CPF मिलान पर हमेशा lgpd_minor,
minor_under_18 और minor_under_16 शामिल होते हैं; जब CPF
डेटा LGPD (HTTP 422/451) के तहत रोक दिया जाता है, तो
इसमें अपस्ट्रीम HTTP स्टेटस भी शामिल होता है। ECU
street, formatted_address, nationality, education,
marital_status, spouse, mother_name, father_name,
profession जोड़ता है। PER paternal_name, maternal_name,
verification_number, verification_letter जोड़ता है। ESP
document_type, expiration_date जोड़ता है। VEN/COL
document_type जोड़ते हैं।
additionalProperties: true
errors:
type: array
description: >-
सत्यापन के दौरान रजिस्ट्री सेवाओं द्वारा लौटाए गए एरर,
प्रत्येक को इसे उत्पन्न करने वाले `service_id` के साथ टैग किया
गया है। **कोई एरर न होने पर यह कुंजी पूरी तरह से छोड़ दी जाती
है।**
items:
type: object
description: >-
अपस्ट्रीम सेवा का त्रुटि ऑब्जेक्ट ज्यों का त्यों विस्तृत —
इसकी कुंजियाँ सेवा के अनुसार भिन्न होती हैं (आमतौर पर एक
संदेश/कोड और कोई भी प्रदाता-विशिष्ट विवरण) — साथ ही त्रुटि
उत्पन्न करने वाली सेवा की पहचान करने वाला `service_id`।
properties:
service_id:
type: string
nullable: true
description: त्रुटि उत्पन्न करने वाली रजिस्ट्री सेवा का पहचानकर्ता।
additionalProperties: true
match_type:
type: string
enum:
- no_match
- partial_match
- full_match
nullable: true
description: >-
क्वेरी की गई सेवाओं में समग्र मिलान परिणाम। सत्यापन का
मूल्यांकन होने तक `null`।
status:
type: string
description: >-
इस डेटाबेस सत्यापन की सुविधा-स्तरीय स्थिति। शीर्ष-स्तरीय सत्र
`status` से स्वतंत्र — एक सत्र अपने समग्र निर्णय तक पहुँच सकता
है जबकि एक अलग सुविधा `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: >-
वह सुविधा जिसने यह चेतावनी उत्पन्न की। यह मान उस सुविधा
ब्लॉक की पहचान करता है जिससे चेतावनी संबंधित है।
प्रत्येक मॉड्यूल का चेतावनी ऐरे आमतौर पर अपने मॉड्यूल से
मेल खाने वाले मान का उपयोग करता है (उदाहरण के लिए,
`phone_verifications[].warnings` के अंदर `PHONE`), लेकिन
ऊपर दिया गया enum निर्णय payload पर सभी सुविधा
चेतावनियों में आधिकारिक है।
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: वर्कफ़्लो ग्राफ़ नोड ID जिसने यह चेतावनी उत्पन्न की
description: डेटाबेस सत्यापन से संबंधित चेतावनियाँ।
database_validation_not_performed_reason:
type: object
nullable: true
additionalProperties: true
description: >-
एक कॉन्फ़िगर किए गए डेटाबेस सत्यापन ने कोई परिणाम क्यों नहीं दिया,
`{code, message}` और संदर्भ फ़ील्ड के रूप में। केवल तभी मौजूद होता
है जब उस चरण वाले वर्कफ़्लो के लिए `database_validations`, `null`
हो, ताकि आप "रजिस्ट्री सहमत थी" को "कुछ नहीं चला" से अलग पहचान सकें।
अन्यथा `null`।
properties:
code:
type: string
description: मशीन द्वारा पठनीय स्थिर कारण।
message:
type: string
description: मानव-पठनीय स्पष्टीकरण।
reviews:
type: array
items:
type: object
properties:
user:
type: string
description: >-
समीक्षा किसने की। आमतौर पर कंसोल समीक्षक का पहचानकर्ता (उनका
ईमेल), लेकिन API कुंजी के साथ किए गए स्थिति अपडेट के लिए मान
`"API Client"` होता है और जब किसी कर्ता का समाधान नहीं किया जा
सका तब `"Unknown"` होता है — इसलिए इस फ़ील्ड को ईमेल पते के
रूप में पार्स न करें।
new_status:
type: string
comment:
type: string
created_at:
type: string
format: date-time
assignee:
type: object
nullable: true
description: >-
कंसोल समीक्षक जिसे सत्र सौंपा गया है, या `null` जब इसे कोई नहीं
संभाल रहा हो।
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: >-
सत्र समीक्षा की प्रतीक्षा कब करने लगा। `null` जब तक कि सत्र `In
Review` में न हो और आपका एप्लिकेशन समीक्षा समय-सीमा निर्धारित करे।
sla_due_at:
type: string
format: date-time
nullable: true
description: >-
समीक्षा कब नियत है। `null` जब तक कि सत्र `In Review` में न हो और
आपका एप्लिकेशन समीक्षा समय-सीमा निर्धारित न करे।
created_at:
type: string
format: date-time
description: सत्र बनाए जाने का टाइमस्टैम्प (ISO 8601, UTC)।
expires_at:
type: string
format: date-time
nullable: true
description: >-
वह टाइमस्टैम्प जब इस सत्र की समय-सीमा समाप्त होने का शेड्यूल है।
उपयोगकर्ता सत्यापन (KYC) सत्रों पर तब सेट किया जाता है जब निर्माण के
समय समाप्ति कॉन्फ़िगर की गई हो (या जब `Approved` स्थिति KYC समाप्ति
गणना को ट्रिगर करती है)। बिना कॉन्फ़िगर की गई समाप्ति वाले सत्रों के
लिए, और उन प्रकारों के लिए जो समाप्ति का उपयोग नहीं करते हैं (उदा.
व्यवसाय सत्यापन (KYB) सत्र जिन्हें कभी `expires_at` प्राप्त नहीं
हुआ) `null`।
registry_checks:
type: array
nullable: true
description: >-
कंपनी रजिस्ट्री जांच। केवल तभी मौजूद होती है जब `session_kind =
business` हो। प्रत्येक आइटम संपूर्ण कंपनी-रजिस्ट्री payload को समेटे
रहता है।
items:
type: object
description: >-
एक कंपनी रजिस्ट्री जाँच — स्वामित्व संरचना और चेतावनियों से समृद्ध
पूर्ण कंपनी-रजिस्ट्री payload। केवल तभी मौजूद होता है जब
`session_kind = business` हो।
properties:
status:
type: string
description: सुविधा जीवनचक्र स्थिति।
node_id:
type: string
nullable: true
data_resolved:
type: boolean
company:
type: object
description: >-
कंपनी के लिए पूर्ण रजिस्ट्री payload (रजिस्ट्री रिकॉर्ड
उपयोगकर्ता द्वारा प्रदान किए गए या कंसोल द्वारा संपादित किसी
भी डेटा के साथ मर्ज किया गया)।
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: निगमन का देश (ISO 3166-1 alpha-2, उदा. `GB`, `DE`, `US`)।
region:
type: string
nullable: true
description: >-
लागू होने पर ISO 3166-2 सबडिवीज़न कोड (उदा. अमेरिकी
राज्यों के लिए `CA`, `NY`)।
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: >-
वैकल्पिक, व्यापारिक, पूर्व या मूल-भाषा कंपनी के नाम
टेक्स्ट के रूप में, जब रिपोर्ट किए गए हों।
nature_of_business:
type: string
nullable: true
registered_capital:
type: string
nullable: true
registered_capital_amount:
type: string
format: decimal
nullable: true
description: >-
पंजीकृत/शेयर पूंजी राशि दशमलव स्ट्रिंग के रूप में (उदा.
`"100.00"`), जिसे रजिस्ट्री फ़ाइलिंग से पार्स किया गया है।
उपलब्ध न होने पर `null`।
registered_capital_currency:
type: string
nullable: true
description: >-
`registered_capital_amount` का ISO 4217 करेंसी कोड (उदा.
`"GBP"`)। उपलब्ध न होने पर `null`।
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: >-
EU VAT संख्या, जब होस्टेड रजिस्ट्री चरण के दौरान एकत्र की
गई हो या बाद में संपादित की गई हो।
vat_validation_status:
type: string
enum:
- valid
- invalid
- format_valid
- invalid_format
- could_not_validate
- not_applicable
description: >-
रजिस्ट्री सबमिट पर VAT संख्या या, यदि कोई नहीं है, तो
`tax_number` के सत्यापन का परिणाम। `valid` / `invalid`:
देश की आधिकारिक रजिस्ट्री द्वारा तय किया जाता है (EU VIES,
नॉर्वे, स्विट्जरलैंड, ब्राजील, कोलंबिया, कोस्टा रिका,
इक्वाडोर, पराग्वे; पोलैंड अपने घरेलू VAT रजिस्टर द्वारा
भी)। `format_valid` / `invalid_format`: देश के प्रारूप और
चेक-डिजिट नियमों द्वारा तय किया जाता है जहाँ किसी
रजिस्ट्री से क्वेरी नहीं की जा सकती। `could_not_validate`:
रजिस्ट्री अनुपलब्ध थी। `not_applicable`: कोई संख्या नहीं,
बिना रजिस्ट्री या नियमों वाला देश, या कोई सैंडबॉक्स सत्र।
vat_validated_number:
type: string
nullable: true
description: >-
वह संख्या जिसकी जाँच की गई थी, जैसा कि स्रोत इसे जानता है
(उदाहरण के लिए फ्रेंच SIREN या डच RSIN से प्राप्त VAT
संख्या)। कोई जाँच न चलने पर `null`।
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: >-
वह स्रोत जिसने `vat_validation_status` तय किया: एक
आधिकारिक रजिस्ट्री, या `format_rules`। कोई जाँच न चलने पर
`null`।
vat_validated_name:
type: string
nullable: true
description: >-
नंबर को सत्यापित करने वाले स्रोत के साथ पंजीकृत नाम, जब वह
इसे प्रकट करता है। केवल तब सेट होता है जब स्थिति `valid`
हो।
vat_validated_address:
type: string
nullable: true
description: >-
नंबर को सत्यापित करने वाले स्रोत के पास पंजीकृत पता, यदि
वह इसे प्रकट करता है। केवल तभी सेट किया जाता है जब स्थिति
`valid` हो।
vat_checked_at:
type: string
format: date-time
nullable: true
description: जांच का टाइमस्टैम्प। कोई जांच न चलने पर `null`।
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: >-
पहला नाम जब रजिस्ट्री द्वारा स्पष्ट रूप से रिपोर्ट
किया गया हो; पूरे नाम से अनुमानित नहीं।
last_name:
type: string
nullable: true
description: >-
कुलनाम जब रजिस्ट्री द्वारा स्पष्ट रूप से रिपोर्ट
किया गया हो।
address:
type: string
nullable: true
description: रजिस्ट्री द्वारा रिपोर्ट किया गया अधिकारी का पता।
appointment_date:
type: string
nullable: true
description: अधिकारी की नियुक्ति की तारीख।
format: date
termination_date:
type: string
nullable: true
description: नियुक्ति समाप्त होने की तारीख, जब रिपोर्ट की गई हो।
format: date
date_of_birth:
type: string
nullable: true
description: >-
रजिस्ट्री द्वारा रिपोर्ट की गई पूरी जन्म तिथि। केवल
जन्म वर्ष या माह ज्ञात होने पर Null।
format: date
date_of_birth_year:
type: integer
nullable: true
minimum: 1
maximum: 9999
description: >-
रजिस्ट्री द्वारा रिपोर्ट किया गया जन्म वर्ष, जिसमें
पूर्ण तिथि अनुपलब्ध होने की स्थिति भी शामिल है।
date_of_birth_month:
type: integer
nullable: true
minimum: 1
maximum: 12
description: >-
रजिस्ट्री द्वारा रिपोर्ट किया गया जन्म का महीना।
केवल वर्ष ज्ञात होने पर Null।
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: >-
रजिस्ट्री द्वारा रिपोर्ट किए गए स्वामित्व प्रतिशत की
निचली सीमा। मुक्त-प्रारूप स्ट्रिंग (उदा. `"25.00"`,
`"50"`); पार्स किए गए संख्यात्मक मान के लिए
`effective_ownership_percent` का उपयोग करें।
ownership_max_shares:
type: string
nullable: true
description: >-
रजिस्ट्री द्वारा रिपोर्ट किए गए अनुसार स्वामित्व
प्रतिशत की ऊपरी सीमा। फ्री-फ़ॉर्म स्ट्रिंग; पार्स
किए गए संख्यात्मक मान के लिए
`effective_ownership_percent` का उपयोग करें।
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: रिपोर्ट किए जाने पर पूरी जन्म तिथि।
format: date
appointment_date:
type: string
nullable: true
description: रिपोर्ट किए जाने पर नियुक्ति तिथि।
format: date
shareholding:
$ref: '#/components/schemas/KYBRegistryShareholding'
addresses:
type: array
nullable: true
description: >-
रजिस्ट्री द्वारा उल्लिखित प्रत्येक पता, एक कैनोनिकल स्वरूप
में। यदि कोई उल्लिखित नहीं है तो Null।
items:
$ref: '#/components/schemas/KYBRegistryAddress'
industries:
type: array
nullable: true
description: >-
वे गतिविधियाँ जिनके तहत रजिस्ट्री कंपनी को वर्गीकृत करती
है, एक विहित आकार। जब यह कोई गतिविधि नहीं बताती है तब
null।
items:
$ref: '#/components/schemas/KYBRegistryIndustry'
accounts:
type: object
nullable: true
additionalProperties: true
description: >-
रजिस्ट्री फ़ाइलिंग तिथियां, जब उपलब्ध हों। वार्षिक रिटर्न
और आम बैठकों के लिए last_annual_return_date और
last_agm_date का उपयोग किया जाता है; वे वित्तीय खातों से
भिन्न होते हैं।
registry_data:
$ref: '#/components/schemas/KYBRegistryData'
user_provided_data:
type: object
description: अंतिम उपयोगकर्ता द्वारा पुष्टि या संपादित किया गया डेटा।
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: >-
वर्कफ़्लो द्वारा आदेशित रजिस्ट्री स्तर: `basic`,
`shareholders` या `ubo`। `ownership.tier_requested` में
भी।
registry_tier_delivered:
type: string
nullable: true
description: >-
वह स्तर जो रजिस्ट्री ने डिलीवर किया है और जिसे बिल किया
जाता है। `ownership.tier_delivered` में भी उपलब्ध है।
registry_ownership_status:
type: string
nullable: true
description: >-
`not_requested`, `pending`, `delivered`, `not_held` या
`unavailable`। `ownership.status` में भी।
registry_monitoring:
type: object
nullable: true
description: >-
कंपनी के लिए नवीनतम रजिस्ट्री मॉनिटर, या कोई मौजूद न होने
पर `null`।
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: कंपनी के वे फ़ील्ड जिन पर मॉनिटर नज़र रखता है।
ownership_structure:
$ref: '#/components/schemas/KYBOwnershipStructure'
warnings:
type: array
items:
type: object
key_people_checks:
type: array
nullable: true
description: >-
प्रमुख व्यक्तियों की जाँच का समग्र परिणाम। केवल तभी उपस्थित होता है
जब `session_kind = business` हो। प्रत्येक आइटम दो-बकेट संरचना
(`registry`, `submitted`, `ubo_kyc_summary`) का उपयोग करता है।
items:
type: object
description: >-
कंपनी के अधिकारियों + UBO पर समग्र जाँच। `registry` / `submitted`
संरचना का उपयोग करता है। केवल तभी उपस्थित होता है जब session_kind
= business हो।
properties:
status:
type: string
node_id:
type: string
nullable: true
registry:
type: object
description: रजिस्ट्री जांच के माध्यम से खोजे गए पक्ष।
properties:
officers:
type: array
description: >-
रजिस्ट्री जांच के माध्यम से खोजे गए अधिकारी, प्रत्येक को
उनके लिए शुरू किए गए किसी भी चाइल्ड KYC सत्र और AML
स्क्रीनिंग की स्थिति से समृद्ध किया गया है।
items:
type: object
properties:
uuid:
type: string
format: uuid
name:
type: string
description: रजिस्ट्री में दर्ज अधिकारी का पूरा नाम।
designation:
type: string
nullable: true
description: >-
रजिस्ट्री से मुक्त-पाठ पदनाम (उदा. `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: सामान्यीकृत अधिकारी भूमिका।
nationality:
type: string
nullable: true
appointment_date:
type: string
nullable: true
description: अधिकारी की नियुक्ति की तारीख।
format: date
termination_date:
type: string
nullable: true
description: नियुक्ति समाप्त होने की तारीख, जब रिपोर्ट की गई हो।
format: date
is_active:
type: boolean
address:
type: string
nullable: true
description: रजिस्ट्री द्वारा रिपोर्ट किया गया अधिकारी का पता।
aml_status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
nullable: true
description: >-
इस अधिकारी के लिए चलाए गए AML स्क्रीनिंग रन की
स्थिति। `null` जब कोई AML स्क्रीनिंग नहीं चलाई गई
थी।
kyc_status:
type: string
enum:
- Not Started
- In Progress
- Approved
- Declined
- In Review
- Expired
- Abandoned
- Kyc Expired
- Resubmitted
- Awaiting User
nullable: true
description: >-
इस अधिकारी के लिए जनरेट किए गए चाइल्ड KYC सत्र की रॉ
लाइफ़साइकिल स्थिति। यह पूर्ण सत्र स्थिति enum है (कम
किया गया Approved/Declined/Pending सेट नहीं)। कोई
चाइल्ड KYC सत्र मौजूद न होने पर `null`।
kyc_session_url:
type: string
format: uri
nullable: true
description: >-
चाइल्ड KYC सत्र का साझा करने योग्य URL। `null` जब
कोई चाइल्ड सत्र मौजूद नहीं होता है।
kyc_session_id:
type: string
format: uuid
nullable: true
description: >-
चाइल्ड KYC सत्र का सत्र id। उस व्यक्ति की पूरी KYC
रिपोर्ट लाने के लिए इसे इसी निर्णय endpoint पर पास
करें। कोई चाइल्ड सत्र मौजूद न होने पर `null`।
verification_workflow_type:
type: string
nullable: true
description: >-
चाइल्ड सत्र के वर्कफ़्लो का आधार वर्कफ़्लो प्रकार
(उदा. `kyc`)। ग्राफ़-आधारित वर्कफ़्लो के लिए या जब
कोई चाइल्ड सत्र मौजूद न हो तो `null`।
verification_workflow_id:
type: string
format: uuid
nullable: true
description: >-
चाइल्ड सत्र द्वारा उपयोग किया गया वर्कफ़्लो id।
`null` जब कोई चाइल्ड सत्र मौजूद न हो।
verification_workflow_label:
type: string
nullable: true
description: >-
चाइल्ड सत्र के वर्कफ़्लो का मानव-पठनीय लेबल। अनसेट
होने पर `null`।
verification_workflow_features:
type: array
nullable: true
description: >-
चाइल्ड सत्यापन सत्र की प्रति-सुविधा प्रगति, उदा.
`[{"feature": "ID_VERIFICATION", "status":
"Approved"}]`। जब चाइल्ड सत्र में कोई समाधान योग्य
सुविधा सूची न हो तो `null`।
items:
type: object
properties:
feature:
type: string
description: >-
सुविधा का प्रदर्शित नाम (उदा.
`ID_VERIFICATION`, `LIVENESS`, `AML`)।
status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
description: चाइल्ड सत्र के अंदर सुविधा-स्तरीय स्थिति।
didit_internal_id:
type: string
nullable: true
description: >-
चाइल्ड सत्र के पीछे सत्यापित व्यक्ति का स्थिर आंतरिक
पहचानकर्ता — क्रॉस-सत्र लिंकिंग के लिए उपयोगी।
`null` जब कोई चाइल्ड सत्र मौजूद न हो या उपयोगकर्ता
को अभी तक रिज़ॉल्व न किया गया हो।
kyc_document_type:
type: string
nullable: true
description: >-
चाइल्ड KYC सत्र में प्रस्तुत दस्तावेज़ प्रकार (उदा.
`P`, `ID`, `DL`)। जब तक चाइल्ड सत्र का पहचान सत्यापन
परिणाम न हो तब तक `null`।
kyc_nationality:
type: string
nullable: true
description: >-
चाइल्ड KYC सत्र में दस्तावेज़ से निकाली गई
राष्ट्रीयता। उपलब्ध होने तक `null`।
kyc_liveness_passed:
type: boolean
nullable: true
description: >-
क्या चाइल्ड KYC सत्र की लाइवनेस जाँच पास हो गई।
`null` जब कोई लाइवनेस जाँच नहीं चली हो।
kyc_verified_at:
type: string
format: date-time
nullable: true
description: >-
जब चाइल्ड KYC सत्र `Approved` पर पहुँचा। `null` जब
चाइल्ड सत्र की कोई अन्य स्थिति हो।
kyc_aml_categories:
type: object
nullable: true
description: >-
व्यक्ति के AML हिट से प्राप्त प्रति-श्रेणी सारांश।
कोई हिट न होने पर `null`।
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: >-
इस व्यक्ति के चाइल्ड सत्र के लिए भेजी गई अंतिम
सत्यापन-आमंत्रण अधिसूचना का ISO 8601 टाइमस्टैम्प।
कोई न भेजे जाने पर `null`।
first_name:
type: string
nullable: true
description: >-
पहला नाम जब रजिस्ट्री द्वारा स्पष्ट रूप से रिपोर्ट
किया गया हो; पूरे नाम से अनुमानित नहीं।
last_name:
type: string
nullable: true
description: >-
कुलनाम जब रजिस्ट्री द्वारा स्पष्ट रूप से रिपोर्ट
किया गया हो।
date_of_birth:
type: string
nullable: true
description: >-
रजिस्ट्री द्वारा रिपोर्ट की गई पूरी जन्म तिथि। केवल
जन्म वर्ष या माह ज्ञात होने पर Null।
format: date
date_of_birth_year:
type: integer
nullable: true
minimum: 1
maximum: 9999
description: >-
रजिस्ट्री द्वारा रिपोर्ट किया गया जन्म वर्ष, जिसमें
पूर्ण तिथि अनुपलब्ध होने की स्थिति भी शामिल है।
date_of_birth_month:
type: integer
nullable: true
minimum: 1
maximum: 12
description: >-
रजिस्ट्री द्वारा रिपोर्ट किया गया जन्म का महीना।
केवल वर्ष ज्ञात होने पर Null।
beneficial_owners:
type: array
description: >-
रजिस्ट्री जांच के माध्यम से पाए गए वास्तविक स्वामी, जिनमें
से प्रत्येक उनके लिए शुरू किए गए किसी भी चाइल्ड KYC सत्र
और AML स्क्रीनिंग की स्थिति से समृद्ध है।
items:
type: object
properties:
uuid:
type: string
format: uuid
name:
type: string
description: >-
वास्तविक स्वामी का पूरा नाम (या कॉर्पोरेट UBOs के
लिए कंपनी का नाम)।
first_name:
type: string
nullable: true
last_name:
type: string
nullable: true
date_of_birth:
type: string
nullable: true
description: रिपोर्ट किए जाने पर पूरी जन्म तिथि।
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: >-
इस स्वामी द्वारा धारित भूमिका नाम, उदा. `["ubo",
"shareholder"]`।
items:
type: string
ownership_min_shares:
type: string
nullable: true
description: >-
रजिस्ट्री द्वारा रिपोर्ट किए गए स्वामित्व प्रतिशत की
निचली सीमा। मुक्त-प्रारूप स्ट्रिंग (उदा. `"25"`,
`"25-50%"`); पार्स किए गए संख्यात्मक मान के लिए
`effective_ownership_percent` का उपयोग करें।
ownership_max_shares:
type: string
nullable: true
description: >-
रजिस्ट्री द्वारा रिपोर्ट किए गए अनुसार स्वामित्व
प्रतिशत की ऊपरी सीमा। फ्री-फ़ॉर्म स्ट्रिंग; पार्स
किए गए संख्यात्मक मान के लिए
`effective_ownership_percent` का उपयोग करें।
is_active:
type: boolean
aml_status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
nullable: true
description: >-
इस वास्तविक स्वामी के लिए चलाए गए AML स्क्रीनिंग रन
की स्थिति। `null` जब कोई AML स्क्रीनिंग नहीं चलाई गई
थी।
kyc_status:
type: string
enum:
- Not Started
- In Progress
- Approved
- Declined
- In Review
- Expired
- Abandoned
- Kyc Expired
- Resubmitted
- Awaiting User
nullable: true
description: >-
इस वास्तविक स्वामी के लिए जनरेट किए गए चाइल्ड KYC
सत्र की रॉ लाइफ़साइकिल स्थिति। यह पूर्ण सत्र स्थिति
enum है (कम किया गया Approved/Declined/Pending सेट
नहीं)। कोई चाइल्ड KYC सत्र मौजूद न होने पर `null`।
kyc_session_url:
type: string
format: uri
nullable: true
description: >-
चाइल्ड KYC सत्र का साझा करने योग्य URL। `null` जब
कोई चाइल्ड सत्र मौजूद नहीं होता है।
kyc_session_id:
type: string
format: uuid
nullable: true
description: >-
चाइल्ड KYC सत्र का सत्र id। उस व्यक्ति की पूरी KYC
रिपोर्ट लाने के लिए इसे इसी निर्णय endpoint पर पास
करें। कोई चाइल्ड सत्र मौजूद न होने पर `null`।
verification_workflow_type:
type: string
nullable: true
description: >-
चाइल्ड सत्र के वर्कफ़्लो का आधार वर्कफ़्लो प्रकार
(उदा. `kyc`)। ग्राफ़-आधारित वर्कफ़्लो के लिए या जब
कोई चाइल्ड सत्र मौजूद न हो तो `null`।
verification_workflow_id:
type: string
format: uuid
nullable: true
description: >-
चाइल्ड सत्र द्वारा उपयोग किया गया वर्कफ़्लो id।
`null` जब कोई चाइल्ड सत्र मौजूद न हो।
verification_workflow_label:
type: string
nullable: true
description: >-
चाइल्ड सत्र के वर्कफ़्लो का मानव-पठनीय लेबल। अनसेट
होने पर `null`।
verification_workflow_features:
type: array
nullable: true
description: >-
चाइल्ड सत्यापन सत्र की प्रति-सुविधा प्रगति, उदा.
`[{"feature": "ID_VERIFICATION", "status":
"Approved"}]`। जब चाइल्ड सत्र में कोई समाधान योग्य
सुविधा सूची न हो तो `null`।
items:
type: object
properties:
feature:
type: string
description: >-
सुविधा का प्रदर्शित नाम (उदा.
`ID_VERIFICATION`, `LIVENESS`, `AML`)।
status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
description: चाइल्ड सत्र के अंदर सुविधा-स्तरीय स्थिति।
didit_internal_id:
type: string
nullable: true
description: >-
चाइल्ड सत्र के पीछे सत्यापित व्यक्ति का स्थिर आंतरिक
पहचानकर्ता — क्रॉस-सत्र लिंकिंग के लिए उपयोगी।
`null` जब कोई चाइल्ड सत्र मौजूद न हो या उपयोगकर्ता
को अभी तक रिज़ॉल्व न किया गया हो।
kyc_document_type:
type: string
nullable: true
description: >-
चाइल्ड KYC सत्र में प्रस्तुत दस्तावेज़ प्रकार (उदा.
`P`, `ID`, `DL`)। जब तक चाइल्ड सत्र का पहचान सत्यापन
परिणाम न हो तब तक `null`।
kyc_nationality:
type: string
nullable: true
description: >-
चाइल्ड KYC सत्र में दस्तावेज़ से निकाली गई
राष्ट्रीयता। उपलब्ध होने तक `null`।
kyc_liveness_passed:
type: boolean
nullable: true
description: >-
क्या चाइल्ड KYC सत्र की लाइवनेस जाँच पास हो गई।
`null` जब कोई लाइवनेस जाँच नहीं चली हो।
kyc_verified_at:
type: string
format: date-time
nullable: true
description: >-
जब चाइल्ड KYC सत्र `Approved` पर पहुँचा। `null` जब
चाइल्ड सत्र की कोई अन्य स्थिति हो।
kyc_aml_categories:
type: object
nullable: true
description: >-
व्यक्ति के AML हिट से प्राप्त प्रति-श्रेणी सारांश।
कोई हिट न होने पर `null`।
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: >-
इस व्यक्ति के चाइल्ड सत्र के लिए भेजी गई अंतिम
सत्यापन-आमंत्रण अधिसूचना का ISO 8601 टाइमस्टैम्प।
कोई न भेजे जाने पर `null`।
child_beneficial_owners:
type: array
description: >-
कॉर्पोरेट UBOs के लिए: स्वामित्व वाली संस्था के अपने
वास्तविक स्वामी, रजिस्ट्री से निकाले गए रॉ ऑब्जेक्ट
के रूप में। लागू न होने पर खाली ऐरे।
items:
type: object
effective_ownership_percent:
type: number
nullable: true
description: >-
पार्स किया गया संख्यात्मक स्वामित्व प्रतिशत — उपलब्ध
होने पर अधिकतम सीमा, अन्यथा न्यूनतम सीमा। जब किसी भी
सीमा को पार्स नहीं किया जा सका तो `null`।
voting_min_shares:
type: string
nullable: true
voting_max_shares:
type: string
nullable: true
appointment_date:
type: string
nullable: true
description: रिपोर्ट किए जाने पर नियुक्ति तिथि।
format: date
submitted:
type: object
description: >-
प्रमुख व्यक्ति फ़्लो के दौरान व्यवसाय व्यवस्थापक द्वारा सबमिट
किए गए पक्ष (BusinessParty पंक्तियाँ जहाँ source=USER)।
properties:
parties:
type: array
items:
type: object
description: >-
प्रमुख व्यक्ति फ़्लो के माध्यम से व्यवसाय व्यवस्थापक
द्वारा सबमिट किया गया पक्ष (source=USER)।
properties:
uuid:
type: string
format: uuid
entity_type:
type: string
enum:
- person
- company
source:
type: string
enum:
- USER
description: >-
यहाँ हमेशा `USER` — इस बकेट में केवल वही पक्ष होते
हैं जिन्हें Key People फ़्लो में अंतिम उपयोगकर्ता
द्वारा दर्ज या पुष्टि की गई हो (रजिस्ट्री द्वारा
खोजे गए लोग `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: >-
व्यक्तियों के लिए राष्ट्रीयता; कंपनी पक्षों के लिए
निगमन का देश।
phone_number:
type: string
nullable: true
date_of_birth:
type: string
format: date
nullable: true
position:
type: string
nullable: true
description: मुक्त-पाठ पद का नाम / पद (केवल व्यक्तियों के लिए)।
custom_fields:
type: object
description: >-
इस पार्टी के लिए एकत्र किए गए वर्कफ़्लो-परिभाषित
कस्टम फ़ील्ड; कुंजियाँ वर्कफ़्लो के प्रमुख व्यक्ति
फ़ील्ड वर्णनकर्ता द्वारा परिभाषित की जाती हैं।
is_active:
type: boolean
is_skipped:
type: boolean
description: >-
True जब अंतिम उपयोगकर्ता ने इस पक्ष के लिए सत्यापन
छोड़ दिया (केवल तभी संभव है जब भूमिका छोड़ने की
अनुमति देती है)।
requires_verification:
type: boolean
description: >-
True जब भूमिका सेटिंग्स और स्वामित्व थ्रेशोल्ड के
आधार पर इस पक्ष के लिए चाइल्ड KYC / KYB उप-सत्र
आवश्यक हो।
roles:
type: array
description: >-
इस पक्ष द्वारा धारित सभी भूमिकाएँ, प्रत्येक का अपना
स्वामित्व और मतदान प्रतिशत। स्वयं पक्ष पर कोई स्केलर
`role`/`ownership_percent` नहीं होता है।
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: >-
सत्यापन की आवश्यकता वाले व्यक्तिगत पक्षकारों के लिए
चाइल्ड KYC सत्र ID। अन्यथा `null`।
kyc_session_status:
type: string
enum:
- Not Started
- In Progress
- Approved
- Declined
- In Review
- Expired
- Abandoned
- Kyc Expired
- Resubmitted
- Awaiting User
nullable: true
description: >-
चाइल्ड KYC सत्र की लाइफ़साइकिल स्थिति। कोई चाइल्ड
KYC सत्र मौजूद न होने पर `null`।
kyc_session_url:
type: string
format: uri
nullable: true
kyb_sub_session_id:
type: string
format: uuid
nullable: true
description: >-
सत्यापन की आवश्यकता वाले कॉर्पोरेट पक्षकारों के लिए
चाइल्ड KYB उप-सत्र ID। अन्यथा `null`।
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: >-
चाइल्ड KYB सब-सत्र की लाइफ़साइकिल स्थिति। कोई
सब-सत्र मौजूद न होने पर `null`।
kyb_sub_session_url:
type: string
format: uri
nullable: true
description: >-
चाइल्ड KYB सब-सत्र का साझा करने योग्य URL। `null` जब
कोई सब-सत्र मौजूद नहीं होता है।
verification_workflow_type:
type: string
nullable: true
description: >-
चाइल्ड सत्र के वर्कफ़्लो का आधार वर्कफ़्लो प्रकार
(KYC सत्र को प्राथमिकता दी जाती है, KYB सब-सत्र पर
वापस आते हुए)। ग्राफ़-आधारित वर्कफ़्लो के लिए या जब
कोई चाइल्ड सत्र मौजूद न हो तो `null`।
verification_workflow_id:
type: string
format: uuid
nullable: true
description: >-
चाइल्ड सत्र द्वारा उपयोग किया गया वर्कफ़्लो id।
`null` जब कोई चाइल्ड सत्र मौजूद न हो।
verification_workflow_label:
type: string
nullable: true
description: >-
चाइल्ड सत्र के वर्कफ़्लो का मानव-पठनीय लेबल। अनसेट
होने पर `null`।
verification_workflow_features:
type: array
nullable: true
description: >-
चाइल्ड सत्यापन सत्र की प्रति-सुविधा प्रगति, उदा.
`[{"feature": "ID_VERIFICATION", "status":
"Approved"}]`। जब चाइल्ड सत्र में कोई समाधान योग्य
सुविधा सूची न हो तो `null`।
items:
type: object
properties:
feature:
type: string
description: >-
सुविधा का प्रदर्शित नाम (उदा.
`ID_VERIFICATION`, `LIVENESS`, `AML`)।
status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
description: चाइल्ड सत्र के अंदर सुविधा-स्तरीय स्थिति।
didit_internal_id:
type: string
nullable: true
description: >-
चाइल्ड सत्र के पीछे सत्यापित व्यक्ति का स्थिर आंतरिक
पहचानकर्ता। रिज़ॉल्व न होने पर `null`।
ubo_kyc_summary:
type: object
nullable: true
description: >-
समग्र UBO KYC प्रगति, या null जब किसी भी UBO के पास लिंक किए
गए KYC सत्र न हों।
properties:
total:
type: integer
approved:
type: integer
flagged:
type: integer
description: वास्तविक स्वामी (UBO) जिनका KYC अस्वीकृत या समीक्षाधीन है।
pending:
type: integer
warnings:
type: array
items:
type: object
document_verifications:
type: array
nullable: true
description: >-
वर्कफ़्लो नोड के अनुसार समूहीकृत दस्तावेज़ सत्यापन जाँचें। केवल तब
मौजूद होती हैं जब `session_kind = business` हो।
items:
type: object
description: >-
वर्कफ़्लो नोड द्वारा समूहीकृत दस्तावेज़। केवल तब मौजूद होते हैं जब
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: >-
उच्च-स्तरीय KYB दस्तावेज़ समूह जिसमें फ़ाइल को वर्गीकृत
किया गया था। अवर्गीकृत होने पर `null`।
document_subtype:
type: string
nullable: true
description: >-
विशिष्ट OCR-पहचाना गया सबटाइप (उदा.
`CERTIFICATE_OF_INCORPORATION`, `SHAREHOLDER_REGISTRY`);
`UNKNOWN` जब OCR दस्तावेज़ को विश्वासपूर्वक वर्गीकृत
नहीं कर सका।
document_group:
type: string
enum:
- LEGAL_PRESENCE
- COMPANY_DETAILS
- OWNERSHIP_STRUCTURE
- REPRESENTATIVES_AUTHORIZATION
- OTHER
nullable: true
description: >-
`document_type` का उपनाम — `groups` और `required_groups`
द्वारा उपयोग किया जाने वाला समूह नाम।
file_url:
type: string
format: uri
nullable: true
description: >-
अपलोड की गई फ़ाइल का अल्पकालिक प्रीसाइन्ड लिंक। विश्लेषक
द्वारा बनाए गए दस्तावेज़ अनुरोध प्लेसहोल्डर्स
(`is_requested = true`) के लिए `null` जो अभी तक पूरे
नहीं हुए हैं।
original_filename:
type: string
nullable: true
description: >-
फ़ाइल नाम जैसा कि उपयोगकर्ता या विश्लेषक द्वारा अपलोड
किया गया था।
file_size:
type: integer
nullable: true
description: बाइट्स में फ़ाइल का आकार।
status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
description: प्रति-दस्तावेज़ सत्यापन स्थिति।
created_at:
type: string
format: date-time
cross_check_result:
type: object
nullable: true
description: >-
रजिस्ट्री कंपनी प्रोफ़ाइल के विरुद्ध OCR द्वारा निकाले
गए दस्तावेज़ फ़ील्ड का क्रॉस-रेफ़रंस। `critical`,
`non_critical` और `people` सेक्शन वाला एक ऑब्जेक्ट,
जिनमें से प्रत्येक एक फ़ील्ड नाम (जैसे `company_name`,
`registration_number`, `incorporation_date`,
`registered_address`) को `{"document": "...",
"registry": "...", "match": true, "score": 0.97}` जैसे
तुलना रिकॉर्ड में मैप करता है। `null` जब दस्तावेज़ में
कोई OCR डेटा नहीं था या तुलना करने के लिए कोई रजिस्ट्री
कंपनी नहीं थी।
document_metadata:
type: object
nullable: true
description: >-
अपलोड किए गए कॉर्पोरेट दस्तावेज़ से निकाला गया मेटाडेटा।
जब मेटाडेटा निष्कर्षण सफल होता है, तो सभी 16 कुंजियाँ
हमेशा मौजूद होती हैं (फ़ाइल प्रकार पर लागू न होने पर
व्यक्तिगत मान `null` होते हैं); जब कुछ भी नहीं निकाला जा
सका तो संपूर्ण ऑब्जेक्ट `null` होता है। PDF के लिए,
`overlay_manipulation` में फ़ॉरेंसिक ओवरले-टेक्स्ट
विश्लेषण होता है।
properties:
file_size:
type: integer
nullable: true
description: दस्तावेज़ का आकार।
content_type:
type: string
nullable: true
description: दस्तावेज़ का कंटेंट प्रकार।
creation_date:
type: string
nullable: true
description: तारीख जब दस्तावेज़ बनाया गया था।
modified_date:
type: string
nullable: true
description: तारीख जब दस्तावेज़ संशोधित किया गया था।
creator:
type: string
nullable: true
description: >-
फ़ाइल मेटाडेटा (PDF `Creator`) में दर्ज ऑथरिंग
टूल/उपयोगकर्ता।
producer:
type: string
nullable: true
description: फ़ाइल बनाने वाला सॉफ़्टवेयर (PDF `Producer`)।
software:
type: string
nullable: true
description: >-
फ़ाइल मेटाडेटा में रिकॉर्ड किया गया संपादन
सॉफ़्टवेयर।
encryption:
type: string
nullable: true
description: फ़ाइल की एन्क्रिप्शन स्कीम, जब एन्क्रिप्टेड हो।
is_signed:
type: boolean
nullable: true
description: क्या दस्तावेज़ में डिजिटल हस्ताक्षर मौजूद है।
is_tampered:
type: boolean
nullable: true
description: >-
क्या डिजिटल हस्ताक्षर सत्यापन विफल रहा (हस्ताक्षर के
बाद संशोधन)।
signature_info:
type: object
nullable: true
description: डिजिटल हस्ताक्षर का विवरण, यदि मौजूद हो।
exif_original_date:
type: string
nullable: true
description: छवि अपलोड के लिए EXIF मूल कैप्चर तिथि।
exif_digitized_date:
type: string
nullable: true
description: छवि अपलोड के लिए EXIF डिजिटलीकरण तिथि।
processed_by_known_editor:
type: boolean
nullable: true
description: >-
क्या मेटाडेटा इंगित करता है कि फ़ाइल किसी ज्ञात
छवि/PDF संपादक से गुज़री है।
has_different_creation_mod_date:
type: boolean
nullable: true
description: >-
क्या निर्माण और संशोधन तिथियाँ भिन्न हैं — एक
संभावित (लेकिन अनिर्णायक) संपादन संकेत।
overlay_manipulation:
type: object
nullable: true
description: >-
संदिग्ध ओवरले-टेक्स्ट हेरफेर के लिए PDF फोरेंसिक
विश्लेषण। जब कोई ओवरले हेरफेर का सबूत नहीं मिला हो
या दस्तावेज़ PDF नहीं था, तो Null।
properties:
detected:
type: boolean
description: >-
क्या ओवरले-टेक्स्ट हेरफेर के साक्ष्य का पता चला
था।
analyzed:
type: boolean
description: क्या PDF का विश्लेषण किया जा सका।
analysis_incomplete:
type: boolean
description: >-
जब फ़ाइल को पूरी तरह जाँचा नहीं जा सका, तब यह
मौजूद होता है और केवल तभी सत्य होता है। जितना
हिस्सा जाँचा जा सका, उसके निष्कर्ष जहाँ संभव हो
वहीं रखे जाते हैं, और दस्तावेज़ अप्रमाणित
टेक्स्ट प्रतिस्थापन चेतावनी दिखाता है।
signals:
type: array
items:
type: string
description: >-
फ़ॉरेंसिक सिग्नल जो ट्रिगर हुए, जैसे
duplicate_font_subset या glyph_fragmentation।
manipulated_regions:
type: array
description: >-
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: >-
दस्तावेज़ अनुरोध के लिए विश्लेषक द्वारा प्रदान किया गया
लेबल या कारण। नियमित अपलोड के लिए `null`।
is_requested:
type: boolean
description: >-
विश्लेषक द्वारा बनाए गए दस्तावेज़ अनुरोध प्लेसहोल्डर के
लिए True जो अपलोड की प्रतीक्षा कर रहे हैं।
ocr_data:
type: object
nullable: true
is_console_upload:
type: boolean
description: >-
अंतिम-उपयोगकर्ता प्रवाह के बजाय कंसोल से अपलोड किए गए
दस्तावेज़ों के लिए True। कंसोल अपलोड कभी भी
सुविधा-स्तरीय समग्र स्थिति को नहीं बदलते हैं।
is_confirmed:
type: boolean
description: >-
कंसोल अपलोड `false` से शुरू होते हैं और व्यवस्थापक
द्वारा पुष्टि करने के बाद `true` हो जाते हैं; अंतिम
उपयोगकर्ता अपलोड हमेशा `true` होते हैं।
groups:
type: object
description: >-
समूह नाम (जैसे 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: >-
अनुरोधित प्लेसहोल्डर जिनमें अभी तक कोई फ़ाइल अपलोड नहीं
की गई है।
required_groups:
type: array
items:
type: string
warnings:
type: array
items:
type: object
environment:
type: string
enum:
- live
- sandbox
description: >-
क्या सत्र किसी लाइव एप्लिकेशन (`live`) या सैंडबॉक्स एप्लिकेशन
(`sandbox`) द्वारा बनाया गया था। सैंडबॉक्स सत्र निःशुल्क और पूरी तरह
से सिम्युलेटेड होते हैं, और इनसे कभी भी क्रेडिट का शुल्क नहीं लिया
जाता है।
sandbox_scenario:
type: string
nullable: true
description: >-
वह सैंडबॉक्स परिदृश्य जिसके साथ सत्र बनाया गया था। लाइव सत्रों के
लिए और बिना किसी परिदृश्य के बनाए गए सैंडबॉक्स सत्रों के लिए `null`।
resubmissions:
type: array
description: >-
उपयोगकर्ता और व्यवसाय सत्रों के लिए केवल `include=resubmissions` के
साथ लौटाया जाता है। प्रति पुनः सबमिशन अनुरोध पर एक प्रविष्टि, सबसे
पुरानी पहले। प्रत्येक प्रविष्टि उन परिणामों को ले जाती है जो पुनः
सबमिट किए गए चरणों ने अनुरोध से पहले लौटाए थे, ताकि पहले के सबमिशन
पढ़े जा सकें। सत्र को हटाने से प्रत्येक सबमिशन डिलीट हो जाता है।
items:
type: object
properties:
number:
type: integer
description: सत्र के पहले पुनः सबमिशन के लिए 1, दूसरे के लिए 2, इत्यादि।
created_at:
type: string
format: date-time
description: पुनः सबमिशन का अनुरोध कब किया गया था।
previous_status:
type: string
description: अनुरोध से ठीक पहले सत्र की स्थिति।
nodes:
type: array
description: उपयोगकर्ता को वापस भेजे गए वर्कफ़्लो चरण।
items:
type: object
properties:
node_id:
type: string
feature:
type: string
reasons:
type: object
nullable: true
additionalProperties:
type: string
description: >-
प्रत्येक चरण के लिए दिया गया कारण, `node_id` के अनुसार
कुंजीबद्ध।
requested_by:
type: object
nullable: true
description: पुनः सबमिशन का अनुरोध किसने किया।
properties:
name:
type: string
email:
type: string
type:
type: string
results:
type: object
additionalProperties: true
description: >-
पुनः सबमिट किए गए चरणों ने अनुरोध से पहले क्या लौटाया, उन्हीं
कुंजियों के तहत और उसी आकार में जैसा कि इस रिस्पॉन्स के
वर्तमान परिणाम हैं (`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`; व्यावसायिक सत्रों के लिए
`document_verifications` भी)। केवल वापस भेजे गए चरणों की
कुंजियाँ ही दिखाई देती हैं।
biometric_consent:
type: object
nullable: true
description: >-
क्या सत्र को फ़ेस कैप्चर से पहले स्पष्ट बायोमेट्रिक सहमति की
आवश्यकता थी, क्यों, और उत्तर का साक्ष्य। केवल उपयोगकर्ता सत्यापन
(KYC) सत्र; वही ऑब्जेक्ट सत्र webhooks के `decision` में होता है।
`null` जब सत्र का कभी मूल्यांकन नहीं किया गया, उदाहरण के लिए बिना
फ़ेस कैप्चर वाला वर्कफ़्लो। बिना किसी रिकॉर्ड किए गए मान वाले फ़ील्ड
`null` होते हैं। 4.10.0 से नीचे का एक नेटिव SDK, या जो अपने संस्करण
की रिपोर्ट नहीं करता है, सहमति चरण नहीं दिखा सकता है: इसके फ़ेस
कैप्चर पहले की तरह चलते हैं, और जिस सत्र में सहमति की आवश्यकता थी वह
फिर `reason: "BIOMETRIC_CONSENT_UNSUPPORTED_SDK"` के साथ `status:
"pending"` रिपोर्ट करता है। देखें [बायोमेट्रिक
सहमति](/hi/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: >-
सहमति की आवश्यकता क्यों है, या इसे कैसे संतुष्ट किया गया।
`declared_state`: आपने एक कवर किया गया राज्य घोषित किया है
(`user_state`, या `expected_details` में एक अमेरिकी पता)।
`ip_state`: व्यक्ति का IP कवर किए गए राज्य (इलिनोइस, टेक्सास,
कोलोराडो) में है। `ip_unknown`: साक्ष्य व्यक्ति को अमेरिका में
रखता है लेकिन राज्य का पता नहीं लगाया जा सकता है (IP बिना राज्य
के अमेरिका में है, या इसका पता नहीं लगाया जा सकता जबकि आपके
विवरण या दस्तावेज़ व्यक्ति को अमेरिका में रखते हैं)।
`document_issuer`: पहचान दस्तावेज़ किसी कवर किए गए राज्य द्वारा
जारी किया गया था। `forced`: एप्लिकेशन का मोड Always है।
`customer_collected`: आपने सत्र बनाते समय `biometric_consent`
भेजा था। आवश्यकता न होने पर `null`।
status:
type: string
enum:
- not_required
- pending
- given
- declined
description: >-
`not_required`; `pending` (आवश्यक है और दिया नहीं गया: व्यक्ति
ने अभी तक उत्तर नहीं दिया है, या `reason` बताता है कि इसे क्यों
एकत्र नहीं किया गया था); `given`; `declined` (एक अस्वीकृति दर्ज
की गई थी और सत्र `Declined` के रूप में समाप्त हुआ; आज कोई भी
Didit स्क्रीन अस्वीकृति का विकल्प नहीं देती है)।
given_at:
type: string
format: date-time
nullable: true
description: >-
जब सहमति दी गई थी। `customer_collected` के लिए, आपके द्वारा भेजा
गया `given_at`।
declined_at:
type: string
format: date-time
nullable: true
description: जब कोई अस्वीकृति दर्ज की गई थी।
text_version:
type: string
nullable: true
description: >-
व्यक्ति द्वारा उत्तर दिए गए सहमति टेक्स्ट का संस्करण id, या वह
जो आपने भेजा था।
text_hash:
type: string
nullable: true
description: >-
दिखाए गए सटीक सहमति पाठ का SHA-256 (hex), उसी भाषा में जिसमें
इसे दिखाया गया था।
locale:
type: string
nullable: true
description: जिस भाषा में सहमति पाठ दिखाया गया था।
policy_url:
type: string
format: uri
nullable: true
description: बायोमेट्रिक डेटा नीति, जिससे सहमति चरण लिंक किया गया था।
step:
type: string
nullable: true
description: >-
वर्कफ़्लो चरण जिस पर सत्र था जब व्यक्ति ने उत्तर दिया, उदाहरण के
लिए `LIVENESS`।
node_id:
type: string
nullable: true
description: >-
वर्कफ़्लो ग्राफ़ नोड, जिस पर व्यक्ति के उत्तर देने के समय सत्र
था।
ip_address:
type: string
nullable: true
description: वह IP जिससे उत्तर आया था।
ip_country_code:
type: string
nullable: true
description: उत्तर के IP का ISO 3166-1 alpha-2 देश।
ip_state:
type: string
nullable: true
description: उत्तर के IP का ISO 3166-2 सबडिवीज़न, उदाहरण के लिए `US-IL`।
ip_city:
type: string
nullable: true
description: उत्तर के IP का शहर।
user_agent:
type: string
nullable: true
description: उत्तर के अनुरोध का यूज़र एजेंट।
detected_ip_address:
type: string
nullable: true
description: >-
व्यक्ति का IP जिससे आवश्यकता का अंतिम मूल्यांकन किया गया था। यह
`ip_address` से भिन्न हो सकता है यदि व्यक्ति ने किसी अन्य डिवाइस
पर उत्तर दिया हो।
detected_country_code:
type: string
nullable: true
description: डिटेक्ट किए गए IP का ISO 3166-1 alpha-2 देश।
detected_state:
type: string
nullable: true
description: डिटेक्ट किए गए IP का ISO 3166-2 सबडिवीज़न।
detected_city:
type: string
nullable: true
description: पहचाने गए IP का शहर।
declared_state:
type: string
nullable: true
description: >-
आपके द्वारा घोषित ISO 3166-2 सबडिवीज़न: `user_state`, या
`expected_details` में किसी अमेरिकी पते का राज्य।
document_state:
type: string
nullable: true
description: >-
पहचान दस्तावेज़ जारी करने वाला ISO 3166-2 सबडिवीज़न, जो ID
कैप्चर के समय पढ़ा गया।
jurisdictions:
type: array
items:
type: string
description: >-
अमेरिकी राज्य (USPS कोड, उदाहरण के लिए `IL`) जिनका बायोमेट्रिक
कानून उस व्यक्ति को कवर करता है। `US` जब साक्ष्य व्यक्ति को
अमेरिका में दर्शाता है लेकिन किसी राज्य की जानकारी नहीं है। जब
कोई लागू न हो तो खाली रहता है।
retention_months:
type: integer
nullable: true
description: >-
`jurisdictions` में सबसे छोटी बायोमेट्रिक प्रतिधारण सीमा, महीनों
में। कोई लागू न होने पर `null`।
reason:
type: string
nullable: true
enum:
- BIOMETRIC_CONSENT_UNSUPPORTED_SDK
- BIOMETRIC_CONSENT_DECLINED
description: >-
`BIOMETRIC_CONSENT_UNSUPPORTED_SDK`: सहमति आवश्यक थी और 4.10.0
से पुराने नेटिव SDK, या जिसने अपना संस्करण रिपोर्ट नहीं किया,
उसने सहमति चरण के बिना चेहरे को कैप्चर कर लिया; `status`
`pending` रहता है, या यदि व्यक्ति बाद में होस्ट किए गए फ़्लो में
सहमत हो गया तो `given` हो जाता है। `BIOMETRIC_CONSENT_DECLINED`:
एक अस्वीकृति रिकॉर्ड की गई थी (यह SDK कारण को प्रतिस्थापित करता
है)। अन्यथा `null`, और जब सत्र को सहमति की आवश्यकता नहीं थी तब
हमेशा `null`।
decline_reason:
type: string
nullable: true
enum:
- BIOMETRIC_CONSENT_DECLINED
description: >-
`BIOMETRIC_CONSENT_DECLINED` जब रिकॉर्ड की गई अस्वीकृति के कारण
सत्र समाप्त हुआ हो, अन्यथा `null`।
face_data_deleted_at:
type: string
format: date-time
nullable: true
description: >-
जब अस्वीकृति ने सत्र की चेहरे की छवियाँ, वीडियो और फ़ेस टेम्पलेट
हटा दिए। `null` जब तक कि अस्वीकृति दर्ज न की गई हो।
investigator:
$ref: '#/components/schemas/InvestigatorBlock'
biometric_retention:
$ref: '#/components/schemas/BiometricRetention'
fraud_check:
type: object
nullable: true
additionalProperties: true
description: एक Fraud Check API कॉल का परिणाम। हर दूसरे सत्र के लिए `null`।
full_session_video:
type: string
format: uri
nullable: true
description: >-
पूर्ण-सत्र रिकॉर्डिंग का समाप्त होने वाला URL। केवल तभी लौटाया जाता
है जब आपका संगठन पूर्ण-सत्र वीडियो रिकॉर्ड करता है।
full_session_video_recorded_at:
type: string
format: date-time
nullable: true
description: >-
जब पूर्ण-सत्र रिकॉर्डिंग की गई थी। केवल तब लौटाया जाता है जब आपका
संगठन पूर्ण-सत्र वीडियो रिकॉर्ड करता है।
AddressValidationResult:
type: object
description: >-
एक Address Validation का परिणाम: क्या पता मौजूद है, और इसका सामान्यीकृत
रूप। यह केवल पते की पुष्टि करता है; यह कभी भी पते को किसी व्यक्ति से
नहीं जोड़ता है।
required:
- status
- verification_level
- address
- formatted_address
- latitude
- longitude
properties:
status:
type: string
enum:
- verified
- partially_verified
- not_verified
- unavailable
description: >-
`verified`: पते की पुष्टि भवन (या फ्लैट अथवा PO बॉक्स) स्तर तक की गई
थी। `partially_verified`: इसकी पुष्टि केवल सड़क स्तर तक की गई थी, या
उस स्थान के लिए डाक संदर्भ डेटा के सबसे सटीक स्तर तक की गई थी।
`not_verified`: केवल क्षेत्र या शहर का मिलान हुआ, या कुछ भी मेल नहीं
खाया। `unavailable`: सत्यापन नहीं चल सका (उदाहरण के लिए संदर्भ सेवा
ने उत्तर नहीं दिया); इसका कोई शुल्क नहीं लिया जाता है और यह कभी भी
सत्यापन को प्रभावित नहीं करता है।
verification_level:
type: string
nullable: true
enum:
- administrative_area
- locality
- thoroughfare
- premise
- delivery_point
- null
description: >-
सबसे सटीक स्तर जिस पर पते का मिलान किया गया था। कुछ भी मेल न खाने पर
या `status` के `unavailable` होने पर `null`।
address:
type: object
nullable: true
description: सामान्यीकृत पता। `status` के `unavailable` होने पर `null`।
properties:
address_line_1:
type: string
nullable: true
description: पहली डिलीवरी लाइन, जिस तरह से देश इसे लिखता है उसी तरह लिखी गई।
example: 1600 Amphitheatre Pkwy
address_line_2:
type: string
nullable: true
description: >-
दूसरी डिलीवरी पंक्ति (फ़्लैट, भवन या इलाका), यदि पते में उपलब्ध
हो।
city:
type: string
nullable: true
example: Mountain View
region:
type: string
nullable: true
description: राज्य, प्रांत या क्षेत्र।
example: CA
postal_code:
type: string
nullable: true
example: 94043-1351
country:
type: string
nullable: true
description: ISO 3166-1 alpha-2 देश कोड।
example: US
formatted_address:
type: string
nullable: true
description: एक पंक्ति में सामान्यीकृत पता।
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
PhoneIntelligence:
type: object
description: >-
सामान्यीकृत फ़ोन-इंटेलिजेंस ब्लॉक। केवल तभी मौजूद होता है जब इस लुकअप के
लिए इंटेलिजेंस ऐड-ऑन चला हो; मौजूद होने पर इसे समान मानों के साथ
`enrichment` उपनाम के तहत भी दिखाया जाता है।
properties:
score:
type: number
nullable: true
description: सामान्यीकृत 0-100 जोखिम स्कोर। उच्च मान अधिक जोखिम भरा होता है।
phone_type_risk:
type: string
nullable: true
description: '`Low`, `Medium` या `High`, स्कोर से निकाला गया।'
phone_trust_index:
type: number
nullable: true
description: >-
स्कोर का व्युत्क्रम, उन डैशबोर्ड के लिए जो उच्च स्कोर को बेहतर मानते
हैं।
network_stability_index:
type: number
nullable: true
description: लाइन के नेटवर्क की स्थिरता।
is_disposable:
type: boolean
nullable: true
description: '`true` जब नंबर डिस्पोज़ेबल या वर्चुअल प्रतीत होता हो।'
is_ported:
type: boolean
nullable: true
description: '`true` जब नंबर ने कैरियर बदल लिया हो।'
is_recently_ported:
type: boolean
nullable: true
description: '`true` जब पोर्ट हाल ही में हुआ हो।'
carrier_type:
type: string
nullable: true
description: लुकअप द्वारा रिपोर्ट किया गया लाइन वर्गीकरण (उदा. `mobile`)।
reason_codes:
type: array
items:
type: object
properties:
code:
type: string
description: >-
सिग्नल का स्थिर Didit पहचानकर्ता, उदाहरण के लिए `IR-5AC67A32`।
अपारदर्शी: इसके आधार पर समूह बनाएँ और फ़िल्टर करें, इसे पार्स
न करें।
value:
nullable: true
description: >-
जोखिम फ़्लैग के लिए (उदाहरण के लिए `voip`, `leaked`,
`disposable`, `spam_trap`), इसका मान: एक बूलियन, एक स्तर या एक
तिथि। स्कोर्ड कारण कोड के लिए नल।
direction:
type: string
enum:
- risk
- trust
description: क्या सिग्नल ने जोखिम बढ़ाया या विश्वास जोड़ा।
message:
type: string
description: सिग्नल का मानव-पठनीय स्पष्टीकरण, अंग्रेज़ी में।
impact_level:
type: string
nullable: true
description: >-
सिग्नल ने स्कोर को कितनी दृढ़ता से प्रभावित किया, उदाहरण के
लिए `low`, `medium` या `high`।
description: >-
स्कोर की व्याख्या करने वाले सिग्नल, प्रत्येक एक स्थिर Didit कोड, एक
दिशा, एक संदेश और एक प्रभाव स्तर के साथ। समय के साथ नए कोड दिखाई दे
सकते हैं, इसलिए अज्ञात कोड को अस्वीकार न करें।
PhoneSocialFootprint:
type: object
nullable: true
description: >-
फ़ोन नंबर का सोशल फ़ुटप्रिंट: वे ऑनलाइन प्लेटफ़ॉर्म जिन पर यह पंजीकृत
है। केवल तभी मौजूद होता है जब `enable_social` सेट किया गया था और जांच
पूरी हो गई थी। प्रत्येक संख्या शून्य हो सकती है यदि इसके लिए कोई डेटा
वापस नहीं आया। `profiles_registered: 0` का अर्थ है कि प्लेटफ़ॉर्म की
जांच की गई थी और उनमें से किसी पर भी फ़ोन नंबर नहीं मिला - एक मान्य, बिल
योग्य उत्तर और एक सामान्य सिंथेटिक-पहचान संकेत।
properties:
profiles_registered:
type: integer
nullable: true
description: वे प्लेटफ़ॉर्म जहाँ फ़ोन नंबर के पंजीकृत होने की पुष्टि हुई है।
example: 5
profiles_checked:
type: integer
nullable: true
description: पंजीकरण के लिए मूल्यांकन किए गए प्लेटफ़ॉर्म।
example: 14
names_found:
type: integer
nullable: true
description: वे प्लेटफ़ॉर्म जिन्होंने संबद्ध नाम लौटाया।
example: 0
photos_found:
type: integer
nullable: true
description: वे प्लेटफ़ॉर्म जिन्होंने प्रोफ़ाइल फ़ोटो लौटाई।
example: 0
communication_breadth:
type: integer
nullable: true
description: संचार प्लेटफ़ॉर्म जिनमें उपस्थिति का पता चला है।
example: 2
digital_footprint_diversity:
type: integer
nullable: true
description: संसूचित उपस्थिति वाली विशिष्ट प्लेटफ़ॉर्म श्रेणियां।
example: 5
digital_sophistication_index:
type: integer
nullable: true
description: कंपोजिट डिजिटल-परिपक्वता संकेतक, 0-10।
example: 5
engagement_depth_index:
type: integer
nullable: true
description: प्रोफ़ाइल-समृद्धि संकेतक, 0-10।
example: 3
subscription_affordability_index:
type: integer
nullable: true
description: निःशुल्क बनाम सशुल्क प्लेटफ़ॉर्म मिक्स, 0-10।
example: 2
free_platforms:
type: integer
nullable: true
description: निःशुल्क प्लेटफ़ॉर्म पर पंजीकरण।
example: 4
full_paid_platforms:
type: integer
nullable: true
description: पूरी तरह से भुगतान वाले प्लेटफ़ॉर्म पर पंजीकरण।
example: 0
partial_paid_platforms:
type: integer
nullable: true
description: फ़्रीमियम प्लेटफ़ॉर्म पर पंजीकरण।
example: 1
whatsapp_profile_completeness:
type: string
nullable: true
enum:
- Basic
- Partial
- Complete
- Not Present
- null
description: WhatsApp प्रोफ़ाइल की पूर्णता। केवल फ़ोन; ईमेल के लिए null।
example: Partial
registered_platforms:
type: array
description: वे प्लेटफ़ॉर्म जहाँ पंजीकरण की पुष्टि हुई है।
items:
$ref: '#/components/schemas/SocialFootprintPlatform'
not_registered_platforms:
type: array
description: नकारात्मक परिणाम के साथ जाँचे गए प्लेटफ़ॉर्म।
items:
$ref: '#/components/schemas/SocialFootprintPlatform'
categories:
type: object
description: प्रति प्लेटफ़ॉर्म श्रेणी पंजीकृत संख्या और अनुपात।
additionalProperties:
$ref: '#/components/schemas/SocialFootprintCategorySummary'
profiles:
type: object
description: >-
प्रति-प्लेटफ़ॉर्म प्रोफ़ाइल विवरण, प्लेटफ़ॉर्म द्वारा की-बद्ध, जब
प्लेटफ़ॉर्म उन्हें प्रदर्शित करता है।
additionalProperties:
$ref: '#/components/schemas/SocialFootprintProfile'
EmailIntelligence:
type: object
description: >-
सामान्यीकृत ईमेल-इंटेलिजेंस ब्लॉक। केवल तभी मौजूद होता है जब इस ईमेल के
लिए इंटेलिजेंस ऐड-ऑन चला हो; मौजूद होने पर इसे समान मानों के साथ
`enrichment` उपनाम के रूप में भी दिखाया जाता है।
properties:
score:
type: number
nullable: true
description: सामान्यीकृत 0-100 जोखिम स्कोर। उच्च मान अधिक जोखिम भरा होता है।
deliverable:
type: string
nullable: true
description: डिलीवरी क्षमता बैंड (उदा., `high`)।
breach_risk_level:
type: string
nullable: true
description: '`Low`, `Medium` या `High`।'
breach_risk_index:
type: number
nullable: true
description: संख्यात्मक उल्लंघन-जोखिम सूचकांक।
is_recent_breach:
type: boolean
nullable: true
description: '`true` जब पता किसी हालिया ब्रीच में दिखाई देता है।'
is_frequent_breached:
type: boolean
nullable: true
description: '`true` जब पता कई ब्रीच में दिखाई देता है।'
is_disposable:
type: boolean
nullable: true
description: '`true` जब डोमेन एक थ्रोअवे प्रदाता हो।'
is_free_domain:
type: boolean
nullable: true
description: '`true` जब डोमेन एक मुफ़्त मेल प्रदाता हो।'
is_breached:
type: boolean
nullable: true
description: '`true` जब पता ज्ञात ब्रीच में दिखाई देता है।'
no_of_breaches:
type: number
nullable: true
description: इस पते को शामिल करने वाले ज्ञात डेटा उल्लंघनों की संख्या।
reason_codes:
type: array
items:
type: object
properties:
code:
type: string
description: >-
सिग्नल का स्थिर Didit पहचानकर्ता, उदाहरण के लिए `IR-5AC67A32`।
अपारदर्शी: इसके आधार पर समूह बनाएँ और फ़िल्टर करें, इसे पार्स
न करें।
value:
nullable: true
description: >-
जोखिम फ़्लैग के लिए (उदाहरण के लिए `voip`, `leaked`,
`disposable`, `spam_trap`), इसका मान: एक बूलियन, एक स्तर या एक
तिथि। स्कोर्ड कारण कोड के लिए नल।
direction:
type: string
enum:
- risk
- trust
description: क्या सिग्नल ने जोखिम बढ़ाया या विश्वास जोड़ा।
message:
type: string
description: सिग्नल का मानव-पठनीय स्पष्टीकरण, अंग्रेज़ी में।
impact_level:
type: string
nullable: true
description: >-
सिग्नल ने स्कोर को कितनी दृढ़ता से प्रभावित किया, उदाहरण के
लिए `low`, `medium` या `high`।
description: >-
स्कोर की व्याख्या करने वाले सिग्नल, प्रत्येक एक स्थिर Didit कोड, एक
दिशा, एक संदेश और एक प्रभाव स्तर के साथ। समय के साथ नए कोड दिखाई दे
सकते हैं, इसलिए अज्ञात कोड को अस्वीकार न करें।
EmailSocialFootprint:
type: object
nullable: true
description: >-
ईमेल पते का सोशल फ़ुटप्रिंट: वे ऑनलाइन प्लेटफ़ॉर्म जिन पर यह पंजीकृत है।
केवल तभी मौजूद होता है जब `enable_social` सेट किया गया था और जांच पूरी
हो गई थी। प्रत्येक संख्या शून्य हो सकती है यदि इसके लिए कोई डेटा वापस
नहीं आया। `profiles_registered: 0` का अर्थ है कि प्लेटफ़ॉर्म की जांच की
गई थी और उनमें से किसी पर भी ईमेल पता नहीं मिला - एक मान्य, बिल योग्य
उत्तर और एक सामान्य सिंथेटिक-पहचान संकेत।
properties:
profiles_registered:
type: integer
nullable: true
description: वे प्लेटफ़ॉर्म जहाँ ईमेल पते के पंजीकृत होने की पुष्टि हुई है।
example: 5
profiles_checked:
type: integer
nullable: true
description: पंजीकरण के लिए मूल्यांकन किए गए प्लेटफ़ॉर्म।
example: 14
names_found:
type: integer
nullable: true
description: वे प्लेटफ़ॉर्म जिन्होंने संबद्ध नाम लौटाया।
example: 0
photos_found:
type: integer
nullable: true
description: वे प्लेटफ़ॉर्म जिन्होंने प्रोफ़ाइल फ़ोटो लौटाई।
example: 0
communication_breadth:
type: integer
nullable: true
description: संचार प्लेटफ़ॉर्म जिनमें उपस्थिति का पता चला है।
example: 2
digital_footprint_diversity:
type: integer
nullable: true
description: संसूचित उपस्थिति वाली विशिष्ट प्लेटफ़ॉर्म श्रेणियां।
example: 5
digital_sophistication_index:
type: integer
nullable: true
description: कंपोजिट डिजिटल-परिपक्वता संकेतक, 0-10।
example: 5
engagement_depth_index:
type: integer
nullable: true
description: प्रोफ़ाइल-समृद्धि संकेतक, 0-10।
example: 3
subscription_affordability_index:
type: integer
nullable: true
description: निःशुल्क बनाम सशुल्क प्लेटफ़ॉर्म मिक्स, 0-10।
example: 2
free_platforms:
type: integer
nullable: true
description: निःशुल्क प्लेटफ़ॉर्म पर पंजीकरण।
example: 4
full_paid_platforms:
type: integer
nullable: true
description: पूरी तरह से भुगतान वाले प्लेटफ़ॉर्म पर पंजीकरण।
example: 0
partial_paid_platforms:
type: integer
nullable: true
description: फ़्रीमियम प्लेटफ़ॉर्म पर पंजीकरण।
example: 1
whatsapp_profile_completeness:
type: string
nullable: true
enum:
- Basic
- Partial
- Complete
- Not Present
- null
description: WhatsApp प्रोफ़ाइल की पूर्णता। केवल फ़ोन; ईमेल के लिए null।
example: Partial
registered_platforms:
type: array
description: वे प्लेटफ़ॉर्म जहाँ पंजीकरण की पुष्टि हुई है।
items:
$ref: '#/components/schemas/SocialFootprintPlatform'
not_registered_platforms:
type: array
description: नकारात्मक परिणाम के साथ जाँचे गए प्लेटफ़ॉर्म।
items:
$ref: '#/components/schemas/SocialFootprintPlatform'
categories:
type: object
description: प्रति प्लेटफ़ॉर्म श्रेणी पंजीकृत संख्या और अनुपात।
additionalProperties:
$ref: '#/components/schemas/SocialFootprintCategorySummary'
profiles:
type: object
description: >-
प्रति-प्लेटफ़ॉर्म प्रोफ़ाइल विवरण, प्लेटफ़ॉर्म द्वारा की-बद्ध, जब
प्लेटफ़ॉर्म उन्हें प्रदर्शित करता है।
additionalProperties:
$ref: '#/components/schemas/SocialFootprintProfile'
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: >-
पहचाना गया सिम्बोलॉजी, उदाहरण के लिए `QR_CODE`, `CODE_128`,
`EAN_13`, `DATA_MATRIX`, या `PDF_417`।
page_number:
type: integer
minimum: 1
description: 1-आधारित पेज संख्या।
position:
type: array
nullable: true
description: >-
रेंडर किए गए पेज के पिक्सेल निर्देशांक में पहचाना गया बहुभुज। कोई
विश्वसनीय स्थान उपलब्ध न होने पर `null`।
items:
type: array
minItems: 2
maxItems: 2
items:
type: integer
x:
type: integer
nullable: true
description: रेंडर किए गए पेज पिक्सेल में बाउंडिंग बॉक्स का बायाँ किनारा।
'y':
type: integer
nullable: true
description: रेंडर किए गए पेज के पिक्सेल में बाउंडिंग बॉक्स का ऊपरी किनारा।
width:
type: integer
nullable: true
description: रेंडर किए गए पेज के पिक्सल में बाउंडिंग-बॉक्स की चौड़ाई।
height:
type: integer
nullable: true
description: रेंडर किए गए पेज के पिक्सल में बाउंडिंग-बॉक्स की ऊंचाई।
page_width:
type: integer
description: रेंडर किए गए पेज की चौड़ाई पिक्सेल में।
page_height:
type: integer
description: रेंडर किए गए पेज की ऊंचाई पिक्सेल में।
raw_payload:
type: string
description: >-
उपलब्ध होने पर base64 स्ट्रिंग के रूप में रॉ डिकोडर payload; अन्यथा
एक खाली स्ट्रिंग।
parsed_payload:
nullable: true
description: >-
डिकोड की गई स्ट्रिंग या संरचित मान। `null` जब कोड का पता चला था
लेकिन उसे डिकोड नहीं किया जा सका।
BankVerificationResult:
type: object
description: >-
उपयोगकर्ता और व्यवसाय सत्यापन के लिए एक बैंक सत्यापन चरण का परिणाम।
`method` बताता है कि खाते का सत्यापन कैसे किया गया था, और `none` कि
व्यक्ति ने किसी भी प्रयास का मूल्यांकन किए जाने से पहले बैंक के बिना
जारी रखा। `continued_without_bank` बताता है कि व्यक्ति ने बैंक के बिना
जारी रखा, मूल्यांकन किए गए प्रयास के बाद भी। देखें [बैंक सत्यापन
विधियाँ](/hi/core-technology/bank-verification/verification-methods) और
[जब व्यक्ति अपने बैंक का सत्यापन नहीं कर
सकता](/hi/core-technology/bank-verification/fallbacks)।
properties:
schema_version:
type: integer
description: इस परिणाम संरचना का संस्करण। वर्तमान में `1`।
bank_verification_id:
type: string
format: uuid
description: इस परिणाम की ID।
node_id:
type: string
description: वर्कफ़्लो नोड जिससे यह परिणाम संबंधित है।
status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Expired
description: अपनी कार्रवाइयों और स्थिति नियमों के बाद, चरण का निर्णय।
original_status:
type: string
nullable: true
description: >-
चरण द्वारा निकाला गया पहला निर्णय, किसी भी बाद के परिवर्तन जैसे कि
मैन्युअल समीक्षा से पहले।
method:
type: string
nullable: true
enum:
- open_banking
- account_lookup
- microdeposits
- statement
- none
description: >-
खाते को कैसे सत्यापित किया गया: `open_banking` (बैंक साइन-इन:
व्यक्ति ने अपने बैंक में साइन इन किया), `account_lookup` (खाता जांच:
व्यक्ति ने खाता विवरण टाइप किया और बैंक ने नाम की पुष्टि की),
`microdeposits` या `statement` (विवरण अपलोड)। `none` जब किसी भी
प्रयास का मूल्यांकन होने से पहले व्यक्ति बैंक के बिना आगे बढ़ गया,
इसलिए कोई खाता सत्यापित नहीं हुआ। मूल्यांकन किए गए प्रयास के बाद, यह
उस प्रयास की विधि बनी रहती है। किसी खाते का मूल्यांकन होने तक, और जब
वर्कफ़्लो अपने द्वारा लौटाए जाने वाले डेटा को सीमित करता है, तब
`null` रहता है। वर्कफ़्लो नियम `bank.method` के समान मान पढ़ते हैं।
provider:
type: string
nullable: true
description: >-
उस रूट की कुंजी जिसने कनेक्शन चलाया। खाता कैसे सत्यापित किया गया था,
यह जानने के लिए इस कुंजी को नहीं, बल्कि `method` को पढ़ें।
credential_source:
type: string
nullable: true
enum:
- native
- byok
description: >-
`native`: Didit का अपना रूट, जिसका बिल आपके Didit बैलेंस से लिया
जाता है। `byok`: एक मार्केटप्लेस प्रदाता जिसे आपने अपने
क्रेडेंशियल्स से कनेक्ट किया है।
route:
type: object
nullable: true
description: सहमति से पहले चुना गया रूट। यह बाद में कभी नहीं बदलता है।
properties:
provider_key:
type: string
nullable: true
description: रूट की कुंजी।
credential_source:
type: string
enum:
- native
- byok
is_fallback:
type: boolean
description: >-
क्या Didit का अपना रूट किसी ऐसे मार्केटप्लेस प्रदाता के स्थान पर
प्रयुक्त हुआ जो कनेक्ट नहीं हो सका।
provider_connection_id:
type: string
nullable: true
description: '`byok` के लिए उपयोग किया गया मार्केटप्लेस कनेक्शन।'
requested_scopes:
type: array
items:
type: string
description: >-
कनेक्शन द्वारा अनुरोधित डेटा, उदाहरण के लिए `ownership` या
`balances`।
connection:
type: object
nullable: true
description: नवीनतम प्रयास का कनेक्शन। पहले प्रयास से पहले `null`।
properties:
status:
type: string
enum:
- pending
- connected
- cancelled
- timeout
- failed
- unsupported
- revoked
- expired
institution_id:
type: string
nullable: true
description: >-
बैंक की ID। खाता जांच के लिए `null`, जहाँ कोई बैंक नहीं चुना गया
है।
institution_name:
type: string
nullable: true
description: बैंक का नाम। खाता जांच के लिए `null`।
institution_country:
type: string
nullable: true
description: खाते का देश, ISO 3166-1 alpha-3।
oauth:
type: boolean
nullable: true
description: >-
क्या बैंक साइन-इन OAuth या ऐप-टू-ऐप पर चला था। खाता जाँच के लिए
`null`।
connected_at:
type: string
format: date-time
nullable: true
description: जब कनेक्शन सफल हुआ था।
consent_expires_at:
type: string
format: date-time
nullable: true
description: बैंक साइन-इन के लिए, बैंक सहमति कब समाप्त होती है।
last_refreshed_at:
type: string
format: date-time
nullable: true
description: जब वित्तीय डेटा अंतिम बार पुनः पढ़ा गया था।
attempts:
type: integer
description: व्यक्ति द्वारा इस चरण पर किए गए प्रयास, हर विधि को मिलाकर।
reason_code:
type: string
nullable: true
description: >-
कनेक्शन केवल `connected` क्यों नहीं है, उदाहरण के लिए
`USER_CANCELLED`, `INSTITUTION_DOWN`, `ACCOUNT_NOT_FOUND`,
`REFERENCE_IDENTITY_MISSING` या `VERIFICATION_COMPLETED`।
account:
type: object
nullable: true
description: >-
मूल्यांकित खाता। जब तक किसी खाते का मूल्यांकन नहीं हो जाता तब तक
`null`।
properties:
account_id_masked:
type: string
nullable: true
description: खाता संख्या, मास्क की गई।
iban_masked:
type: string
nullable: true
description: IBAN, मास्क किया गया।
sort_code:
type: string
nullable: true
description: यूनाइटेड किंगडम में सॉर्ट कोड।
routing_number_masked:
type: string
nullable: true
description: राउटिंग नंबर, मास्क किया गया।
type:
type: string
nullable: true
enum:
- checking
- current
- savings
- business
- other
subtype:
type: string
nullable: true
description: बैंक का अपना खाता उपप्रकार।
currency:
type: string
nullable: true
description: खाते की ISO 4217 करेंसी।
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: >-
सत्यापित पहचान के साथ खाताधारक की तुलना कैसे की गई। किसी खाते का
मूल्यांकन होने तक `null`।
properties:
result:
type: string
enum:
- match
- partial_match
- no_match
- unknown
- not_verifiable
description: >-
`partial_match` एक करीबी मिलान है। `not_verifiable`: बैंक ने ऐसा
उत्तर दिया जिसमें तुलना करने के लिए कोई खाताधारक नहीं था।
`unknown`: साक्ष्य पढ़ा नहीं जा सका, या तुलना करने के लिए कोई
पहचान नहीं थी।
reference_identity_source:
type: string
nullable: true
description: >-
वह चरण जिसकी पहचान से धारक की तुलना की गई थी: `kyc`,
`database_validation`, `expected_details`, `questionnaire`,
`document_ai` या `kyb`।
name_score:
type: integer
minimum: 0
maximum: 100
nullable: true
description: Didit का धारक नाम स्कोर।
provider_name_score:
type: integer
minimum: 0
maximum: 100
nullable: true
description: बैंक का अपना खाताधारक नाम स्कोर, जब उसने एक लौटाया हो।
address_score:
type: integer
minimum: 0
maximum: 100
nullable: true
description: धारक के पते का स्कोर, जब पता मिलान चलाया गया हो।
email_score:
type: integer
minimum: 0
maximum: 100
nullable: true
description: धारक के ईमेल का स्कोर, जब ईमेल मिलान चलाया गया हो।
phone_score:
type: integer
minimum: 0
maximum: 100
nullable: true
description: धारक के फ़ोन का स्कोर, जब फ़ोन मिलान चलाया गया हो।
dob_score:
type: integer
minimum: 0
maximum: 100
nullable: true
description: धारक की जन्म तिथि का स्कोर, जब बैंक ने इसे साझा किया हो।
close_match:
type: boolean
nullable: true
description: क्या नाम क्लोज़-मैच बैंड में आया।
holder_confirmation:
type: string
nullable: true
enum:
- pending
- confirmed
- rejected
description: >-
करीबी मिलान वाले नाम की पुष्टि करने के लिए पूछे जाने पर व्यक्ति
का उत्तर। पूछे न जाने पर `null`।
method:
type: string
nullable: true
enum:
- exact
- token_set
- nickname
- transliteration
- fuzzy
- provider_only
- microdeposits
description: >-
किस नाम तुलना ने स्कोर उत्पन्न किया। यह सत्यापन विधि नहीं है:
उसके लिए शीर्ष-स्तरीय `method` पढ़ें।
matched_holder_index:
type: integer
nullable: true
holders:
type: array
items:
type: object
description: बैंक द्वारा सूचीबद्ध प्रत्येक धारक, उसके स्कोर के साथ।
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: निर्णय की गणना कब की गई थी।
financial_data:
type: object
description: वित्तीय डेटा जो चरण ने पढ़ा। केवल बैंक साइन-इन इसे पढ़ता है।
properties:
balances:
type: object
nullable: true
description: '`balances` स्कोप के साथ।'
transactions:
type: object
nullable: true
description: '`transactions` स्कोप के साथ।'
income:
type: object
nullable: true
description: '`income` स्कोप के साथ।'
categorization:
type: object
nullable: true
description: पढ़े गए लेन-देन का Didit द्वारा वर्गीकरण। उनके बिना `null`।
not_collected:
type: array
items:
type: string
enum:
- balances
- income
- transactions
description: >-
चरण द्वारा अनुरोधित डेटा जिसे खाते को सत्यापित करने वाली विधि
द्वारा एकत्र नहीं किया जाता है। बैलेंस, लेन-देन और आय केवल बैंक
साइन-इन से आते हैं, इसलिए खाता जांच द्वारा सत्यापित खाता उन्हें
यहाँ सूचीबद्ध करता है। यह कभी विफलता नहीं होती। अन्यथा खाली।
billing:
type: object
nullable: true
properties:
route:
type: string
enum:
- native
- byok
billed:
type: boolean
marketplace_fee:
type: string
nullable: true
description: '`byok` के लिए लिया गया मार्केटप्लेस प्लेटफॉर्म शुल्क।'
usage_type:
type: string
nullable: true
description: >-
उपयोग पंक्ति जिस पर शुल्क बुक किया गया था: बैंक साइन-इन या खाता
जाँच के लिए `bank_verification`, जिससे पहले कोई शुल्क वाला बैंक
प्रयास न हुआ हो ऐसे स्टेटमेंट अपलोड के लिए
`bank_statement_upload`, और आपके अपने प्रदाता पर मार्केटप्लेस
शुल्क के लिए `bank_byok_fee`। कुछ भी बिल न किए जाने पर `null`।
reference_identity:
type: object
nullable: true
description: वह पहचान जिससे धारक की तुलना की गई थी, उसके स्रोत के साथ।
signals:
type: object
nullable: true
description: लेन-देन इतिहास से पढ़े गए खाता सिग्नल, जब चरण ने किसी को पढ़ा हो।
connection_abandoned:
type: boolean
nullable: true
description: >-
क्या व्यक्ति द्वारा अपने बैंक में प्रक्रिया छोड़ने के बाद यह चरण
बिना किसी मिलान के समाप्त हो गया।
not_covered:
type: boolean
nullable: true
description: >-
क्या इस चरण पर व्यक्ति के बैंक या देश तक नहीं पहुँचा जा सका। तब भी
`true` होता है जब व्यक्ति बिना बैंक के आगे बढ़ा क्योंकि कोई भी तरीका
उसके देश या बैंक को सत्यापित नहीं कर सका।
continued_without_bank:
type: boolean
description: >-
क्या व्यक्ति ने **Continue without your bank** के साथ चरण छोड़ दिया।
`continuation` तब कारण बताता है। जब उनके आगे बढ़ने से पहले किसी भी
प्रयास का मूल्यांकन नहीं किया गया था, तो `method` `none` होता है।
किसी मूल्यांकित प्रयास के बाद, जैसे कि ऐसा खाताधारक जो मेल नहीं
खाता, `method` उस प्रयास का तरीका बना रहता है और उसका निर्णय तथा
कारण कोड मान्य रहते हैं। यह तब भी वापस किया जाता है जब वर्कफ़्लो
अपने द्वारा लौटाए जाने वाले डेटा को सीमित करता है।
continuation:
type: object
nullable: true
description: >-
व्यक्ति बैंक के बिना कैसे आगे बढ़ा। जब वे आगे नहीं बढ़े तो `null`।
जब वर्कफ़्लो अपने द्वारा लौटाए जाने वाले डेटा को सीमित करता है, तब
भी `reason` लौटाया जाता है और प्रत्येक अन्य कुंजी `null` होती है।
properties:
reason:
type: string
enum:
- no_route
- institution_unsupported
- attempts_exhausted
- person_choice
description: >-
कारण, जैसा कि Didit ने व्यक्ति के आगे बढ़ने पर निर्धारित किया:
`no_route` (कोई भी बैंक साइन-इन या खाता जाँच उनके देश में सेवा
नहीं देती है), `institution_unsupported` (उनके द्वारा चुने गए
बैंक का उपयोग इस चरण पर नहीं किया जा सकता है),
`attempts_exhausted` (प्रत्येक प्रयास पहले ही समाप्त हो चुका था
और कोई भी जारी नहीं था), या `person_choice` (सत्यापन का एक तरीका
उपलब्ध था और उन्होंने आगे बढ़ना चुना, तब भी जब उनके बैंक से अभी
संपर्क नहीं हो सका)। `no_route` और `institution_unsupported`
`bank_unsupported_action` का पालन करते हैं, `attempts_exhausted`
`bank_attempts_exhausted_action` का पालन करता है, और
`person_choice` `bank_skipped_action` का पालन करता है, जब तक कि
किसी मूल्यांकित प्रयास ने पहले ही चरण का निर्णय न ले लिया हो।
country:
type: string
nullable: true
description: >-
वह देश जहाँ व्यक्ति सत्यापन कर रहा था, ISO 3166-1 alpha-3।
`null` यदि वे किसी देश को चुने बिना आगे बढ़ गए।
offered:
type: array
items:
type: string
enum:
- statement
- microdeposits
nullable: true
description: >-
व्यक्ति द्वारा आगे बढ़ने पर उस देश को सत्यापित करने के अन्य
तरीके जो पेश किए गए थे, जिस क्रम में वे पेश किए गए थे:
`statement` (एक स्टेटमेंट अपलोड), फिर `microdeposits`। कुछ भी
पेश न किए जाने पर खाली।
institution_id:
type: string
nullable: true
description: >-
`institution_unsupported` के लिए, उस बैंक की ID जिसका उपयोग
व्यक्ति नहीं कर सका: वह बैंक जिसे उन्होंने चुना था, या वह बैंक
जिस पर उनका अंतिम प्रयास समाप्त हुआ था। Didit इसे बैंकों की अपनी
सूची से लेता है, व्यक्ति के डिवाइस से कभी नहीं, इसलिए जो बैंक उस
सूची में नहीं है वह `null` होता है। अन्य सभी कारणों के लिए
`null`।
institution_name:
type: string
nullable: true
description: >-
`institution_unsupported` के लिए, उस बैंक का नाम,
`institution_id` जैसी ही सूची से। `null` जब उस सूची में बैंक
नहीं होता है, और अन्य सभी कारणों के लिए भी।
continued_at:
type: string
format: date-time
nullable: true
description: व्यक्ति कब आगे बढ़ा।
evidence_purged_at:
type: string
format: date-time
nullable: true
description: >-
जब बैंक साक्ष्य को `bank_evidence_retention_days` के तहत हटा दिया
गया था। अन्यथा `null`।
warnings:
type: array
items:
type: string
description: >-
सूचनात्मक कोड, उदाहरण के लिए `holder_declared`। एक चेतावनी कभी भी
अपने दम पर स्थिति नहीं बदलती है।
reason_codes:
type: array
items:
type: string
description: >-
निर्णय वैसा क्यों आया जैसा आया, उदाहरण के लिए `OWNER_NAME_PARTIAL`।
कई लागू हो सकते हैं। `NOT_COVERED`: व्यक्ति बिना बैंक के आगे बढ़ा
क्योंकि कोई भी विधि उनके देश या बैंक को सत्यापित नहीं कर सकी।
`SKIPPED`: व्यक्ति ने बिना बैंक के आगे बढ़ने का विकल्प चुना जबकि
सत्यापित करने का एक तरीका उपलब्ध था। जब किसी मूल्यांकित प्रयास ने
पहले ही चरण का निर्णय ले लिया हो, तो इनमें से कोई भी नहीं जोड़ा जाता
है।
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
SignatureResult:
type: object
description: >-
एक ई-हस्ताक्षर चरण के लिए एक हस्ताक्षरकर्ता का परिणाम। [ई-हस्ताक्षर
रिपोर्ट](/hi/core-technology/electronic-signature/report-electronic-signature)
देखें।
properties:
id:
type: string
format: uuid
description: >-
इस हस्ताक्षरकर्ता के साक्ष्य डाउनलोड करने या उनके हस्ताक्षर को मान्य
करने के लिए इसे `signature_id` के रूप में पास करें।
node_id:
type: string
description: वर्कफ़्लो चरण जिसने इसे उत्पन्न किया।
status:
type: string
enum:
- intro
- review
- code
- signing
- signed
- declined
description: >-
चरण में हस्ताक्षरकर्ता कहाँ है। केवल `signed` का अर्थ है कि
दस्तावेज़ हस्ताक्षरित हैं।
verdict:
type: string
enum:
- Not Finished
- Approved
- In Review
- Declined
description: >-
चरण का परिणाम। एक चेतावनी इसे अपने नियम के माध्यम से सेट करती है;
कस्टम स्थिति नियम बाद में लागू होते हैं।
level:
type: string
enum:
- simple
- aes
- qes
description: >-
`simple` (डिफ़ॉल्ट) या `aes`। `qes` (क्वालिफ़ाइड इलेक्ट्रॉनिक
सिग्नेचर, QES) एक ऐड-ऑन है जो अभी उपलब्ध नहीं है।
format:
type: string
enum:
- pdf
- pades
description: Simple हस्ताक्षर के लिए `pdf`, Advanced (AES) के लिए `pades`।
profile:
type: string
nullable: true
description: Advanced (AES) हस्ताक्षर हो जाने पर `PAdES-B-LT`, अन्यथा null।
signer:
type: object
properties:
name:
type: string
nullable: true
description: >-
हस्ताक्षरकर्ता का नाम। सत्यापित (स्वीकृत पहचान सत्यापन या सत्र
से), सिवाय सत्यापित सत्र नाम के बिना Simple स्तर के, जहाँ यह वह
नाम होता है जिसे हस्ताक्षरकर्ता ने टाइप किया था और यह सत्यापित
नहीं होता है।
capacity:
type: string
enum:
- self
- company
company:
type: string
nullable: true
role:
type: string
nullable: true
description: प्रमुख व्यक्ति का पदनाम, जैसा कि घोषित किया गया है।
roles:
type: array
items:
type: string
description: कंपनी के लिए घोषित प्रमुख व्यक्ति की संरचित भूमिकाएँ।
identity_session_id:
type: string
format: uuid
description: वह KYC सत्र जिसमें हस्ताक्षरकर्ता का सत्यापन हुआ था।
identity_used:
type: object
description: >-
सत्यापित पहचान जिस पर हस्ताक्षर निर्भर करता है। बिना किसी सत्यापित
पहचान वाले Simple हस्ताक्षर के लिए खाली।
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: वह नाम जिससे हस्ताक्षरकर्ता का मिलान होना था।
certificate:
type: object
nullable: true
description: >-
वह प्रमाणपत्र जिसके साथ दस्तावेज़ों पर हस्ताक्षर किए गए थे।
हस्ताक्षरित होने तक `null`, और सरल हस्ताक्षर के लिए हमेशा `null`।
properties:
issuer:
type: string
issued_to:
type: string
serial:
type: string
description: सीरियल नंबर, हेक्साडेसिमल।
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: Simple हस्ताक्षर के लिए `null`, जिसमें कोई कोड नहीं होता है।
destination:
type: string
nullable: true
description: मास्क किया गया संपर्क जिस पर कोड भेजा गया था।
confirmed_at:
type: string
format: date-time
nullable: true
attempts:
type: integer
description: दर्ज किए गए कोड, सही कोड सहित।
timestamp:
type: object
nullable: true
description: >-
हस्ताक्षर में RFC 3161 टाइमस्टैम्प, जो Didit द्वारा जारी किया गया
है। हस्ताक्षर होने तक `null`, और Simple हस्ताक्षर के लिए हमेशा
`null`।
properties:
time:
type: string
format: date-time
qualified:
type: boolean
description: AES के लिए हमेशा `false`।
valid:
type: boolean
documents:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
description: >-
इस हस्ताक्षरकर्ता की प्रति पर मौजूद दस्तावेज़। हस्ताक्षरित
फ़ाइल डाउनलोड करने के लिए इसका उपयोग करें।
uuid:
type: string
format: uuid
description: '`id` के समान।'
title:
type: string
file_name:
type: string
pages:
type: integer
description: >-
हस्ताक्षरित दस्तावेज़ के पेज। Word के लिए, कनवर्ट किए गए PDF
के।
size_bytes:
type: integer
sha256_original:
type: string
description: दस्तावेज़ का SHA-256 जैसा कि हस्ताक्षरकर्ता को दिखाया गया था।
sha256_signed:
type: string
nullable: true
description: हस्ताक्षरित PDF का SHA-256, एक बार हस्ताक्षरित होने के बाद।
status:
type: string
enum:
- signed
- declined
- not_signed
- not_reached
description: >-
`not_signed`: खोला गया लेकिन हस्ताक्षर नहीं किए गए।
`not_reached`: कभी नहीं खोला गया।
opened_at:
type: string
format: date-time
nullable: true
read_at:
type: string
format: date-time
nullable: true
description: >-
हस्ताक्षरकर्ता फ़ील्ड रहित दस्तावेज़ के अंत तक कब पहुँचा, जब
चरण के लिए यह आवश्यक हो।
read_to_end:
type: boolean
consented_at:
type: string
format: date-time
nullable: true
description: >-
हस्ताक्षरकर्ता फ़ील्ड रहित दस्तावेज़ पर कब सहमत हुआ, या फ़ील्ड
वाले दस्तावेज़ के फ़ील्ड कब पूरे किए।
consent:
type: boolean
signed_file:
type: string
nullable: true
description: >-
हस्ताक्षरित PDF का पाथ, एक बार हस्ताक्षर होने के बाद। देखें
[हस्ताक्षरित दस्तावेज़ डाउनलोड
करें](/hi/sessions-api/electronic-signature/download-signed-document)।
mode:
type: string
enum:
- fields
- read_and_agree
description: >-
फ़ील्ड वाले दस्तावेज़ के लिए `fields`, बिना फ़ील्ड वाले
दस्तावेज़ के लिए `read_and_agree`।
source_format:
type: string
enum:
- pdf
- docx
description: >-
`pdf`, या Word दस्तावेज़ के लिए `docx` जिसे Didit ने PDF में
रूपांतरित किया।
conversion:
type: object
nullable: true
description: >-
PDF के लिए `null`। Word दस्तावेज़ के लिए, मूल फ़ाइल और
कन्वर्ज़न।
properties:
from:
type: string
enum:
- docx
file_name:
type: string
description: आपका मूल Word फ़ाइल नाम।
sha256:
type: string
description: आपकी मूल Word फ़ाइल का SHA-256।
size_bytes:
type: integer
description: आपकी मूल Word फ़ाइल का आकार।
converter:
type: string
description: PDF तैयार करने वाले कनवर्टर का संस्करण।
fields:
type: array
description: >-
दस्तावेज़ पर फ़ील्ड, उनके मानों के साथ। फ़ील्ड रहित दस्तावेज़
के लिए खाली।
items:
$ref: '#/components/schemas/SignatureFieldResult'
adopted_signature:
type: object
nullable: true
description: >-
हस्ताक्षरकर्ता द्वारा हस्ताक्षर और आद्याक्षर फ़ील्ड के लिए अपनाया
गया हस्ताक्षर और आद्याक्षर। हस्ताक्षरकर्ता द्वारा इसे अपनाए जाने तक
`null`।
properties:
method:
type: string
enum:
- typed
- drawn
description: >-
`typed`: हस्तलेखन शैली में सत्यापित नाम। `drawn`: उंगली या माउस
से बनाया गया।
font:
type: string
nullable: true
description: टाइप किए गए हस्ताक्षर की हस्तलेखन शैली। ड्रा किए जाने पर `null`।
adopted_at:
type: string
format: date-time
electronic_signature_consent_at:
type: string
format: date-time
nullable: true
description: >-
समीक्षा स्क्रीन पर हस्ताक्षरकर्ता दस्तावेज़ों पर इलेक्ट्रॉनिक रूप से
हस्ताक्षर करने के लिए कब सहमत हुआ। तब सेट होता है जब किसी भी
दस्तावेज़ में फ़ील्ड हों।
evidence_file:
type: string
nullable: true
description: >-
हस्ताक्षरित होने के बाद साक्ष्य PDF का पथ। देखें [हस्ताक्षर साक्ष्य
डाउनलोड
करें](/hi/sessions-api/electronic-signature/download-evidence)।
warnings:
type: array
description: >-
इस हस्ताक्षरकर्ता के लिए उठाई गई चेतावनियाँ। [ई-हस्ताक्षर
चेतावनियाँ](/hi/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: >-
हस्ताक्षरित दस्तावेज़ों की अंतिम क्रिप्टोग्राफ़िक जाँच। दस्तावेज़ों
पर हस्ताक्षर होने तक `null`। यदि Didit हस्ताक्षर करने के परिणाम की
पुष्टि नहीं कर सकता है, तो यह `{"valid": null, "reason":
"signature_provider_outcome_unknown", "checked_at": ...}` होता है और
`status` `signing` बना रहता है: इसे हस्ताक्षरित न माना जाए।
properties:
valid:
type: boolean
nullable: true
description: >-
`true` जब प्रत्येक दस्तावेज़ मान्य हो। `null` जब हस्ताक्षर के
परिणाम की पुष्टि नहीं की जा सकी।
reason:
type: string
description: >-
तब सेट किया जाता है जब `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` जब हस्ताक्षर और टाइमस्टैम्प दोनों मान्य और
विश्वसनीय हों।
integrity:
type: boolean
description: >-
`true` जब हस्ताक्षर करने के बाद से दस्तावेज़ में कोई बदलाव
नहीं हुआ हो।
trusted:
type: boolean
description: >-
`true` जब हस्ताक्षर प्रमाणपत्र एक विश्वसनीय रूट से जुड़ा
हो।
revoked:
type: boolean
trusted_list:
type: object
description: >-
EU ट्रस्टेड लिस्ट की जाँच। AES के लिए: `{"status":
"not_applicable", "reason": "aes_not_qualified"}`।
properties:
status:
type: string
reason:
type: string
certificate:
type: object
nullable: true
description: >-
वह प्रमाणपत्र जिसके साथ दस्तावेज़ों पर हस्ताक्षर किए गए
थे। हस्ताक्षरित होने तक `null`, और सरल हस्ताक्षर के लिए
हमेशा `null`।
properties:
issuer:
type: string
issued_to:
type: string
serial:
type: string
description: सीरियल नंबर, हेक्साडेसिमल।
valid_from:
type: string
format: date-time
valid_until:
type: string
format: date-time
timestamp:
type: object
nullable: true
description: >-
हस्ताक्षर में RFC 3161 टाइमस्टैम्प, जो Didit द्वारा जारी
किया गया है। हस्ताक्षर होने तक `null`, और Simple हस्ताक्षर
के लिए हमेशा `null`।
properties:
time:
type: string
format: date-time
qualified:
type: boolean
description: AES के लिए हमेशा `false`।
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: हस्ताक्षर लिंक काम करना कब बंद कर देता है।
email_sent_at:
type: string
format: date-time
nullable: true
email_unavailable_reason:
type: string
nullable: true
ip_address:
type: string
nullable: true
description: हस्ताक्षरकर्ता का IP पता जब उन्होंने अपने कोड का अनुरोध किया था।
place:
type: string
nullable: true
description: 'एकत्रित नहीं किया गया: हमेशा `null`।'
place_unavailable_reason:
type: string
nullable: true
enum:
- not_collected
AMLScreening:
type: object
properties:
node_id:
type: string
description: वर्कफ़्लो ग्राफ़ में इस AML चरण के लिए विशिष्ट पहचानकर्ता।
status:
type: string
description: >-
इस AML स्क्रीनिंग की सुविधा-स्तरीय स्थिति। शीर्ष-स्तरीय सत्र
`status` से स्वतंत्र — एक सत्र अपने समग्र निर्णय तक पहुँच सकता है
जबकि एक अलग सुविधा `In Review` रह सकती है।
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
total_hits:
type: integer
description: पाए गए मिलानों की कुल संख्या
entity_type:
type: string
description: 'स्क्रीन किए गए निकाय का प्रकार: व्यक्ति या कंपनी'
hits:
type: array
items:
type: object
properties:
id:
type: string
description: >-
हिट के लिए Didit का स्थायी आइडेंटिफ़ायर: `hit_` के बाद 24
हेक्साडेसिमल वर्ण। विषय की दोबारा स्क्रीनिंग होने पर भी वही
मिलान की गई एंटिटी समान `id` बनाए रखती है। इसे AML हिट समीक्षा
endpoints पर `hit_id` के रूप में पास करें।
url:
type: string
format: uri
description: मिलान के लिए स्रोत URL
match:
type: boolean
description: क्या यह एक पुष्ट मिलान है
score:
type: number
format: float
nullable: true
minimum: 0
maximum: 1
description: >-
0-1 रेंज में बहिष्कृत भारित मिलान स्कोर (उदा. `0.73`)। इसके
बजाय `match_score` (0-100) का उपयोग करें।
deprecated: true
target:
type: boolean
nullable: true
description: >-
क्या मिलान की गई इकाई लिस्टिंग का सीधा लक्ष्य है (संबंधित पक्ष
के विपरीत)। `null` जब स्रोत इसे निर्दिष्ट नहीं करता है।
caption:
type: string
description: मिलान का कैप्शन या शीर्षक
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: >-
डेटासेट श्रेणियों की सूची जहाँ मिलान पाया गया था। इंगित करता
है कि क्या निकाय PEP सूचियों (स्तर के साथ), प्रतिबंध डेटाबेस,
प्रतिकूल मीडिया, चेतावनियों/नियामक प्रवर्तन, या अन्य अनुपालन
डेटासेट में दिखाई दिया है। जब निकाय का स्रोत इनमें से किसी भी
श्रेणी का उल्लेख नहीं करता है, तो `Other Lists`।
features:
type: object
nullable: true
description: मिलान की अतिरिक्त विशेषताएँ
rca_name:
type: string
description: यदि लागू हो तो RCA का नाम
last_seen:
type: string
format: date-time
description: तारीख जब मिलान अंतिम बार देखा गया था
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: तारीख जब मिलान पहली बार देखा गया था
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: >-
नाम समानता, जन्म तिथि और देश मिलान से परिकलित भारित पहचान
विश्वास स्कोर (0-100)। यह निर्धारित करने के लिए उपयोग किया
जाता है कि हिट फ़ॉल्स पॉज़िटिव है या संभावित मिलान।
format: float
nullable: true
risk_score:
type: number
description: >-
इकाई जोखिम स्कोर (0-100)। गैर-फ़ॉल्स पॉज़िटिव हिट्स के बीच
उच्चतम risk_score के आधार पर अंतिम AML स्थिति
(स्वीकृत/समीक्षाधीन/अस्वीकृत) निर्धारित करने के लिए उपयोग किया
जाता है।
review_status:
type: string
description: >-
इस हिट के लिए समीक्षा स्थिति। यह 'Unreviewed', 'Confirmed
Match', 'False Positive', या 'Inconclusive' हो सकती है।
enum:
- Unreviewed
- Confirmed Match
- False Positive
- Inconclusive
score_breakdown:
type: object
description: match_score की गणना कैसे की गई, इसका विस्तृत विवरण।
properties:
name_score:
type: integer
description: रॉ नाम समानता प्रतिशत (0-100)।
name_weight:
type: integer
description: कॉन्फ़िगरेशन से नाम के लिए मूल वेट (0-100)।
name_weight_normalized:
type: number
description: >-
गुम डेटा के लिए पुन: भारण के बाद नाम के लिए सामान्यीकृत
भार (0-100)।
name_contribution:
type: number
description: कुल स्कोर में नाम द्वारा योगदान किए गए अंक।
dob_score:
type: integer
description: जन्म तिथि मिलान स्कोर (-100 से 100)।
dob_weight:
type: integer
description: कॉन्फ़िगरेशन से DOB के लिए मूल वेट (0-100)।
dob_weight_normalized:
type: number
description: >-
गुम डेटा के लिए पुन: भारण के बाद DOB के लिए सामान्यीकृत
भार (0-100)।
dob_contribution:
type: number
description: कुल स्कोर में जन्म तिथि द्वारा योगदान किए गए अंक।
country_score:
type: integer
description: देश मिलान स्कोर (-100 से 100)।
country_weight:
type: integer
description: कॉन्फ़िगरेशन से देश के लिए मूल वेट (0-100)।
country_weight_normalized:
type: number
description: >-
गुम डेटा के लिए पुन: भारण के बाद देश के लिए सामान्यीकृत
भार (0-100)।
country_contribution:
type: number
description: कुल स्कोर में देश द्वारा योगदान किए गए अंक।
document_number_match_type:
type: string
description: दस्तावेज़ संख्या 'Golden Key' मूल्यांकन का परिणाम।
enum:
- MATCH
- NEUTRAL
- HARD_MISMATCH
document_number_effect:
type: string
description: स्कोर पर दस्तावेज़ संख्या के प्रभाव का मानव-पठनीय विवरण।
total_score:
type: integer
description: अंतिम भारित मिलान स्कोर (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: >-
चेतावनी और नियामक प्रवर्तन मिलानों की सूची। इसमें श्रेणियों की
प्रविष्टियाँ शामिल हैं: Warning, SIP, Warnings and Regulatory
Enforcement, Fitness and Probity, SIE, और Insolvency।
items:
type: object
properties:
list_name:
type: string
description: चेतावनी सूची प्रकाशक का नाम
matched_name:
type: string
description: चेतावनी सूची से मेल खाने वाला नाम
description:
type: string
description: चेतावनी प्रविष्टि का विवरण
publisher:
type: string
description: चेतावनी का प्रकाशक या स्रोत
source_url:
type: string
format: uri
description: चेतावनी के स्रोत का URL
other_sources:
type: array
items:
type: string
description: अतिरिक्त स्रोत URL
countries:
type: array
items:
type: string
nullable: true
description: चेतावनी से जुड़े देश
created_at:
type: string
nullable: true
description: चेतावनी प्रविष्टि बनाए जाने की तारीख
updated_at:
type: string
nullable: true
description: चेतावनी प्रविष्टि को अंतिम बार अपडेट किए जाने की तारीख
additional_data:
type: object
description: >-
चेतावनी स्रोत से अतिरिक्त डेटा। इसमें `case_details` ऐरे
के साथ एक `data` ऑब्जेक्ट शामिल हो सकता है।
properties:
data:
type: object
properties:
case_details:
type: array
description: इस मिलान से जुड़े चेतावनी मामलों का विवरण
items:
type: object
properties:
case_type:
type: string
description: चेतावनी केस का प्रकार
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: इस निकाय के लिए पाए गए प्रतिबंध सूची मिलानों की सूची।
items:
type: object
properties:
list_name:
type: array
items:
type: string
nullable: true
description: प्रतिबंध सूची/सूचियों के नाम
matched_name:
type: string
description: प्रतिबंध सूची से मेल खाने वाला नाम
description:
type: string
description: प्रतिबंध प्रविष्टि का विवरण
reason:
type: string
nullable: true
description: >-
मुक्त-पाठ कारण कि इकाई पर प्रतिबंध क्यों लगाया गया था।
प्रतिबंध सूची की कारण प्रविष्टियों से संयोजित। उदाहरण:
'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
other_sources:
type: array
items:
type: string
description: अतिरिक्त स्रोत URL
details:
type: array
items:
type: string
description: प्रतिबंध के बारे में अतिरिक्त विवरण
legal_basis:
type: array
items:
type: string
description: प्रतिबंध के लिए कानूनी आधार
listed_on:
type: array
items:
type: string
nullable: true
description: तारीखें जब इकाई को सूचीबद्ध किया गया था
sanction_list:
type: array
items:
type: string
nullable: true
description: प्रतिबंध सूची पहचानकर्ता
sanction_program:
type: array
items:
type: string
description: प्रतिबंध कार्यक्रम जिसके तहत इकाई सूचीबद्ध है
sanctioning_authority:
type: array
items:
type: string
description: प्राधिकरण जिसने/जिन्होंने प्रतिबंध लगाया
updated_on:
type: array
items:
type: string
description: >-
प्रतिबंध प्रविष्टि को अंतिम बार अपडेट किए जाने की
तारीख/तारीखें
additional_data:
type: object
description: >-
प्रतिबंध स्रोत से अतिरिक्त डेटा जो मुख्य फ़ील्ड में
कैप्चर नहीं किया गया है
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: >-
समग्र AML स्क्रीनिंग स्कोर — सभी हिट्स में उच्चतम जोखिम स्कोर
(फ़्लोट, 0-100)। गणना होने तक `null`।
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: >-
क्या इस स्क्रीनिंग के लिए सतत AML निगरानी सक्षम है। `true` होने पर,
निकाय की समय-समय पर पुनः स्क्रीनिंग की जाती है और कोई भी नया मिलान
रिपोर्ट को अपडेट करता है।
next_ongoing_monitoring_bill_date:
type: string
format: date
nullable: true
description: >-
तारीख (YYYY-MM-DD) जब इस सतत निगरानी सब्सक्रिप्शन का अगला बिल लिया
जाएगा। `is_ongoing_monitoring_enabled = true` होने पर अंतिम सतत
निगरानी बिलिंग की तारीख में 365 दिन जोड़कर गणना की जाती है; अन्यथा
`null`। यह बिलिंग की तारीख है, स्क्रीनिंग की तारीख नहीं - उसके लिए
`last_ongoing_screening_at` का उपयोग करें।
last_ongoing_screening_at:
type: string
format: date-time
nullable: true
description: >-
जब सतत निगरानी ने अंतिम बार इस रिकॉर्ड की पुनः स्क्रीनिंग पूरी की
थी, चाहे परिणाम बदला हो या नहीं। `null` जब रिकॉर्ड की कभी पुनः
स्क्रीनिंग नहीं की गई हो; इसे सक्षमीकरण या बिलिंग तिथि से कभी
बैक-फ़िल नहीं किया जाता है।
last_ongoing_screening_datasets_updated_at:
type: string
format: date-time
nullable: true
description: >-
उस स्क्रीनिंग के समय प्रदाता द्वारा रिपोर्ट की गई सबसे हालिया AML
डेटासेट अपडेट तिथि। प्रदाता द्वारा कोई डेटासेट तिथियां रिपोर्ट न किए
जाने पर `null`; कभी अनुमानित नहीं।
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: >-
वह सुविधा जिसने यह चेतावनी उत्पन्न की। यह मान उस सुविधा ब्लॉक
की पहचान करता है जिससे चेतावनी संबंधित है। AML स्क्रीनिंग के
भीतर यह आमतौर पर `AML` होता है, लेकिन ऊपर दिया गया enum निर्णय
payload पर सभी सुविधा चेतावनियों में आधिकारिक है।
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: वर्कफ़्लो ग्राफ़ नोड ID जिसने यह चेतावनी उत्पन्न की
GeolocationCheck:
type: object
description: >-
एक स्थान सत्यापन परिणाम, एक वर्कफ़्लो नोड का स्वीकृत प्रयास। मापन,
अनिश्चितता और प्रामाणिकता अलग-अलग कुंजियाँ हैं, इसलिए एक सटीक अप्रमाणित
फ़िक्स एक अपरिशुद्ध प्रमाणित फ़िक्स से अलग पढ़ा जाता है।
properties:
node_id:
type: string
nullable: true
description: >-
वर्कफ़्लो नोड जिसने यह परिणाम तैयार किया, ताकि दो स्थान सत्यापन
चरणों वाला वर्कफ़्लो पढ़ने योग्य बना रहे।
status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
description: >-
इस स्थान सत्यापन चरण की सुविधा-स्तरीय स्थिति, जो इसकी चेतावनियों के
आधार पर निर्धारित की जाती है। सत्र `status` से स्वतंत्र।
outcome:
type: string
nullable: true
description: इस प्रयास में क्या हुआ।
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: >-
ऑपरेटिंग सिस्टम या ब्राउज़र ने क्या अनुमति दी। `not_requested` का
अर्थ है कि चरण केवल कनेक्शन के IP स्थान का उपयोग करता है, इसलिए
व्यक्ति से कभी भी अनुमति नहीं माँगी जाती है।
enum:
- granted_precise
- granted_approximate
- denied
- restricted
- unavailable
- timeout
- dismissed
- not_requested
- null
latitude:
type: number
nullable: true
description: फ़िक्स का WGS84 अक्षांश। कोई फ़िक्स न होने पर `null`।
format: double
longitude:
type: number
nullable: true
description: फ़िक्स का WGS84 देशांतर। कोई फ़िक्स न होने पर `null`।
format: double
accuracy_m:
type: number
nullable: true
description: >-
`accuracy_confidence` में विश्वास स्तर पर, मीटर में अनिश्चितता का
दायरा।
format: double
accuracy_confidence:
type: string
nullable: true
description: >-
विश्वास स्तर जो प्लेटफ़ॉर्म `accuracy_m` से जोड़ता है: `p95`
(ब्राउज़र), `p68` (Android) या `unspecified` (iOS)।
enum:
- p95
- p68
- unspecified
- null
measured_at:
type: string
nullable: true
description: जब डिवाइस ने अपनी घड़ी के अनुसार फ़िक्स प्राप्त किया।
format: date-time
age_seconds:
type: integer
nullable: true
description: >-
डिवाइस द्वारा स्थिति प्राप्त करने और Didit द्वारा इसे प्राप्त करने
के बीच के सेकंड।
source:
type: string
nullable: true
description: >-
फ़िक्स कहाँ से आया, जब प्लेटफ़ॉर्म बताता है। `ip` का अर्थ है कि
स्थिति कनेक्शन का IP स्थान है।
enum:
- gps
- fused
- network
- wifi
- cell
- browser
- unknown
- ip
- null
platform:
type: string
nullable: true
description: वह क्लाइंट जिसने सुधार किया।
enum:
- web
- ios
- android
- react_native
- flutter
- null
sdk_version:
type: string
nullable: true
description: फिक्स तैयार करने वाले SDK का संस्करण।
is_mock:
type: boolean
nullable: true
description: >-
`true` जब डिवाइस रिपोर्ट करता है कि स्थान फिक्स किसी मॉक लोकेशन
प्रदाता या सिमुलेशन सॉफ़्टवेयर से आया है। `null` जब प्लेटफ़ॉर्म इसकी
रिपोर्ट नहीं करता है (ब्राउज़र इसका पता नहीं लगा सकते); `null` का
अर्थ `false` नहीं है।
produced_by_accessory:
type: boolean
nullable: true
description: >-
केवल iOS: `true` जब फ़िक्स किसी बाहरी एक्सेसरी से आया हो। अन्यत्र
`null`।
integrity:
type: string
enum:
- attested
- not_attested
- failed
- unsupported
- not_determined
description: >-
क्या डिवाइस अटेस्टेशन इस समाधान का समर्थन करता है। `unsupported` वही
है जो ब्राउज़र रिपोर्ट करते हैं, क्योंकि वेब में कोई अटेस्टेशन तंत्र
नहीं है; यह कोई विफलता नहीं है।
country_code:
type: string
nullable: true
description: ISO 3166-1 alpha-2 देश जिसमें फ़िक्स स्थित है।
region_code:
type: string
nullable: true
description: ISO 3166-2 सबडिवीज़न जिसमें फ़िक्स है।
city:
type: string
nullable: true
description: निकटतम आबादी वाला स्थान, समीक्षकों के लिए एक लेबल।
geofence:
type: object
description: चरण के देश और क्षेत्र नियमों का परिणाम।
properties:
enabled:
type: boolean
description: क्या चरण कोई देश या क्षेत्र नियम लागू करता है।
result:
type: string
nullable: true
description: >-
नियमों के सापेक्ष स्थिति कहाँ बैठती है। `undetermined` का अर्थ
है कि सटीकता वृत्त सीमा के दोनों ओर होता है या स्थिति का समाधान
किसी भी देश में नहीं हुआ; यह बाहर होने का प्रमाण नहीं है।
enum:
- inside
- outside
- undetermined
- null
inside_geofence:
type: boolean
nullable: true
description: >-
`true` जब `geofence.result` `inside` हो, `false` जब `outside` हो,
अन्यथा `null`।
geofence_basis:
type: string
nullable: true
description: >-
क्षेत्र परिणाम का निर्णय किस स्थिति से किया गया था: `device` फ़िक्स,
या कनेक्शन का `ip` स्थान।
enum:
- device
- ip
- null
inside_areas:
type: array
items:
type: string
description: >-
कॉन्फ़िगर किए गए उन अनुमत क्षेत्रों के Ids जिनके अंदर स्थान स्थित
है।
blocked_areas:
type: array
items:
type: string
description: कॉन्फ़िगर किए गए उन अवरुद्ध क्षेत्रों के IDs जिनमें स्थान स्थित है।
position_source:
type: string
nullable: true
description: >-
जैसा कि कॉन्फ़िगर किया गया है, चरण स्थान कहाँ से लेता है: IP स्थान
के विरुद्ध जाँचा गया डिवाइस, केवल डिवाइस, या केवल IP स्थान।
enum:
- device_and_ip
- device_only
- ip_only
- null
anonymizers:
type: object
nullable: true
description: >-
कनेक्शन और डिवाइस कैसे दिखते हैं, प्रत्येक `true`, `false` या `null`
जब स्रोत नहीं बता सकता।
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: >-
सत्र के IP स्थान की दूरी दोनों अनिश्चितता त्रिज्या घटाने के बाद; जब
वे ओवरलैप होते हैं तो `0`।
format: double
ip_distance_uncertainty_km:
type: number
nullable: true
description: 'घटाया गया संयुक्त दायरा: IP स्थान का दायरा और इस फिक्स की सटीकता।'
format: double
ip_consistent:
type: boolean
nullable: true
description: >-
क्या `ip_distance_km` चरण पर कॉन्फ़िगर की गई दूरी के भीतर है। दोनों
में से किसी एक के अज्ञात होने पर `null`।
document_distance_km:
type: number
nullable: true
description: >-
पहचान दस्तावेज़ या पते के प्रमाण पर जियोकोडेड पते की दूरी। फ़ाइल में
कोई पता न होने पर `null`।
format: double
travel_excused:
type: boolean
nullable: true
description: >-
क्या चरण के ट्रैवल टॉलरेंस ने पते से दूरी को छूट दी। टॉलरेंस बंद
होने पर `null`।
consecutive_mismatches:
type: integer
nullable: true
description: 'अंतिम प्रयास पर: यह जांच और उसी व्यक्ति के लगातार पिछले बेमेल।'
attempts:
type: integer
description: नोड के भीतर इस प्रयास की संख्या, जो 1 से शुरू होती है।
consent:
type: object
nullable: true
description: >-
सिस्टम प्रॉम्प्ट से पहले व्यक्ति द्वारा दी गई सहमति, उनके द्वारा
देखे गए शब्दांकन संस्करण और भाषा के साथ दर्ज की गई।
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: >-
वह सुविधा जिसने यह चेतावनी उत्पन्न की। यह मान उस सुविधा ब्लॉक
की पहचान करता है जिससे चेतावनी संबंधित है। प्रत्येक मॉड्यूल का
चेतावनी ऐरे आमतौर पर अपने मॉड्यूल से मेल खाने वाले मान का
उपयोग करता है (उदाहरण के लिए, `phone_verifications[].warnings`
के अंदर `PHONE`), लेकिन ऊपर दिया गया enum निर्णय payload पर
सभी सुविधा चेतावनियों में आधिकारिक है।
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: वर्कफ़्लो ग्राफ़ नोड ID जिसने यह चेतावनी उत्पन्न की
description: >-
इस स्थान सत्यापन चरण द्वारा उठाई गई चेतावनियाँ, जिसमें `feature` को
`GEOLOCATION` पर सेट किया गया है। चेतावनी कोड `LOCATION_` से शुरू
होते हैं।
GeolocationAttempt:
type: object
description: >-
स्थान सत्यापन चरण का एक प्रयास: `warnings` को छोड़कर
`geolocation_checks[]` जैसी ही कुंजियाँ, साथ ही Didit को यह कब प्राप्त
हुआ।
properties:
node_id:
type: string
nullable: true
description: >-
वर्कफ़्लो नोड जिसने यह परिणाम तैयार किया, ताकि दो स्थान सत्यापन
चरणों वाला वर्कफ़्लो पढ़ने योग्य बना रहे।
status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
description: >-
इस स्थान सत्यापन चरण की सुविधा-स्तरीय स्थिति, जो इसकी चेतावनियों के
आधार पर निर्धारित की जाती है। सत्र `status` से स्वतंत्र।
outcome:
type: string
nullable: true
description: इस प्रयास में क्या हुआ।
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: >-
ऑपरेटिंग सिस्टम या ब्राउज़र ने क्या अनुमति दी। `not_requested` का
अर्थ है कि चरण केवल कनेक्शन के IP स्थान का उपयोग करता है, इसलिए
व्यक्ति से कभी भी अनुमति नहीं माँगी जाती है।
enum:
- granted_precise
- granted_approximate
- denied
- restricted
- unavailable
- timeout
- dismissed
- not_requested
- null
latitude:
type: number
nullable: true
description: फ़िक्स का WGS84 अक्षांश। कोई फ़िक्स न होने पर `null`।
format: double
longitude:
type: number
nullable: true
description: फ़िक्स का WGS84 देशांतर। कोई फ़िक्स न होने पर `null`।
format: double
accuracy_m:
type: number
nullable: true
description: >-
`accuracy_confidence` में विश्वास स्तर पर, मीटर में अनिश्चितता का
दायरा।
format: double
accuracy_confidence:
type: string
nullable: true
description: >-
विश्वास स्तर जो प्लेटफ़ॉर्म `accuracy_m` से जोड़ता है: `p95`
(ब्राउज़र), `p68` (Android) या `unspecified` (iOS)।
enum:
- p95
- p68
- unspecified
- null
measured_at:
type: string
nullable: true
description: जब डिवाइस ने अपनी घड़ी के अनुसार फ़िक्स प्राप्त किया।
format: date-time
age_seconds:
type: integer
nullable: true
description: >-
डिवाइस द्वारा स्थिति प्राप्त करने और Didit द्वारा इसे प्राप्त करने
के बीच के सेकंड।
source:
type: string
nullable: true
description: >-
फ़िक्स कहाँ से आया, जब प्लेटफ़ॉर्म बताता है। `ip` का अर्थ है कि
स्थिति कनेक्शन का IP स्थान है।
enum:
- gps
- fused
- network
- wifi
- cell
- browser
- unknown
- ip
- null
platform:
type: string
nullable: true
description: वह क्लाइंट जिसने सुधार किया।
enum:
- web
- ios
- android
- react_native
- flutter
- null
sdk_version:
type: string
nullable: true
description: फिक्स तैयार करने वाले SDK का संस्करण।
is_mock:
type: boolean
nullable: true
description: >-
`true` जब डिवाइस रिपोर्ट करता है कि स्थान फिक्स किसी मॉक लोकेशन
प्रदाता या सिमुलेशन सॉफ़्टवेयर से आया है। `null` जब प्लेटफ़ॉर्म इसकी
रिपोर्ट नहीं करता है (ब्राउज़र इसका पता नहीं लगा सकते); `null` का
अर्थ `false` नहीं है।
produced_by_accessory:
type: boolean
nullable: true
description: >-
केवल iOS: `true` जब फ़िक्स किसी बाहरी एक्सेसरी से आया हो। अन्यत्र
`null`।
integrity:
type: string
enum:
- attested
- not_attested
- failed
- unsupported
- not_determined
description: >-
क्या डिवाइस अटेस्टेशन इस समाधान का समर्थन करता है। `unsupported` वही
है जो ब्राउज़र रिपोर्ट करते हैं, क्योंकि वेब में कोई अटेस्टेशन तंत्र
नहीं है; यह कोई विफलता नहीं है।
country_code:
type: string
nullable: true
description: ISO 3166-1 alpha-2 देश जिसमें फ़िक्स स्थित है।
region_code:
type: string
nullable: true
description: ISO 3166-2 सबडिवीज़न जिसमें फ़िक्स है।
city:
type: string
nullable: true
description: निकटतम आबादी वाला स्थान, समीक्षकों के लिए एक लेबल।
geofence:
type: object
description: चरण के देश और क्षेत्र नियमों का परिणाम।
properties:
enabled:
type: boolean
description: क्या चरण कोई देश या क्षेत्र नियम लागू करता है।
result:
type: string
nullable: true
description: >-
नियमों के सापेक्ष स्थिति कहाँ बैठती है। `undetermined` का अर्थ
है कि सटीकता वृत्त सीमा के दोनों ओर होता है या स्थिति का समाधान
किसी भी देश में नहीं हुआ; यह बाहर होने का प्रमाण नहीं है।
enum:
- inside
- outside
- undetermined
- null
inside_geofence:
type: boolean
nullable: true
description: >-
`true` जब `geofence.result` `inside` हो, `false` जब `outside` हो,
अन्यथा `null`।
geofence_basis:
type: string
nullable: true
description: >-
क्षेत्र परिणाम का निर्णय किस स्थिति से किया गया था: `device` फ़िक्स,
या कनेक्शन का `ip` स्थान।
enum:
- device
- ip
- null
inside_areas:
type: array
items:
type: string
description: >-
कॉन्फ़िगर किए गए उन अनुमत क्षेत्रों के Ids जिनके अंदर स्थान स्थित
है।
blocked_areas:
type: array
items:
type: string
description: कॉन्फ़िगर किए गए उन अवरुद्ध क्षेत्रों के IDs जिनमें स्थान स्थित है।
position_source:
type: string
nullable: true
description: >-
जैसा कि कॉन्फ़िगर किया गया है, चरण स्थान कहाँ से लेता है: IP स्थान
के विरुद्ध जाँचा गया डिवाइस, केवल डिवाइस, या केवल IP स्थान।
enum:
- device_and_ip
- device_only
- ip_only
- null
anonymizers:
type: object
nullable: true
description: >-
कनेक्शन और डिवाइस कैसे दिखते हैं, प्रत्येक `true`, `false` या `null`
जब स्रोत नहीं बता सकता।
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: >-
सत्र के IP स्थान की दूरी दोनों अनिश्चितता त्रिज्या घटाने के बाद; जब
वे ओवरलैप होते हैं तो `0`।
format: double
ip_distance_uncertainty_km:
type: number
nullable: true
description: 'घटाया गया संयुक्त दायरा: IP स्थान का दायरा और इस फिक्स की सटीकता।'
format: double
ip_consistent:
type: boolean
nullable: true
description: >-
क्या `ip_distance_km` चरण पर कॉन्फ़िगर की गई दूरी के भीतर है। दोनों
में से किसी एक के अज्ञात होने पर `null`।
document_distance_km:
type: number
nullable: true
description: >-
पहचान दस्तावेज़ या पते के प्रमाण पर जियोकोडेड पते की दूरी। फ़ाइल में
कोई पता न होने पर `null`।
format: double
travel_excused:
type: boolean
nullable: true
description: >-
क्या चरण के ट्रैवल टॉलरेंस ने पते से दूरी को छूट दी। टॉलरेंस बंद
होने पर `null`।
consecutive_mismatches:
type: integer
nullable: true
description: 'अंतिम प्रयास पर: यह जांच और उसी व्यक्ति के लगातार पिछले बेमेल।'
attempts:
type: integer
description: नोड के भीतर इस प्रयास की संख्या, जो 1 से शुरू होती है।
consent:
type: object
nullable: true
description: >-
सिस्टम प्रॉम्प्ट से पहले व्यक्ति द्वारा दी गई सहमति, उनके द्वारा
देखे गए शब्दांकन संस्करण और भाषा के साथ दर्ज की गई।
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: Didit को यह प्रयास कब प्राप्त हुआ।
format: date-time
created_at:
type: string
format: date-time
KYBRegistryShareholding:
type: object
nullable: true
description: >-
स्वामी के पास क्या धारिता है, प्रत्येक देश और रजिस्ट्री स्रोत के लिए
समान स्वरूप में। जब रजिस्ट्री में किसी धारिता का उल्लेख न हो तो Null। एक
बैंड (उदाहरण के लिए UK PSC का 25-50%) हिस्सेदारी नहीं है: `percentage`
null है और बैंड `ownership_min_shares` / `ownership_max_shares` में रहता
है।
properties:
share_class:
type: string
nullable: true
description: शेयर वर्ग या प्रकार जैसा कि रजिस्ट्री में नामित है।
number_of_shares:
type: number
nullable: true
description: धारित शेयरों की संख्या।
currency:
type: string
nullable: true
description: नीचे दिए गए मानों की ISO 4217 करेंसी।
nominal_value:
type: number
nullable: true
description: प्रति शेयर अंकित मूल्य।
total_value:
type: number
nullable: true
description: होल्डिंग का कुल मूल्य।
percentage:
type: number
nullable: true
description: दशमलव के चार स्थानों तक प्रतिशत में सटीक हिस्सेदारी।
required:
- share_class
- number_of_shares
- currency
- nominal_value
- total_value
- percentage
KYBRegistryAddress:
type: object
description: >-
एक पता जो रजिस्ट्री बताती है, प्रत्येक देश और रजिस्ट्री स्रोत के लिए
समान संरचना में। प्रत्येक कुंजी हमेशा मौजूद होती है; वह भाग जिसे
रजिस्ट्री प्रकाशित नहीं करती है, null होता है।
properties:
type:
type: string
nullable: true
description: >-
लोअरकेस में पते का प्रकार: पंजीकृत कार्यालय के लिए `registered`;
अन्य प्रकार जैसा कि रजिस्ट्री उन्हें नाम देती है (उदाहरण के लिए
`postal`, `office`)। जब रजिस्ट्री यह नहीं बताती कि पता क्या है, तब
`null`।
address:
type: string
description: एक पंक्ति के रूप में पूरा पता। प्रत्येक पते पर हमेशा मौजूद रहता है।
street:
type: string
nullable: true
description: सड़क और संख्या।
city:
type: string
nullable: true
description: शहर या इलाका।
postal_code:
type: string
nullable: true
description: डाक कोड।
region:
type: string
nullable: true
description: क्षेत्र, राज्य या प्रांत।
country_code:
type: string
nullable: true
description: ISO 3166-1 alpha-2 देश कोड।
description:
type: string
nullable: true
description: पते के लिए रजिस्ट्री का अपना लेबल, जब वह कोई लेबल प्रदान करती है।
required:
- type
- address
- street
- city
- postal_code
- region
- country_code
- description
KYBRegistryIndustry:
type: object
description: >-
एक गतिविधि जिसके तहत रजिस्ट्री कंपनी को वर्गीकृत करती है, प्रत्येक देश
और रजिस्ट्री स्रोत के लिए समान संरचना में।
properties:
code:
type: string
nullable: true
description: >-
गतिविधि कोड जैसा कि रजिस्ट्री इसे प्रिंट करती है (उदाहरण के लिए
`73110`)।
description:
type: string
nullable: true
description: गतिविधि लेबल, जब रजिस्ट्री इसे प्रकाशित करती है।
scheme:
type: string
nullable: true
description: >-
वर्गीकरण प्रणाली, प्रत्येक प्रणाली के लिए एक नाम, चाहे जिस भी स्रोत
ने इसे रिपोर्ट किया हो: `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`; अन्य राष्ट्रीय प्रणालियां रजिस्ट्री का अपना
नाम बनाए रखती हैं। जब रजिस्ट्री प्रणाली का नाम नहीं देती है, तो
Null।
is_primary:
type: boolean
description: >-
कंपनी की मुख्य गतिविधि के लिए True। सूची खाली न होने पर ठीक एक
प्रविष्टि प्राथमिक होती है।
required:
- code
- description
- scheme
- is_primary
KYBRegistryData:
type: object
nullable: true
description: >-
कंपनी के लिए Didit का सामान्यीकृत रजिस्ट्री विवरण: स्वामित्व परिणाम
(`ownership_error`, `section_errors`, `ubo_resolution`,
`lite_enrichment`), update-data के साथ किए गए सुधार, और रजिस्ट्री तथ्य
जिनका अपना कोई फ़ील्ड नहीं है। इसमें कभी भी रजिस्ट्री स्रोत का अपना
रिकॉर्ड शामिल नहीं होता है। प्रत्येक कुंजी वैकल्पिक है और केवल तभी मौजूद
होती है जब कंपनी के पास इसके लिए कोई मान हो; नई कुंजियाँ जोड़ी जा सकती
हैं। उनके अंतर्गत आने वाली किसी भी चीज़ के लिए कैनोनिकल फ़ील्ड
(`addresses`, `industries`, `ownership`,
`beneficial_owners[].shareholding`) पढ़ें।
properties:
company_name:
type: string
description: कंपनी का नाम जैसा कि कंसोल में ठीक किया गया है।
registration_number:
type: string
description: पंजीकरण संख्या जैसा कि रजिस्ट्री या कंसोल सुधार में बताया गया है।
country_code:
type: string
description: पंजीकरण का देश, जैसा कि रजिस्ट्री या कंसोल सुधार में बताया गया है।
region:
type: string
description: पंजीकरण का क्षेत्र या राज्य।
incorporation_date:
type: string
description: निगमन तिथि (ISO 8601)।
registration_date:
type: string
description: पंजीकरण तिथि (ISO 8601) जब रजिस्ट्री इसे निगमन तिथि से अलग बताती है।
dissolution_date:
type: string
description: विघटन तिथि (ISO 8601) जब रजिस्ट्री में उल्लिखित हो।
tax_number:
type: string
description: कर पहचान संख्या।
vat_number:
type: string
description: VAT नंबर।
legal_address:
type: string
description: कंसोल में सही किया गया कानूनी पता।
registered_address:
type: string
description: रजिस्ट्री में जैसा दर्ज है, वैसा पंजीकृत पता।
company_type:
type: string
description: कानूनी रूप।
registry_status:
type: string
description: रजिस्ट्री में कंपनी की स्थिति।
verification_status:
type: string
description: सत्यापन स्थिति।
alternative_names:
type: string
description: अन्य नाम जिनसे कंपनी कारोबार करती है या करती थी।
nature_of_business:
type: string
description: गतिविधि विवरण।
registered_capital:
type: string
description: मुद्रित रूप में पंजीकृत पूंजी।
registered_capital_amount:
type: string
description: पंजीकृत पूंजी राशि, दशमलव स्ट्रिंग के रूप में।
registered_capital_currency:
type: string
description: पंजीकृत पूंजी की मुद्रा (ISO 4217)।
website:
type: string
description: वेबसाइट।
email:
type: string
description: संपर्क ईमेल।
phone:
type: string
description: संपर्क फ़ोन।
legal_entity_identifier:
type: string
description: लीगल एंटिटी आइडेंटिफ़ायर (LEI)।
location_of_registration:
type: string
description: पंजीकरण का स्थान।
control_scheme:
type: string
description: गवर्नेंस योजना जब रजिस्ट्री इसे प्रदर्शित करती है।
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: >-
अनुरोधित स्वामित्व स्तर क्यों डिलीवर नहीं किया गया,
`ownership.unavailable_reason` के समान कोड में।
`no_owners_on_record` (रजिस्ट्री ने उत्तर दिया और किसी स्वामी का नाम
नहीं दिया) और `ownership_section_unavailable` (रजिस्ट्री ने
स्वामित्व अनुभाग नहीं लौटाया) अलग-अलग निष्कर्ष हैं।
section_errors:
type: object
description: >-
वे अनुभाग जो रजिस्ट्री ने नहीं लौटाए, अनुभाग के आधार पर कुंजीबद्ध
(`officers`, `shareholders`, `group_structure`)। यहाँ सूचीबद्ध
अनुभाग कभी डिलीवर नहीं किया गया था: इसके आगे की खाली सूची कंपनी के
बारे में कुछ नहीं बताती।
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: >-
कंपनी के लिए रजिस्ट्री के अपने फ़ील्ड, रजिस्ट्री में दिए गए उनके
नामों के अनुसार, सादे मानों के रूप में (लीगेसी रिकॉर्ड)। केवल
रजिस्ट्री तथ्यों के रूप में समीक्षा किए गए फ़ील्ड शामिल हैं।
registry_sources:
type: array
description: >-
आधिकारिक रजिस्टर जिनसे रिकॉर्ड पढ़ा गया था (लीगेसी रिकॉर्ड)। अन्य
स्रोतों के नाम नहीं दिए गए हैं।
items:
$ref: '#/components/schemas/KYBRegistrySource'
previous_names:
type: array
items:
type: string
description: वे नाम जिनके तहत कंपनी पहले पंजीकृत थी (लीगेसी रिकॉर्ड्स)।
parent_companies:
type: array
items:
type: string
description: मूल कंपनियाँ जिनका नाम रजिस्ट्री में दर्ज है (लेगेसी रिकॉर्ड)।
documents_available:
type: integer
description: >-
कंपनी के लिए रजिस्ट्री कितनी फाइलिंग प्रदान करती है (लेगेसी
रिकॉर्ड्स)।
KYBRegistryOwnership:
type: object
description: >-
स्वामित्व (शेयरधारक / UBO) स्तर का परिणाम, प्रत्येक देश और रजिस्ट्री
स्रोत के लिए समान प्रारूप में।
properties:
status:
type: string
nullable: true
enum:
- not_requested
- pending
- delivered
- not_held
- unavailable
- null
description: >-
`delivered` जब रजिस्ट्री ने स्वामित्व प्रकाशित किया; `not_held` जब
स्वामित्व रजिस्ट्री ने उत्तर दिया और कंपनी को बिल्कुल भी सूचीबद्ध
नहीं करती है (`unavailable_reason` देखें); `unavailable` जब इसने
किसी अन्य कारण से स्वामित्व डेटा प्रदान नहीं किया
(`unavailable_reason` देखें); `pending` जबकि रजिस्ट्री अभी भी इसे
प्राप्त कर रही है; Basic स्तर के लिए `not_requested`।
tier_requested:
type: string
nullable: true
enum:
- basic
- shareholders
- ubo
- null
description: वर्कफ़्लो द्वारा ऑर्डर किया गया स्तर।
tier_delivered:
type: string
nullable: true
enum:
- basic
- shareholders
- ubo
- null
description: >-
वह स्तर जो रजिस्ट्री ने डिलीवर किया है (और जिसे बिल किया जाता है)।
केवल प्रत्यक्ष शेयरधारकों के साथ उत्तर दिया गया UBO अनुरोध
`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: >-
अनुरोधित स्वामित्व स्तर क्यों डिलीवर नहीं किया गया। जब तक `status`,
`unavailable` या `pending` न हो, तब तक Null।
direct_ownership_complete:
type: boolean
nullable: true
description: >-
True जब प्रत्यक्ष शेयरधारकों के घोषित हिस्से कुल मिलाकर 100% होते
हैं (राउंडिंग के एक प्रतिशत बिंदु के भीतर); false जब वे ऐसा नहीं
करते हैं; null जब स्वामित्व डिलीवर नहीं किया गया था या कोई हिस्सा
घोषित नहीं है।
unresolved:
type: array
description: >-
स्वामित्व शृंखला के वे भाग जिन्हें रजिस्ट्री हल नहीं कर सकी, उदाहरण
के लिए प्रत्यक्ष स्वामियों के ऊपर रिकॉर्ड में कोई समूह संरचना न
होना।
items:
type: object
properties:
reason:
type: string
section:
type: string
nullable: true
required:
- status
- tier_requested
- tier_delivered
- unavailable_reason
- direct_ownership_complete
- unresolved
KYBOwnershipStructure:
type: object
nullable: true
description: >-
रजिस्ट्री द्वारा प्रमाणित कैप टेबल, जैसा कि यह स्वामित्व स्तर डिलीवर किए
जाने के समय मौजूद था: प्रत्यक्ष `shareholders` और `beneficial_owners`।
जब रजिस्ट्री ने किसी स्वामित्व को प्रमाणित नहीं किया तो Null। यह कभी भी
रजिस्ट्री स्रोत की अपनी पंक्तियाँ नहीं रखता है; वर्तमान रिकॉर्ड के लिए
`company.beneficial_owners` और `company.ownership` पढ़ें।
properties:
shareholders:
type: array
items:
$ref: '#/components/schemas/KYBOwnershipStructureOwner'
beneficial_owners:
type: array
items:
$ref: '#/components/schemas/KYBOwnershipStructureOwner'
required:
- shareholders
- beneficial_owners
InvestigatorBlock:
type: object
nullable: true
description: >-
आइटम की नवीनतम Investigator समीक्षा, या जब इसकी कभी कोई समीक्षा नहीं हुई
हो तो null। V3 सत्र और व्यावसायिक सत्र के निर्णय (और इसलिए
`status.updated` webhooks) द्वारा वहन किए जाते हैं।
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: >-
इन्वेस्टिगेटर ने स्वयं निर्णय लिया, भले ही बाद में निर्णय को ओवरराइड
कर दिया गया हो।
decided_by:
type: string
enum:
- investigator
- member
nullable: true
decision:
nullable: true
allOf:
- $ref: '#/components/schemas/InvestigatorDecision'
type: object
BiometricRetention:
type: object
description: इस सत्र का लाइव बायोमेट्रिक डेटा कब हटाया जाता है।
required:
- jurisdictions
- deletes_at
properties:
jurisdictions:
type: array
items:
type: string
description: >-
उन US राज्यों के कोड जिनके बायोमेट्रिक नियम इस व्यक्ति के लिए विलोपन
सीमा निर्धारित करते हैं (राज्य अज्ञात होने पर `US`)। कोई लागू न होने
पर खाली।
deletes_at:
type: string
format: date-time
nullable: true
description: >-
वह तिथि जब इस सत्र का लाइव बायोमेट्रिक डेटा (चेहरे की छवियाँ और
टेम्पलेट) हटा दिया जाता है, जो आपके एप्लिकेशन की डेटा प्रतिधारण
सेटिंग और, जहाँ लागू हो, व्यक्ति के अधिकार क्षेत्र की कानूनी सीमा से
निर्धारित होती है। जब अभी तक कोई तिथि लागू नहीं होती है तो `null`।
SocialFootprintPlatform:
type: object
properties:
platform:
type: string
description: प्लेटफ़ॉर्म पहचानकर्ता।
example: whatsapp
category:
type: string
description: >-
प्लेटफ़ॉर्म श्रेणी, उदाहरण के लिए MESSAGING, SOCIAL_MEDIA,
ECOMMERCE, PROFESSIONAL, EMAIL_PROVIDER।
example: MESSAGING
scope:
type: string
enum:
- global
- local
description: >-
विश्वव्यापी प्लेटफ़ॉर्म के लिए `global`, क्षेत्र-विशिष्ट प्लेटफ़ॉर्म
के लिए `local`।
example: global
SocialFootprintCategorySummary:
type: object
properties:
registered:
type: integer
nullable: true
description: इस श्रेणी के वे प्लेटफ़ॉर्म जहाँ पंजीकरण की पुष्टि हो गई है।
example: 2
ratio:
type: number
format: float
nullable: true
description: श्रेणी के जाँचे गए प्लेटफ़ॉर्म का पंजीकरण सहित हिस्सा, 0.0-1.0।
example: 0.6667
SocialFootprintProfile:
type: object
properties:
name:
type: string
nullable: true
description: प्रोफ़ाइल का नाम, जब प्लेटफ़ॉर्म इसे प्रदर्शित करता है।
photo:
type: string
nullable: true
description: प्रोफ़ाइल फ़ोटो URL, जब प्लेटफ़ॉर्म इसे प्रदर्शित करता है।
about:
type: string
nullable: true
description: >-
प्रोफ़ाइल का अबाउट/बायो टेक्स्ट, जब प्लेटफ़ॉर्म इसे प्रदर्शित करता
है।
privacy_status:
type: string
nullable: true
enum:
- PUBLIC
- PRIVATE
- null
description: प्रोफ़ाइल दृश्यता, जब प्लेटफ़ॉर्म इसे प्रदर्शित करता है।
business_account:
type: boolean
nullable: true
description: >-
क्या प्रोफ़ाइल एक व्यावसायिक खाता है, जब प्लेटफ़ॉर्म इसे प्रदर्शित
करता है।
SignatureFieldResult:
type: object
description: >-
हस्ताक्षरित दस्तावेज़ का एक फ़ील्ड, इस हस्ताक्षरकर्ता की प्रति पर उसके
मान के साथ।
[फ़ील्ड](/hi/core-technology/electronic-signature/report-electronic-signature#फ़ील्ड)
देखें।
properties:
key:
type: string
description: फ़ील्ड की कुंजी, जैसा कि `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: >-
पेज संख्या, 1 से। Word दस्तावेज़ के लिए, कनवर्ट किए गए PDF का एक
पेज।
x:
type: number
description: बायाँ किनारा, पेज की चौड़ाई के एक अंश के रूप में।
'y':
type: number
description: पेज की ऊंचाई के एक अंश के रूप में ऊपरी किनारा।
width:
type: number
description: पेज की चौड़ाई के अंश के रूप में चौड़ाई।
height:
type: number
description: ऊंचाई, पेज की ऊंचाई के एक अंश के रूप में।
required:
type: boolean
value:
nullable: true
description: >-
`text`, `email`, `full_name`, `date_signed` और `data` के लिए एक
स्ट्रिंग, `checkbox` के लिए एक बूलियन, और लागू हस्ताक्षर या
आद्याक्षर (initials) के लिए `true`। खाली होने पर `null`।
display_value:
type: string
nullable: true
description: >-
पेज पर अंकित मान: फ़ील्ड के `date_format` में तारीखें, चेकबॉक्स के
लिए `Yes` या `No`, हस्ताक्षर या शुरुआती अक्षरों के लिए `Signed`।
value_source:
type: string
nullable: true
enum:
- signer
- identity
- contact
- company
- session
- metadata
- api
- signing_time
- null
description: >-
मान कहाँ से आया: `signer` (हस्ताक्षरकर्ता द्वारा टाइप किया गया, टिक
किया गया या लागू किया गया), `identity` (सत्यापित ID), `contact`
(सत्यापित ईमेल या फ़ोन), `company` (सत्यापित कंपनी), `session`
(`vendor_data`), `metadata`, `api` (`sign.field_values`) या
`signing_time` (हस्ताक्षर करने की तिथि)।
filled_at:
type: string
format: date-time
nullable: true
image_url:
type: string
nullable: true
description: >-
केवल हस्ताक्षर और आद्याक्षर: लागू छवि का पथ। [हस्ताक्षर छवि डाउनलोड
करें](/hi/sessions-api/electronic-signature/download-field-image)
देखें।
value_unavailable_reason:
type: string
nullable: true
enum:
- source_empty
- null
description: >-
जब किसी पहले से भरे हुए फ़ील्ड का सत्र में कोई मान नहीं था और
`signature_field_data_missing_action` ने हस्ताक्षरकर्ता को वैसे भी
हस्ताक्षर करने की अनुमति दी, तब `source_empty`।
KYBRegistrySectionError:
type: object
description: एक ऐसा अनुभाग जिसे रजिस्ट्री ने वापस नहीं किया।
properties:
status_code:
type: integer
nullable: true
description: वह स्थिति जो रजिस्ट्री ने अनुभाग के लिए उत्तर में दी।
required:
- status_code
KYBRegistryUboResolution:
type: object
description: UBO स्तर ने कंपनी के ऊपर स्वामित्व श्रृंखला को कैसे पार किया।
properties:
parent_chain:
type: array
description: अंतिम मूल कंपनी से लेकर कंपनी तक के कॉर्पोरेट पैरेंट्स।
items:
$ref: '#/components/schemas/KYBRegistryGroupCompany'
subsidiaries:
type: array
description: कंपनी के कॉर्पोरेट समूह में सीधे उसके नीचे की कंपनियाँ।
items:
$ref: '#/components/schemas/KYBRegistryGroupCompany'
unresolved:
type: array
description: >-
शृंखला के वे भाग जिन्हें रजिस्ट्री हल नहीं कर सकी
(`ownership.unresolved` के समान प्रविष्टियाँ)।
items:
type: object
properties:
reason:
type: string
description: >-
कारण, उदाहरण के लिए `no_group_structure_on_record`,
`selected_company_not_in_group_structure` या `section_error`।
section:
type: string
nullable: true
description: संबंधित अनुभाग, उदाहरण के लिए `group_structure`।
required:
- reason
- section
required:
- parent_chain
- subsidiaries
- unresolved
KYBRegistryLiteEnrichment:
type: object
description: >-
खाली Lite प्रोफ़ाइल फ़ील्ड जिन्हें देश के किसी अन्य रजिस्ट्री स्रोत ने
भरा है। स्रोत का नाम नहीं दिया गया है।
properties:
fields:
type: array
items:
type: string
description: कंपनी के वे फ़ील्ड जो भरे गए थे।
people_added:
type: integer
description: कितने अधिकारियों या स्वामियों को जोड़ा गया।
required:
- fields
- people_added
KYBRegistrySource:
type: object
description: >-
एक आधिकारिक रजिस्टर जिससे रिकॉर्ड पढ़ा गया था। केवल आधिकारिक सरकारी
रजिस्टरों, नियामकों और आधिकारिक पहचानकर्ता प्रणाली का नाम दिया गया है;
किसी अन्य स्रोत को छोड़ दिया गया है।
properties:
name:
type: string
description: रजिस्टर का नाम, उदाहरण के लिए `UK Companies House`।
source_type:
type: string
enum:
- official
description: हमेशा `official`।
required:
- name
- source_type
KYBOwnershipStructureOwner:
type: object
description: >-
स्वामित्व स्नैपशॉट का एक स्वामी: वही रजिस्ट्री पहचान और हिस्सेदारी जो
`company.beneficial_owners[]` में है, और इसका कैनोनिकल `shareholding`।
properties:
name:
type: string
nullable: true
description: मालिक का नाम जैसा कि रजिस्ट्री में दर्ज है।
first_name:
type: string
nullable: true
description: प्राकृतिक व्यक्ति के लिए पहला नाम, जब रजिस्ट्री में यह निर्दिष्ट हो।
last_name:
type: string
nullable: true
description: >-
कुलनाम, एक प्राकृतिक व्यक्ति के लिए, जब रजिस्ट्री इसे स्पष्ट करती
है।
date_of_birth:
type: string
nullable: true
description: जन्म तिथि (ISO 8601) जब रजिस्ट्री इसे प्रकाशित करती है।
country_of_birth:
type: string
nullable: true
description: जन्म का देश, जब रजिस्ट्री इसे प्रकाशित करती है।
company_name:
type: string
nullable: true
description: कॉर्पोरेट स्वामी के लिए कंपनी का नाम।
registration_number:
type: string
nullable: true
description: कॉर्पोरेट स्वामी के लिए पंजीकरण संख्या।
entity_type:
type: string
nullable: true
enum:
- person
- company
- null
description: क्या स्वामी कोई प्राकृतिक व्यक्ति है या कंपनी।
nationality:
type: string
nullable: true
description: राष्ट्रीयता जब रजिस्ट्री में इसका उल्लेख हो।
designation:
type: string
nullable: true
description: स्वामी का पद या भूमिका जैसा कि रजिस्ट्री में दर्ज है।
roles:
type: array
items:
type: string
description: प्रत्यक्ष धारक के लिए `shareholder`, वास्तविक स्वामी के लिए `ubo`।
ownership_min_shares:
type: string
nullable: true
description: >-
हिस्सेदारी की निचली सीमा, प्रतिशत में (सटीक हिस्सेदारी के लिए ऊपरी
सीमा के बराबर)।
ownership_max_shares:
type: string
nullable: true
description: हिस्सेदारी की ऊपरी सीमा, प्रतिशत में।
voting_min_shares:
type: string
nullable: true
description: मतदान अधिकारों की निचली सीमा, प्रतिशत में।
voting_max_shares:
type: string
nullable: true
description: मतदान अधिकारों की ऊपरी सीमा, प्रतिशत में।
appointment_date:
type: string
nullable: true
description: होल्डिंग या नियुक्ति शुरू होने की तारीख (ISO 8601)।
is_active:
type: boolean
nullable: true
description: पूर्व स्वामी के लिए False।
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
InvestigatorDecision:
type: object
description: >-
आइटम Investigator कतार से कैसे बाहर निकला। `decided_by`,
`original_outcome` और `overrides` accept और override endpoints तथा
रिपोर्ट द्वारा लौटाए जाते हैं; सत्र निर्णय का `investigator` ब्लॉक अन्य
फ़ील्ड रखता है।
properties:
outcome:
type: string
enum:
- accepted
- edited
- overridden
- decided_elsewhere
- automated
description: >-
`accepted` या `edited` ने अनुशंसा को स्वीकार किया (`edited` पुनः
लिखे गए विवरण के साथ), `overridden` ने दूसरी कार्रवाई की,
`decided_elsewhere` रिपोर्ट खुली होने के दौरान Investigator के बाहर
लिया गया निर्णय है, `automated` ऐसा निर्णय है जो Investigator ने
स्वयं लिया था।
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: निर्णय के बाद आइटम की स्थिति।
agreed:
type: boolean
description: क्या निर्णय सिफ़ारिश से मेल खाता था।
nullable: true
decided_at:
type: string
format: date-time
billed:
type: boolean
description: समीक्षा के लिए शुल्क लिया गया था।
decided_by:
type: string
enum:
- investigator
- member
original_outcome:
type: object
description: >-
Investigator द्वारा स्वतंत्र रूप से लिया गया निर्णय, जो बाद के
ओवरराइड द्वारा अपरिवर्तित रहता है। टीम द्वारा लिए गए निर्णय के लिए
null।
properties:
action:
type: string
final_status:
type: string
decided_at:
type: string
format: date-time
nullable: true
overrides:
type: array
description: >-
अन्वेषक द्वारा अपने दम पर लिए गए निर्णय का प्रत्येक ओवरराइड, सबसे
पुराना पहले।
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
KYBRegistryGroupCompany:
type: object
description: कॉर्पोरेट समूह की एक कंपनी, उसकी रजिस्ट्री पहचान द्वारा।
properties:
name:
type: string
nullable: true
description: कंपनी का नाम।
country_code:
type: string
nullable: true
description: पंजीकरण का देश।
registration_number:
type: string
nullable: true
description: पंजीकरण संख्या।
required:
- name
- country_code
- registration_number
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys
से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप
किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या
स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक
सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी
समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी,
कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP
सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी
के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को
छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write
के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं।
देखें https://docs.didit.me/console/api-keys।
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.