Create an Onboarding Form Link

Overview

Create a new link to allow users to return and continue completing their form session. This endpoint is useful when the original onboarding link has expired or when you need to generate a new link for a user to resume their onboarding process.

Resource Access

• User Permissions: Partner role only (ROLE_PARTNER)
• Endpoint: POST /onboarding_forms/\{onboarding_form_id}/links

Arguments

Parameter	Type	Required	Description
onboarding_form_id	string	Yes	The unique ID of the onboarding_form resource
return_url	string	No	URL the user is redirected to after successful completion
expired_session_url	string	No	URL the user is redirected to if the link expires
terms_of_service_url	string	No	URL linking to the platform's terms of service
fee_details_url	string	No	URL linking to the platform's fee details
expiration_in_minutes	integer	No	Time until the new link expires (default: 10080 minutes / 7 days)

Example Request

curl -X POST \
  'https://api.ahrvo.network/payments/na/onboarding_forms/OFonboardingFormExample123/links' \
  -u username:password \
  -H 'Content-Type: application/json' \
  -d '{
    "return_url": "https://yourplatform.com/onboarding/success",
    "expired_session_url": "https://yourplatform.com/onboarding/expired",
    "terms_of_service_url": "https://yourplatform.com/terms",
    "fee_details_url": "https://yourplatform.com/fees",
    "expiration_in_minutes": 1440
  }'

Example Response

{
  "expires_at": "2023-06-17T10:30:00Z",
  "link_url": "https://forms.finix.com/onboarding/OFonboardingFormExample123?token=xyz789abc"
}

Minimal Request Example

If you want to use the same link details as the original form, you can send an empty request body:

curl -X POST \
  'https://api.ahrvo.network/payments/na/onboarding_forms/OFonboardingFormExample123/links' \
  -u username:password \
  -H 'Content-Type: application/json' \
  -d '{}'

Additional Information

• Resume Functionality: The new link allows users to resume their onboarding session with any previously entered data pre-filled
• Link Expiration: Each link is single-use and time-limited. The default expiration is 10080 minutes (7 days)
• Custom Expiration: You can set a custom expiration time using the expiration_in_minutes parameter:
  • 1 hour: 60 minutes
  • 24 hours: 1440 minutes
  • 7 days: 10080 minutes (default)
  • 30 days: 43200 minutes
• URL Updates: You can optionally update the redirect URLs when creating a new link. If not provided, the original URLs from the onboarding_form will be used
• Use Cases:
  • Expired Links: When the original onboarding link has expired
  • Lost Links: When a user loses the original email with the onboarding link
  • Email Resend: When you need to send a new email with a fresh link
  • Different Expiration: When you want to provide a shorter or longer expiration time
• Form Status: This endpoint only works with forms that have status IN_PROGRESS. Once a form is COMPLETED, you cannot create new links
• Security: Each new link generates a unique token, invalidating any previously generated links for the same form
• Session Continuity: Users will see their previously entered information when they access the new link, allowing them to pick up where they left off