# Increase API API

> Increase API API on Apizie: 131 endpoints (List Account Numbers, Create an Account Number, Retrieve an Account Number, Update an Account Number, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/open-data:increase/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:increase`
- Category: Open Data
- Status: byok
- Source: https://increase.com
- Page: https://www.apizie.tech/api/open-data/increase
- OpenAPI: https://www.apizie.tech/api/open-data/increase/openapi.json



## Endpoints

### List Account Numbers
`GET https://www.apizie.tech/v1/open-data:increase/list-account-numbers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| status | string | no | The status to retrieve Account Numbers for. |
| account_id | string | no | Filter Account Numbers to those belonging to the specified Account. |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |

### Create an Account Number
`POST https://www.apizie.tech/v1/open-data:increase/create-an-account-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an Account Number
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-an-account-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_number_id | string | yes | The identifier of the Account Number to retrieve. |

### Update an Account Number
`POST https://www.apizie.tech/v1/open-data:increase/update-an-account-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_number_id | string | yes | The identifier of the Account Number. |
| body | object | yes | JSON request body |

### List Account Statements
`GET https://www.apizie.tech/v1/open-data:increase/list-account-statements` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| account_id | string | no | Filter Account Statements to those belonging to the specified Account. |
| statement_period_start.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| statement_period_start.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| statement_period_start.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| statement_period_start.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |

### Retrieve an Account Statement
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-an-account-statement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_statement_id | string | yes | The identifier of the Account Statement to retrieve. |

### List Account Transfers
`GET https://www.apizie.tech/v1/open-data:increase/list-account-transfers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| account_id | string | no | Filter Account Transfers to those that originated from the specified Account. |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |

### Create an Account Transfer
`POST https://www.apizie.tech/v1/open-data:increase/create-an-account-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an Account Transfer
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-an-account-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_transfer_id | string | yes | The identifier of the Account Transfer. |

### Approve an Account Transfer
`POST https://www.apizie.tech/v1/open-data:increase/approve-an-account-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_transfer_id | string | yes | The identifier of the Account Transfer to approve. |

### Cancel an Account Transfer
`POST https://www.apizie.tech/v1/open-data:increase/cancel-an-account-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_transfer_id | string | yes | The identifier of the pending Account Transfer to cancel. |

### List Accounts
`GET https://www.apizie.tech/v1/open-data:increase/list-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| entity_id | string | no | Filter Accounts for those belonging to the specified Entity. |
| status | string | no | Filter Accounts for those with the specified status. |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |

### Create an Account
`POST https://www.apizie.tech/v1/open-data:increase/create-an-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an Account
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-an-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | The identifier of the Account to retrieve. |

### Update an Account
`POST https://www.apizie.tech/v1/open-data:increase/update-an-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | The identifier of the Account to update. |
| body | object | yes | JSON request body |

### Close an Account
`POST https://www.apizie.tech/v1/open-data:increase/close-an-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | The identifier of the Account to close. |

### List ACH Prenotifications
`GET https://www.apizie.tech/v1/open-data:increase/list-ach-prenotifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |

### Create an ACH Prenotification
`POST https://www.apizie.tech/v1/open-data:increase/create-an-ach-prenotification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an ACH Prenotification
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-an-ach-prenotification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ach_prenotification_id | string | yes | The identifier of the ACH Prenotification to retrieve. |

### List ACH Transfers
`GET https://www.apizie.tech/v1/open-data:increase/list-ach-transfers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| account_id | string | no | Filter ACH Transfers to those that originated from the specified Account. |
| external_account_id | string | no | Filter ACH Transfers to those made to the specified External Account. |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |

### Create an ACH Transfer
`POST https://www.apizie.tech/v1/open-data:increase/create-an-ach-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an ACH Transfer
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-an-ach-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ach_transfer_id | string | yes | The identifier of the ACH Transfer. |

### Approve an ACH Transfer
`POST https://www.apizie.tech/v1/open-data:increase/approve-an-ach-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ach_transfer_id | string | yes | The identifier of the ACH Transfer to approve. |

### Cancel a pending ACH Transfer
`POST https://www.apizie.tech/v1/open-data:increase/cancel-a-pending-ach-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ach_transfer_id | string | yes | The identifier of the pending ACH Transfer to cancel. |

### Look up the balance for an Account
`POST https://www.apizie.tech/v1/open-data:increase/look-up-the-balance-for-an-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List Bookkeeping Accounts
`GET https://www.apizie.tech/v1/open-data:increase/list-bookkeeping-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |

### Create a Bookkeeping Account
`POST https://www.apizie.tech/v1/open-data:increase/create-a-bookkeeping-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List Bookkeeping Entries
`GET https://www.apizie.tech/v1/open-data:increase/list-bookkeeping-entries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |

### Create a Bookkeeping Entry Set
`POST https://www.apizie.tech/v1/open-data:increase/create-a-bookkeeping-entry-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List Card Disputes
`GET https://www.apizie.tech/v1/open-data:increase/list-card-disputes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| status.in | array | no | Filter Card Disputes for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited… |

### Create a Card Dispute
`POST https://www.apizie.tech/v1/open-data:increase/create-a-card-dispute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a Card Dispute
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-a-card-dispute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| card_dispute_id | string | yes | The identifier of the Card Dispute. |

### List Card Profiles
`GET https://www.apizie.tech/v1/open-data:increase/list-card-profiles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| status.in | array | no | Filter Card Profiles for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited… |

### Create a Card Profile
`POST https://www.apizie.tech/v1/open-data:increase/create-a-card-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a Card Profile
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-a-card-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| card_profile_id | string | yes | The identifier of the Card Profile. |

### List Cards
`GET https://www.apizie.tech/v1/open-data:increase/list-cards` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| account_id | string | no | Filter Cards to ones belonging to the specified Account. |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |

### Create a Card
`POST https://www.apizie.tech/v1/open-data:increase/create-a-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a Card
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-a-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| card_id | string | yes | The identifier of the Card. |

### Update a Card
`POST https://www.apizie.tech/v1/open-data:increase/update-a-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| card_id | string | yes | The card identifier. |
| body | object | yes | JSON request body |

### Retrieve sensitive details for a Card
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-sensitive-details-for-a-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| card_id | string | yes | The identifier of the Card to retrieve details for. |

### List Check Deposits
`GET https://www.apizie.tech/v1/open-data:increase/list-check-deposits` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| account_id | string | no | Filter Check Deposits to those belonging to the specified Account. |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |

### Create a Check Deposit
`POST https://www.apizie.tech/v1/open-data:increase/create-a-check-deposit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a Check Deposit
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-a-check-deposit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| check_deposit_id | string | yes | The identifier of the Check Deposit to retrieve. |

### List Check Transfers
`GET https://www.apizie.tech/v1/open-data:increase/list-check-transfers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| account_id | string | no | Filter Check Transfers to those that originated from the specified Account. |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |

### Create a Check Transfer
`POST https://www.apizie.tech/v1/open-data:increase/create-a-check-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a Check Transfer
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-a-check-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| check_transfer_id | string | yes | The identifier of the Check Transfer. |

### Approve a Check Transfer
`POST https://www.apizie.tech/v1/open-data:increase/approve-a-check-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| check_transfer_id | string | yes | The identifier of the Check Transfer to approve. |

### Cancel a pending Check Transfer
`POST https://www.apizie.tech/v1/open-data:increase/cancel-a-pending-check-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| check_transfer_id | string | yes | The identifier of the pending Check Transfer to cancel. |

### Request a stop payment on a Check Transfer
`POST https://www.apizie.tech/v1/open-data:increase/request-a-stop-payment-on-a-check-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| check_transfer_id | string | yes | The identifier of the Check Transfer. |

### List Declined Transactions
`GET https://www.apizie.tech/v1/open-data:increase/list-declined-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| account_id | string | no | Filter Declined Transactions to ones belonging to the specified Account. |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| route_id | string | no | Filter Declined Transactions to those belonging to the specified route. |

### Retrieve a Declined Transaction
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-a-declined-transaction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| declined_transaction_id | string | yes | The identifier of the Declined Transaction. |

### List Digital Wallet Tokens
`GET https://www.apizie.tech/v1/open-data:increase/list-digital-wallet-tokens` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| card_id | string | no | Filter Digital Wallet Tokens to ones belonging to the specified Card. |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |

### Retrieve a Digital Wallet Token
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-a-digital-wallet-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| digital_wallet_token_id | string | yes | The identifier of the Digital Wallet Token. |

### List Documents
`GET https://www.apizie.tech/v1/open-data:increase/list-documents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| entity_id | string | no | Filter Documents to ones belonging to the specified Entity. |
| category.in | array | no | Filter Documents for those with the specified category or categories. For GET requests, this should be encoded as a comma-delimited… |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |

### Retrieve a Document
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-a-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| document_id | string | yes | The identifier of the Document to retrieve. |

### List Entities
`GET https://www.apizie.tech/v1/open-data:increase/list-entities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |

### Create an Entity
`POST https://www.apizie.tech/v1/open-data:increase/create-an-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an Entity
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-an-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| entity_id | string | yes | The identifier of the Entity to retrieve. |

### Create a supplemental document for an Entity
`POST https://www.apizie.tech/v1/open-data:increase/create-a-supplemental-document-for-an-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| entity_id | string | yes | The identifier of the Entity to retrieve. |
| body | object | yes | JSON request body |

### List Event Subscriptions
`GET https://www.apizie.tech/v1/open-data:increase/list-event-subscriptions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |

### Create an Event Subscription
`POST https://www.apizie.tech/v1/open-data:increase/create-an-event-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an Event Subscription
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-an-event-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| event_subscription_id | string | yes | The identifier of the Event Subscription. |

### Update an Event Subscription
`POST https://www.apizie.tech/v1/open-data:increase/update-an-event-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| event_subscription_id | string | yes | The identifier of the Event Subscription. |
| body | object | yes | JSON request body |

### List Events
`GET https://www.apizie.tech/v1/open-data:increase/list-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| category.in | array | no | Filter Events for those with the specified category or categories. For GET requests, this should be encoded as a comma-delimited string,… |
| associated_object_id | string | no | Filter Events to those belonging to the object with the provided identifier. |

### Retrieve an Event
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-an-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| event_id | string | yes | The identifier of the Event. |

### List Exports
`GET https://www.apizie.tech/v1/open-data:increase/list-exports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |

### Create an Export
`POST https://www.apizie.tech/v1/open-data:increase/create-an-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an Export
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-an-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| export_id | string | yes | The identifier of the Export to retrieve. |

### List External Accounts
`GET https://www.apizie.tech/v1/open-data:increase/list-external-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| status.in | array | no | Filter External Accounts for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited… |

### Create an External Account
`POST https://www.apizie.tech/v1/open-data:increase/create-an-external-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an External Account
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-an-external-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_account_id | string | yes | The identifier of the External Account. |

### Update an External Account
`POST https://www.apizie.tech/v1/open-data:increase/update-an-external-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_account_id | string | yes | The external account identifier. |
| body | object | yes | JSON request body |

### List Files
`GET https://www.apizie.tech/v1/open-data:increase/list-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| purpose.in | array | no | Filter Files for those with the specified purpose or purposes. For GET requests, this should be encoded as a comma-delimited string, such… |

### Create a File
`POST https://www.apizie.tech/v1/open-data:increase/create-a-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### Retrieve a File
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-a-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The identifier of the File. |

### Retrieve Group details
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-group-details` (byok)

### List Inbound ACH Transfer Returns
`GET https://www.apizie.tech/v1/open-data:increase/list-inbound-ach-transfer-returns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |

### Create an ACH Return
`POST https://www.apizie.tech/v1/open-data:increase/create-an-ach-return` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an Inbound ACH Transfer Return
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-an-inbound-ach-transfer-return` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| inbound_ach_transfer_return_id | string | yes | The identifier of the Inbound ACH Transfer Return to retrieve. |

### List Inbound Wire Drawdown Requests
`GET https://www.apizie.tech/v1/open-data:increase/list-inbound-wire-drawdown-requests` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |

### Retrieve an Inbound Wire Drawdown Request
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-an-inbound-wire-drawdown-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| inbound_wire_drawdown_request_id | string | yes | The identifier of the Inbound Wire Drawdown Request to retrieve. |

### List Limits
`GET https://www.apizie.tech/v1/open-data:increase/list-limits` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| model_id | string | no | The model to retrieve limits for. |
| status | string | no | The status to retrieve limits for. |

### Create a Limit
`POST https://www.apizie.tech/v1/open-data:increase/create-a-limit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a Limit
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-a-limit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit_id | string | yes | The identifier of the Limit to retrieve. |

### Update a Limit
`POST https://www.apizie.tech/v1/open-data:increase/update-a-limit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit_id | string | yes | The limit to update. |
| body | object | yes | JSON request body |

### List OAuth Connections
`GET https://www.apizie.tech/v1/open-data:increase/list-oauth-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |

### Retrieve an OAuth Connection
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-an-oauth-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| oauth_connection_id | string | yes | The identifier of the OAuth Connection. |

### List Pending Transactions
`GET https://www.apizie.tech/v1/open-data:increase/list-pending-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| account_id | string | no | Filter pending transactions to those belonging to the specified Account. |
| route_id | string | no | Filter pending transactions to those belonging to the specified Route. |
| source_id | string | no | Filter pending transactions to those caused by the specified source. |
| status.in | array | no | Filter Pending Transactions for those with the specified status. By default only Pending Transactions in with status `pending` will be… |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |

### Retrieve a Pending Transaction
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-a-pending-transaction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pending_transaction_id | string | yes | The identifier of the Pending Transaction. |

### List Programs
`GET https://www.apizie.tech/v1/open-data:increase/list-programs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |

### Retrieve a Program
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-a-program` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| program_id | string | yes | The identifier of the Program to retrieve. |

### Retrieve a Real-Time Decision
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-a-real-time-decision` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| real_time_decision_id | string | yes | The identifier of the Real-Time Decision. |

### Action a Real-Time Decision
`POST https://www.apizie.tech/v1/open-data:increase/action-a-real-time-decision` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| real_time_decision_id | string | yes | The identifier of the Real-Time Decision. |
| body | object | yes | JSON request body |

### List Real Time Payments Transfers
`GET https://www.apizie.tech/v1/open-data:increase/list-real-time-payments-transfers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| account_id | string | no | Filter Real Time Payments Transfers to those belonging to the specified Account. |
| external_account_id | string | no | Filter Real Time Payments Transfers to those made to the specified External Account. |
| created_at.after | string | no | Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.before | string | no | Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_after | string | no | Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |
| created_at.on_or_before | string | no | Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. |

### Create a Real Time Payments Transfer
`POST https://www.apizie.tech/v1/open-data:increase/create-a-real-time-payments-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a Real Time Payments Transfer
`GET https://www.apizie.tech/v1/open-data:increase/retrieve-a-real-time-payments-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| real_time_payments_transfer_id | string | yes | The identifier of the Real Time Payments Transfer. |

### List Routing Numbers
`GET https://www.apizie.tech/v1/open-data:increase/list-routing-numbers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | Return the page of entries after this one. |
| limit | integer | no | Limit the size of the list that is returned. The default (and maximum) is 100 objects. |
| routing_number | string | yes | Filter financial institutions by routing number. |

### Simulate an Account Statement being created
`POST https://www.apizie.tech/v1/open-data:increase/simulate-an-account-statement-being-created` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Complete a Sandbox Account Transfer
`POST https://www.apizie.tech/v1/open-data:increase/complete-a-sandbox-account-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_transfer_id | string | yes | The identifier of the Account Transfer you wish to complete. |

### Return a Sandbox ACH Transfer
`POST https://www.apizie.tech/v1/open-data:increase/return-a-sandbox-ach-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ach_transfer_id | string | yes | The identifier of the ACH Transfer you wish to return. |
| body | object | yes | JSON request body |

### Submit a Sandbox ACH Transfer
`POST https://www.apizie.tech/v1/open-data:increase/submit-a-sandbox-ach-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ach_transfer_id | string | yes | The identifier of the ACH Transfer you wish to submit. |

### Simulate an authorization on a Card
`POST https://www.apizie.tech/v1/open-data:increase/simulate-an-authorization-on-a-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Simulates advancing the state of a card dispute
`POST https://www.apizie.tech/v1/open-data:increase/simulates-advancing-the-state-of-a-card-dispute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| card_dispute_id | string | yes | The dispute you would like to action. |
| body | object | yes | JSON request body |

### Simulate a refund on a card
`POST https://www.apizie.tech/v1/open-data:increase/simulate-a-refund-on-a-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Simulate settling a card authorization
`POST https://www.apizie.tech/v1/open-data:increase/simulate-settling-a-card-authorization` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Reject a Sandbox Check Deposit
`POST https://www.apizie.tech/v1/open-data:increase/reject-a-sandbox-check-deposit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| check_deposit_id | string | yes | The identifier of the Check Deposit you wish to reject. |

### Return a Sandbox Check Deposit
`POST https://www.apizie.tech/v1/open-data:increase/return-a-sandbox-check-deposit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| check_deposit_id | string | yes | The identifier of the Check Deposit you wish to return. |

### Submit a Sandbox Check Deposit
`POST https://www.apizie.tech/v1/open-data:increase/submit-a-sandbox-check-deposit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| check_deposit_id | string | yes | The identifier of the Check Deposit you wish to submit. |

### Deposit a Sandbox Check Transfer
`POST https://www.apizie.tech/v1/open-data:increase/deposit-a-sandbox-check-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| check_transfer_id | string | yes | The identifier of the Check Transfer you wish to mark deposited. |

### Mail a Sandbox Check Transfer
`POST https://www.apizie.tech/v1/open-data:increase/mail-a-sandbox-check-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| check_transfer_id | string | yes | The identifier of the Check Transfer you wish to mail. |

### Return a Sandbox Check Transfer
`POST https://www.apizie.tech/v1/open-data:increase/return-a-sandbox-check-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| check_transfer_id | string | yes | The identifier of the Check Transfer you wish to mark returned. |
| body | object | yes | JSON request body |

### Simulate digital wallet provisioning for a card
`POST https://www.apizie.tech/v1/open-data:increase/simulate-digital-wallet-provisioning-for-a-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Simulate a tax document being created
`POST https://www.apizie.tech/v1/open-data:increase/simulate-a-tax-document-being-created` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Simulate an ACH Transfer to your account
`POST https://www.apizie.tech/v1/open-data:increase/simulate-an-ach-transfer-to-your-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Simulate a Real Time Payments Transfer to your account
`POST https://www.apizie.tech/v1/open-data:increase/simulate-a-real-time-payments-transfer-to-your-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Simulate an Inbound Wire Drawdown request being created
`POST https://www.apizie.tech/v1/open-data:increase/simulate-an-inbound-wire-drawdown-request-being-created` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Simulate a Wire Transfer to your account
`POST https://www.apizie.tech/v1/open-data:increase/simulate-a-wire-transfer-to-your-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Simulate an Interest Payment to your account
`POST https://www.apizie.tech/v1/open-data:increase/simulate-an-interest-payment-to-your-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Complete a Sandbox Real Time Payments Transfer
`POST https://www.apizie.tech/v1/open-data:increase/complete-a-sandbox-real-time-payments-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| real_time_payments_transfer_id | string | yes | The identifier of the Real Time Payments Transfer you wish to complete. |
| body | object | yes | JSON request body |

### Reverse a Sandbox Wire Transfer
`POST https://www.apizie.tech/v1/open-data:increase/reverse-a-sandbox-wire-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| wire_transfer_id | string | yes | The identifier of the Wire Transfer you wish to reverse. |

…and 11 more. See the OpenAPI spec.

## Example
```
curl "https://www.apizie.tech/v1/open-data:increase/list-account-numbers" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Increase API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/open-data:increase/list-account-numbers with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Increase API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Increase API itself also needs your own key from increase.com.

### Can AI agents use the Increase API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:increase.

### What is the status of the Increase API API?
Needs your own provider key (bring your own key)
