Skip to main content

Outputs

An output is a piece of data we return from the SDK or API.

1-Click Verify

1-Click Signup

Credentials

A credential is a piece of identity data about a user.

Credential Formats

We support multiple formats for some credential types (see below). If you'd like to use formats different than the defaults, please reach out to us at Support@Verified.inc and we'll enable them for you.

Core Data

Coverage

We can source the data below for ~95% of US adults if you provide both phone and a challenge (either birthday or SSN4) as inputs — and for about 20% if you provide only phone. (The one exception is the Sex credential, which we can source for ~80% of US adults.)

Exact coverage depends on your user base and varies widely across companies. Some companies see >97% coverage, while a few see only 50%. See Coverage for more information.

OutputKeyTypeFormat(s)DescriptionExample
PhonephonestringE.164Phone number"+12125550010"
Full NamefullName
  • Default: object
  • string
  • Default: Object with keys for all child credentials listed below
  • Any combination of child shortenedCredentialTypes under fullName, , (comma), and - (dash)
Full name
↳ First NamefullName.firstNamestringTitle CaseFirst name"Richard"
↳ Middle NamefullName.middleNamestringTitle CaseMiddle name"Harrison"
↳ Last NamefullName.lastNamestringTitle CaseLast name"Hendricks"
Addressaddress
  • Default: object
  • string
  • Default: Object with keys for all child credentials listed below
  • Any combination of child shortenedCredentialTypes under address, , (comma), and - (dash)
Address
↳ Line 1address.line1stringTitle CaseLine 1 of address"5320 Newell Rd"
↳ Line 2address.line2stringTitle CaseLine 2 of address""
↳ Cityaddress.citystringTitle CaseCity of address"Palo Alto"
↳ Stateaddress.statestring
  • Default: 2 letter abbreviation (last 2 characters of ISO 3166-2 code for US state/territory)
  • Full state/territory name (ISO 3166-2 subdivision name)
State of address
  • "CA"
  • "California"
↳ ZIP Codeaddress.zipCodestringZIP Code (5 digits, 0-9)ZIP Code of address"94303"
↳ Countryaddress.countrystring
  • Default: 2 letter abbreviation (ISO 3166-1 alpha-2 code, currently always "US")
  • Full country name (ISO 3166-1 English short name, currently always "United States of America")
Country of address
  • "US"
  • "United States of America"
Birth DatebirthDatestringBirth date
  • Default: yyyy-MM-dd
  • Any combination of y(year), M(month), d(day), /(slash), and -(dash)
  • Unix time (milliseconds)
  • "1989-08-01"
  • "08/01/1989"
  • "617947200000"
SSN (or ITIN)ssnstring9 digits (0-9)Social Security Number (or Individual Taxpayer Identification Number)"000456789"
Sexsexstring
enum

Possible values:

  • "Male"
  • "Female"
  • "Non-Binary"
Sex"Male"
Risk Signals Enable Multiple Addresses

We can return up to 3 most recent addresses for a user, if you have risk signals turned on. We order these addresses from most to least recent, as best as we're able to determine recency.

You can show the user a dropdown to select one of the addresses on the info confirmation step (see here on the User Experience page). We highly recommend this because it helps reduce the chance the user will need to manually enter an address, reducing friction and boosting conversion.

We Return ITINs When Applicable

If we find an ITIN but not an SSN for a user, we return the ITIN under the ssn key. ITINs and SSNs are both 9 digit numbers, and ITINs are easily distinguishable because they start with the number 9.

Government IDs
Beta

Coverage and Recency for Driver's License

Access to driver's license data varies state by state, so coverage and recency are substantially lower than for core data.

OutputKeyTypeFormat(s)DescriptionExample
Driver's LicensedriversLicenseobjectObject with keys for all child credentials listed belowDriver's license-
↳ Document NumberdriversLicense.documentNumberstringFormat varies by stateDriver's license number"A0000000"
↳ Issuance StatedriversLicense.issuanceStatestring
  • Default: Unix time (milliseconds)
  • Any combination of y(year), M(month), d(day), /(slash), and -(dash)
Issuance state of driver's license
  • "CA"
  • "California"
↳ Issuance DatedriversLicense.issuanceDatestring
  • Default: Unix time (milliseconds)
  • Any combination of y(year), M(month), d(day), /(slash), and -(dash)
Issuance date of driver's license
  • "1596254400"
  • "08/01/2020"
