Account Access

An accountAccess object represents the relationship between a customer and an account. For accounts with exactly one customer associated with the account (i.e. non-joint accounts), the account access object will always have an accessTypeCode of FULL and the customer will be denoted as the primaryCustomerId for the account. For joint accounts (use of this functionality requires approval from the bank partner), different customers may have different types of access to a given account.

accountAccess Object

PropertyData Type (length)Description
accessTypeCodeenumThe type of access customerId has to accountId. Possible values:
- FULL: Customer can do anything with the account; read, withdraw funds, deposit funds
- AUTHSIGNER: Customer can have a debit card, receive account statements, deposit and withdraw to/from the account, access account transactions.
- RDONLY: Customer can read data associated with the account, but not edit the account itself, withdraw funds, or deposit funds
- NONE: Customer can do nothing with the account. Typically not returned via /account/listAccess (customers with NONE access type are filtered out), but is accepted via /account/editAccess
accountIdintegerThe accountId property from the account object.
accountNamestringThe name property from the account object.
accountNumberstringThe accountNumber property from the account object.
accountNumberMaskedstringThe accountNumberMasked property from the account object.
accountTagstringThe tag property from the account object.
customerIdintegerThe customerId property from the customer object.
customerPriorityintegerThe priority of the customer on this account. 1 is highest.
customerTagstringThe tag property from the customer object.
emailAddressstringThe emailAddress property from the customer object.
firstNamestringThe firstName property from the customer object.
isPrimaryCustomerbooleantrue if customerId matches primaryCustomerId.
lastNamestringThe lastName property from the customer object.
middleNamestringThe middleName property from the customer object.
primaryCustomerIdintegerThe primaryCustomerId property from the account object.
routingNumberstringThe routingNumber property from the account object.
routingNumberMaskedstringThe routingNumberMasked property from the account object.
suffixstringThe suffix property from the customer object.