API reference, Interview

Fetch onboarding url

GEThttps://demo-api.incodesmile.com/omni/onboarding-url

Fetch onboarding URL generated for specific user and specific flow. Only supply a clientId, if a redirect to mobile feature has been added to the flow configuration and SMS and desktop onboarding is needed. Alternatively, if only a QR code is needed, it's recommended to supply clientId, components and tag parameters. The alternative will return a highly performant app launcher screen when redirect to mobile has been ena bled.

Query parameters

componentsstring

URL encode String Array of accepted string values

enumqr
tagstring
enumpaymentsverification
shortUrlstring
enumtruefalse

Headers

api-versionstringrequiredDefaults to 1.0

Responses

Was this page helpful?