Ramp: Fetch a financing application
Ramp application.getApplicationResource: arguments, response, policy and SDK examples.
← Application operations · Get started
Operation ramp.get_application_resource
Provider route: GET /developer/v1/applications. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["application"]["getApplicationResource"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.application.getApplicationResource(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_ramp import RampIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.application.get_application_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Fetch a financing application — response body |
Referenced models: Fetch a financing application — response body
Schemas
Section titled “Schemas”5 more schemas are linked from the tables above, on the schema pages.
Fetch a financing application — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
applicant | Model | Required within parent | Expand Fetch a financing application — response body — applicant Information about the applicant, the person who completes the application in Ramp and becomes the business owner once it is approved. |
application_type | string | Optional | Type of financing application. Known values: BILL_PAY_ONLY, RAMP_SUITE |
beneficial_owners | JSON | Required within parent | |
beneficial_owners (anyOf 1) | array | Alternative | Beneficial owners of the business. |
beneficial_owners (anyOf 1)[] | Model | Each item | Expand Fetch a financing application — response body — beneficial owners Beneficial owners of the business item |
beneficial_owners (anyOf 2) | null | Alternative | |
business | JSON | Required within parent | |
business (anyOf 1) | Model | Alternative | Expand Fetch a financing application — response body — business address, business description, business name dba, business name legal, business name on card, business website, incorporation, phone Business details. |
business (anyOf 2) | null | Alternative | |
controlling_officer | JSON | Required within parent | |
controlling_officer (anyOf 1) | Model | Alternative | Expand Fetch a financing application — response body — controlling officer address, birth date, email, first name, is beneficial owner, last name, ownership percentage, passport last 4, phone, ssn last 4, title The controlling officer of the business. |
controlling_officer (anyOf 2) | null | Alternative | |
financial_details | JSON | Required within parent | |
financial_details (anyOf 1) | Model | Alternative | Expand Fetch a financing application — response body — financial details estimated monthly ap spend amount, estimated monthly spend amount Financial details for underwriting. |
financial_details (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier of the application. Format: uuid |
incorporation_status | string | Required within parent | Incorporation status for the business. NOT_INCORPORATED when the business has no incorporation record. Known values: FORMED, INCORPORATED_EXTERNALLY, INCORPORATING, NOT_INCORPORATED |
needs_incorporation | boolean | Required within parent | Whether the business still needs to be incorporated through Ramp. Reflects the needs_incorporation flag supplied at application creation. |
open_ramp_checking_account | boolean | Required within parent | Whether the applicant is applying for a Ramp checking account. For Agent FA, this is always true and external bank linking is unavailable. |
status | string | Required within parent | Current status of the financing application. Known values: APPROVED, FOLLOW_UPS_REQUIRED, IN_REVIEW, REJECTED, STARTED, WITHDRAWN |
Referenced models: Fetch a financing application — response body — applicant, Fetch a financing application — response body — business address, business description, business name dba, business name legal, business name on card, business website, incorporation, phone, Fetch a financing application — response body — controlling officer address, birth date, email, first name, is beneficial owner, last name, ownership percentage, passport last 4, phone, ssn last 4, title, Fetch a financing application — response body — financial details estimated monthly ap spend amount, estimated monthly spend amount, Fetch a financing application — response body — beneficial owners Beneficial owners of the business item
Fetch a financing application — response body — applicant
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Required within parent | Business email address of the applicant. The applicant signs in to Ramp with this email to complete the application, is the first user created on the new Ramp business, and becomes its business owner once the application is approved. Use the email of the person who should own the Ramp business. To complete general details without applicant action in Ramp, the business website domain must match this email domain or be its subdomain. If the domains differ, the applicant must explain the mismatch in Ramp. Format: email |
first_name | string | Required within parent | First name of the applicant. |
last_name | string | Required within parent | Last name of the applicant. |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Phone number of the applicant in E.164 format. Default: null |
phone (anyOf 2) | null | Alternative |
Fetch a financing application — response body — business address, business description, business name dba, business name legal, business name on card, business website, incorporation, phone
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | |
address (anyOf 1) | Model | Alternative | Expand Fetch a financing application — response body — business address, business description, business name dba, business name legal, business name on card, business website, incorporation, phone address apt suite, city, postal code, state, street address Principal place of business address. Default: null |
address (anyOf 2) | null | Alternative | |
business_description | JSON | Optional | |
business_description (anyOf 1) | string | Alternative | Brief description of the business. Default: null Maximum length: 250 |
business_description (anyOf 2) | null | Alternative | |
business_name_dba | JSON | Optional | |
business_name_dba (anyOf 1) | string | Alternative | Doing-business-as name. Default: null |
business_name_dba (anyOf 2) | null | Alternative | |
business_name_legal | JSON | Optional | |
business_name_legal (anyOf 1) | string | Alternative | Legal name of the business. Default: null |
business_name_legal (anyOf 2) | null | Alternative | |
business_name_on_card | JSON | Optional | |
business_name_on_card (anyOf 1) | string | Alternative | Name to display on cards. Default: null |
business_name_on_card (anyOf 2) | null | Alternative | |
business_website | JSON | Optional | |
business_website (anyOf 1) | string | Alternative | Business website URL. To complete general details without applicant action in Ramp, its domain must match the applicant email domain or be its subdomain. If the domains differ, the applicant must explain the mismatch in Ramp. Default: null |
business_website (anyOf 2) | null | Alternative | |
incorporation | JSON | Optional | |
incorporation (anyOf 1) | Model | Alternative | Expand Fetch a financing application — response body — business address, business description, business name dba, business name legal, business name on card, business website, incorporation, phone incorporation date of incorporation, ein number, entity type, state of incorporation Business incorporation details. Default: null |
incorporation (anyOf 2) | null | Alternative | |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Office phone number in E.164 format. Default: null |
phone (anyOf 2) | null | Alternative |
Referenced models: Fetch a financing application — response body — business address, business description, business name dba, business name legal, business name on card, business website, incorporation, phone address apt suite, city, postal code, state, street address, Fetch a financing application — response body — business address, business description, business name dba, business name legal, business name on card, business website, incorporation, phone incorporation date of incorporation, ein number, entity type, state of incorporation
Fetch a financing application — response body — financial details estimated monthly ap spend amount, estimated monthly spend amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
estimated_monthly_ap_spend_amount | JSON | Optional | |
estimated_monthly_ap_spend_amount (anyOf 1) | JSON | Alternative | |
estimated_monthly_ap_spend_amount (anyOf 1) (anyOf 1) | integer | Alternative | Estimated monthly accounts payable spend amount in dollars. Default: null |
estimated_monthly_ap_spend_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
estimated_monthly_ap_spend_amount (anyOf 2) | null | Alternative | |
estimated_monthly_spend_amount | JSON | Optional | |
estimated_monthly_spend_amount (anyOf 1) | JSON | Alternative | |
estimated_monthly_spend_amount (anyOf 1) (anyOf 1) | integer | Alternative | Estimated monthly card spend amount in dollars. Default: null |
estimated_monthly_spend_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
estimated_monthly_spend_amount (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.get_application_resource. Catalog operation: get_application_resource. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["applications:read"]