post https://sandbox-api.helix.q2.com/customer/create
Create a customer record. See customer object definition for parameter details. The parameters you are required to pass to Helix can vary depending on your program settings.
This endpoint does not run KYC, fraud, OFAC, etc checks. Helix has an additional endpoint,
/customer/onboard, for performing customer KYC/IDV. The behavior of/customer/onboardvaries depending on your program settings and thus is not documented publicly. Please contact us for more information.
Error Codes
Click to expand
| Code | Message (en-US) | Notes |
|---|---|---|
| 1-60000 | Any "Common Error Code" may occur. | See Common Error Codes |
| 60106 | Invalid Verification Level for program. Current Level: '{0}'. | |
| 60111 | Residence Address is missing. | |
| 60112 | Residence Zip Code is missing. | |
| 60201 | First Name is a required field. | |
| 60202 | Last Name is a required field. | |
| 60203 | Birth Date is a required field. | |
| 60204 | Birth Date is invalid. Please enter a valid date after 01/01/1900 and in the past. | |
| 60205 | Gender is a required field. Valid values are: 'M', 'F', and 'U'. | |
| 60206 | Gender is invalid. Valid values are: 'M', 'F', and 'U'. | |
| 60207 | Culture is a required field. | |
| 60208 | Invalid Status. | |
| 60209 | Tax Id is a required field. | |
| 60210 | isSubjectToBackupWithholding is a required field. | |
| 60211 | Is Opted In To Bank Communication is a required field. | |
| 60212 | isDocumentsAccepted must be 'true'. | End user should be required to confirm that they have read and accept the terms of all documents returned by /bankdocument/list. |
| 60213 | ID Verification required for the program specified. | This route cannot be used based on your program configuration. |
| 60214 | A Residence Address is required. | Provide an address object with an addressType of Residence. |
| 60215 | Invalid addressType '{0}'. Refer to API documentation for valid types. | |
| 60216 | Address Line 1 is a required field. | |
| 60217 | Residential Addresses can not contain a PO Box. | |
| 60218 | City is a required field. | |
| 60219 | State is a required field. | |
| 60220 | Postal Code is a required field. | |
| 60221 | Country is a required field. | |
| 60222 | Invalid Phone Type. Valid values are: Home, Mobile, Office. | |
| 60223 | Phone Number is a required field. | |
| 60224 | This TaxId is already associated with an customer. | Provide a Tax Id unique to this customer. |
| 60225 | Tag '{0}' is already associated with another customer. | Provide a unique tag for this customer, or no tag at all. |
| 60226 | First name must not be longer than 12 characters. | Provide a unique tag for this customer, or no tag at all. |
| 60227 | Last name must not be longer than 20 characters. | |
| 60230 | Driver license state is required when driver license number is provided. | |
| 60235 | Passport country is required when passport number is provided. | |
| 60250 | Only three addresses are allowed -- one for each valid type of Residence, Mailing, or Prior. | Do not provide more than 3 address objects, each one with a different value for addressType. |
| 60251 | Only three phones are allowed -- one for each valid type of Home, Mobile, or Office. | Do not provide more than 3 phone objects, each one with a different value for phoneType. |
| 60260 | Registration attempt limit has been reached. Please try again at a later date. | |
| 60261 | Invalid taxIdType ''{0}''. Refer to API documentation for valid types. | |
| 60262 | Invalid residencyStatusType ''{0}''. Refer to API documentation for valid types. | |
| 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 | |
| 60267 | foreignDocumentType is required when foreignDocumentNumber is provided. | |
| 60268 | foreignDocumentExpirationDate is required when foreignDocumentNumber is provided. | |
| 60269 | foreignDocumentCountryCode is required when foreignDocumentNumber is provided. | |
| 60270 | Invalid foreignDocumentType ''{request.foreignDocumentType}''. Refer to API documentation for valid types. | |
| 60271 | Foreign document values are not allowed by program. Please contact your relationship manager for details. | |
| 60272 | foreignDocumentNumber is required when foreignDocumentType is provided. | |
| 60273 | foreignDocumentNumber is required when foreignDocumentExpirationDate is provided. | |
| 60274 | foreignDocumentNumber is required when foreignDocumentCountryCode is provided. | |
| 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. | |
| 69301 | Denial limit for this taxId has been exceeded. Registration may be attempted again on {0:d}. | This check is performed only in the Production environment; it is not performed in the Sandbox environment. |