OpenApi SpecContact Us
API Reference

Create a customer

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. [block:callout] { "type": "warning", "body": "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." } [/block]

Body Params
string
required
length ≤ 64
string
length ≤ 64
string
required
length ≤ 128
string
length ≤ 20
date-time
string
enum
Allowed:
string
enum

Accepted values vary by program:

  • en-US: English
  • es-US: Spanish
Allowed:
string
length ≤ 50
string
length ≤ 30

No formatting (no dashes, spaces, etc).

string
enum
Allowed:
string
length ≤ 30
string
length ≤ 2
date-time
date-time
string
length ≤ 30
string
length ≤ 5
date-time
date-time
string
length ≤ 255
string
length ≤ 3
date-time
string
length ≤ 30
string
enum
Allowed:
boolean
required
boolean
required
boolean
required
string
length ≤ 100
string
length ≤ 100
string
length ≤ 100
string
length ≤ 100
string
length ≤ 100
string
length ≤ 21
boolean
Defaults to false
string
enum
Allowed:
addresses
array of objects
addresses
phones
array of objects
phones
Responses

Updated 7 days ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago