GET
Get the KYC form schema
When currentStep is KYC_INTERNAL (or KYB_INTERNAL), fetch the form definition and render it. The schema is grouped into steps. Each field carries its input_type, label, required flag, validation rules, and any conditional required_if logic. Document fields (kyc_type: "documents") take file uploads. Collect the answers and send them to Submit KYC data.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

applicationId
string
required

The unique identifier of the application.

Query Parameters

programId
string
required

The program the application/customer belongs to. Appended as a query parameter on every back-office request.

Response

The onboarding form schema.

success
boolean
Example:

true

data
object