Skip to main content
POST
/
auth
/
user-auth
/
initiate
Initiate authentication for a user
curl --request POST \
  --url https://external.dev.onboardpay.co/auth/user-auth/initiate \
  --header 'Content-Type: application/json' \
  --header 'x-signature: <api-key>' \
  --data '
{
  "email": "<string>"
}
'
{
  "authSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isReturning": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.onboard.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-signature
string
header
required

Body

application/json
​
email
string
required

user's email

Response

Success

​
authSessionId
string<uuid>

The log in session ID of the user, valid for the duration of the OTP validity

​
isReturning
boolean
default:false

Indicates if user is a returning user, i.e. previously verified