Skip to main content

Individual onboarding API workflow

Individual KYC नीति को वर्तमान generated API reference से जोड़ने के लिए इस map का उपयोग करें। नीति-facing labels को API state machine के रूप में implement करने के बजाय प्रत्येक step पर वर्तमान resource का पालन करें।

Workflow map

1. Individual customer बनाएँ

Customer को POST /v3/customers के साथ बनाएँ। लौटाए गए customer id को संग्रहीत करें और वर्तमान resource को GET /v3/customers/{customerId} के साथ पढ़ें।

2. Eligible capability खोजें और अनुरोध करें

GET /v3/customers/{customerId}/capabilities/supported पढ़ें। एक variant केवल तब चुनें जब इसकी वर्तमान availability और eligibility request की अनुमति दे, फिर POST /v3/customers/{customerId}/capabilities/{capabilityId} का उपयोग करें।

3. वर्तमान capability और applications पढ़ें

GET /v3/customers/{customerId}/capabilities/{capabilityId} और GET /v3/customers/{customerId}/capabilities/{capabilityId}/applications पढ़ें। पहले के response से readiness मानने के बजाय वर्तमान open task ids का पालन करें।

4. वर्तमान task detail प्राप्त करें

Customer tasks को GET /v3/customers/{customerId}/tasks के साथ सूचीबद्ध करें। Authorized action surface को GET /v3/customers/{customerId}/tasks/{taskId} के साथ प्राप्त करें। Task detail first-party hosted session URLs और वर्तमान actionable requirements उजागर कर सकता है। इसकी वर्तमान revision और status का उपयोग करें।

5. Hosted sessions पूरे करें या task answers submit करें

जब task detail एक hosted session प्रदान करता है, तो अपने client को केवल आवश्यक session data लौटाएँ और API key को अपने backend में रखें। जब task answers की आवश्यकता होती है, तो POST /v3/customers/{customerId}/tasks/{taskId}/submissions के साथ एक पूर्ण immutable attempt बनाएँ। एक वर्तमान submission और उसके public outcome को GET /v3/customers/{customerId}/tasks/{taskId}/submissions/{submissionId} के साथ पढ़ें।

6. केवल अनुरोधित होने पर documents upload करें

Documents केवल तब upload करें जब वर्तमान task पूछता है। POST /v3/customers/{customerId}/documents का उपयोग करें, फिर लौटाए गए document id को applicable document answer में रखें।

7. वर्तमान resources को पुन: प्राप्त करें

प्रत्येक event या action के बाद वर्तमान customer, capability, applications, और task को पुन: प्राप्त करें। अगले step का चयन करने के लिए उनकी नवीनतम states, reasons, requirements, और open task ids का उपयोग करें।

Generated operation map

नीति और implementation मार्गदर्शन

Simplified, Standard, और Enhanced KYC नीति tiers हैं। वे वर्तमान capability, application, task, submission, requirement, या hosted-session states का स्थान नहीं लेते। Implementation विवरण के लिए, individual onboarding guide, Capabilities और tasks, और Integration Documents guide का पालन करें।