Skip to main content
POST
/
merchants
/
{merchant_id}
/
onboarding_link
Create Embeddable Onboarding Link (does not require login)
curl --request POST \
  --url https://api-sandbox.cashfree.com/partners/merchants/{merchant_id}/onboarding_link \
  --header 'Content-Type: application/json' \
  --header 'x-partner-apikey: <x-partner-apikey>' \
  --data '
{
  "type": "account_onboarding",
  "return_url": "https://b8af79f41056.eu.ngrok.io?key1=value1"
}
'
{
  "created_at": "2023-07-24T12:24:44+0530",
  "expires_at": "2023-07-24T13:24:44+0530",
  "onboarding_link": "https://merchant.cashfree.com/merchantwebapp/validate/..token..?goto=onboarding"
}

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

​
onboarding_link
string

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