FIfinix
Onboarding Forms

Create an Onboarding Form Link

Changed on

Create a link that lets users resume their Onboarding Form.

post/onboarding_forms/{onboarding_form_id}/links

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

expiration_in_minutesinteger

Duration (in minutes) the link is valid. Sets expires_at in the response. Defaults to 60 minutes.

expired_session_urlstring required

The URL users get sent to if the bearer token expires.

fee_details_urlstring required

The URL of the page where you display the fees related to processing payments (for more info, see Onboarding Forms).

merchant_max_transaction_amountinteger

The maximum transaction amount for the merchant's card payment processing.

merchant_ach_max_transaction_amountinteger

The maximum transaction amount for the merchant's ACH payment processing.

return_urlstring required

The URL users get sent to after completing the onboarding flow.

terms_of_service_urlstring required

Your Terms of Service URL. The URL is provided to users for consent along with Finix's Terms of Service.

Response

A single Onboarding Link

expires_atstring

A UTC timestamp detailing when the onboarding form expires and will no longer be available via link_url. To generate a new link to the same form, see Get an Onboarding Form URL.

link_urlstring

The URL of the user's Finix Onboarding Form. Users can use the link_url to return to the form until the link expires.

Changes

  • 27f92cb842a4Revision changes
    • info

      the request property //// became optional

  • fa256b901d16Revision changes
    • breaking

      added to the request body allOf list

    • breaking

      the request's body type changed from object to no type

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property