Customer
A customer represents a single end-user. Almost every action in Helix requires a customerId
to identify for whom the action is being performed. To correlate a customer in Helix to a user in your system, you can:
- Pass your system's unique user ID into the
tag
property during customer creation. This allows you to use your system's ID to fetch the customer's Helix data via /customer/getByTag - Capture and store the unique
customerId
returned by Helix after customer creation. You can then use /customer/Get to fetch the customer's Helix data
Take me to the Customer Endpoint Reference
customer Object
Property | Data Type (length) | Description |
---|---|---|
| enum | The maximum level of access this customer can have. Possible
See customer.accessTypeCode for more details |
| array | An array of account objects owned by the customer |
| array | An array of address objects associated with the customer |
| datetime | Example: |
| array | An array of card objects owned by the customer |
| datetime | Date the customer was created. Note: a customer may have |
| enum | Accepted values vary by program. i.e.:
|
| string (50) | A property for holding client-defined data. There is no |
| string (50) | A property for holding client-defined data. There is no |
| string (50) | A property for holding client-defined data. There is no |
| string (50) | A property for holding client-defined data. There is no |
| string (50) | A property for holding client-defined data. There is no |
| integer | The Helix-assigned unique ID for a customer. Will be |
| datetime | Denotes the date the customer was reported as deceased. |
| datetime | Date the driver's license expires. i.e.: |
| datetime | Date the driver's license was issued. i.e.: |
| string (30) | The identifying number from a government-issued driver's |
| string | Last 4 digits of the |
| string (2) | State from which the driver's license is issued. i.e.: |
| string (255) | Example: |
| array | An array of externalAccount objects owned by the customer |
| string (64) | First (given) name |
| enum | Possible values:
|
| deprecated | Use |
| boolean | Only required when creating a new customer. Confirms that |
| boolean | Denotes if a customer is locked, typically caused by fraud |
| boolean | Denotes if customer opts in to receiving marketing |
| boolean | All customers need to indicate whether they are subject to |
| datetime | Timestamp for the last time any action was performed on this |
| datetime | Date when the object was last altered in any way |
| string (128) | Last name (surname) |
| datetime | Denotes the last time |
| string | The reason |
| string (64) | |
| string (5) | Country from which the passport is issued. i.e.:
|
| datetime | Date the passport expires. i.e.: |
| datetime | Date the passport was issued. i.e.: |
| string (30) | The identifying number from a government-issued passport |
| string | Last 4 digits of the |
| array | An array of phone objects associated with the customer |
| enum | Possible values:
|
| string (20) | A customer's name suffix. i.e.:
|
| string (50) | A client-assigned unique identifier to represent exactly |
| string (30) | SSN in the US. Specify only the digits, no formatting (dashes, |
| string | Last 4 digits of the |
Updated 4 months ago