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",
  "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.

id

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.

parameters

array

Required

The values for the Program’s application parameters.

plaid_processor_tokens

array

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 $'{
    "reason": "credit_score"
  }'

Parameters

loan_application_id

string

Required

The identifier of the Loan Application you wish to reject.

More about Loan Applications.

reason

enum

Required

The reason the Loan Application is being rejected.

Loan Offers

A Loan Offer is a firm offer of credit extended by the bank to a customer following an approved Loan Application.

Events

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

The Loan Offer object

{
  "acceptance": null,
  "amount": 1000000,
  "created_at": "2020-01-31T23:59:59Z",
  "entity_id": "entity_n8y8tnk2p9339ti393yi",
  "expires_at": "2020-01-31T23:59:59Z",
  "id": "loan_offer_fspi9zpgcib98ok0h3dh",
  "loan_application_id": "loan_application_mpe6oe4a2gc5knzl1xfy",
  "program_id": "program_i2v2os4mwza1oetokh9i",
  "status": "pending",
  "terms_file_id": "file_makxrc67oh9l6sg7w9yc",
  "type": "loan_offer"
}

Attributes

acceptance

dictionary

Nullable

If the Loan Offer has been accepted, this contains details of the acceptance.

amount

integer

The offered amount of credit in the minor unit of the currency. For dollars, this is cents.

created_at

string

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

entity_id

string

The identifier of the Entity the offer was extended to.

More about Entities.

expires_at

string

The ISO 8601 date and time at which the Loan Offer expires.

id

string

The Loan Offer’s identifier.

loan_application_id

string

Nullable

The identifier of the Loan Application that yielded this offer, if any.

More about Loan Applications.

program_id

string

The identifier of the Program the offer was made under.

More about Programs.

status

enum

The status of the Loan Offer.

terms_file_id

string

The identifier of the File containing the loan terms contract.

More about Files.

type

string

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

List Loan Offers

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

Returns a list response :

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

Parameters

status.in

array of strings

Filter Loan Offers 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.

More parameters

Retrieve a Loan Offer

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

Parameters

loan_offer_id

string

Required

The identifier of the Loan Offer.

More about Loan Offers.

Sandbox: Expire a Loan Offer

Simulates a Loan Offer expiring because the customer did not accept it before its expires_at. This Loan Offer must first have a status of pending.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/loan_offers/loan_offer_fspi9zpgcib98ok0h3dh/expire" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

loan_offer_id

string

Required

The identifier of the Loan Offer you wish to expire.

More about Loan Offers.

Loan Obligations

A Loan Obligation represents a bill on a loan: an amount of principal, interest, and fees the borrower must pay by a due date.

Events

Your application can listen to webhooks about this resource. All of the events about Loan Obligations will have the category "loan_obligation.created" .

The Loan Obligation object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "created_at": "2020-01-31T23:59:59Z",
  "due_at": "2020-01-31T23:59:59Z",
  "due_fees": 100,
  "due_interest": 100,
  "due_principal": 100,
  "file_id": "file_makxrc67oh9l6sg7w9yc",
  "id": "loan_obligation_p6zk4mqoelj8bs7b8jmh",
  "idempotency_key": null,
  "past_due_at": "2020-01-31T23:59:59Z",
  "type": "loan_obligation"
}

Attributes

account_id

string

The identifier of the loan Account the Loan Obligation is billed against.

More about Accounts.

created_at

string

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

due_at

string

The ISO 8601 date and time at which the Loan Obligation is due.

due_fees

integer

The amount of fees due in the minor unit of the currency. For dollars, this is cents.

due_interest

integer

The amount of interest due in the minor unit of the currency. For dollars, this is cents.

due_principal

integer

The amount of principal due in the minor unit of the currency. For dollars, this is cents.

file_id

string

The identifier of the File containing a PDF of the Loan Obligation.

More about Files.

id

string

The Loan Obligation 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.

past_due_at

string

The ISO 8601 date and time after which the Loan Obligation is past due if it is unpaid.

type

string

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

List Loan Obligations

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

Returns a list response :

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

Parameters

account_id

string

Filter Loan Obligations to those billed against the specified loan Account.

More about Accounts.

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

Retrieve a Loan Obligation

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

Parameters

loan_obligation_id

string

Required

The identifier of the Loan Obligation.

More about Loan Obligations.

Retrieve the balances of a Loan Obligation

curl \
  --url "${INCREASE_URL}/loan_obligations/loan_obligation_p6zk4mqoelj8bs7b8jmh/balances" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a Loan Obligation Balance Lookup object:

{
  "due_fees": 100,
  "due_interest": 100,
  "due_principal": 100,
  "loan_obligation_id": "loan_obligation_p6zk4mqoelj8bs7b8jmh",
  "paid_fees": 100,
  "paid_interest": 100,
  "paid_principal": 100,
  "type": "loan_obligation_balance_lookup"
}

Parameters

loan_obligation_id

string

Required

The identifier of the Loan Obligation to look up the balances of.

