Outputs

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

Text to Signup

Output	Key	Type	Format(s)	Description	Example
Phone	phone	string	E.164	Phone number a user uses to verify for 1-Click Signup	"+12125550010"

1-Click Verify

Device IP Format

GET /1-click/verifications/device-ip always returns device IP in IPv6 format, because this is what our other endpoints require. We internally map IPv4 to IPv6 when necessary.

Output	Key	Type	Format(s)	Description	Example
Device IP	deviceIp	string	IPv6	IPv6 address of user's device	"::121:2555:0010"
Phone	phone	string	E.164	Phone number a user uses to verify for 1-Click Signup	"+12125550010"

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.

Output	Key	Type	Format(s)	Description	Example
Phone	phone	string	E.164	Phone number	"+12125550010"
Full Name	fullName	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	See 1ClickEntity example "Hendricks, Richard"
↳ First Name	fullName.firstName	string	Title Case	First name	"Richard"
↳ Middle Name	fullName.middleName	string	Title Case	Middle name	"Harrison"
↳ Last Name	fullName.lastName	string	Title Case	Last name	"Hendricks"
Address	address	Default: object string	Default: Object with keys for all child credentials listed below Any combination of child shortenedCredentialTypes under address, , (comma), and - (dash)	Address	See 1ClickEntity example "Palo Alto, US-CA"
↳ Line 1	address.line1	string	Title Case	Line 1 of address	"5320 Newell Rd"
↳ Line 2	address.line2	string	Title Case	Line 2 of address	""
↳ City	address.city	string	Title Case	City of address	"Palo Alto"
↳ State	address.state	string	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 Code	address.zipCode	string	ZIP Code (5 digits, 0-9)	ZIP Code of address	"94303"
↳ Country	address.country	string	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 Date	birthDate	string	Birth 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)	ssn	string	9 digits (0-9)	Social Security Number (or Individual Taxpayer Identification Number)	"000456789"
Sex	sex	string	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.

Output	Key	Type	Format(s)	Description	Example
Driver's License	driversLicense	object	Object with keys for all child credentials listed below	Driver's license	-
↳ Document Number	driversLicense.documentNumber	string	Format varies by state	Driver's license number	"A0000000"
↳ Issuance State	driversLicense.issuanceState	string	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 Date	driversLicense.issuanceDate	string	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 Date	driversLicense.expirationDate	string	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"
↳ Address	driversLicense.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	See 1ClickEntity example "Palo Alto, US-CA"
↳ ↳ Line 1	driversLicense.address.line1	string	Title Case	Line 1 of driver's license address	"5320 Newell Rd"
↳ ↳ Line 2	driversLicense.address.line2	string	Title Case	Line 2 of driver's license address	""
↳ ↳ City	driversLicense.address.city	string	Title Case	City of driver's license address	"Palo Alto"
↳ ↳ State	driversLicense.address.state	string	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 Code	driversLicense.address.zipCode	string	ZIP Code (5 digits, 0-9)	ZIP Code of driver's license address	"94303"
↳ ↳ Country	driversLicense.address.country	string	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

Output	Key	Type	Applies To	Format	Description	Example
Verification Method	verificationMethod	enum Possible values: "credit_bureau" "data_bureau" "phone_carrier" "otp" "customer_otp" "self_attested" null	Identifiers Credentials	snake_case	How 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

Output	Key	Type	Applies To	Format	Description	Example
Risk Signals	riskSignals	object	Identifiers	Object with keys specified below in Risk Signals	Risk signals associated with the identifiers provided	See 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:

Option	Description
On	Include 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.

