Initiate authentication for a user

Initiate authentication for a user. If the email address is for a new user, a new onboard profile will be created

post/auth/user-auth/initiate

Request

Base URL
https://external.dev.onboardpay.co
Auth
API key in header x-signature
TypeScript
https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/docs/auth/user-auth/initiate/post.ts
A function with typed inputs. Its response is checked against the schema.

emailstring required

user's email

Success

authSessionIdstring uuid

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

isReturningboolean

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

No recorded changes to this operation across all 22 revisions of this API.