Inputs
An input is a piece of data you pass to the SDK or API.
To source verified data (outputs) for a user:
- Identifiers: Phone is always required. Email is optional, but including it helps source better and more metadata — especially risk signals. It cannot be used on its own to source credentials (user identity data).
- Challenges: These are only required sometimes: if you get the
OCE11error code, which indicates that additional information is required. This happens when Verified is unable to narrow down to a single user based on the inputs already provided. - Other Inputs: These are optional. For name, we'll try to match against all names we find associated with the user. This often means, for example, that a user's nickname will match as well as their legal name, but that depends on which names we can source for the user.
1-Click Signup
Identifiers
An identifier is a piece of user data that's used as a primary lookup for outputs and must match the outputs.
| Input | Key | Required? | Type | Format(s) | Description | Example |
|---|---|---|---|---|---|---|
| Phone | phone | Required | string | E.164 | Phone number a user uses to verify for 1-Click Signup | "+12125550010" |
email | Optional | string | Email address a user uses to verify for 1-Click Signup | "richard@piedpiper.net" |
Challenges
A challenge is a piece of user data that's used as a secondary lookup for outputs and must match the outputs.
Unlike other inputs, challenges must match the outputs sourced for a user. In other words, they have to match the records we find for a user, or you'll get an OCE012 error. That's because birth dates and SSN4s don't vary, while names and addresses do. For example, a user may enter a nickname rather than their legal name, or they might have recently moved.
| Input | Key | Required? | Type | Format(s) | Description | Example |
|---|---|---|---|---|---|---|
| Birth Date | birthDate | optional (but required after some OCE011 errors) | string | YYYY-MM-DD | Birth date | "1989-08-01" |
| SSN4 | ssn4 | optional (but required after some OCE011 errors) | string | 4 digits (0-9) | Last 4 digits of Social Security Number | "6789" |
Other Inputs
An other input is a piece of user data that's used as an additional lookup for outputs and does not have to match the outputs.
Unlike challenges, these other inputs do not have to match the outputs sourced for a user. That's because names and addresses vary, while birth dates and SSN4s don't. For example, a user may enter a nickname rather than their legal name, or they might have recently moved.
| Input | Key | Required? | Type | Format(s) | Description | Example |
|---|---|---|---|---|---|---|
| Full Name | fullName | Optional | Object | Object with keys for one or more child credentials listed below | Full name | |
| ↳ First Name | fullName.firstName | Optional | string | cAse inSensiTive | First name | "Richard" |
| ↳ Middle Name | fullName.middleName | Optional | string | cAse inSensiTive | Middle name | "Harrison" |
| ↳ Last Name | fullName.lastName | Optional | string | cAse inSensiTive | Last name | "Hendricks" |
| Address | address | Optional | Object | Object with keys for one or more child credentials listed below | Address | |
| ↳ Line 1 | address.line1 | Optional | string | cAse inSensiTive | Line 1 of address | "5320 Newell Rd" |
| ↳ Line 2 | address.line2 | Optional | string | cAse inSensiTive | Line 2 of address | "" |
| ↳ City | address.city | Optional | string | cAse inSensiTive | City of address | "Palo Alto" |
| ↳ State | address.state | Optional | string |
| State of address |
|
| ↳ ZIP Code | address.zipCode | Optional | string | ZIP Code of address |
| |
| ↳ Country | address.country | Optional | string |
| Country of address |
|
1-Click Health
Whether 1-Click Health returns health data for a user depends on a complex matching process between the inputs provided and the outputs Verified sources. The more inputs you provide (as long as they're accurate), the better the outputs will be.
We recommend using 1-Click Signup to source inputs for 1-Click Health! Using the two products together results in the fastest, easiest user experience.
| Input | Key | Required? | Type | Format(s) | Description | Example |
|---|---|---|---|---|---|---|
| Full Name | fullName | Mixed | Object | Object with keys for one or more child credentials listed below | Full name | |
| ↳ First Name | fullName.firstName | Required | string | cAse inSensiTive | First name | "Richard" |
| ↳ Middle Name | fullName.middleName | Optional | string | cAse inSensiTive | Middle name | "Harrison" |
| ↳ Last Name | fullName.lastName | Required | string | cAse inSensiTive | Last name | "Hendricks" |
| Birth Date | birthDate | Required | string | YYYY-MM-DD | Birth date | "1989-08-01" |
| Address | address | Optional | Object | Object with keys for one or more child credentials listed below | Address | |
| ↳ Line 1 | address.line1 | Optional | string | cAse inSensiTive | Line 1 of address | "5320 Newell Rd" |
| ↳ Line 2 | address.line2 | Optional | string | cAse inSensiTive | Line 2 of address | "" |
| ↳ City | address.city | Optional | string | cAse inSensiTive | City of address | "Palo Alto" |
| ↳ State | address.state | Optional | string | 2 letter abbreviation (last 2 characters of ISO 3166-2 code for US state/territory) | State of address | "CA" |
| ↳ ZIP Code | address.zipCode | Optional | string | ZIP Code (5 digits, 0-9) | ZIP Code of address | "94303" |
| ↳ Country | address.country | Optional | string | 2 letter abbreviation (ISO 3166-1 alpha-2 code, currently always "US") | Country of address | "US" |
| Sex | sex | Optional |
| Title Case | Sex | "Male" |
| SSN | ssn | Optional | string | 9 digits (0-9) | Social Security Number | "000456789" |