Sign in

v1

latestOpenAPI 3.0.02026-07-2667172347.6 KB
Workflows

Create SDK session

Use this endpoint to create an App Drop-in or Web SDK session for a workflow. <br /><br /><img src="https://files.readme.io/310d4d3-Inline_Caution.svg" align="left" alt="Important" /> Important: <br />• SDK validation codes are single use and expire after <strong>2 hours</strong>. <br />• If the client stops in the middle of the workflow, you need to create a new SDK session. <br />• When the client closes the app or browser, the validationCode is invalidated and cleared from the cache.

post/v1/workflows/{workflowId}/validationcode

Path parameters

workflowIdstring required

Our unique identifier for the workflow, returned in the Create workflow response. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0 <br /><br /><img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/> Tip: Use this as the reference number for any questions.

Headers

Authorizationstring required

The access_token returned in your most recent Create access token response.

Request body

target'Mobile' | 'Web' required

The type of SDK session. <br />Enum: <br />• Mobile: App Drop-in session <br />• Web: Web SDK session

Response

Validation code returned

validationCodestring

The single-use validation code to link the SDK session to the workflow. <br /><br />Format: Alphanumerical string of 8 characters

expiryDateTimestring Datetime

The timestamp for when the validation code expires (2 hours after creation) <br /><br />Format: ISO 8601 UTC date and time