Create Customer

post

https://{your-totality-url}.com/api/customers

Create new customer. Permission: Create Customers

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

achProcessingPreference

string

Defaults to null

Preferred ACH processing method. Set to "Primary" to make ACH the customer's primary processing preference. At most one of achProcessingPreference, debitCardProcessingPreference, eftProcessingPreference, interacProcessingPreference, and rccProcessingPreference may be set to "Primary"; a request that would result in more than one returns 422.

addresses

array of objects

Array of customer addresses.

addresses

birthdate

date

required

string date

canBeContactedViaPhone

boolean

Defaults to true

Whether the customer consents to phone contact.

canBeContactedViaSms

boolean

Defaults to true

Whether the customer consents to SMS messages.

canBeMarketedToViaEmail

boolean

Defaults to true

Whether the customer consents to marketing emails.

currentBankruptcyDeclaredAt

date

Defaults to null

string date/time

customFieldData

object

Customer-level custom fields, keyed by the custom field's name. Values are typed per each field's definition (string, number, boolean, date, or array for multi-select). Discover available fields via GET /api/custom-fields?context=Customer. On POST/PATCH this object is additive and optional; on PATCH only the supplied keys are updated.

debitCardProcessingPreference

string

Defaults to null

Preferred debit card processing method. Set to "Primary" to make debit card the customer's primary processing preference. At most one of the five *ProcessingPreference fields (ACH, debit card, EFT, Interac, RCC) may be set to "Primary"; a request that would result in more than one returns 422.

string

required

The customer's email address.

ethnicity

string

Defaults to null

The customer's ethnicity.

externalId

string

Defaults to null

External system identifier for cross-referencing.

eyeColor

string

Defaults to null

The customer's eye color.

firstName

string

required

The customer's first name.

gender

string

enum

Defaults to null

The customer's gender.

Allowed:

height

string

Defaults to null

Number as string

homeOwnershipStatus

string

enum

Defaults to null

Housing status (Own, Rent, Other).

Allowed:

homePhone

string

Defaults to null

Number as string

identificationNumber

string

Defaults to null

Government ID number.

identificationState

string

Defaults to null

State that issued the government ID.

identificationType

string

enum

Defaults to null

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

Allowed:

importCompany

string

Defaults to null

Company the record was imported from.

importedOn

string

Defaults to null

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

importSource

string

Defaults to null

Source system the record was imported from.

incomeSources

array of objects

Array of customer income sources.

incomeSources

isBlockedFromReapply

boolean

Whether the customer is blocked from reapplying for a new loan because they match a configured reapply exclusion condition. Enforced server-side and not overridable per customer.

isBlockedFromReapplyReason

string | null

The matched reapply exclusion condition describing why the customer is blocked from reapply, or null when not blocked.

isBlockedFromRefinance

boolean

Whether the customer is blocked from refinancing: they have at least one active loan, none currently refinance-eligible, and the cause is a manual deny, a disqualifying tag, or a matched exclusion condition (not a benign not-yet-eligible state).

isBlockedFromRefinanceReason

string | null

The reason the customer is blocked from refinance (manual deny, disqualifying tag, or matched exclusion condition), or null when not blocked.

isEligibleForInstantFunding

boolean

Defaults to false

Whether eligible for instant funding.

isMilitary

boolean

Defaults to false

Whether the customer is active-duty military.

lastName

string

required

The customer's last name.

loans

array of strings

Loans.

loans

maritalStatus

string

enum

Defaults to null

The customer's marital status.

Allowed:

middleName

string

The customer's middle name.

mobilePhone

string

required

number as string

mothersMaidenName

string

Defaults to null

The customer's mother's maiden name.

password

string

Password settings are located at the bottom of Lender settings

paymentProcessingTime

date-time

Defaults to null

string time

preferredContactTime

string

enum

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

Allowed:

preferredPhone

string

enum

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

Allowed:

previousBankruptcyDeclaredAt

date

Defaults to null

string date/time

previousBankruptcyDismissedAt

date

Defaults to null

string date/time

purchasedOn

date

Defaults to null

string date

race

string

Defaults to null

The customer's race.

rccProcessingPreference

string

Defaults to null

Preferred RCC processing method. Set to "Primary" to make RCC the customer's primary processing preference. At most one of the five *ProcessingPreference fields (ACH, debit card, EFT, Interac, RCC) may be set to "Primary"; a request that would result in more than one returns 422.

revokedPaymentTypes

array

Payment types revoked for this customer.

revokedPaymentTypes

socialSecurityNumber

string

required

number as string

spouseEmail

string

Defaults to null

Email of the customer's spouse.

spouseName

string

Defaults to null

Name of the customer's spouse.

suffix

string

enum

Defaults to null

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

username

string

Username the customer can use to login to their portal

weight

int32

Defaults to null

The customer's weight.

Responses

201Customer created successfully.

401401

403403

422422

500500