↳ Expiration DatedriversLicense.expirationDatestring
  • Default: Unix time (milliseconds)
  • Any combination of y(year), M(month), d(day), /(slash), and -(dash)
Expiration date of of driver's license
  • "1911787200"
  • "08/01/2030"
↳ AddressdriversLicense.address
  • Default: object
  • string
  • Default: Object with keys for all child credentials listed below
  • Any combination of child shortenedCredentialTypes under address, , (comma), and - (dash)
Driver's license address
↳ ↳ Line 1driversLicense.address.line1stringTitle CaseLine 1 of driver's license address"5320 Newell Rd"
↳ ↳ Line 2driversLicense.address.line2stringTitle CaseLine 2 of driver's license address""
↳ ↳ CitydriversLicense.address.citystringTitle CaseCity of driver's license address"Palo Alto"
↳ ↳ StatedriversLicense.address.statestring
  • Default: 2 letter abbreviation (last 2 characters of ISO 3166-2 code for US state/territory)
  • Full state/territory name (ISO 3166-2 subdivision name)
State of driver's license address
  • "CA"
  • "California"
↳ ↳ ZIP CodedriversLicense.address.zipCodestringZIP Code (5 digits, 0-9)ZIP Code of driver's license address"94303"
↳ ↳ CountrydriversLicense.address.countrystring
  • Default: 2 letter abbreviation (ISO 3166-1 alpha-2 code, currently always "US")
  • Full country name (ISO 3166-1 English short name, currently always "United States of America")
Country of driver's license address
  • "US"
  • "United States of America"
More Government IDs are Coming Soon

We're working on adding support for new types of government ID. Let us know what would be most helpful for your use case! Email us at Support@Verified.inc and we'll prioritize accordingly.

Vehicles
Coming Soon

Employment
Coming Soon

Properties
Coming Soon

Metadata

A piece of metadata is additional data that's not a user's identity data — though it's often about that identity data.

Verification Method

OutputKeyTypeApplies ToFormatDescriptionExample
Verification MethodverificationMethod
enum

Possible values:

  • "credit_bureau"
  • "data_bureau"
  • "phone_carrier"
  • "otp"
  • "customer_otp"
  • "self_attested"
  • null
  • Identifiers
  • Credentials
snake_caseHow an identifier or credential was verified"phone_carrier"
What Verification Method Means

verificationMethod describes how a credential was verified:

  • "credit_bureau": verified via credit bureau records
  • "data_bureau": verified via data bureau records
  • "phone_carrier": verified via phone carrier records
  • "otp": verified via an OTP (one time passcode)
  • "customer_otp": verified via an OTP (one time passcode) by a Verified customer, not directly by Verified
  • "self_attested": attested by the user themselves (not verified)
  • null

You can build custom logic to handle credentials based on their verificationMethod, for example requiring additional verification if an important credential is "self_attested".

Risk Signals

OutputKeyTypeApplies ToFormatDescriptionExample
Risk SignalsriskSignalsobject
  • Identifiers
Object with keys specified below in Risk SignalsRisk signals associated with the identifiers providedSee RiskSignals example

Risk signals metadata enhance 1-Click Signup's anti-fraud capabilities. They come with extra cost and can be disabled if desired, but we recommend that you use them to improve your ability to prevent fraud.

See also the RiskSignals type.

tip

You can configure which risk signals you receive using the risk signals brand setting:

OptionDescription
OnInclude risk signals
Off
Not Recommended
Don't include risk signals

If risk signals are enabled, we will block users with an Overall Score greater than 600 and return a OCE017 error.

Definition of Risky Services

We and other companies assign specific services — called "risky services" — to interact with numbers that are considered more likely to be malicious. These risky services are not themselves risky. Rather, if the phone number you submit to our API has had a lot of interaction with them, that phone number is potentially risky.

OutputKeyTypeFormat(s)DescriptionExample
OveralloverallobjectObject with keys for all overall risk signals listed belowOverall risk signals, considering all identifiers provided

See RiskSignals example

↳ Scoreoverall.score

integer

Number from 0 (low risk) to 1000 (high risk)

Overall risk score, considering all identifiers provided. (If the score is over 600, Verified blocks the user and returns a OCE017 error.)

463

↳ Leveloverall.level
enum

Possible values:

  • "low"
  • "medium-low"
  • "medium"
  • "medium-high"
  • "high"

