Create an onboarding link

Issues a link into the CardNexus-hosted onboarding flow for an account your application created. Send it in the CardNexus-Account header naming that account.

Send the seller to the returned URL. There they accept the CardNexus terms and complete the payment-onboarding steps in their own browser — which is what takes their listings live. When they finish, CardNexus returns them to your returnUrl.

While the account is unclaimed the link signs the seller straight in; once they've claimed it, the link takes them through normal sign-in.

Body

required

application/json

returnUrl
Type: string
min length:
1
required

Where CardNexus returns the seller after they finish onboarding. Must be one of your application's registered redirect URIs.

Responses

application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json

post/account/onboarding-link

curl https://public-api.cardnexus.com/v1/account/onboarding-link \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "returnUrl": ""
}'

Show Schema

{
  "url": "https://cardnexus.com/en/onboard?account=65f3a2b1c8d4e9f7a6b5c4d3&ticket=…",
  "expiresAt": "2026-02-03T18:52:55.000Z"
}

The onboarding link was issued.