Private API Reference

Loan Applications

A Loan Application is a request for credit submitted by a customer. Once submitted, Increase reviews the application and either approves it, yielding a Loan Offer, or rejects it.

Events

Your application can listen to webhooks about this resource. The events about Loan Applications will have the categories "loan_application.created" or "loan_application.updated".

The Loan Application object

{
  "adverse_action_notice_evidence": null,
  "approval": null,
  "created_at": "2020-01-31T23:59:59Z",
  "entity_id": "entity_n8y8tnk2p9339ti393yi",
  "guarantor_beneficial_owner_id": null,
  "id": "loan_application_mpe6oe4a2gc5knzl1xfy",
  "idempotency_key": null,
  "parameters": [
    {
      "amount": null,
      "category": "text",
      "enumerated_option": null,
      "key": "event_name",
      "text": {
        "value": "Cherry Street Pier Market"
      }
    }
  ],
  "plaid_processor_tokens": [
    {
      "plaid_processor_token_id": "plaid_processor_token_u8go17ptm6tnxi70hwiz"
    }
  ],
  "program_id": "program_i2v2os4mwza1oetokh9i",
  "rejection": null,
  "status": "pending_reviewing",
  "type": "loan_application"
}

Attributes

adverse_action_notice_evidence

dictionary

Nullable

If evidence of an adverse action notice has been submitted for the Loan Application, this contains details of the notice.

approval

dictionary

Nullable

If the Loan Application has been approved, this contains details of the approval.

created_at

string

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

entity_id

string

The identifier of the Entity applying for credit.

More about Entities.

guarantor_beneficial_owner_id

string

Nullable

The identifier of the Beneficial Owner of the Entity who is guaranteeing the loan, if any.

More about Beneficial Owners.

string

The Loan Application’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.

parameters

array

The values the applicant provided for the Program’s application parameters.

plaid_processor_tokens

array

The Plaid Processor Tokens corresponding to bank accounts owned by the applicant.

program_id

string

The identifier of the Program under which the application was submitted.

More about Programs.

rejection

dictionary

Nullable

If the Loan Application has been rejected, this contains details of the rejection.

status

enum

The status of the Loan Application.

type

string

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

List Loan Applications

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

Returns a list response:

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

Parameters

status.in

array of strings

Filter Loan Applications 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

Create a Loan Application

curl -X "POST" \
  --url "${INCREASE_URL}/loan_applications" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "entity_id": "entity_n8y8tnk2p9339ti393yi",
    "parameters": [
      {
        "category": "text",
        "key": "event_name",
        "text": {
          "value": "Cherry Street Pier Market"
        }
      }
    ],
    "plaid_processor_tokens": [
      {
        "plaid_processor_token_id": "plaid_processor_token_u8go17ptm6tnxi70hwiz"
      }
    ],
    "program_id": "program_i2v2os4mwza1oetokh9i"
  }'

Parameters

entity_id

string

Required

The identifier of the Entity applying for credit.

More about Entities.

guarantor_beneficial_owner_id

string

The identifier of a Beneficial Owner of the Entity who is guaranteeing the loan.

More about Beneficial Owners.

parameters

array

Required

The values for the Program’s application parameters.

plaid_processor_tokens

array

Required

Plaid Processor Tokens corresponding to bank accounts owned by the applicant.

program_id

string

Required

The identifier of the Program to apply under.

More about Programs.

Retrieve a Loan Application

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

Parameters

loan_application_id

string

Required

The identifier of the Loan Application.

More about Loan Applications.

Submit adverse action notice evidence for a Loan Application

Each rejected application should result in an adverse action notice stored at file_id delivered to the applicant via email.

curl -X "POST" \
  --url "${INCREASE_URL}/loan_applications/loan_application_mpe6oe4a2gc5knzl1xfy/submit_adverse_action_notice_evidence" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "recipient_email_address": "user@example.com",
    "sender_email_address": "notices@example.com",
    "sent_at": "2020-01-31T23:59:59Z"
  }'

Parameters

loan_application_id

string

Required

The identifier of the Loan Application the adverse action notice was sent for.

More about Loan Applications.

recipient_email_address

string

Required

The email address the adverse action notice was sent to.

Between 1 and 255 characters

sender_email_address

string

Required

The email address the adverse action notice was sent from.

Between 1 and 255 characters

sent_at

string

Required

The ISO 8601 date and time at which the adverse action notice was sent to the applicant.

Sandbox: Approve a Loan Application

Simulates the approval of a Loan Application by Increase, yielding a Loan Offer. This Loan Application must first have a status of pending_reviewing.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/loan_applications/loan_application_mpe6oe4a2gc5knzl1xfy/approve" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "amount": 1000000
  }'

Parameters

loan_application_id

string

Required

The identifier of the Loan Application you wish to approve.

More about Loan Applications.

amount

integer

Required

The amount of the resulting Loan Offer in the minor unit of the currency. For dollars, this is cents.

Sandbox: Reject a Loan Application

Simulates the rejection of a Loan Application by Increase, generating an adverse action notice. This Loan Application must first have a status of pending_reviewing.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/loan_applications/loan_application_mpe6oe4a2gc5knzl1xfy/reject" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "reasons": [
      "credit_score"
    ]
  }'

Parameters

loan_application_id

string

Required

The identifier of the Loan Application you wish to reject.

More about Loan Applications.

reasons

array of strings

The principal reasons the Loan Application is being rejected, up to four.