Skip to main content

Authorized User Resources

The following resources are used in the Authorized Users API:

AuthorizedUser

The AuthorizedUser type represents an individual that has full access to a Customer's financials and can authenticate on behalf of the customer.

NameTypeDescription
fullName RequiredFullNameFull name of the authorized user.
email RequiredstringThe authorized user's email address.
phone RequiredPhoneThe authorized user's phone number. This number will be used for One Time Password (OTP) authentication.
jwtSubject OptionalstringSee this section for more information.
canConnectWithAuthVendor OptionalbooleanDefault is true. When set to false, the authorized user cannot authenticate through exchange networks such as Plaid. See Plaid Exchange for more information.
Example AuthorizedUser:
{
"fullName": {
"first": "Richard",
"last": "Hendricks"
},
"email": "richard@piedpiper.com",
"phone": {
"countryCode": "1",
"number": "5555555555"
},
"canConnectWithAuthVendor": true
}
ResourceDescription
BusinessCustomerBusiness customer that may have authorized users
IndividualCustomerIndividual customer that may have authorized users