Skip to main content
POST
Create Embeddable Onboarding Link (does not require login)

Headers

x-partner-apikey
string
required

Your partner API key for authentication

x-api-version
string
default:2023-01-01

API version to be used for the request

Path Parameters

merchant_id
string
required

Unique identifier for the merchant

Body

application/json
type
string

The type of onboarding link. Value should be "account_onboarding".

return_url
string

The URL to which the user will be redirected after KYC submission

Response

OK

created_at
string

Timestamp when the onboarding link was created

expires_at
string

Timestamp when the onboarding link will expire

URL for the onboarding link. Embed this link within your platform.