Output	Key	Type	Format(s)	Description	Example
Overall	overall	object	Object with keys for all overall risk signals listed below	Overall risk signals, considering all relevant inputs provided	See RiskSignals example
↳ Score	overall.score	integer	Number from 0 (low risk) to 1000 (high risk)	Overall risk score, considering all relevant inputs provided. (If the score is over 600, Verified blocks the user and returns a OCE017 error.)	463
↳ Level	overall.level	enum Possible values: "low" "medium-low" "medium" "medium-high" "high"	kebab-case	Overall risk level, considering all relevant inputs 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"
↳ Recommendation	overall.recommendation	enum Possible values: "allow" "flag" "block"	kebab-case	Overall risk recommendation, considering all relevant inputs 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 Codes	overall.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 relevant inputs provided	"OCR10021"
Phone	phone	object	Object with keys for all phone risk signals listed below	Phone risk signals	See RiskSignals example
↳ Carrier	phone.carrier	object	Object with keys for all carrier details listed below	Carrier information	"flag"
↳ ↳ ID	phone.carrier.id	integer	Any number of digits (0-9)	Carrier ID number	309
↳ ↳ Name	phone.carrier.name	string	"Title Case"	Carrier name	"AT&T Wireless"
↳ Reason Codes	phone.reasonCodes	enum[] Possible values: see Phone reason codes	"OCR" (for One Click Reason) followed by 5 digits (0-9)	Phone reason codes for risk score/level/recommendation	"OCR20004"
Email	email	object	Object with keys for all email risk signals listed below	Email risk signals	See RiskSignals example
↳ Reason Codes	email.reasonCodes	enum[] Possible values: see Email reason codes	"OCR" (for One Click Reason) followed by 5 digits (0-9)	Email reason codes for risk score/level/recommendation	"OCR60001"
Device IP	deviceIp	object	Object with keys for all device IP risk signals listed below	IP address identifier risk signals	See RiskSignals example
↳ Reason Codes	deviceIp.reasonCodes	Details enum[] Possible values: see Device IP reason codes	"OCR" (for One Click Reason) followed by 5 digits (0-9)	Device IP reason codes for risk score/level/recommendation	"OCR50001"

Reason Codes

Overall

Code	Description	Details	Risk Indicator	Trust Indicator
OCR10010	low activity	Not enough activity or attributes to classify the transaction as either risky or trustworthy.
OCR10020	low regular activity	Trustworthy category, based on past behavior.		✔
OCR10021	regular activity	Most trustworthy category, based on past behavior.		✔
OCR10030	low-risk irregular activity	Risky category, based on past behavior.	✔
OCR10031	medium-risk irregular activity	High-risk category, based on past behavior.	✔
OCR10032	high-risk irregular activity	Highest-risk category, based on past behavior.	✔
OCR10040	irregular number type	This number has risky static attributes (like VOIP phone type or being on a blocklist).	✔

Phone

