One-Time Code

To invite Your Customer to the Onboarding Flow securely, you must generate a One-Time Code (OTC). You generate this secure, single-use code when inviting them; once it is used, it becomes invalid. Include the OTC in the Onboarding Flow URL—see URL and parameters for the full URL format.

Generating an OTC

Call the Consent API to generate an OTC; the response contains the One-Time Code. Use it in the Onboarding Flow URL when embedding the flow, redirecting Your Customer, or building a direct link.

URL encoding

The One-Time Code is not URL-encoded in the API response. You must URL-encode it before including it in the Onboarding Flow URL.

Validity

A One-Time Code is valid for one hour from its creation. Use it by embedding the Onboarding Flow in Your Platform or by redirecting Your Customer to the flow from Your Platform. Avoid sharing the link via channels that generate link previews (e.g. email, Slack)—the OTC is invalidated once it is consumed, and previews can consume it so the link no longer works.

OTC validity

A One-Time Code is valid for one hour from its creation and is single-use (invalidated once consumed).