API Reference

Update Customer

Update a preexisting customer's information. Permission: Update Customers

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

UUID | The UUID of the customer to get information.

Body Params
string
Defaults to null

Preferred ACH processing method.

date
Defaults to null

string date

boolean

Whether the customer consents to phone contact.

boolean

Whether the customer consents to SMS messages.

boolean

Whether the customer consents to marketing emails.

date
Defaults to null

string date/time

string
Defaults to null

Preferred debit card processing method.

string

The customer's email address.

string
Defaults to null

The customer's ethnicity.

string
Defaults to null

External system identifier for cross-referencing.

string
Defaults to null

The customer's eye color.

string

The customer's first name.

string
enum
Defaults to null

The customer's gender.

Allowed:
string
Defaults to null

Number as string

string
enum
Defaults to null

Housing status (Own, Rent, Other).

Allowed:
string

Number as string

string
Defaults to null

Government ID number.

string
Defaults to null

State that issued the government ID.

string
enum

Type of government ID (e.g., State ID, Drivers License, Passport).

Allowed:
string
Defaults to null

Company the record was imported from.

string
Defaults to null

Date the record was imported (YYYY-MM-DD).

string
Defaults to null

Source system the record was imported from.

incomeSources
array of objects

Array of customer income sources.

incomeSources
boolean

Whether the customer is active-duty military.

string

The customer's last name.

loans
array of strings

Loans.

loans
string
enum
Defaults to null

The customer's marital status.

Allowed:
string

The customer's middle name.

string

number as string

string
Defaults to null

The customer's mother's maiden name.

date-time
Defaults to null

string time

string
enum

Preferred time to contact (e.g., Anytime, Morning, Afternoon, Evening).

Allowed:
string
enum

Preferred phone for contact (Home, Mobile, Work).

Allowed:
date
Defaults to null

string date/time

date
Defaults to null

string date/time

date
Defaults to null

string date

string
Defaults to null

The customer's race.

string
Defaults to null

Preferred RCC processing method.

revokedPaymentTypes
array of strings

Payment types revoked for this customer.

revokedPaymentTypes
string
Defaults to null

number as string

string
Defaults to null

Email of the customer's spouse.

string
Defaults to null

Name of the customer's spouse.

string
enum
Defaults to null

Name suffix (e.g., Jr, Sr, I, II, III).

int32
Defaults to null

The customer's weight.

boolean
Defaults to false

Whether eligible for instant funding.

Headers
string
required
Defaults to application/vnd.totality.v1+json

Must be application/json.

string
required
Defaults to application/json

Must be application/json.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json