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
Property | Data Type (length) | Description |
---|---|---|
accessTypeCode | enum | The 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 |
accountId | integer | The accountId property from the account object. |
accountName | string | The name property from the account object. |
accountNumber | string | The accountNumber property from the account object. |
accountNumberMasked | string | The accountNumberMasked property from the account object. |
accountTag | string | The tag property from the account object. |
customerId | integer | The customerId property from the customer object. |
customerPriority | integer | The priority of the customer on this account. 1 is highest. |
customerTag | string | The tag property from the customer object. |
emailAddress | string | The emailAddress property from the customer object. |
firstName | string | The firstName property from the customer object. |
isPrimaryCustomer | boolean | true if customerId matches primaryCustomerId . |
lastName | string | The lastName property from the customer object. |
middleName | string | The middleName property from the customer object. |
primaryCustomerId | integer | The primaryCustomerId property from the account object. |
routingNumber | string | The routingNumber property from the account object. |
routingNumberMasked | string | The routingNumberMasked property from the account object. |
suffix | string | The suffix property from the customer object. |
Updated over 1 year ago