# Beam FastAPI API

> Beam FastAPI API on Apizie: 33 endpoints (Get Application By Id, Get Applicant, Revet Submission, Revet Csv Submission, …) 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://apizie.tech/v1/finance:beam/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:beam`
- Category: Finance
- Status: byok
- Source: https://beamlend.com
- Page: https://apizie.tech/api/finance/beam
- OpenAPI: https://apizie.tech/api/finance/beam/openapi.json

Beam is the intelligent way to manage risk with laser precision in real time. Beam's state-of-the-art software solution sources traditional and alternative data to give you a real-time affordability analysis of your…

## Endpoints

### Get Application By Id
`GET https://apizie.tech/v1/finance:beam/applications-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| application_id | string | yes |  |

### Get Applicant
`GET https://apizie.tech/v1/finance:beam/applications-get-applicant-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicant_id | string | yes |  |

### Revet Submission
`POST https://apizie.tech/v1/finance:beam/applications-submit-revet-application` (byok)

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

### Revet Csv Submission
`POST https://apizie.tech/v1/finance:beam/applications-submit-csv` (byok)

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

### Revet Csv Template
`GET https://apizie.tech/v1/finance:beam/applications-get-csv-template` (byok)

### Get Connections Available
`GET https://apizie.tech/v1/finance:beam/applicationconfigs-list-connections-available` (byok)

### Get Application Configs By Id
`GET https://apizie.tech/v1/finance:beam/applicationconfigs-get-application-config-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| app_config_id | string | yes |  |

### Get Organisation Personal Connections By Id
`GET https://apizie.tech/v1/finance:beam/personalinfoconnections-get-organisations-personal-connectio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| connection_id | string | yes |  |

### Get Labelled Transactions
`GET https://apizie.tech/v1/finance:beam/bankconnections-get-labelled-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| application_id | string | yes |  |

### Get Affordability
`GET https://apizie.tech/v1/finance:beam/bankconnections-get-affordability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| application_id | string | yes |  |

### Get Income Analysis
`GET https://apizie.tech/v1/finance:beam/bankconnections-get-income-analysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| application_id | string | yes |  |

### Get Risk Insights
`GET https://apizie.tech/v1/finance:beam/bankconnections-get-risk-insights` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| application_id | string | yes |  |

### Get Liquidity Score
`GET https://apizie.tech/v1/finance:beam/bankconnections-get-liquidity-score` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| application_id | string | yes |  |

### Get Expense Insights
`GET https://apizie.tech/v1/finance:beam/bankconnections-get-expense-insights` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| application_id | string | yes |  |

### Rerun Crunch Analysis
`GET https://apizie.tech/v1/finance:beam/bankconnections-rerun-crunch-analysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| application_id | string | yes |  |

### Rerun Thread Analysis
`GET https://apizie.tech/v1/finance:beam/bankconnections-rerun-thread-analysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| application_id | string | yes |  |

### Get Labelled Transactions
`GET https://apizie.tech/v1/finance:beam/bankconnections-get-labelled-transactions-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| application_id | string | yes |  |

### Get Liquidity Score
`GET https://apizie.tech/v1/finance:beam/bankconnections-get-liquidity-score-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| application_id | string | yes |  |

### Get Outstanding Bill Amount
`GET https://apizie.tech/v1/finance:beam/billing-get-outstanding-bill-amount` (byok)

### List Events
`GET https://apizie.tech/v1/finance:beam/billing-list-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| skip | integer | no |  |
| limit | integer | no |  |

### Get Pricing
`GET https://apizie.tech/v1/finance:beam/billing-get-pricing` (byok)

### Peach Webhook
`GET https://apizie.tech/v1/finance:beam/payments-get-peach-webhook` (byok)

### Peach Webhook
`POST https://apizie.tech/v1/finance:beam/payments-create-peach-webhook` (byok)

### Get Organisation Applications
`GET https://apizie.tech/v1/finance:beam/applications-get-organisation-applications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| skip | integer | no |  |
| limit | integer | no |  |

### Get Organisations Applicants
`GET https://apizie.tech/v1/finance:beam/applications-get-applicants-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| skip | integer | no |  |
| limit | integer | no |  |

### Create Applicant
`POST https://apizie.tech/v1/finance:beam/applications-submit-applicant` (byok)

### Create Application
`POST https://apizie.tech/v1/finance:beam/applications-create-new-application` (byok)

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

### Get Organisation
`GET https://apizie.tech/v1/finance:beam/organisations-list` (byok)

### Get Data Point Args
`GET https://apizie.tech/v1/finance:beam/applicationconfigs-get-data-point-args` (byok)

### Get Application Configs By Organisation
`GET https://apizie.tech/v1/finance:beam/applicationconfigs-get-by-organisation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| skip | integer | no |  |
| limit | integer | no |  |

### Create Application Config
`POST https://apizie.tech/v1/finance:beam/applicationconfigs-create-config` (byok)

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

### Get Organisations Personal Connections
`GET https://apizie.tech/v1/finance:beam/personalinfoconnections-get-organisations-personal-connectio-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| skip | integer | no |  |
| limit | integer | no |  |

### Update Org Whitelabel
`POST https://apizie.tech/v1/finance:beam/whitelabel-update-org-config` (byok)

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

## Example
```
curl "https://apizie.tech/v1/finance:beam/applications-get-by-id" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Beam FastAPI API?
Create a free Apizie key, then send GET https://apizie.tech/v1/finance:beam/applications-get-by-id with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

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

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