Calling the API endpoint

When the user clicks on the offer CTA the partner should call the start hosted application endpoint to start a Wayflyer application for the user's company.

The partner should provide as much data as possible to the API endpoint. During the API call Wayflyer will create a funding application and pre-fill it with data from the API call.

The request body should be like below (further details can be found in the API spec)

{
  "company_data": {},
  "user_data": {},
  "partner_data": {}
}

The company_data object should contain information about the company starting the application. The user_data object should contain information about the user initiating the action.

The response will be like below:

{
  next: "https://app.wayflyer.com"
}

The next property is the URL the user should be redirected to. This will be a co-branded landing page where they can continue and complete their application.

If the partner calls this endpoint and the customer already has an open hosted application that application will be used instead of creating a new one. Partners should avoid calling this endpoint while the company has an open hosted application.

Customising the application with partner_data

For some partners some extra data may be required to start a hosted application. This data can be provided by the partner_data object. The shape of this object will be agreed during your onboarding with Wayflyer.