Skip to content
/Onboarding Token

Onboarding Token API (1.0)

This API enables customers to programmatically generate unique onboarding tokens (OT) for end-users, following existing onboarding logic, and automatically email the token to the user. Tokens are created with a 14-day expiration, conflict detection, and standard state handling (Issued, Used, Expired). Issued tokens are recorded in the organization's dashboard.

Download OpenAPI description
onboarding-token-docs.json
onboarding-token-docs.yaml
Overview
URL
https://sqr.id
SQR
support@sqr.id
Languages
Servers
https://api.sqr-group.com/

Onboarding Token

— This API allows customers to programmatically create onboarding tokens and email them to end-users.

Operations

Create onboarding token

Request

Create a unique onboarding token (OT) for an end-user, email it to them using the standard onboarding template, and return the token in the response

Security
bearer
Bodyapplication/jsonrequired
emailstringrequired

Email Address of the user

Example: "john.doe@sqr-group.com"
first_namestringrequired

First name of the user

Example: "John"
last_namestringrequired

Last name of the user

Example: "Doe"
curl -i -X POST \
  https://api.sqr-group.com/v1/onboarding-token \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "john.doe@sqr-group.com",
    "first_name": "John",
    "last_name": "Doe"
  }'

Responses

Onboarding token has been successfully created and submitted to the client via Email.

Bodyapplication/json
onboarding_tokenstringread-only

The onboarding token created by admin.

Example: "SNFF3I2"
Response
application/json
{
  "onboarding_token": "SNFF3I2"
}
Copyright © 2025 SQR. All Rights Reserved.