Initiate OTP authentication

Initiate OTP authentication for a user. Result is a one-time password (OTP) that can be used to authenticate against Upheal.

Request Body required

Auth initiation request

userId string required
The user's internal Upheal UUID (returned from user creation or GET endpoints) for which the OTP is being generated. Partner external IDs (partnerUserId) are not supported.
extras object
Context-specific details for various OTP use cases.
property name* string

Responses

Schema

otpToken string required
the generated token to be used for authentication of external service
userRole string required
Possible values: [Client, HealthcareProvider, OrgAdmin, Admin]
Role of the user for which the OTP was generated.

{
  "otpToken": "string",
  "userRole": "Client"
}

Initiate OTP authentication​