FIfinix
Onboarding Forms

Fetch an Onboarding Form

Changed on

Retrieve the details of an existing Onboarding Form.

get/onboarding_forms/{onboarding_form_id}

Request

Headers

Finix-Versionstring
Example:2022-02-01

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

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

  • b86139232ef9Revision changes
    • info

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