Skip to main content
GET
/
onboarding
/
token
/
{publicIdentifier}
Get Onboarding Token
curl --request GET \
  --url https://api.ever.day/onboarding/token/{publicIdentifier} \
  --header 'x-api-key: <api-key>'
{
  "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.

Path Parameters

​
publicIdentifier
string
required

The unique public identifier of the user.

Response

Onboarding token retrieved successfully.

​
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..."