kebab-case

Overall risk level, considering all identifiers provided. (This is a bucketing of the risk score, where 0-200 is "low", 201-400 is "medium-low", 401-600 is "medium", 601-800 is "medium-high", and 801-1000 is "high".)

"medium"

↳ Recommendationoverall.recommendation
enum

Possible values:

  • "allow"
  • "flag"
  • "block"

kebab-case

Overall risk recommendation, considering all identifiers provided. (This is a bucketing of the risk level, where "low" and "medium-low" are "allow", "medium" is "flag", and "medium-high" and "high" are "block".)

"flag"

↳ Reason Codesoverall.reasonCodes
enum[]

Possible values: see Overall reason codes

"OCR" (for One Click Reason) followed by 5 digits (0-9)

Overall reason codes for risk score/level/recommendation, considering all identifiers provided

"OCR10021"

PhonephoneobjectObject with keys for all phone identifier risk signals listed belowPhone identifier risk signals

See RiskSignals example

↳ Carrierphone.carrierobjectObject with keys for all carrier details listed belowCarrier information

"flag"

↳ ↳ IDphone.carrier.idintegerAny number of digits (0-9)Carrier ID number309
↳ ↳ Namephone.carrier.namestring"Title Case"Carrier name"AT&T Wireless"
↳ Reason Codesphone.reasonCodes
enum[]

Possible values: see Phone reason codes

"OCR" (for One Click Reason) followed by 5 digits (0-9)

Phone identifier reason codes for risk score/level/recommendation

"OCR20004"

EmailemailobjectObject with keys for all email identifier risk signals listed belowEmail identifier risk signals

See RiskSignals example

↳ Reason Codesemail.reasonCodes
enum[]

Possible values: see Email reason codes

"OCR" (for One Click Reason) followed by 5 digits (0-9)

Email identifier reason codes for risk score/level/recommendation

"OCR60001"

Reason Codes
Overall
Phone
Email

1-Click Health

Health Insurance Plans

Coverage

We can source the data below for ~80% of US adults. Exact coverage depends on your user base.

See Coverage for more information.

Most Probable Plans are Listed First

If we return multiple health insurance plans for a user, they're ordered from most to least probable. All plans we return have a high probability of matching the user, since we filter out low probability ones.

A user may have multiple plans, for example if they have separate ones for medical, dental, or vision. We recommend that you let the user choose which plan they want to use, setting the first plan we return (which we deem most probable) as the default choice.

Payer IDs

1-Click Health can return many different IDs for a given payer:

  • verifiedId: This ID identifies the payer within Verified but is not used in external systems. It never changes, so it can reliably used to identify the payer over time.
  • ids[]: These IDs identify the payer in external systems, like healthcare clearing houses or the payer's own system. They may change over time.
    • ids[0]: This is considered the primary ID for the payer and is generally the ID the payer uses for itself. It may change over time.
OutputKeyTypeFormat(s)DescriptionExample
Member IDmemberIdstringAlphanumericMember ID for health insurance plan"V000000000"
PayerpayerobjectObject with keys for all child credentials listed belowPayer for health insurance plan
{
"name": "Aviato Health Insurance Of California",
"verifiedId": "V431835",
"ids": ["0000A"]
}
↳ Namepayer.namestringTitle CaseName of payer for health insurance plan"Aviato Health Insurance Of California"
↳ Verified IDpayer.verifiedIdstringV followed by 6 digits (0-9)Verified ID (never changes) of payer for health insurance plan"V431835"
↳ IDspayer.idsarrayArray of stringsIDs (can change) of payer for health insurance plan — ids[0] is considered primary["0000A"]
EDI 271edi_271stringX12 EDI 271 (Health Care Eligibility Benefit Response)AddressSee X12 EDI 271 examples

Metadata

A piece of metadata is additional data that's not a user's identity data — though it's often about that identity data.

Verification Method

OutputKeyTypeFormatDescriptionExample
Verification MethodverificationMethod
enum

Possible values:

  • "clearinghouse"
  • "self_attested"
  • null
snake_caseHow a health insurance plan was verified"clearinghouse"
What Verification Method Means

verificationMethod describes how a health insurance plan was verified:

  • "clearinghouse": verified via clearinghouse records
  • "self_attested": attested by the user themselves (not verified)
  • null

You can build custom logic to handle health insurance plans based on their verificationMethod, for example applying additional validation if one is "self_attested".