API ReferenceOnboarding

Create Onboarding

  1. Validate the request and get the partner from it
  2. Verify if consumer exists and if so, if there’s an onboarding flow
  3. Create a new onboarding (and new consumer) if needed
  4. Return the onboarding id and consumer data

Headers

AuthorizationstringRequired

Basic authentication of the form Basic <username:password>.

Request

This endpoint expects an object.
pcidstringRequired
onboarding_template_idstringRequired

Response

idstringformat: "uuid"
statusstring
consumerobject
kycobject
e_signobject
underwritingobject
productobject
previous_stepslist of objects
current_stepslist of objects or null
metadataobject or null