Each object in the Helix API is intended to offer the appropriate level of visibility for functionality related to that object. However, we strive to maintain a level of consistency across all objects to make using the Helix API as a whole a pleasant experience.
Common Properties
Property
Summary
Notes
customerId
Helix-generated unique Id for a customer.
Used by almost every single route in Helix. It is recommended you store this in your system as well.
tag
A unique identifier for that object in your system.
Use this to tie data in your system to data in Helix
Must be unique across your entire program
Possible to update this value, but discouraged
Stored as an unencrypted string 50 characters in length
Do NOT pass personally identifiable information in this property, including but not limited to SSN, TIN, debit/credit card numbers, etc.
{object}Id
The Helix-generated unique identifier for {object}.
Usually returned when a /{object}/create or /{object}/initiate route is called. May be 32- or 64-bit integer, see specific route for details
Common Actions
Action
Summary
Notes
/{object}/create
Creates a new {object} in Helix
{object} will be created and is immediately
available for use
/{object}/initiate
Initiates creation of a new {object}
in Helix
Always used in tandem with /{object}/verify
On success, {object} is created, but not
available for use until /{object}/verify is
called successfully
/{object}/verify
Verifies creation of a new {object}
in Helix
Always used in tandem with /{object}/initiate
On success, {object} will be ready for
immediate use
/{object}/archive
Permanently deactivates a specific {object} in Helix
It is never possible to re-activate the {object}
via Helix API
Sometimes it is possible to re-activate the {object} via the Helix Admin console
/{object}/get
Retrieves a single {object}
based on a Helix-generated {object}Id
If {object} is not found, either an HTTP 400
may occur or the data property may be null. Depends
on the specific route
/{object}/getByTag
Returns a single instance of an {object} based on the tag
supplied when /{object}/create or /{object}/initiate was called
If {object} is not found, either an HTTP 400
may occur or the data property may be null. Depends
on the specific route
/{object}/list
Returns a list of {object}s based
on supplied parameter(s)
