Sign in

v1

latestOpenAPI 3.0.12026-08-0435481.5 MB
Experience

Identify user for the current interaction

This API identifies the user based on the verificationId within the current experience interaction: <br/>- SignIn and ForgotPassword interactions: Verifies the user's identity using the provided verificationId. <br/>- Register interaction: Creates a new user account using the profile data from the current interaction. If a verificationId is provided, the profile data will first be updated with the verification record before creating the account. If not, the account is created directly from the stored profile data.

post/api/experience/identification

Request body

verificationIdstring

The ID of the verification record used to identify the user. <br/>- For SignIn and ForgotPassword interactions: Required to verify the user's identity. <br/>- For Register interaction: Optional. If provided, new profile(s) will be attached to the registration session using the information from the verification record and trigger the account creation attempt. If not provided, the user account creation attempt will be triggered using the existing profile data in the interaction.

linkSocialIdentityboolean

Applies only to the SignIn interaction and is used when a SocialVerification type verification ID is provided. <br/>- If true, the user is identified using the verified email or phone number from the social identity provider, and the social identity is linked to the user's account. <br/>- If false or not provided, the API identifies the user solely through the social identity. <br/>This parameter is used to link a non-existing social identity to a related user account identified by the verified email or phone number.

Response

Register interaction: The user account has been successfully created and identified.