Code	Description	Details	Risk Indicator	Trust Indicator
OCR20001	no long-term activity	Much less than expected activity, or none at all, for this number over the past 90 days. Cannot classify.
OCR20002	high long-term activity	More than expected activity for this number over the past 90 days.	✔
OCR20003	high short-term activity	More than expected activity for this number over the last 24 hours.	✔
OCR20004	moderate long-term activity	Expected activity for this number over the past 90 days.		✔
OCR20005	moderate short-term activity	Expected activity for this number over the last 24 hours.		✔
OCR20006	sparse long-term activity	Sparse, regular volume of verification traffic on this number over the past 90 days.		✔
OCR20007	continuous long-term activity	Continuous, regular volume of verification traffic on this number over the past 90 days.		✔
OCR20008	very high long-term activity	Very high volume of verification traffic on this number over the past 90 days.	✔
OCR20009	very high short-term activity	Very high volume of verification traffic on this number over the past 24 hours.	✔
OCR20010	no activity	Very low volume of verification traffic, or none at all, was ever observed on this number.
OCR20011	low long-term activity	Low volume of verification traffic on this phone number over the past 90 days.
OCR20012	low short-term activity	Low volume of verification traffic on this phone number over the past 24 hours. Very low volume of verification traffic, or none at all over the past 90 days.
OCR20013	low activity	Less than expected activity for this number.
OCR20101	no range activity	Very little activity, or none at all, for a risky range that this number belongs to over the past 90 days. Also returned if the number does not belong to a risky range.		✔
OCR20102	low range activity	Some activity for a risky range that this number belongs to over the past 90 days.	✔
OCR20103	moderate short-term range activity	Significant activity for a risky range that this number belongs to over the last 24 hours.	✔
OCR20104	moderate long-term range activity	Significant activity for a risky range that this number belongs to over the past 90 days.	✔
OCR20105	high short-term range activity	Very significant activity for a risky range that this number belongs to over the last 24 hours.	✔
OCR20106	high long-term range activity	Very significant activity for a risky range that this number belongs to over the past 90 days.	✔
OCR20107	very high long-term range activity	Extremely significant activity for a risky range that this number belongs to over the past 90 days.	✔
OCR20108	very high short-term range activity	Extremely significant activity for a risky range that this number belongs to over the last 24 hours.	✔
OCR21001	moderate activity on risky services	Significant activity on this number to or from risky services over the past 90 days.	✔
OCR21002	high activity on risky services	Very significant activity on this number to or from risky services over the past 90 days.	✔
OCR21004	long-term activity on risky services	Verification traffic on risky services on this number over the past 90 days.	✔
OCR21005	short-term activity on risky services	Verification traffic on risky services on this number over the past 24 hours.	✔
OCR21006	high long-term activity on risky services	High volume of verification traffic on risky services on this number over the past 90 days.	✔
OCR21007	high short-term activity on risky services	High volume of verification traffic on risky services on this number over the past 24 hours.	✔
OCR21008	long-term range activity on risky services	Verification traffic on risky services on the range this number belongs to over the past 90 days.	✔
OCR21009	short-term range activity on risky services	Verification traffic on risky services on the range this number belongs to over the past 24 hours.	✔
OCR21010	high long-term range activity on risky services	High volume of verification traffic on risky services on the range this number belongs to over the past 90 days.	✔
OCR21011	high short-term range activity on risky services	High volume of verification traffic on risky services on the range this number belongs to over the past 24 hours.	✔
OCR21012	very high short-term activity on risky services	Very high volume of verification traffic on risky services on this number over the past 90 days.	✔
OCR21013	very high long-term activity on risky services	Very high volume of verification traffic on risky services on this number over the past 24 hours.	✔
OCR21014	very high short-term range activity on risky services	Very high volume of verification traffic on risky services on the range this number belongs to over the past 90 days.	✔
OCR21015	very high long-term range activity on risky services	Very high volume of verification traffic on risky services on the range this number belongs to over the past 24 hours.	✔
OCR21003	machine-like activity	Behavior pattern that suggests this number is being used by a bot. Although we expect a submitted number engaged in A2P traffic to communicate with automated systems, we don’t expect the user of that number to be an automated system.	✔
OCR21016	machine-like range activity	Extremely high volume of verification traffic in a very short period (less than 1 hour) on the range this number belongs to.	✔
OCR22001	seen in the last 1 day	This number was seen in verification traffic in the last 1 day.
OCR22007	seen in the last 7 days	This number was seen in verification traffic in the last 7 days.
OCR22015	seen in the last 15 days	This number was seen in verification traffic in the last 15 days.
OCR22101	seen in the last 1 month	This number was seen in verification traffic in the last 1 month.
OCR22102	seen in the last 2 months	This number was seen in verification traffic in the last 2 months.
OCR22103	seen in the last 3 months	This number was seen in verification traffic in the last 3 months.
OCR22203	seen more than 3 months ago	This number was not seen in verification traffic in the last 3 months.
OCR30201	no P2P data analyzed	P2P data was not analyzed. Cannot classify.
OCR40001	premium number	This is a premium number.	✔
OCR40002	VOIP number	This is a VOIP number.	✔
OCR40003	toll-free number	This is a toll-free number.	✔
OCR40004	invalid number	This is an invalid number.	✔
OCR40005	payphone number	This number is associated with a payphone.	✔
OCR40006	voicemail number	This is a voicemail number.	✔
OCR40007	pager number	This number is associated with a pager.	✔
OCR40008	high-risk phone type	This number has another phone type that is risky, and that is not covered by any of the other number_type reason codes.	✔
OCR40009	high-risk carrier	This number is associated with a very risky carrier.	✔
OCR40010	medium-risk carrier	This number is associated with a risky carrier.	✔
OCR40011	high-risk prefix	This number has a risky prefix.	✔
OCR40012	phone too long	This number is invalid because it is too long, even after the application of cleansing rules.	✔
OCR40013	blacklisted number	This number has been flagged as a source of fraud.	✔
OCR40014	high-risk country	The country code of this number is for a risky country, one that originates a disproportionate share of fraud attacks.	✔
OCR40015	technical number	This number is used for special technical purposes by telecom companies, such as for roaming.
OCR40016	number used by application	Reserved for use by customers with our applications (for example to send verification messages), but it appears that it is being used for a different purpose.	✔
OCR40017	number whitelisted by customer	You have flagged this number as safe.		✔
OCR40018	phone too short	This number is too short to be a valid phone number.	✔

