Naar hoofdinhoud gaan

Individuele onboarding API-workflow

Gebruik deze map om individueel KYC-beleid te verbinden met de huidige gegenereerde API-referentie. Volg bij elke stap de huidige resource in plaats van beleidsgerichte labels als API-state machine te implementeren.

Workflow-map

1. Maak de individuele klant aan

Maak de klant aan met POST /v3/customers. Sla de geretourneerde klant-ID op en lees de huidige resource met GET /v3/customers/{customerId}.

2. Ontdek en vraag een eligible capability aan

Lees GET /v3/customers/{customerId}/capabilities/supported. Selecteer alleen een variant wanneer de huidige availability en eligibility het request toestaan en gebruik dan POST /v3/customers/{customerId}/capabilities/{capabilityId}.

3. Lees de huidige capability en applications

Lees GET /v3/customers/{customerId}/capabilities/{capabilityId} en GET /v3/customers/{customerId}/capabilities/{capabilityId}/applications. Volg huidige open task-ID’s in plaats van readiness aan te nemen op basis van een eerdere respons. Voor named bank-capabilities heeft een klant één application-case per bank, gedeeld over compatibele capabilities. Zie Gedeelde applications per bank voor responscodes, selectedApplicationId en de lijst met applications van de klant.

4. Haal het huidige taakdetail op

Bekijk klanttaken met GET /v3/customers/{customerId}/tasks. Haal het geautoriseerde action surface op met GET /v3/customers/{customerId}/tasks/{taskId}. Het taakdetail kan first-party hosted session URL’s en de huidige actionable requirements tonen. Gebruik de huidige revisie en status. In intaketaken die directe indiening accepteren, gaan eligible vereisten die al worden onderbouwd door het profiel van de klant of geüploade documenten automatisch naar review. Bouw formulieren op basis van de metadata van elke vereiste. Zie Vereisten renderen.

5. Voltooi hosted sessions of dien taakantwoorden in

Wanneer het taakdetail een hosted session levert, retourneer je alleen de vereiste sessiedata naar je client en houd je de API-key op je backend. Wanneer de taak antwoorden vereist, maak je één volledige immutable attempt met POST /v3/customers/{customerId}/tasks/{taskId}/submissions. Lees één huidige submission en de publieke outcome met GET /v3/customers/{customerId}/tasks/{taskId}/submissions/{submissionId}.

6. Upload documenten alleen wanneer gevraagd

Upload documenten alleen wanneer de huidige taak erom vraagt. Gebruik POST /v3/customers/{customerId}/documents en plaats vervolgens de geretourneerde document-ID in het toepasselijke document-antwoord.

7. Refetch huidige resources

Refetch de huidige customer, capability, applications en task na elke event of actie. Gebruik hun nieuwste states, reasons, requirements en open task-ID’s om de volgende stap te kiezen.

Gegenereerde operation-map

Beleid en implementatierichtlijnen

Simplified, Standard en Enhanced KYC zijn beleidstiers. Ze vervangen geen huidige capability-, application-, task-, submission-, requirement- of hosted-session-states. Voor implementatiedetails volg je de individuele onboarding-gids, Capabilities en tasks en de Integration Documents-gids.