post https://sandbox-api.helix.q2.com/customer/update
See customer object definition for parameter details.
As a fraud prevention mechanism very few properties can be updated via API if your program uses Helix KYC/IDV. The list of properties will vary based on your specific program settings. Please reach out to your relationship manager if you have any questions about enabling certain property updates.
Error Codes
Click to expand
| Code | Message (en-US) | Notes |
|---|---|---|
| 1-60000 | Any "Common Error Code" may occur. | See Common Error Codes |
| 60001 | Customer id [NULL] is invalid. | |
| 60006 | businessNameOnCard {0} is restricted to 26 characters. | |
| 60007 | businessNameOnCard {0} contains invalid characters. Refer to API documentation for valid characters. | |
| 60263 | PreferredName ‘{0}’ is restricted to 21 characters | |
| 60264 | PreferredName ‘{0}’ has some unsupported characters | |
| 60265 | PreferredName not enabled on program | |
| 60266 | preferredName is required when usePreferredNameOnCard is passed as true | |
| 60301 | Birth Date is invalid. Please enter a valid date after 01/01/1900. | |
| 60302 | Gender is invalid. Valid values are: 'M', 'F', and 'U'. | |
| 60303 | Tag '{0}' is already associated with a different customer. | |
| 60304 | Invalid email address | |
| 60305 | Invalid industryClassificationCodeId '{id}' | |
| 60306 | Your program settings do not allow for firstName or lastName to be updated via API. | |
| 60307 | Your program settings do not allow for emailAddress to be updated via API. | |
| 60308 | Your program settings do not allow for residence address to be updated via API. | |
| 60350 | Only three addresses are allowed -- one for each valid type of Residence, Mailing, or Prior. | |
| 60351 | Only three phones are allowed -- one for each valid type of Home, Mobile, or Office. | |
| 60352 | Invalid foreignDocumentType | |
| 60353 | Foreign document values are not allowed by program | |
| 60354 | foreignDocumentType required foreignDocumentNumber on the the customer record | |
| 60355 | foreignDocumentCountryCode required a foreignDocumentNumber on the customer record | |
| 60356 | foreignDocumentExpirationDate requires a foreignDocumentNumber on the customer record | |
| 60450 | Updating any properties that are used during the ID Verification process is not allowed. These properties include firstName, middleName, lastName, birthDate, taxId, emailAddress, license information, passport information, and Residence address information | Only applicable if your program uses Helix's KYC/Fraud/OFAC checks for customer verification |
| 66801 | Invalid Phone Type. Valid values are: 'Home', 'Mobile', 'Office'. | |
| 66802 | Phone Number is a required field. | |
| 66901 | Invalid Address Type. Valid values are: Mailing, Residence, Prior. | |
| 66902 | Address Line 1 is a required field. | |
| 66903 | City is a required field. | |
| 66904 | State is a required field. | |
| 66905 | Postal Code is a required field. | |
| 66906 | Country is a required field. | |
| 66907 | Residential Addresses can not contain a PO Box. | |
| 66908 | DPS Clients Only: Address lines must not exceed 76 characters. | |
| 194102 | Your program settings do not allow for updating of businessLegalName. | |
| 194103 | "Your program settings do not allow for updating of dba. | |
| 194104 | Your program settings do not allow for updating of legalEntityType. | |
| 194105 | Your program settings do not allow for updating of isTaxExempt. | |
| 194106 | Your program settings do not allow for updating of taxId. | |
| 194107 | Your program settings do not allow for updating of taxIdType. | |
| 194108 | Your program settings do not allow for updating of PrimaryBusiness addressType. | |
| 194109 | Your program settings do not allow for updating of Mailing addressType. | |
| 194115 | Preferred Name is not allowed for businesses |