OpenApi SpecContact Us
API Reference

Update a customer

post
https://sandbox-api.helix.q2.com/customer/update

See customer object definition for parameter details. [block:callout] { "type": "warning", "body": "As a fraud prevention mechanism very few properties can be updated via API if your program uses Helix KYC/IDV. The list of properties will vary based on your specific program settings. Please reach out to your relationship manager if you have any questions about enabling certain property updates." } [/block]

Body Params
int32
required
≥ 1
string
length ≤ 64
string
length ≤ 64
string
length ≤ 128
string
length ≤ 20
date-time
string
length ≤ 30

No formatting (no dashes, spaces, etc).

string
length ≤ 30
string
length ≤ 2
date-time
date-time
string
length ≤ 30
string
length ≤ 30
date-time
date-time
string
length ≤ 255
string
enum
Allowed:
string
enum

Accepted values vary by program:

  • en-US: English
  • es-US: Spanish
Allowed:
boolean
boolean
boolean
string
length ≤ 50
string
length ≤ 100
string
length ≤ 100
string
length ≤ 100
string
length ≤ 100
string
length ≤ 100
string
length ≤ 3
date-time
string
length ≤ 30
string
enum
Allowed:
string
string
string
length ≤ 200
date-time
string
length ≤ 2
int32
≥ 1
boolean
string
boolean
string
enum

The reason the business is exempt from Beneficial Ownership. See customer.exemptFromBeneficialOwnershipType for more details.

string
string
string
string
length ≤ 26
addresses
array of objects
addresses
phones
array of objects
phones
Responses

Updated 5 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 5 days ago