Create a customer

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/onboard varies depending on your program settings and thus is not documented publicly. Please contact us for more information.

Error Codes

Click to expand
CodeMessage (en-US)Notes
1-60000Any "Common Error Code" may occur.See Common Error Codes
60106Invalid Verification Level for program. Current Level: '{0}'.
60111Residence Address is missing.
60112Residence Zip Code is missing.
60201First Name is a required field.
60202Last Name is a required field.
60203Birth Date is a required field.
60204Birth Date is invalid. Please enter a valid date after 01/01/1900 and in the past.
60205Gender is a required field. Valid values are: 'M', 'F', and 'U'.
60206Gender is invalid. Valid values are: 'M', 'F', and 'U'.
60207Culture is a required field.
60208Invalid Status.
60209Tax Id is a required field.
60210isSubjectToBackupWithholding is a required field.
60211Is Opted In To Bank Communication is a required field.
60212isDocumentsAccepted 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.
60213ID Verification required for the program specified.This route cannot be used based on your program configuration.
60214A Residence Address is required.Provide an address object with an addressType of Residence.
60215Invalid Address Type. Valid values are: Mailing, Residence, Prior.
60216Address Line 1 is a required field.
60217Residential Addresses can not contain a PO Box.
60218City is a required field.
60219State is a required field.
60220Postal Code is a required field.
60221Country is a required field.
60222Invalid Phone Type. Valid values are: Home, Mobile, Office.
60223Phone Number is a required field.
60224This TaxId is already associated with an customer.Provide a Tax Id unique to this customer.
60225Tag '{0}' is already associated with another customer.Provide a unique tag for this customer, or no tag at all.
60226First name must not be longer than 12 characters.Provide a unique tag for this customer, or no tag at all.
60227Last name must not be longer than 20 characters.
60230Driver license state is required when driver license number is provided.
60235Passport country is required when passport number is provided.
60250Only 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.
60251Only 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.
60260Registration attempt limit has been reached. Please try again at a later date.
60261Invalid taxIdType ''{0}''. Refer to API documentation for valid types.
60262Invalid residencyStatusType ''{0}''. Refer to API documentation for valid types.
66801Invalid Phone Type. Valid values are: 'Home', 'Mobile', 'Office'.
66802Phone Number is a required field.
66901Invalid Address Type. Valid values are: Mailing, Residence, Prior.
66902Address Line 1 is a required field.
66903City is a required field.
66904State is a required field.
66905Postal Code is a required field.
66906Country is a required field.
66907Residential Addresses can not contain a PO Box.
66908DPS Clients Only: Address lines must not exceed 76 characters.
69301Denial 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.
Language
Authentication
Basic
base64
:
URL
Click Try It! to start a request and see the response here!