ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β π shadcn/directory/clerk/clerk-docs/guides/development/upgrading/upgrade-guides/progressive-sign-up β ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β
[!NOTE] If your application was created after June 7, 2022, you're already using Progressive Sign Up.
Progressive Sign Up is a new Sign Up flow introduced in Q2 2022, that aims to improve upon the previous implementation by handling more scenarios and adhering more strictly to the authentication settings of the instance. Additionally, it allows Web3 authentication to be used together with the regular authentication settings.
It can be enabled using the Instance Settings{{ target: '_blank' }} endpoint from the Backend API.
Progressive Sign Up involves changes in the responses of the Frontend API{{ target: '_blank' }}. That said, there are no structural changes in the keys of the response payloads or any new types introduced. The changes only apply to some existing fields of the SignUp object, namely missing_fields, unverified_fields, and status. The possible values of those fields also haven not changed - what changes is when each of those values is returned.
On a high level, Progressive Sign Up contains the following changes:
On a technical level, what changes is that the values of the following fields will more accurately represent the current state of the sign-up, adhering to the instanceβs authentication requirements. This practically means:
sign_up.status may now be set to missing_requirements after a successful OAuth or Web3 flowsign_up.missing_fields may be non-empty after a successful OAuth or Web3 flowsign_up.unverified_fields may be non-empty after a successful OAuth or Web3 flowBefore you enable Progressive Sign Up, make sure youβre on Clerk.js version 3.13.2 or later.
The Progressive Sign Up flow can be toggled on via an instance setting, using the Instance Settings{{ target: '_blank' }} endpoint in Backend API. In the future, this setting will be exposed as a Dashboard toggle as well.
If you're using the prebuilt UI components, there are no changes required on your behalf.
If you're implementing a custom flow, you should cater for the case in which, after a successful OAuth or Web3 flow, the sign-up might still be in a pending state. This essentially means that you should peek into sign_up.status, sign_up.missing_fields, and sign_up.unverified_fields and act accordingly.
β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β β
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