Skip to main content
POST
/
onboarding
/
token
Create Onboarding Token
curl --request POST \
  --url https://api.ever.day/onboarding/token \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "publicIdentifier": "john-doe-1234",
  "redirectUrl": "https://platform.client.com/complete"
}
'
{
  "signature": "a1b2c3d4...",
  "status": "pending",
  "link": "https://onboarding.ever.day/243324-234324-123123?signature=a1b2c3..."
}

Authorizations

​
x-api-key
string
header
required

Include your API key in the x-api-key header to authenticate requests. Each organisation is provided with a unique API key. If your key is lost or compromised, contact support to request a new one.

Body

application/json
​
publicIdentifier
string

A unique identifier for the user.

Example:

"john-doe-1234"

​
redirectUrl
string

The URL to which the user will be redirected after onboarding is completed.

Example:

"https://platform.client.com/complete"

Response

Onboarding token successfully created.

​
signature
string

A unique signature used for verifying the onboarding link.

Example:

"a1b2c3d4..."

​
status
enum<string>

The status of the onboarding process.

Available options:
pending,
completed,
revoked
Example:

"pending"

​
link
string | null

The generated onboarding link for the user. Null if revoked.

Example:

"https://onboarding.ever.day/243324-234324-123123?signature=a1b2c3..."