Onboarding applications
Overview
The hosted onboarding is a customizable, pre-built page hosted on Getpaid's servers. You can tailor its appearance to match your platform's branding and manage the entire onboarding process, allowing your sellers to submit the information required to start accepting payments in the Getpaid solution.
Steps
1. Create an onboarding application
Your first step is to create the onboarding application via API by calling the POST api.getpaid.io/v2/applications
endpoint, including at least the email of the application.
To reduce the abandonment rate, you may prefer to include as much information as you already have about the company, saving the applicant time and allowing them to review and edit it if needed.
{
"reference": "53426",
"applicant": {
"email": "markus.keller@garagegermany.de",
"first_name": "Markus",
"last_name": "Keller"
},
"business": {
"legal_name": "Garage Deutschland AG",
"registered_address": {
"line1": "Immermannstraße",
"line2": "Haus 2, Wohnung 3A",
"street_number": "40",
"city": "Düsseldorf",
"region": "Nordrhein-Westfalen",
"postal_code": "40210"
},
"registration_number": {
"type": "de_hrb",
"value": "HRB 12345",
"registry": "duesseldorf"
}
},
"redirect": {
"default": "https://titanauto.com/onboarding/complete?customer=53426"
},
"webhooks": {
"url": "https://webhooks.titanauto.com/getpaid"
}
}
2. Handle the application response
A successful onboarding application creation returns an application id and a flow.next_step.url to present the
onboarding form to the applicant that it is representing the seller.
{
"id": "app_4fekhxdpss1et7rjp8t7rdpnw4",
"status": "initiated",
"reference": "53426",
"created_at": "2026-01-14T14:45:22.993Z",
"updated_at": "2026-01-14T14:45:22.993Z",
"expires_at": "2026-01-28T14:45:22.993Z",
"flow": {
"next_step": {
"type": "redirect",
"url": "https://onboarding.getpaid.io/v2/app_4fekhxdpss1et7rjp8t7rdpnw4?token=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}
}
}
3. Redirect to hosted onboarding
You can either redirect the seller to the hosted onboarding URL immediately or send them the link to complete it later.
4. Onboarding form rendered
Once the seller is redirected or clicks the application link, the onboarding page is displayed in their browser, showing the required information to submit before they start accepting payments.
5. Submit company and representatives details
The applicant will be guided through the steps to upload the required information on the company and its directors and ultimate beneficial owners to start accepting payments in the Getpaid solution.
Each completed step is saved so the process can be resumed later without losing progress. Previous steps can also be reviewed after completion and changed if needed.
6. Refresh the onboarding application
The onboarding application URL is valid for 14 days. If the seller hasn't completed and submitted the onboarding form
within that period, you can extend the application's validity for another 14 days by calling the POST
api.getpaid.io/v2/applications/{application_id}/refresh
endpoint.
Use the URL returned in the response at flow.next_step.url to redirect your seller to continue completing the
onboarding form.
{
"id": "app_4fekhxdpss1et7rjp8t7rdpnw4",
"updated_at": "2026-01-28T14:45:22.993Z",
"expires_at": "2026-02-11T14:45:22.993Z",
"flow": {
"next_step": {
"type": "redirect",
"url": "https://onboarding.getpaid.io/v2/app_4fekhxdpss1et7rjp8t7rdpnw4?token=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}
}
}
7. Submit onboarding application
The applicant, representing the seller, will see a summary of the information submitted in each step and can update any details that are incorrect before confirming the application and submitting it for review.
8. Redirect to platform website
Once the application is submitted, the seller is redirected to your website, as specified in the redirect block during
application creation, allowing your client-side application to update or fetch
the application status from your system.
9. Application submitted notification
After the application is submitted, your platform server — set in the webhooks block during application
creation — receives an application_submitted
webhook.
{
"id": "evt_49c6zjncp5fk4572vj1y1f9gw8",
"type": "application_submitted",
"version": "v2",
"occurred_at": "2026-01-14T09:38:12.831Z",
"data": {
"id": "app_4fekhxdpss1et7rjp8t7rdpnw4",
"reference": "53426"
}
}
10. Seller company and representatives screening
Getpaid conducts the screening of the company and its representatives to ensure that every party involved in the funds flow can start receiving payments safely.
The process prevents fraud and complies with Anti-Money Laundering (AML) regulations to ensure that sellers are not engaged in illegal activities. The Getpaid solution verifies the identity and legitimacy of the seller before allowing them to accept payments or receive payouts, so your platform doesn't need to do this from a payments acceptance perspective.
11. Application completed notification
Once the application is reviewed and the screening process is completed satisfactorily, the application is approved,
your platform server — set in the webhooks block during application creation —
receives an application_completed webhook.
As a result Getpaid account is created for the seller so you can start using the seller account ID to start accepting payments, for example, including the account ID in the splits of the checkout creation.
{
"id": "evt_49c6zjncp5fk4572vj1y1f9gw8",
"type": "application_completed",
"version": "v2",
"occurred_at": "2026-01-16T08:02:55.339Z",
"data": {
"id": "app_4fekhxdpss1et7rjp8t7rdpnw4",
"reference": "53426"
}
}