Email

Code	Description	Details	Risk Indicator	Trust Indicator
OCR60001	moderate short-term activity	Expected level of activity for this email address over the last 24-hours.		✔
OCR60002	moderate long-term activity	Expected level of activity for this email address over the past 90 days.		✔
OCR60003	moderate short-term activity on risky services	Significant activity for this email address to or from risky services over the last 24 hours .	✔
OCR60004	moderate long-term activity on risky services	Significant activity on this email address to or from risky services over the last 90 days .	✔
OCR60005	high short-term activity	More than expected activity for this email address over the last 24-hours.	✔
OCR60006	high long-term activity	More than expected activity for this email address over the past 90 days.	✔

Device IP

Code	Description	Details	Risk Indicator	Trust Indicator
OCR50001	moderate short-term activity	Expected level of activity for this IP address over the last 24 hours.		✔
OCR50002	moderate long-term activity	Expected level of activity for this IP address over the past 90 days.		✔
OCR50003	moderate short-term activity on risky services	Significant activity for this IP address to or from risky services over the last 24 hours .	✔
OCR50004	moderate long-term activity on risky services	Significant activity on this IP address to or from risky services over the last 90 days .	✔
OCR50005	high short-term activity	More than expected activity for this IP address over the last 24 hours.	✔
OCR50006	high long-term activity	More than expected activity for this IP address over the past 90 days.	✔
OCR50007	high short-term activity on risky services	Very significant activity for this IP address to or from risky services over the last 24 hours .	✔
OCR50008	high long-term activity on risky services	Very significant activity on this IP address to or from risky services over the last 90 days .	✔
OCR50009	very high short-term activity	Very frequent changes of IP address attributes in verification traffic on this number over the past 24 hours.	✔
OCR50010	very high long-term activity	Very frequent changes of IP address attributes in verification traffic on this number over the past 90 days.	✔
OCR50011	short-term activity on risky services	Changes of IP address attributes in verification traffic on risky services on this number over the past 24 hours.	✔
OCR50012	long-term activity on risky services	Changes of IP address attributes in verification traffic on risky services on this number over the past 90 days.	✔
OCR50013	very high short-term activity on risky services	Very frequent changes of IP address attributes in verification traffic on risky services on this number over the past 24 hours.	✔
OCR50014	very high long-term activity on risky services	Very frequent changes of IP address attributes in verification traffic on risky services on this number over the past 90 days.	✔
OCR50015	anonymous proxy	This IP address is associated with anonymous proxies, which can help conceal the true origins of online traffic.	✔
OCR50016	VPN	This IP address is associated with virtual private networks (VPNs), which can help conceal the true origins of online traffic.	✔
OCR50017	hosting provider	This IP address is associated with web hosting servers, which have a pattern of activity different than genuine end users.	✔
OCR50018	TOR exit node	This IP address is associated with Tor anonymous browsers, which can help conceal the true origins of online traffic.	✔

1-Click Health

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.

Basic Insurance Details

Basic insurance details include high level information about health insurance plans, like the member ID and payer. Full insurance details are available when an eligibility check is run.

Member ID

Output	Key	Type	Format(s)	Description	Example
Member ID	memberId	string	Alphanumeric	Member ID for health insurance plan	"V000000000"

Payer

