Quick Start Guide
This Quick Start Guide is the fastest way to try 1-Click Signup at a technical level.
| Time to Complete | 5 minutes |
|---|---|
| Skills Required | Ability to make API calls |
Setup
1. Access Dashboard.
Someone at your company may have already created an account for you, in which case you would have received an email invite. Check for this before creating a new account.
Detailed Steps
a. Enter your email and click the 1-Click Login button.
We'll send you a verification code by email.
Use your work email. We use AI magic to autofill brand information based on your email domain, so you don't have to manually enter it!
b. Complete the verification step.
Click the verification button in the email or enter the verification code. We'll automatically log you in. It's a 1-click experience, as promised!
c. (if necessary) Confirm your company name.
If you're creating the Dashboard account for your company, we'll ask you to confirm your company name. If someone on your team has already created your account, you won't need to do this.
If your account doesn't have a brand yet, we'll automatically create one for you and take you to its Brand Details page.
Your company account can have one or more brands. Generally, you'll only need one brand, but there are some cases where it's helpful to use multiple. For example:
- If you have multiple products: If you have products that go by different names, it can be useful to create different brands to help users know which product they're using 1-Click Signup for — and to help your team track metrics specific to that product.
- If you want to try different brand settings: If you want to change brand settings without affecting your existing implementation (even in Sandbox), you can duplicate your brand and configure different settings on the new brand.
d. (optional) Invite team members.
Invite your team members to join your Dashboard account.
For this Quick Start Guide, just leave the default brand settings in place. Notice that the default setting for integration type is Hosted. This means you'll use a user interface and phone verification that Verified hosts. This is the quickest way to get started.
For full technical details on how to integrate 1-Click Signup, see Integration Guide. For more information on integration types, see Determine integration type.
1-Click Signup
2. Call POST /1-click.
Call POST /1-click with your own phone number (or one of our test user's phone numbers). Use the Sandbox API key for the brand you just created in the Dashboard.
All requests to the Verified API require an API key as the Authorization header value.
For detailed information on authentication, see the Authentication Page.
The response body will contain url and code, which you'll use in the following steps.
In a full integration, you'd send an SMS containing code to the user to verify the phone number. But for this Quick Start Guide, we'll skip the SMS step. Just pretend you sent the SMS.
3. Complete user experience.
Because for this Quick Start Guide we're using a Hosted integration type, the 1-Click Signup user interface will be hosted by Verified (at url).
a. Navigate to url.
Open url in any web browser, on any device. This will take you to our hosted user interface.
b. Enter code.
When we prompt you for a verification code, enter code.
c. Click the 1-Click Signup button.
We'll display your (mock) verified data and ask you to confirm you want to share it with the brand. Do so by clicking the 1-Click Signup button.
Then, we'll redirect you to the default redirect URL defined in your brand settings in the Dashboard. (Unless you changed what we autofilled, this will be the same as your email domain.) We'll append an identityUuid URL parameter, which you'll use in the next step.
4. Call GET /1-click.
Call GET /1-click/{identityUuid} with the value of the identityUuid URL paramter on the redirect URL we navigate you to.
If you can't find the identityUuid parameter (for example if your website automatically strips URL parameters), you can instead use uuid from the response body of POST /1-click, which has the same value.
The response body will be a 1ClickEntity (see this example), which contains the user's data and metadata about it. You can use this data however you like to create a new account for the user!