Submit a new lead to the LMS

post

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

Create a customer and loan application based on a lead submission. Permission: Submit Leads

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

addresses

array of objects

addresses

birthdate

date

required

string date

string

firstName

string

gender

string

enum

Defaults to null

Allowed:

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:

incomeSources

array of objects

incomeSources

isMilitary

boolean

required

Not required if lead is submitted with the country specified as "Canada"

lastBankruptcyDeclaredAt

date

Defaults to null

string date/time

leadAffiliateId

string

Defaults to null

number as string

leadAffiliateSubId

string

leadExternalId

string

Defaults to null

string as int

leadProvider

string

Defaults to null

leadReferenceId

string

Defaults to null

loan

object

required

maritalStatus

string

enum

Defaults to null

Allowed:

mobilePhone

string

Defaults to null

number as string

mothersMaidenName

string

Defaults to null

paymentMethods

array of objects

paymentMethods

preferredContactTime

string

enum

Defaults to null

Allowed:

preferredPhone

string

enum

Defaults to null

Allowed:

purchasePrice

int32

Defaults to null

socialSecurityNumber

string

required

number as string | Not required if lead is submitted with the country specified as "Canada"

suffix

string

enum

Defaults to null

lastName

string

campaign

string

Username

string

Username the customer can use to login to their portal

password

string

Password settings are located at the bottom of Lender settings

Headers

string

required

Defaults to application/vnd.totality.v1+json

Content-Type

string

required

Defaults to application/json

Responses

200200

400400

401401

412412

422422

500500