More about Loan Obligations.

at_time

string

The moment to query the balances at. If not set, returns the current balances.

Sandbox: Create a Loan Obligation

Simulates a Loan Obligation being created for a loan Account, billing everything the Account owes. In production, Loan Obligations are created at the end of each cycle of the Account’s obligation schedule.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/loan_obligations" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky"
  }'

Parameters

account_id

string

Required

The identifier of the loan Account the Loan Obligation should be billed against.

More about Accounts.

Loan Purchases

A Loan Purchase records the purchase of seasoned receivables on a loan Account, moving funds out of a source Account.

Events

Your application can listen to webhooks about this resource. All of the events about Loan Purchases will have the category "loan_purchase.created" .

The Loan Purchase object

{
  "amount": 100,
  "created_at": "2020-01-31T23:59:59Z",
  "id": "loan_purchase_998w3thud40bt7uxop2s",
  "idempotency_key": null,
  "loan_account_id": "account_in71c4amph0vgo2qllky",
  "source_account_id": "account_in71c4amph0vgo2qllky",
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "loan_purchase"
}

Attributes

amount

integer

The amount of the purchase in the minor unit of the currency. For dollars, this is cents.

created_at

string

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

id

string

The Loan Purchase 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.

loan_account_id

string

The identifier of the loan Account whose receivables were purchased.

More about Accounts.

source_account_id

string

The identifier of the Account that funded the purchase.

More about Accounts.

transaction_id

string

Nullable

The identifier of the Transaction created on the source Account.

More about Transactions.

type

string

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

List Loan Purchases

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

Returns a list response :

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

Parameters

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 Purchase

curl -X "POST" \
  --url "${INCREASE_URL}/loan_purchases" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "amount": 100,
    "loan_account_id": "account_in71c4amph0vgo2qllky",
    "source_account_id": "account_in71c4amph0vgo2qllky"
  }'

Parameters

amount

integer

Required

The amount to purchase in the minor unit of the currency. For dollars, this is cents.

loan_account_id

string

Required

The identifier of the loan Account whose receivables are being purchased.

More about Accounts.

source_account_id

string

Required

The identifier of the Account funding the purchase.

More about Accounts.

Retrieve a Loan Purchase

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

Parameters

loan_purchase_id

string

Required

The identifier of the Loan Purchase.

More about Loan Purchases.

Loan Distributions

A Loan Distribution returns collected funds on purchased receivables to the owner of those receivables.

Events

Your application can listen to webhooks about this resource. All of the events about Loan Distributions will have the category "loan_distribution.created" .

The Loan Distribution object

{
  "amount": 100,
  "created_at": "2020-01-31T23:59:59Z",
  "destination_account_id": "account_in71c4amph0vgo2qllky",
  "id": "loan_distribution_h7z0rzz6ytwk285yg312",
  "loan_account_id": "account_in71c4amph0vgo2qllky",
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "loan_distribution"
}

Attributes

amount

integer

The amount of the distribution in the minor unit of the currency. For dollars, this is cents.

created_at

string

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

destination_account_id

string

The identifier of the Account the funds were distributed to.

More about Accounts.

id

string

The Loan Distribution identifier.

loan_account_id

string

The identifier of the loan Account the distribution relates to.

More about Accounts.

transaction_id

string

Nullable

The identifier of the Transaction created on the destination Account.

More about Transactions.

type

string

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

List Loan Distributions

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

Returns a list response :

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

Parameters

More parameters

Retrieve a Loan Distribution

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

Parameters

loan_distribution_id

string

Required

The identifier of the Loan Distribution.

More about Loan Distributions.

Plaid Processor Tokens

A Plaid Processor Token grants Increase access to an external bank account’s balance and transaction data through Plaid. Increase uses this data when underwriting Loan Applications.

Events

Your application can listen to webhooks about this resource. All of the events about Plaid Processor Tokens will have the category "plaid_processor_token.created" .

The Plaid Processor Token object

{
  "created_at": "2020-01-31T23:59:59Z",
  "id": "plaid_processor_token_u8go17ptm6tnxi70hwiz",
  "idempotency_key": null,
  "type": "plaid_processor_token"
}

Attributes

created_at

string

The ISO 8601 date and time at which the Plaid Processor Token was created.

id

string

The Plaid Processor Token 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.

type

string

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

List Plaid Processor Tokens

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

Returns a list response :

{
  "data": [
    { /* Plaid Processor Token object */ },
    { /* Plaid Processor Token object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

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 Plaid Processor Token

curl -X "POST" \
  --url "${INCREASE_URL}/plaid_processor_tokens" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "processor_token": "processor-production-0asd1-a92nc"
  }'

Parameters

processor_token

string

Required

The processor token generated by Plaid for sharing the external bank account with Increase.

Between 1 and 200 characters

Retrieve a Plaid Processor Token

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

Parameters

plaid_processor_token_id

string

Required

The identifier of the Plaid Processor Token.

More about Plaid Processor Tokens.