Re-authenticate existing participant

Request

If you want to re-authenticate an existing participant in an ongoing Builder session, you can use this endpoint.

See details about the url in create builder session.

Security

APIKey

Path

session_idstring, (uuid)required

The UUID of the session.

Example:7f3f5f62-2c69-7d4e-8a3d-9c0f0e2c5f3a

participant_idstring, (uuid)required

The UUID of the participant to authenticate.

Example:123e4567-e89b-12d3-a456-426614174000

Acceptstringrequired

Specify the response format.

Value:"application/json"

Bodyapplication/json

ui_languagestring(App.Enums.UiLanguage)

Enum:"en-GB""fi""de""pl""sv"

curl -i -X POST \
  https://api.builder.docue.com/api/builder/sessions/7f3f5f62-2c69-7d4e-8a3d-9c0f0e2c5f3a/participants/123e4567-e89b-12d3-a456-426614174000/authenticate \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ui_language": "en-GB"
  }'

Responses

Successful response with details about the authenticated participant.

Bodyapplication/json

dataobject(Api.BuilderSession.Participant.Data.ParticipantAuthenticatedData.ParticipantAuthenticatedData)

Response

{
  "data": {
    "id": "0195c6eb-99ae-73c1-94f0-1763b872735d",
    "url": "https://app.builder.docue.com/browser-session/0195c6eb-99ae-73c1-94f0-1763b872735d#pREXDkBmZSOnl29EzmoICcfx9S19ix6u",
    "participant": { … }
  }
}