Output	Key	Type	Format(s)	Description	Example
Payer	payer	Payer	See Payer	Payer for health insurance plan	See Payer Example
↳ Name	payer.name	string	Title Case	Name of payer for health insurance plan	"Aviato Health Insurance Of California"
↳ Verified ID	payer.verifiedId	string	V followed by 6 digits (0-9)	Verified ID (never changes) of payer for health insurance plan	"V431835"
↳ IDs	payer.ids	string[]	Array of strings	IDs (can change) of payer for health insurance plan — ids[0] is considered primary	["0000A"]
↳ Logo URL	payer.logoUrl	string	URL	URL for logo of payer for health insurance plan	"https://assets.verified.inc/1-click/health/payers/11145919-80e4-4cb0-8518-cffbf44ee9fb.png"

Additional Info

note

Unlike member ID and payer, this additional info isn't generally user facing.

Output	Key	Type	Format(s)	Description	Example
Verification Method	verificationMethod	enum Possible values: "clearinghouse" "self_attested" null	snake_case	How a health insurance plan was verified	"clearinghouse"
Coverage Types	coverageTypes	enum[] Possible values: "medical" "dental" "vision"	lower case	Coverage type(s) of health insurance plan	"[medical]"
Service Type Codes	serviceTypeCodes	string[]	Array of strings	List of X12 service type codes for health insurance plans	["30"]
Is Medicare	isMedicare	boolean	-	Whether health insurance plan is for Medicare	true

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".

Full Insurance Details

Full insurance details include all known information about a health insurance plan and are available when an eligibility check is run.

EDI 271

Output	Key	Type	Format	Description	Example
EDI 271	edi_271	string	X12 EDI 271 (Health Care Eligibility Benefit Response)	Address	See X12 EDI 271 examples

Eligibility

