Migration Guide (v2.0 to v2.1)

Time to Complete	1 day
Time to Test and Deploy	1-2 days
Skills Required	Make API calls

note

v2.1 is a minor, non-breaking version change from v2.0, but we encourage you to migrate.

important

If you're using the Non-Hosted v2.0 integration type, no action is needed!

As detailed below, Non-Hosted in v2.0 is equivalent to API in v2.1.

Updates in v2.1

The most significant updates in v2.1 are:

• We introduced an SDK, which is 10x faster to integrate. It's highly customizable and handles the user experience end to end, including sending SMS to users for phone verification.
• We revamped our suite of test users, making it far easier to test all possible flows of 1-Click Signup. Crucially, the new test users all have phone numbers that pass validation checks, making them much simpler to use for both manual and automated testing.
• We changed the available integration types: The integration types in v2.0 are updated to integration types in v2.1 as follows:
  • Hosted in v2.0 is replaced by SDK in v2.1
  • Semi-Hosted in v2.0 is no longer available in v2.1
  • Non-Hosted in v2.0 is equivalent to API in v2.0

Migrate from Hosted v2.0

If you're using the Hosted v2.0 integration type, you should migrate to SDK v2.1. This is very easy to do because the SDK handles more functionality (hosting the Phone screen and sending SMS), so you can remove much of what you needed for Hosted.

Here are the differences between the integration types:

Version	v2.0	v2.1
Integration Type	Hosted	SDK
User Interface	Partly Hosted by Verified (no Phone screen)	Fully Hosted by Verified (embeddable as SDK)
Phone Verification Code	Generated by Verified	Generated by Verified
SMS	Sent by You	Sent by Verified (or You)

Migrate to SDK v2.1

All you need to do is integrate the SDK, which is extremely easy! Just follow the v2.1 Setup and SDK Integration guides. It should take no more than half a day.

tip

You can remove the Phone screen and SMS sending you implemented for Hosted v2.0. There's no need for them now: the SDK handles everything for you.

Migrate from Semi-Hosted v2.0

If you're using the Semi-Hosted v2.0 integration type, you can either migrate to SDK v2.1 or migrate to API v2.1:

• We generally recommend using the SDK integration type in v2.1 because it handles all functionality (including hosting the user interface and sending SMS) and is highly customizable, so it's extremely easy to use in a way that matches your branding. It also implements the hyper-optimized user experience our team has honed with countless hours of research, design, testing, and iteration.
• However, with the Semi-Hosted integration type in v2.0, you're already hosting your own user interface and sending SMS, so you have most of what you need in place to use the API integration type in v2.1. So, this would be a good option for you if you want to keep your existing user experience in place.

tip

Migrating to either integration type is easy, so it's just a question of what you prefer!

Here are the differences between the integration types:

Version	v2.0	v2.1
Integration Type	Semi-Hosted	SDK	API
User Interface	Hosted by You	Hosted by Verified (embeddable as SDK)	Hosted by You
Phone Verification Code	Generated by Verified	Generated by Verified	Generated by You
SMS	Sent by You	Sent by Verified (or You)	Sent by You

Migrate to SDK v2.1

All you need to do is integrate the SDK, which is extremely easy! Just follow the v2.1 Setup and SDK Integration guides. It should take no more than half a day.

tip

You can remove the user interface and SMS sending you implemented for Semi-Hosted v2.0. There's no need for them now: the SDK handles everything for you.

Migrate to API v2.1

All you need to do is the following. It should take no more than a day.

1. Generate and check phone verification codes: With API integration type in v2.1, Verified does not generate or check phone verification codes for you, so you'll need to do this yourself. You can also use a dedicated third party service (like Twilio Verify) for this if you prefer.
2. Update your API calls:
   1. Remove the first POST /1-click call (step 2 under Semi-Hosted in the table below). This call was to have Verified generate a phone verification code, which in API v2.1 you do yourself.
   2. Replace the GET /1-click call (step 5 under Semi-Hosted in the table below). Call POST /1-click instead. You'll receive either data or an error. The same error handling you have in place for the GET call will work for the POST call.
   3. Replace the PATCH /1-click call (step 7 under Semi-Hosted in the table below). Call POST /1-click instead (with additional info from the user). You'll receive either data or an error. The same error handling you have in place for the PATCH call will work for the POST call.

That's it!

See the v2.1 API Integration guide for full details. Here are the differences in steps between the integration types:

Version	v2.0	v2.1
Integration Type	Semi-Hosted	API
Steps	Prompt user for phone number. Call POST /1-click. Send SMS to user. Prompt user for verification code. Call GET /1-click. (if necessary) Prompt user for additional info. (if necessary) Call PATCH /1-click with additional info. Prompt user to confirm their data.	Prompt user for phone number and verify it. Generate verification code. Send SMS to user. Prompt user for verification code. Check user input against verification code. Call POST /1-click. (if necessary) Prompt user for additional info. (if necessary) Call POST /1-click with additional info. Prompt user to confirm their data.

Migrate from Non-Hosted v2.0

important

If you're using the Non-Hosted v2.0 integration type, no action is needed!

As detailed below, Non-Hosted in v2.0 is equivalent to API in v2.1.