Submit a New Lead

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

Array of customer addresses.

addresses

birthdate

date

required

string date

string

The customer's email address.

firstName

string

The customer's first name.

gender

string

enum

Defaults to null

The customer's gender.

Allowed:

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:

incomeSources

array of objects

Array of customer income sources.

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

Lead affiliate sub id.

leadExternalId

string

Defaults to null

string as int

leadProvider

string

Defaults to null

Lead provider name.

leadReferenceId

string

Defaults to null

Lead reference id.

loan

object

required

Loan details for the lead submission.

maritalStatus

string

enum

Defaults to null

The customer's marital status.

Allowed:

mobilePhone

string

Defaults to null

number as string

mothersMaidenName

string

Defaults to null

The customer's mother's maiden name.

paymentMethods

array of objects

Payment methods for the lead.

paymentMethods

preferredContactTime

string

enum

Defaults to null

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

Allowed:

preferredPhone

string

enum

Defaults to null

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

Allowed:

purchasePrice

int32

Defaults to null

Purchase price.

socialSecurityNumber

string

required

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

suffix

string

enum

Defaults to null

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

lastName

string

The customer's last name.

campaign

string

Campaign.

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

Must be application/json.

Content-Type

string

required

Defaults to application/json

Must be application/json.

Responses

200200

400400

401401

412412

422422

500500