Output	Key	Type	Format	Description	Example
Eligibility	eligibility	ParsedEdi271	See ParsedEdi271	Parsed version of edi_271	See ParsedEdi271 Example
↳ Coverage Status	eligibility.coverageStatus	enum Possible values: "active" "indeterminate" "inactive"	camelCase	Coverage status of health insurance plan	"active"
↳ Coverage Type	eligibility.coverageType	enum[] Possible values: "medical" "dental" "vision"	lower case	Coverage type(s) of health insurance plan	"[medical]"
↳ Service Type Codes	eligibility.serviceTypeCodes	string[]	Array of strings	List of X12 service type codes for health insurance plan	["30"]
↳ Payer	eligibility.payer	object	Object with key described below	Payer for health insurance plan	["0000A"]
↳ ↳ Payer Name	eligibility.payer.name	string	-	Name of payer for health insurance plan	"Aetna"
↳ Member	eligibility.member	object	Object with keys described below	Member for health insurance plan	-
↳ ↳ Member ID	eligibility.member.memberId	string	-	Member ID of member for health insurance plan	"A484069"
↳ ↳ Full Name	eligibility.member.fullName	string	-	Full name of member for health insurance plan	-
↳ ↳ ↳ First Name	eligibility.member.fullName.firstName	object	-	First name of member for health insurance plan	"Richard"
↳ ↳ ↳ Last Name	eligibility.member.fullName.lastName	string	-	Last name of member for health insurance plan	"Hendricks"
↳ ↳ Birth Date	eligibility.member.birthDate	string	yyyy-MM-dd	Birth date of member for health insurance plan	"1989-08-01"
↳ ↳ Sex	eligibility.member.sex	enum Possible values: "Male" "Female"	Title Case	Sex of member for health insurance plan	"Male"
↳ ↳ Full Name	eligibility.member.fullName	object	-	Full name of member for health insurance plan	-
↳ ↳ ↳ First Name	eligibility.member.fullName.firstName	string	-	First name of member for health insurance plan	"Richard"
↳ ↳ Address	eligibility.member.address	object	Object with keys described below	Address of member for health insurance plan	{ "line1": "5320 Newell Rd", "line2": "", "city": "Palo Alto", "state": "CA", "zipCode": "94303" }
↳ ↳ ↳ Line 1	eligibility.member.address.line1	string	Title Case	Line 1 of address of member for health insurance plan	"5320 Newell Rd"
↳ ↳ ↳ Line 2	eligibility.member.address.line2	string	Title Case	Line 2 of address of member for health insurance plan	""
↳ ↳ ↳ City	eligibility.member.address.city	string	Title Case	City of address of member for health insurance plan	"Palo Alto"
↳ ↳ ↳ State	eligibility.member.address.state	string	2 letter abbreviation (last 2 characters of ISO 3166-2 code for US state/territory)	State of address of member for health insurance plan	"CA"
↳ ↳ ↳ ZIP Code	eligibility.member.address.zipCode	string	ZIP Code (5 digits, 0-9)	ZIP Code of address of member for health insurance plan	"94303"
↳ Plan	eligibility.plan	object	Object with keys described below	Details for health insurance plan	-
↳ ↳ Name	eligibility.plan.name	string	-	Name for health insurance plan	"Managed Choice Open Access"
↳ ↳ Group Number	eligibility.plan.groupNumber	string	-	Group number (for employer or purchaser group) for health insurance plan	"123456-123-12345"
↳ ↳ Group Name	eligibility.plan.groupName	string	-	Group name (for employer or purchaser group) for health insurance plan	"Pied Piper"
↳ ↳ Insurance Types	eligibility.plan.insuranceTypeCodes	string[]	Array of strings	List of X12 insurance descriptor codes relevant to benefit of health insurance plan	["C1"]
↳ ↳ Effective Date	eligibility.plan.effectiveDate	string	yyyy-MM-dd	Coverage start date for health insurance plan	"2026-01-01"
↳ ↳ Termination Date	eligibility.plan.terminationDate	string	yyyy-MM-dd	Coverage end date for health insurance plan	"2026-12-31"
↳ Benefits	eligibility.benefits	object[]	Array of objects	Benefits for health insurance plan	-
↳ ↳ Type	eligibility.benefits[i].type	enum Possible values: "deductible" "outOfPocket" "copay" "coinsurance" "limitation"	camelCase	Type of cost share for health insurance plan	"deductible"
↳ ↳ Service Type Codes	eligibility.benefits[i].serviceTypeCodes	string[]	Array of strings	List of X12 service type codes relevant to benefit for health insurance plan	["30"]
↳ ↳ Insurance Type	eligibility.benefits[i].insuranceTypeCode	string	-	X12 insurance descriptor code for health insurance plan	"C1"
↳ ↳ Level	eligibility.benefits[i].level	enum Possible values: "individual" "family"	camelCase	Coverage level that amount applies to for health insurance plan	"individual"
↳ ↳ Network	eligibility.benefits[i].network	enum Possible values: "in" "out"	camelCase	Whether 271 says health insurance plan is in or out of network (different from the network object of type NetworkDecision, which is based on network rules you define)	"in"
↳ ↳ Amount	eligibility.benefits[i].amount	string	decimal	Dollar amount applicable (copay, or period total for deductible or out of pocket) for health insurance plan	"1500.00"
↳ ↳ Remaining	eligibility.benefits[i].remaining	string	decimal	Dollar amount remaining (deductible or out of pocket) for health insurance plan	"750.00"
↳ ↳ Percent	eligibility.benefits[i].percent	string	decimal fraction	Patient coinsurance responsibility for health insurance plan	"0.20"
↳ Contacts	eligibility.contacts	object[]	Array of objects	Contacts for health insurance plan	-
↳ ↳ Name	eligibility.contacts[i].name	string	-	Entity to contact (e.g. the payer's member services or a carve out administrator) about health insurance plan	"Aetna Member Services"
↳ ↳ Service Type Codes	eligibility.contacts[i].serviceTypeCodes	string[]	Array of strings	List of X12 service type codes relevant to contact for health insurance plan	["30"]
↳ ↳ Phone	eligibility.contacts[i].phone	string	-	Phone number	"8005550000"
↳ ↳ Fax	eligibility.contacts[i].fax	string	-	Fax number	"8005550001"
↳ ↳ Email	eligibility.contacts[i].email	string	Email	Email address	"memberservices@aetna.com"
↳ ↳ URL	eligibility.contacts[i].url	string	URL	Contact URL	"https://aetna.com/member-services"

Network Decision

info

Network decisions are included in outputs when an eligibility check is run and at least one network rule is defined.

Output	Key	Type	Format	Description	Example
Network	network	NetworkDecision	See NetworkDecision	Parsed version of edi_271	See NetworkDecision Example
↳ Status	network.status	enum Possible values: "IN_NETWORK" "OUT_OF_NETWORK" "INDETERMINATE"	UPPER_SNAKE_CASE	Network status of health insurance plan, based on your network rules	"IN_NETWORK"
↳ Rules	network.rules	NetworkRule[]	Array of NetworkRules	List of network rules that matched health insurance plan	-
↳ ↳ Rule	network.rules[i]	NetworkRule	See NetworkRule	Network rule that matched health insurance plan	See NetworkRule Example
↳ ↳ ↳ UUID	network.rules[i].uuid	string	Version 4 UUID	Unique identifier for the network rule	"ab280ee0-5f66-4076-9d1b-255d5f0024e3"
↳ ↳ ↳ Name	network.rules[i].name	string	-	Name for the network rule	"Rule 1: Aetna - INN"
↳ ↳ ↳ Status	network.rules[i].status	enum Possible values: "IN_NETWORK" "OUT_OF_NETWORK" "INDETERMINATE"	UPPER_SNAKE_CASE	Network status the network rule returns	"IN_NETWORK"
↳ ↳ ↳ Notes	network.rules[i].notes	string	-	Notes about the network rule	"Requires manual review"
↳ ↳ ↳ Metadata	network.rules[i].metadata	object	-	Metadata for the network rule	{ "selfPay": false, "priority": 1, "packageId": "123456" }
↳ ↳ ↳ ↳ Metadata	network.rules[i].metadata[key]	string | number | boolean	-	Piece of metadata for the network rule	"selfPay": false
↳ ↳ ↳ Start Date	network.rules[i].startDate	string	yyyy-MM-dd	Start date for the network rule	"2026-10-01"
↳ ↳ ↳ End Date	network.rules[i].endDate	string	yyyy-MM-dd	End date for the network rule	"2027-09-30"
↳ ↳ ↳ Conditions	network.rules[i].conditions	object[]	Array of objects	Conditions for when the network rule matches	[ { "key": "payerId", "operator": "EQUAL", "values": ["V404110"] }, { "key": "payerName", "operator": "INCLUDE", "values": ["Aetna"] }, { "key": "state", "operator": "EQUAL", "values": ["MA", "NY", "WA"] }, { "key": "insuranceTypeCodes", "operator": "INCLUDE", "values": ["PR"] }, { "key": "planName", "operator": "INCLUDE", "values": ["PPO"] }, { "key": "relatedEntites", "operator": "INCLUDE", "values": ["Hooli Health"] }, { "key": "groupNumber", "operator": "EQUAL", "values": ["123456-123-12345"] }, { "key": "groupName", "operator": "INCLUDE", "values": ["Pied Piper"] } ]
↳ ↳ ↳ ↳ Condition	network.rules[i].conditions[j]	object	-	Condition for when the network rule matches	{ "key": "payerId", "operator": "EQUAL", "values": ["V404110"] },
↳ ↳ ↳ ↳ ↳ Key	network.rules[i].conditions[j].key	enum Possible values: "payerId" "payerName" "state" "insuranceTypeCodes" "planName" "relatedEntites" "groupNumber" "groupName"	camelCase	Key for condition	"payerId"
↳ ↳ ↳ ↳ ↳ Operator	network.rules[i].conditions[j].operator	enum Possible values: "EQUAL" "NOT_EQUAL" "INCLUDE" "NOT_INCLUDE"	UPPER_SNAKE_CASE	Operator for condition	"EQUAL"
↳ ↳ ↳ ↳ ↳ Values	network.rules[i].conditions[j].values	string[]	camelCase	Value(s) for condition	["V404110"]