Docs
Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status
API Reference
Documents

Increase generates certain documents / forms automatically for your application; they can be listed here.

The Document object
{
  "account_verification_letter": {
    "account_number_id": "account_number_v18nkfqm6afpsrvy82b2"
  },
  "category": "account_verification_letter",
  "created_at": "2020-01-31T23:59:59Z",
  "entity_id": "entity_n8y8tnk2p9339ti393yi",
  "file_id": "file_makxrc67oh9l6sg7w9yc",
  "funding_instructions": null,
  "id": "document_qjtqc6s4c14ve2q89izm",
  "idempotency_key": null,
  "type": "document"
}
Attributes
account_verification_letter
dictionary
Nullable

Properties of an account verification letter document.

category
enum

The type of document.

created_at
string

The ISO 8601 time at which the Document was created.

entity_id
string
Nullable

The identifier of the Entity the document was generated for.

file_id
string

The identifier of the File containing the Document's contents.

funding_instructions
dictionary
Nullable

Properties of a funding instructions document.

id
string

The Document 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 document.

List Documents
curl \
  --url "${INCREASE_URL}/documents" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

entity_id
string

Filter Documents to ones belonging to the specified Entity.

category.in
array of strings

Filter Documents for those with the specified category or categories. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

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.

200 character maximum
Create a Document
curl -X "POST" \
  --url "${INCREASE_URL}/documents" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_verification_letter": {
      "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
      "balance_date": "2024-12-31"
    },
    "category": "account_verification_letter"
  }'
Parameters
account_verification_letter
dictionary

An account verification letter.

category
enum
Required

The type of document to create.

funding_instructions
dictionary

Funding instructions.

Retrieve a Document
curl \
  --url "${INCREASE_URL}/documents/document_qjtqc6s4c14ve2q89izm" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
document_id
string
Required

The identifier of the Document to retrieve.

Sandbox: Create a tax document

Simulates an tax document being created for an account.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/documents" \
  -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 Account the tax document is for.