Private API Reference

Loan Application Sessions

Loan Application Sessions let your customers apply for credit by completing Increase-hosted forms. Create a session and redirect your customer to the returned URL. When they’re done, they’ll be redirected back to your site.

The Loan Application Session object

{
  "created_at": "2020-01-31T23:59:59Z",
  "entity_id": "entity_n8y8tnk2p9339ti393yi",
  "expires_at": "2020-02-01T05:59:59+00:00",
  "id": "loan_application_session_un3dwu1nfktknfd89p8a",
  "idempotency_key": null,
  "program_id": "program_i2v2os4mwza1oetokh9i",
  "redirect_url": "https://example.com/loan-application/completed",
  "session_url": "https://onboarding.increase.com/loan_application/sessions?id=HIrdj46cXyyNqT5RDcIR38dzPqzRBgTdG84XwzOz",
  "status": "active",
  "type": "loan_application_session"
}

Attributes

created_at

string

The ISO 8601 date and time at which the Loan Application Session was created.

entity_id

string

Nullable

The identifier of the Entity associated with this session, if one has been created.

More about Entities.

expires_at

string

The ISO 8601 date and time at which the Loan Application Session will expire.

string

The Loan Application Session’s identifier.

idempotency_key

string

Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

program_id

string

The identifier of the Program the customer is applying to.

More about Programs.

redirect_url

string

The URL to redirect to after the session is complete. Increase will include the query parameters loan_application_session_id and entity_id when redirecting.

session_url

string

Nullable

The URL containing the loan application form. You should share this link with your customer. Only present when the session is active.

status

enum

The status of the Loan Application Session.

type

string

A constant representing the object’s type. For this resource it will always be loan_application_session.

List Loan Application Sessions

curl \
  --url "${INCREASE_URL}/loan_application_sessions" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* Loan Application Session object */ },
    { /* Loan Application Session object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

status.in

array of strings

Filter Loan Application Sessions for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

idempotency_key

string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Between 1 and 200 characters

More parameters

cursor

string

limit

integer

Create a Loan Application Session

curl -X "POST" \
  --url "${INCREASE_URL}/loan_application_sessions" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "entity_id": "entity_n8y8tnk2p9339ti393yi",
    "prefill_parameters": [
      {
        "category": "string",
        "key": "posh_group_identifier",
        "text": {
          "value": "applicant_12345"
        }
      }
    ],
    "program_id": "program_i2v2os4mwza1oetokh9i",
    "redirect_url": "https://example.com/loan-application/session"
  }'

Parameters

entity_id

string

The identifier of the customer Entity applying for credit. You typically create this Entity out of band.

More about Entities.

prefill_parameters

array

Values for the Program’s application parameters that are not collected from the applicant in the session. You must provide a value for each such parameter.

program_id

string

Required

The identifier of the Program the customer is applying to.

More about Programs.

redirect_url

string

Required

The URL to redirect the customer to after they complete the loan application form. The redirect will include loan_application_session_id and entity_id query parameters.

Retrieve a Loan Application Session

curl \
  --url "${INCREASE_URL}/loan_application_sessions/loan_application_session_un3dwu1nfktknfd89p8a" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

loan_application_session_id

string

Required

The identifier of the Loan Application Session.

More about Loan Application Sessions.

Expire a Loan Application Session

curl -X "POST" \
  --url "${INCREASE_URL}/loan_application_sessions/loan_application_session_un3dwu1nfktknfd89p8a/expire" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

loan_application_session_id

string

Required

The identifier of the Loan Application Session to expire.

More about Loan Application Sessions.