FIfinix
Onboarding Forms

Create an Onboarding Form

Changed on

Create an Onboarding Form by entering the processor’s name you want to onboard users to. Also, provide the links to send users after they finish or leave the form.

You can only create an Onboarding Form if you have ROLE_PARTNER credentials.

post/onboarding_forms

Request

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Content-Typestring
Example:application/json

The data type being sent in the request body must be application/json.

Request body

OR
OR
OR

Response

A single Onboarding Form

idstring

The ID of the resource.

status'IN_PROGRESS' | 'COMPLETED' | 'UPDATE_REQUESTED'

Status of the onboarding_form.

identity_idstring nullable

The ID of the identity resource. This is only provided when the onboarding_form is COMPLETED.

application_idstring

ID of the Application the resource was created under.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)

Changes

  • 27f92cb842a4Revision changes
    • breaking

      the response property / became optional for the status

    • info

      the request property ////// became optional

    • info

      the request property ////// became optional

    • info

      the request property ////// became optional

    • info

      the request property ////// became optional

  • b86139232ef9Revision changes
    • info

      the request optional property ////// became read-only

    • info

      the request optional property ////// became read-only

    • info

      the request optional property ////// became read-only

    • info

      the request optional property ////// became read-only

    • info

      the response optional property / became read-only for the status