Skip to main content
POST
Create a setup link for a customer

Authorizations

Authorization
string
header
required

Tenant API key.

Path Parameters

customerId
string<uuid>
required

Body

application/json
allowedOrigins
string[]
required
Required array length: 1 - 8 elements

Exact https origin, e.g. https://app.example.com

Maximum string length: 200
successRedirectUrl
string

https URL on one of allowedOrigins.

Maximum string length: 2000
failureRedirectUrl
string
Maximum string length: 2000
allowedConnectionTypes
enum<string>[]
Required array length: 1 - 2 elements
Available options:
dedicated,
coexistence

Response

Setup link.

url
string<uri>

Hosted Embedded Signup page /connect/{token}. Single use, expires in 1 hour.

token
string
expiresAt
integer<int64>

Unix epoch milliseconds.

customerId
string | null
allowedConnectionTypes
enum<string>[]
Available options:
dedicated,
coexistence
successRedirectUrl
string | null
failureRedirectUrl
string | null