Create Customers

post

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

Create new customer. Permission: Create Customers

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

achProcessingPreference

string

Defaults to null

addresses

array of objects

addresses

birthdate

date

required

string date

canBeContactedViaPhone

boolean

Defaults to true

canBeContactedViaSms

boolean

Defaults to true

canBeMarketedToViaEmail

boolean

Defaults to true

currentBankruptcyDeclaredAt

date

Defaults to null

string date/time

debitCardProcessingPreference

string

Defaults to null

email

string

required

ethnicity

string

Defaults to null

externalId

string

Defaults to null

eyeColor

string

Defaults to null

firstName

string

required

gender

string

enum

Defaults to null

Allowed:

height

string

Defaults to null

Number as string

homeOwnershipStatus

string

enum

Defaults to null

Allowed:

homePhone

string

Defaults to null

Number as string

identificationNumber

string

Defaults to null

identificationState

string

Defaults to null

identificationType

string

enum

Defaults to null

Allowed:

importCompany

string

Defaults to null

importedOn

string

Defaults to null

importSource

string

Defaults to null

incomeSources

array of objects

incomeSources

isEligibleForInstantFunding

boolean

Defaults to false

isMilitary

boolean

Defaults to false

lastName

string

required

loans

array of strings

loans

maritalStatus

string

enum

Defaults to null

Allowed:

middleName

string

mobilePhone

string

required

number as string

mothersMaidenName

string

Defaults to null

password

string

Password settings are located at the bottom of Lender settings

paymentProcessingTime

date-time

Defaults to null

string time

preferredContactTime

string

enum

Allowed:

preferredPhone

string

enum

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

rccProcessingPreference

string

Defaults to null

revokedPaymentTypes

array

revokedPaymentTypes

socialSecurityNumber

string

required

number as string

spouseEmail

string

Defaults to null

spouseName

string

Defaults to null

suffix

string

enum

Defaults to null

username

string

Username the customer can use to login to their portal

weight

int32

Defaults to null

Headers

Accept

string

required

Defaults to application/vnd.totality.v1+json

Content-Type

string

required

Defaults to application/json

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json