Initiate provider authentication
Initiate authentication for a user. After this request, the user can be redirected to Upheal Video Call experience and is able to use the session token from response to authenticate with Upheal.
- application/json
Request Body required
Auth initiation request
- providerUserId string required
The provider user's internal Upheal UUID (returned from user creation or GET endpoints). Partner external IDs (partnerUserId) are not supported.
- clientUserIds string[] required
Client user internal Upheal UUIDs (returned from user creation or GET endpoints). Partner external IDs (partnerUserId) are not supported.
- partnerAppointmentId string
Optional identifier that will be included in the web-hook payload. Can be used to correlate upheal session with partner's identifier.
- subjectUserId string
The user's internal Upheal UUID to initiate the authentication for. Must be either the provider or client user specified in this request. Defaults to the providerUserId. Partner external IDs (partnerUserId) are not supported.
- 200
- 400
- 403
OK
- application/json
- Schema
- Example (from schema)
Schema
- meetingUrl string required
URL used to navigate to Upheal Video Call experience and continue authentication.
{
"meetingUrl": "string"
}
Invalid input. For example when provided user ids do not exist.
Invalid API Key