Onboard allows 3rd party applications to create and authenticate users seamlessly through API endpoints. This process ensures that users can be onboarded quickly and securely.

​
Overview

User creation via API follows a simple flow:

1

Initiate authentication

Send a request via the Initiate endpoint to authenticate a user. If the provided email does not exist, a new Onboard profile is automatically created.

2

OTP verification

The user receives an OTP via email and must verify it using the Verify Auth OTP endpoint to complete authentication.

3

Resend OTP (if needed)

If the OTP is not received or has expired, trigger a resend via the Resend Auth OTP endpoint.

4

Refresh token

Once authenticated, refresh tokens as needed using the Refresh Token endpoint to maintain access without re-authentication.

​
Additional Notes

  • This flow applies to both new and existing users.
  • OTPs are required to confirm identity before access is granted.
  • For security, OTPs expire after a set duration and must be verified within that time.

For full implementation details, refer to the API reference for each endpoint.

AuthenticationInitiate user authentication