Skip to main content
POST
Create a buyer onboarding session
Before a buyer can use Tilta payment terms, they must complete the onboarding flow – a white-labeled, Tilta-hosted experience where they confirm their business details and consent to the credit application. This endpoint creates a short-lived session that gives the buyer secure, authenticated access to that flow.

Integration options

Redirect integration

Redirect the buyer’s browser to the url returned in the response. Tilta hosts the full onboarding experience and redirects back to your success_url or error_url when the buyer finishes. This is the quickest way to get started with zero frontend code changes.

Embedded Web Element

Use the token to initialize the Tilta JS SDK and embed the onboarding UI directly within your platform’s checkout or account page. Provides a seamless white-labeled experience without leaving your site.
Onboarding sessions are short-lived. If the buyer does not start the onboarding flow within the session’s validity window, you must create a new session. Do not cache or reuse session tokens across requests.
Onboarding is only relevant for buyers who do not yet have a credit facility. Call Retrieve facility first – if it returns a facility, the buyer has already been through onboarding.

Authorizations

Authorization
string
header
required

Your Tilta API key, sent as Bearer <key>.

Path Parameters

external_id
string
required

Unique identifier of a buyer.

Maximum string length: 100
Pattern: ^[a-zA-Z0-9-_]+$

Body

application/json
success_url
string<uri>
error_url
string<uri>

Response

JWT token and hosted onboarding URL to authenticate a buyer in the self onboarding flow. The token is valid for 2h.

token
string
required
url
string
required