post https://sandbox-api.helix.q2.com/account/addEntitlement
Grant business account access to a customer related to the business.
Use of this endpoint requires approval from Q2 and your bank partner.
Error Codes
Click to expand
| Code | Message (en-US) | Notes |
|---|---|---|
| 1-60000 | Any "Common Error Code" may occur. | See Common Error Codes |
| 195100 | requestingCustomerId '{requestingCustomerId}' has insufficient entitlement on accountId '{accountId}' to add entitlement for targetCustomerId '{targetCustomerId}' | |
| 195101 | Program is not authorized to use this endpoint. Please contact your relationship manager for details. | |
| 195102 | accountId '{accountId}' must be a business account. | |
| 195103 | accountId '{accountId}' is currently in '{accountStatusType}' status and entitlements cannot be added. Please refer to API documentation. | |
| 195104 | accountId '{accountId}' is currently locked and entitlements cannot be added. | |
| 195105 | requestingCustomerId is required | |
| 195106 | accountId is required | |
| 195107 | targetCustomerId is required | |
| 195108 | entitlement '{entitlement}' is invalid. Refer to API documentation for valid values | |
| 195109 | Invalid accountId '{accountId}' | |
| 195110 | targetCustomerId '{targetCustomerId}' already has an entitlement for accountId '{accountId}' | |
| 195112 | {customerIdDescription} '{customerId}' is invalid. | CustomerIdDescription == either "targetCustomerId" or "requestingCustomerId" |
| 195113 | {customerIdDescription} '{customerId}' is inactive. | |
| 195114 | {customerIdDescription} '{customerId}' is locked. | |
| 195115 | {customerIdDescription} '{customerId}' is marked as deceased. | |
| 195116 | {customerIdDescription} '{customerId}' is not in verified status. | |
| 195117 | {customerIdDescription} '{customerId}' is must have an active customer relationship to the business customer who owns the account. | |
| 195118 | targetCustomerId '{targetCustomerId}' has not met sufficient onboarding requirements to be given '{entitlement}' entitlement for accountId '{accountId}' | Occurs when Entitlement != RDONLY and customer's OFACStatus isn't "Verified" |
| 195122 | targetCustomerId '{targetCustomerId}' can not be the business customer. |