Skip to content

Onboarding and verification

Module id: onboarding

The case that gathers personal or business evidence over time, before the party record is the durable one.

The institution keeps approval policy and the choice of identity provider. OpenPlatform holds the case and the evidence attached to it.

Onboarding, read top to bottom: the journey, then the KYC or KYB case, then the evidence record
Read top to bottom. The channel runs the journey. The domain moves the KYC or KYB case. The core stores the evidence.

exp-onboarding is the channel API. domain-customer-kyc-kyb moves the case. core-common-kycb-mgmt stores evidence. When a durable party is required, registration goes to customers.

What it owns

  • Individual and business onboarding journeys
  • KYC cases and KYB cases, including status
  • Verification documents, corporate documents, and powers of attorney
  • Beneficial-owner records, source of funds, and expected activity
  • Sanctions questionnaire answers and screening matches stored on the case
  • Business profile and location records gathered for the case

What it does not own

  • The durable party. That is customers, after the case is ready.
  • The identity provider or screening vendor. Those stay behind an adapter.
  • Scoring cases and reporting submissions. Those are risk.
  • Sign-in and sessions. Those are shared services.

Repositories

Repository Layer What it holds OpenAPI
exp-onboarding Experience Individual onboarding, business onboarding, business search openapi.yml
domain-customer-kyc-kyb Domain KYC cases and KYB cases openapi.yml
core-common-kycb-mgmt Core Evidence, corporate profile, and case records openapi.yml

How the pieces fit

exp-onboarding exposes /api/v1/onboarding/individuals and /api/v1/onboarding/businesses. That is the journey the channel calls.

domain-customer-kyc-kyb exposes KYC cases and KYB cases. The repository README states that the KYB track is the implemented flow: create the case, collect corporate documents and beneficial owners, request verification, then evaluate the result. The KYC track exposes a lifecycle API, and the README states that the service implementation is still incomplete. Confirm that file before planning a KYC-only cutover.

core-common-kycb-mgmt stores what the case collects: verification documents, corporate documents, beneficial owners, source of funds, sanctions questionnaire answers, screening matches, and the business profile. Identity providers are not imported here. They sit behind an adapter.

Channel branding and reference data for the first screen live in exp-channel-management, documented under shared services.