The identity and technical contract details declared by the specification.
PaymentInstructionPEB
object
4 properties
2 required
IdentityRiskScore
number
Comprehensive identity risk score with a higher score indicating a riskier account sign-up.
AuthorizationExpires
boolean
A Boolean flag that indicates whether the customer’s authorization period has a defined authorization end date.
PhoneCountryCode
string
The ISO-3166 alpha-2 country code associated with the phone number.
ZipCode
string
A ZIP code
AccountOwnerDocumentation
object
Account owner documentation
3 properties
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…
AccountOwnerHolders
object
1 property
1 required
EmailAddress
string
An email address
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.
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
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.
PhoneCountry
string
Country calling code of the phone number as defined by ITU-T E.123 and E.164 international standards (max length 3)".
Alerts
string
An alert generated when processing the request.
MiddleName
string
The middle name of the account holder
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
AccountIdentitySuccessCount
integer
Total number of successful sections returned when requesting accountIdentity. If not provided, value will be 0.
NameClassificationType
string
The classification of the account holder: "person / personal / home" "business" "other"
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.
IpPhoneDistance
number
The distance (in miles) between the IP address and the closest physical address associated with the phone number.
AccountOwnerEmails
array
List of emails
IpAddressDistance
number
The distance (in miles) between the IP address and the physical address.
PaymentInstructionSuccessCount
integer
Total number of successful sections returned when requesting paymentInstruction. If not provided, value will be 0.
Descriptor
object
2 properties
2 required
EmailValid
boolean
True if the email address is valid.
AggregationStatus
string
"pending" during account discovery, always "active" following successful account activation
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.
PaymentEnablementBundle
object
7 properties
3 required
LastName
string
The last name of the account holder
AccountSimpleDetails
object
15 properties
6 required
AvailableBalancePEB
object
8 properties
7 required
AccountType
string
The list of supported account types. "checking": Standard checking "savings": Standard savings "cd": Certificates of deposit "moneyMarket": Money Market "credi…
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"
AuthorizationEndDate
integer
Authorization end date and time in epoch format (not used if AuthorizationExpires is false).
AccountOwnerEmailPrimary
boolean
The email is primary.
InstitutionName
string
The name of the institution
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).
Fields
string
Mention API fields that needs to be fetched
PhoneValid
boolean
True if the phone number is valid.
FieldErrors
array
Lists of errors while getting the data
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
InstitutionId
string
The ID of a financial institution
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.
Name
string
The account name from the institution
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.
PebAllowedBalanceCacheInterval
integer
Time interval in minutes to check balance data against live balance from financial institution or from latest cached
GovernmentId
string
A federal or state issued identification number in alphanumeric characters. Canada: Passport: 8 digits Driver: 6-9 digits
AggregationStatusCode
integer
The status of the most recent aggregation attempt (see [Aggregation Status Codes](https://developer.mastercard.com/open-finance-us/documentation/products/manag…
IpGeolocationSubdivision
string
More granular detail about the IP address location.
AuthorizationStartDate
integer
Authorization start date and time in epoch format.
NumericAccountId
integer
An account ID represented as a number
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
Currency
string
A currency code
PEBAccountDetails
object
10 properties
4 required
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…
BalanceDetailsSuccessCount
integer
Total number of successful sections returned when requesting balanceDetails. If not provided, value will be 0.
Suffix
string
A generational or academic suffix
ErrorCount
integer
The number of errors or failures that have occurred while processing the API request. If all the requested parameters are returned successfully then this value…
NumericInstitutionLoginId
integer
An institution login ID (from the account record), represented as a number
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.
AsOfDate
integer
The last time the payroll data was updated in the payroll provider's system
AccountOwnerPhone
object
Consumer phone
3 properties
FirstName
string
The first name of the account holder
FieldError
object
3 properties
3 required
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
DateTimeWithZone
string
A date-time with time zone
CustomerId
string
A customer ID. See Add Customer API for how to create a customer ID.
AccountNumberLast4
string
The last 4 digits of the account number, derived by Mastercard from the account number provided by the financial institution. This is only returned for ACH-ena…
AccountOwnerEmail
object
Account owner email
3 properties
RequestRefId
string
The generated unique web transaction identifier.
DisplayPosition
integer
Display position of the account at the financial institution, "1" being the top listed account
AccountOwnerEmailType
string
The account owner's email type. "Personal" "Business"
AccountNumberDisplay
string
Account identifier derived by Mastercard from the account number provided by the financial institution. The format varies depending on the institution. We reco…
AccountCount
integer
Total number of accounts returned.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Finicity publishes across the network.
