Finicity Identity API is one of 41 APIs that Finicity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Identity. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
3 operations
across 3 paths,
and defines 99 schemas.
It is described by OpenAPI 3.2.0, at version 1.43.0.
Requests are made against a single base URL, https://api.finicity.com.
The identity and technical contract details declared by the specification.
IdentityRiskScore
number
Comprehensive identity risk score with a higher score indicating a riskier account sign-up.
PhoneCountryCode
string
The ISO-3166 alpha-2 country code associated with the phone number.
ZipCode
string
A ZIP code
SingleLineAddress
string
A street address
AccountOwnerDocumentation
object
Account owner documentation
3 properties
AccountOwnerHolders
object
1 property
1 required
PhoneLineType
string
The line type of the phone number. landline - traditional wired phone line. fixed-voip - VoIP-based fixed line phones. mobile - wireless phone line. voicemail…
WithInsights
boolean
If Identity Insights data must be returned or not
EmailAddress
string
An email address
EmailScores
object
1 property
AccountOwnerDocumentations
array
List of account owner documentation. Not currently available in the US region.
EmailDomainCreationDate
string
Returns a date that the email domain was created.
AccountOwnerVerificationMatchingDetails
object
Owner of a customer account
14 properties
4 required
AccountOwnerPhones
array
List of phones
AddressLine2
string
Address line 2
AddressLine3
string
Address line 3
IpGeolocationCountryCode
string
The ISO-3166 alpha-2 country code associated with the geolocation of the IP address.
AddressLine1
string
Address line 1
AccountOwnerDetails
object
Owner of a customer account
14 properties
3 required
AccountOwner
object
Owner of a customer account
3 properties
2 required
EmailIsDisposable
boolean
True if the email address is from a disposable email service.
IdentityRiskReasonCode
string
Reason code for the identity risk score. Must be exactly two uppercase letters.
Insights
boolean
If Identity Insights data must be returned or not
PhoneCountry
string
Country calling code of the phone number as defined by ITU-T E.123 and E.164 international standards (max length 3)".
MiddleName
string
The middle name of the account holder
Alerts
string
An alert generated when processing the request.
AccountOwnerVerificationMatchResults
object
2 properties
PhoneNumber
string
A phone number (max length 15).
ErrorMessage
object
10 properties
1 required
DeviceBrowser
string
The name of the browser used to authorize your product or service.
AccountId
string
An account ID
AccountOwnerAddress
object
Account owner address
9 properties
NameClassificationType
string
The classification of the account holder: "person / personal / home" "business" "other"
IpPhoneDistance
number
The distance (in miles) between the IP address and the closest physical address associated with the phone number.
IpLastSeenDays
number
Count of days since the IP address was last observed in Ekata's Identity Network. If the IP address has not been observed before, IpLastSeenDays will be 0.
AccountOwnerVerificationMatchingRequestName
object
4 properties
2 required
AccountOwnerEmails
array
List of emails
AccountOwnerVerificationMatchingEmail
object
Account owner email
4 properties
IpAddressDistance
number
The distance (in miles) between the IP address and the physical address.
EmailValid
boolean
True if the email address is valid.
PhoneLastSeenDays
number
Count of days since the phone was last observed in Ekata's Identity Network. If the phone has not been observed before, phoneLastSeenDays will be 0.
AccountOwnerVerificationMatchingPhones
array
List of phones
NameScore
object
List of account owner Identity Insights
5 properties
1 required
LastName
string
The last name of the account holder
EmailFirstSeenDays
number
Count of days since the email was first observed in Ekata's Identity Network. If the email has not been observed before, firstseendays will be 0.
AccountOwnerAddresses
array
List of addresses
PhoneCarrier
string
The company that provides voice and/or data services for the phone number. Carriers are returned at the MVNO level.
AccountOwnerIdentityInsights
object
List of account owner Identity Insights
36 properties
PhoneToAddress
string
The match status between the input phone and the queried entity. match - Phone location matches input address line 1, address line 2, city, state, and postal c…
DeviceBrowserIpTzDifference
integer
Time zone difference between device browser and IP location
AddressType
string
The type of address location: "Business" "Home" "Mailing"
AccountOwnerEmailPrimary
boolean
The email is primary.
AccountOwnerVerificationMatchingAddresses
array
List of addresses
DeviceType
string
The device type used to authorize your product or service.
PhoneToName
string
The match status between the input name and the queried entity. not-found match no-match
Country
string
Country code is Iso3166-1 Alpha-2 code and Alpha 3 standard (max length 3).
PhoneValid
boolean
True if the phone number is valid.
AccountOwnerRelationshipType
string
The type of relationship to the account: "AUTHORIZEDUSER" "BUSINESS" "FORBENEFITOFPRIMARY" "FORBENEFITOFPRIMARYJOINTRESTRICTED" "FORBENEFITOFSECONDARY" "FORBEN…
AddressToName
string
The match status between the input name and the queried entity. not-found match no-match
CountryCode
string
Two-letter ISO 3166-1 alpha-2 country code
Address
string
A street address
AccountOwnerPhoneType
string
The account owner's phone type: "HOME" "BUSINESS" "CELL" "FAX"
DeviceRiskScore
number
Comprehensive risk score associated with a device, with a higher score indicating a riskier device. A number between 0 and 1.
AccountOwnerVerificationPhone
object
Consumer phone
4 properties
DevicePhoneEmailFirstSeen
integer
Days since the combination of device, phone, and email was first seen
IpRisk
boolean
True if the IP address is considered risky, based on multiple IP data points and velocity calculations.
AssetId
string
An asset ID. Generated by Data Connect or by using the Store Customer Pay Statement API.
GovernmentId
string
A federal or state issued identification number in alphanumeric characters. Canada: Passport: 8 digits Driver: 6-9 digits
AccountOwnerVerificationMatchingAddress
object
10 properties
IpGeolocationSubdivision
string
More granular detail about the IP address location.
AccountOwnerVerificationMatchingRequestAddress
object
8 properties
AccountOwnerVerificationMatchingRequest
object
5 properties
1 required
PhoneEmailFirstSeenDays
number
Count of days since the combination of phone and email was first observed in Ekata's Identity Network. If that combination has not been observed before, phoneE…
DeviceIpEmailFirstSeen
integer
Days since the combination of device, IP, and email was first seen
MetaData
string
OBAO is a program that is being offered to Mastercard issuers where when the new account is issued a Mastercard Debit or Prepaid account. OBAO offered partners…
DevicePlatform
string
The device platform used to authorize your product or service.
EmailRisk
number
Email Risk Score assesses the risk level of an email address by leveraging features from our Identity Graph and Identity Network. It provides the strongest ind…
ClassificationConfidenceScore
number
The confidence score 0 – 1.0 of the name classification.
Warnings
string
An array containing warning messages. Warnings can be one of: Address: Input postal code was corrected Address: Input state corrected Email: Address is too lon…
Suffix
string
A generational or academic suffix
PhoneScores
object
1 property
AccountOwnerName
string
The full name of the account owner. Multiple account owners are returned in one string per the source data from the institution.
EmailMailboxVelocity
number
The velocity of the mailbox.
AccountOwnerVerificationMatchingEmails
array
List of emails
AsOfDate
integer
The last time the payroll data was updated in the payroll provider's system
AccountOwnerPhone
object
Consumer phone
3 properties
AddressScore
object
9 properties
FirstName
string
The first name of the account holder
IpRiskScore
number
Comprehensive risk score associated with an IP address, with a higher score indicating a riskier IP address. A number between 0 and 1 rounded to three decimal…
AddressValidityLevel
string
The most granular level to which the address could be validated. Ex. If the address was only valid to the city level (but not to the house level), it would ret…
EmailToName
string
The match status between the input name and the queried entity. not found match no-match
TaxId
string
Country specific tax ID associated with the customer. Canada: Social Insurance Number (SIM) or Numero d'assurance sociale (NAS) Format: 123-456-789
AccountOwnerEmail
object
Account owner email
3 properties
UnixDate
integer
A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practi…
CustomerId
string
A customer ID. See Add Customer API for how to create a customer ID.
RequestRefId
string
The generated unique web transaction identifier.
AccountOwnerEmailType
string
The account owner's email type. "Personal" "Business"
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Finicity publishes across the network.
