Customers Guide

x-akoya-interaction-type header

Optional

Required

x-akoya-last-access header

Not Supported

Required

x-akoya-intent-type header

Not Supported

Required

{version}

Major API version (e.g. v3)

{providerId}

ID for the financial institution providing the data

mode

String

No

BETA. Default is raw. Use standard for FDX-aligned, standardized data values.

Authorization

String

Yes

The ID Token for the permissioned user

x-akoya-interaction-type

String (Enum)

v2: No

v3: Yes

Indicates whether a consumer action prompted the request (USER) or the request is part of a batch process (BATCH).

x-akoya-last-access

String (Date-Time)

v2: N/A

v3: Yes

The date and time stamp for the last active use by the user.

x-akoya-intent-type

String (Enum)

v2: N/A

v3: Yes

Indicates whether a transaction involves a payment. Acceptable values are payments or nonpayments.

customerId

String

Long-term persistent identity of the customer. This identity must be unique to the owning institution

name

Object

none

name.first

String

First or given name. This data element may contain first & last name if not separated.

name.middle

String

none

name.last

String

none

name.prefix

String

Name prefix, e.g. Mr.

name.suffix

String

Generational or academic suffix

name.company

String

Company name

addresses

Array [addresses]

An array of the customer's addresses

addresses.type

String

The location type of an address

addresses.line1

String

May contain full address if not separated

addresses.line2

String

none

addresses.line3

String

none

addresses.city

String

none

addresses.state

String

none

addresses.postalCode

String

none

addresses.country

String

ISO 3166 Country Code

telephones

Array [telephones]

An array of the customer's telephone numbers.

telephones.number

String

none

telephones.type

String

none

telephones.country

String

Country calling codes defined by ITU-T recommendations E.123 and E.164

email

Array [String]

An array of the customer's electronic mail addresses

{version}

API major version (e.g. v2)

{providerId}

ID for the financial institution providing the data

{accountId}

The account ID of the permissioned user

(None)

---

---

---

Authorization

String

Yes

The ID Token for the permissioned user

x-akoya-interaction-type

String (Enum)

v2: No

v3: Yes

Indicates whether a consumer action prompted the request (USER) or the request is part of a batch process (BATCH).

x-akoya-last-access

String (Date-Time)

v2: N/A

v3: Yes

The date and time stamp for the last active use by the user.

x-akoya-intent-type

String (Enum)

v2: N/A

v3: Yes

Indicates whether a transaction involves a payment. Acceptable values are payments or nonpayments.

holders

Array [accountHolder]

FDX account holder, extends customer

holders.businessCustomer

Object

Commercial customers affiliate with a business entity.

businessCustomer.registeredAgents

Array [nameObject]

none

businessCustomer.registeredId

String

TIN or other identifier

businessCustomer.industryCode

Object

none

businessCustomer.industryCode.type

String

BCLASS, BICS, GICS, MOODYS, NAICS, OTHER, SIC

businessCustomer.industryCode.code

String

Code value

businessCustomer.domicile

Object

none

businessCustomer.domicile.region

String

Region of legal jurisdiction

businessCustomer.domicile.country

String

ISO 3166 country code

holders.accounts

Array [account]

List of accounts related to customer

accounts.accountId

String

Account unique identifier

accounts.relationship

String

Relationship. see the next row

relationship

String

Type of relationship between account and holder. Suggested:

AUTHORIZED_USER, BUSINESS, FOR_BENEFIT_OF, FOR_BENEFIT_OF_PRIMARY, FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED, FOR_BENEFIT_OF_SECONDARY, FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED, FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED, POWER_OF_ATTORNEY, PRIMARY, PRIMARY_BORROWER, PRIMARY_JOINT, PRIMARY_JOINT_TENANTS, SECONDARY, SECONDARY_BORROWER, SECONDARY_JOINT, SECONDARY_JOINT_TENANTS, SOLE_OWNER, TRUSTEE, UNIFORM_TRANSFER_TO_MINOR