Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Fetch a financing application — response body

Referenced models: Fetch a financing application — response body

5 more schemas are linked from the tables above, on the schema pages.

Fetch a financing application — response body
FieldTypePresenceDescription and constraints
$objectRoot
applicantModelRequired within parentExpand 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_typestringOptionalType of financing application.
Known values: BILL_PAY_ONLY, RAMP_SUITE
beneficial_ownersJSONRequired within parent
beneficial_owners (anyOf 1)arrayAlternativeBeneficial owners of the business.
beneficial_owners (anyOf 1)[]ModelEach itemExpand Fetch a financing application — response body — beneficial owners Beneficial owners of the business item
beneficial_owners (anyOf 2)nullAlternative
businessJSONRequired within parent
business (anyOf 1)ModelAlternativeExpand 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)nullAlternative
controlling_officerJSONRequired within parent
controlling_officer (anyOf 1)ModelAlternativeExpand 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)nullAlternative
financial_detailsJSONRequired within parent
financial_details (anyOf 1)ModelAlternativeExpand 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)nullAlternative
idstringRequired within parentUnique identifier of the application.
Format: uuid
incorporation_statusstringRequired within parentIncorporation status for the business. NOT_INCORPORATED when the business has no incorporation record.
Known values: FORMED, INCORPORATED_EXTERNALLY, INCORPORATING, NOT_INCORPORATED
needs_incorporationbooleanRequired within parentWhether the business still needs to be incorporated through Ramp. Reflects the needs_incorporation flag supplied at application creation.
open_ramp_checking_accountbooleanRequired within parentWhether the applicant is applying for a Ramp checking account. For Agent FA, this is always true and external bank linking is unavailable.
statusstringRequired within parentCurrent 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
FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parentBusiness 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_namestringRequired within parentFirst name of the applicant.
last_namestringRequired within parentLast name of the applicant.
phoneJSONOptional
phone (anyOf 1)stringAlternativePhone number of the applicant in E.164 format.
Default: null
phone (anyOf 2)nullAlternative
Fetch a financing application — response body — business address, business description, business name dba, business name legal, business name on card, business website, incorporation, phone
FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptional
address (anyOf 1)ModelAlternativeExpand 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)nullAlternative
business_descriptionJSONOptional
business_description (anyOf 1)stringAlternativeBrief description of the business.
Default: null
Maximum length: 250
business_description (anyOf 2)nullAlternative
business_name_dbaJSONOptional
business_name_dba (anyOf 1)stringAlternativeDoing-business-as name.
Default: null
business_name_dba (anyOf 2)nullAlternative
business_name_legalJSONOptional
business_name_legal (anyOf 1)stringAlternativeLegal name of the business.
Default: null
business_name_legal (anyOf 2)nullAlternative
business_name_on_cardJSONOptional
business_name_on_card (anyOf 1)stringAlternativeName to display on cards.
Default: null
business_name_on_card (anyOf 2)nullAlternative
business_websiteJSONOptional
business_website (anyOf 1)stringAlternativeBusiness 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)nullAlternative
incorporationJSONOptional
incorporation (anyOf 1)ModelAlternativeExpand 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)nullAlternative
phoneJSONOptional
phone (anyOf 1)stringAlternativeOffice phone number in E.164 format.
Default: null
phone (anyOf 2)nullAlternative

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
FieldTypePresenceDescription and constraints
$objectRoot
estimated_monthly_ap_spend_amountJSONOptional
estimated_monthly_ap_spend_amount (anyOf 1)JSONAlternative
estimated_monthly_ap_spend_amount (anyOf 1) (anyOf 1)integerAlternativeEstimated monthly accounts payable spend amount in dollars.
Default: null
estimated_monthly_ap_spend_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
estimated_monthly_ap_spend_amount (anyOf 2)nullAlternative
estimated_monthly_spend_amountJSONOptional
estimated_monthly_spend_amount (anyOf 1)JSONAlternative
estimated_monthly_spend_amount (anyOf 1) (anyOf 1)integerAlternativeEstimated monthly card spend amount in dollars.
Default: null
estimated_monthly_spend_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
estimated_monthly_spend_amount (anyOf 2)nullAlternative

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"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.