Onboarding Forms

Finix offers and hosts pre-built onboarding forms that you can use to collect onboarding and identity verification information from your users.

Related Guides: Onboarding, Hosted Onboarding Form.

Create an Onboarding Form

Create an onboarding_form with the name of the processor you plan to onboard users to and the links they` get redirected to when completing or moving away from the Finix Onboarding Form.

Only ROLE_PARTNER credentials can be used to create an onboarding_form.

Request
Request Body schema: application/json
object

The prefilled information of the user that's being onboarded. For more information, see Prefilling Fields.

Array of objects

An array of objects with the processors and gateways users will be onboarded to.

object

The information of the initial onboarding link. This is only provided when creating an onboarding_form.

Responses
200

A single onboarding_from objext.

Response Schema: application/json
id
string

The ID of the onboarding_form resource.

object

The prefilled information of the user that's being onboarding. See Prefilling Fields.

Array of objects

An array of objects with the processors and gateways users will be onboarded to.

object

The information of the initial onboarding link. This is only provided when creating an onboarding_form.

status
string

Status of the onboarding_from.

Enum: "IN_PROGRESS" "COMPLETED"
created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

object

Key value pair for annotating custom meta data (e.g. order numbers).

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

422

Invalid field

post/onboarding_forms
Request samples
Response samples
application/json
{}

Fetch an Onboarding Form

Retrieve the details of an onboarding_form.

Request
path Parameters
onboarding_form_id
required
string

The id of the onboarding_form.

Responses
200

A single onboarding_from objext.

Response Schema: application/json
id
string

The ID of the onboarding_form resource.

object

The prefilled information of the user that's being onboarding. See Prefilling Fields.

Array of objects

An array of objects with the processors and gateways users will be onboarded to.

object

The information of the initial onboarding link. This is only provided when creating an onboarding_form.

status
string

Status of the onboarding_from.

Enum: "IN_PROGRESS" "COMPLETED"
created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

object

Key value pair for annotating custom meta data (e.g. order numbers).

401

Authentication information is missing or invalid

get/onboarding_forms/{onboarding_form_id}
Request samples
Response samples
application/json
{}