API Reference

Create Pre-Application

Create a new pre-application. Creates or matches a customer, creates a loan, and returns application URLs. Permission: Create Pre-Applications

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
≥ 100

Requested loan amount in cents.

custom_fields
object
required

Custom field data. Must have at least 1 field. Each value max 65535 characters.

string
required
length ≤ 255

Applicant email address.

string
required
length ≤ 255

Applicant first name.

string
required
length ≤ 255

Applicant last name.

uuid
required

UUID of the loan group.

uuid
required

UUID of the loan type. The loan type must have maxAmountToLend > 0.

uri
required
length ≤ 2048

URL to redirect the applicant after completion.

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

401

Unauthenticated

403

Forbidden - invalid scope

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