API reference, eKYB

KYB form for an onboarding session

GEThttps://demo-api.incodesmile.com/omni/kyb/form

Returns the form to collect the business details for the KYB step of an onboarding session. Render it as is: which modules run for the country, which fields are shown and required, and their formats are already decided.

Call it first without country: the form has only a country field, listing the countries the organization can run KYB for. Each time the country changes (the field's refetchOnChange), call it again with country: the form then has the fields for that country and a submit section for POST /omni/kyb. Modules selected for the step that are not supported for the country are listed in context.unsupportedModules; they are still submitted and come back with a notSupported error.

Texts carry a translation key and an English text fallback.

Query parameters

countrystring

Country of the business, ISO 3166-1 alpha-2. Omit for the first form.

Headers

api-versionstringrequiredDefaults to 1.0

Responses

no body