Account holder information
https://sandbox-products.ddp.akoya.com/contacts/{version}/{providerId}/{accountId}
This product supports use cases such as payment enablement, account opening, identity verification,or lending & credit enhancement. Responses return information about the authorized consumer, the customer associated with the id_token used in the call, and the relationship specific to the provided accountId.
Get account holder information. Based on FDX 5.2.1.
This product requires consumer consent to share all account holder information.
🛑 The id_token should be used as the bearer token with this call.
Path Parameters
accountId*
stringdefault: :accountIdAccount Identifier
version*
stringdefault: v2Akoya major version number. Do not use minor version numbers. For instance, use v2 and not v2.2
providerId*
stringdefault: mikomoId of provider
Headers
x-akoya-interaction-type
stringOptional but recommended header to include with each data request. Allowed values are `user` or `batch`. `user` indicates a request is prompted by an end-user action. `batch` indicates the request is part of a batch process.
batch
Responses
200
OK
Response Body
object
holders
array of objects
Owners of the account
object
customerId
string
Long-term persistent identity of the end-user. This identity must be unique to the owning institution
name
The end-user's name
object
first
string
First or given name. This data element may contain first & last name if not separated.
middle
string
last
string
prefix
string
Name prefix, e.g. Mr.
suffix
string
Generational or academic suffix
company
string
Company name
businessCustomer
The business customer information, only used if 'type' is 'BUSINESS'.
object
name
string
Name of business customer
registeredAgents
array of objects
A list of registered agents who act on behalf of the business customer
object
first
string
First or given name. This data element may contain first & last name if not separated.
middle
string
last
string
prefix
string
Name prefix, e.g. Mr.
suffix
string
Generational or academic suffix
company
string
Company name
registeredId
string
The registered tax identification number (TIN) or other identifier of business customer
industryCode
object
Industry code and type
type
string
code
string
domicile
object
The country and region of the business customer's location
region
string
country
string
addresses
array of objects
An array of the customer's physical mail addresses
line1
string
Address line 1. May contain full address if not separated
line2
string
Address line 2
line3
string
Address line 3
city
string
City
state
string
State or province. Deprecated, will remove in FDX V6.0
region
string
State or province or territory. Replaces "state" property
postalCode
string
Postal code
country
string
ISO 3166 Country Code
type
string
Type of address location. One of BUSINESS, HOME, MAILING
telephones
array of objects
object
number
string
type
string
HOMEBUSINESSCELLFAXcountry
string
Country calling codes defined by ITU-T recommendations E.123 and E.164
email
array of strings
An array of the end-user's electronic mail addresses
string
accounts
array of objects
List of accounts related to this end-user
object
accountId
string
Account ID of the related account
relationship
string
Types of relationships between accounts and holders. Suggested values
AUTHORIZED_USERBUSINESSFOR_BENEFIT_OFFOR_BENEFIT_OF_PRIMARYFOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTEDFOR_BENEFIT_OF_SECONDARYFOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTEDFOR_BENEFIT_OF_SOLE_OWNER_RESTRICTEDPOWER_OF_ATTORNEYPRIMARY_JOINT_TENANTSPRIMARYPRIMARY_BORROWERPRIMARY_JOINTSECONDARYSECONDARY_JOINT_TENANTSSECONDARY_BORROWERSECONDARY_JOINTSOLE_OWNERTRUSTEEUNIFORM_TRANSFER_TO_MINORrelationship
Customer's relationship to the account
string
emails
array of strings
Email addresses associated with the account
string
addresses
array of objects
Physical mail addresses associated with the account
line1
string
Address line 1. May contain full address if not separated
line2
string
Address line 2
line3
string
Address line 3
city
string
City
state
string
State or province. Deprecated, will remove in FDX V6.0
region
string
State or province or territory. Replaces "state" property
postalCode
string
Postal code
country
string
ISO 3166 Country Code
type
string
Type of address location. One of BUSINESS, HOME, MAILING
telephones
array of objects
Telephone numbers associated with the account
object
type
string
Type of phone number: HOME, BUSINESS, CELL, FAX
HOMEBUSINESSCELLFAXcountry
string
Country calling codes defined by ITU-T recommendations E.123 and E.164
number
string
Telephone subscriber number defined by ITU-T recommendation E.164
Headers
x-akoya-interaction-idstring
Akoya supplied interaction id used for logging and error tracking
404
Not Found
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
Try it
Authorization
const options = {
"method": "GET",
"headers": {
"x-akoya-interaction-type": "batch"
}
}};
fetch('https://sandbox-products.ddp.akoya.com/contacts/v2/mikomo/:accountId', options)
.then(response => response.json())
.catch(err => console.error(err));