Skip to content

Ramp: Create a financing application

Ramp application.postApplicationResource: arguments, response, policy and SDK examples.

← Application operations · Get started

Operation ramp.post_application_resource

Provider route: POST /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"]["postApplicationResource"]>[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.postApplicationResource(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.post_application_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand Create a financing application — request body — body

Referenced models: Create a financing application — request body — body

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

FieldTypePresenceDescription and constraints
$JSONRoot

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

Create a financing application — request body — 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 to create.
Default: RAMP_SUITE
One of: BILL_PAY_ONLY, RAMP_SUITE
beneficial_ownersJSONOptional
beneficial_owners (anyOf 1)arrayAlternativeBeneficial owners of the business.
beneficial_owners (anyOf 1)[]ModelEach itemExpand Create a financing application — request body — body beneficial owners Beneficial owners of the business item
beneficial_owners (anyOf 2)nullAlternative
businessJSONOptional
business (anyOf 1)ModelAlternativeExpand Create a financing application — request body — body business address, business description, business name dba, business name legal, business name on card, business website, incorporation, phone
Business details.
Default: null
business (anyOf 2)nullAlternative
controlling_officerJSONOptional
controlling_officer (anyOf 1)ModelAlternativeExpand Create a financing application — request body — 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.
Default: null
controlling_officer (anyOf 2)nullAlternative
countrystringOptionalCountry where the business is incorporated. GB and CA applications only accept applicant details and basic business information; the applicant completes the rest of the application in Ramp.
Default: US
One of: CA, GB, US
financial_detailsJSONOptional
financial_details (anyOf 1)ModelAlternativeExpand Create a financing application — request body — body financial details estimated monthly ap spend amount, estimated monthly spend amount
Financial details for underwriting.
Default: null
financial_details (anyOf 2)nullAlternative
lead_referral_partner_channelJSONOptional
lead_referral_partner_channel (anyOf 1)stringAlternativeOptional unverified agent harness that reported the lead_referral_partner_code.
Default: null
One of: api, cli, mcp
lead_referral_partner_channel (anyOf 2)nullAlternative
lead_referral_partner_codeJSONOptional
lead_referral_partner_code (anyOf 1)stringAlternativeOptional unverified agent-reported Ramp partner code for agent financing application lead attribution.
Default: null
One of: base44, clerky, cofounder_co, every, nous_research_hermes, paperclip, south_park_commons, yc
lead_referral_partner_code (anyOf 2)nullAlternative
manual_bank_accountJSONOptional
manual_bank_account (anyOf 1)ModelAlternativeExpand Create a financing application — request body — body manual bank account account number, account subtype, balance, routing number
Manual bank account to add for underwriting.
Default: null
manual_bank_account (anyOf 2)nullAlternative
oauth_authorize_paramsJSONOptional
oauth_authorize_params (anyOf 1)ModelAlternativeExpand Create a financing application — request body — body oauth authorize params code challenge, redirect uri, state
OAuth authorization parameters. If provided, the user will be redirected to an OAuth consent screen after accepting the invite.
Default: null
oauth_authorize_params (anyOf 2)nullAlternative
ownership_acknowledgementJSONOptional
ownership_acknowledgement (anyOf 1)stringAlternativeOwnership acknowledgement confirming whether all 25%+ beneficial owners have been supplied.
Default: null
One of: CONFIRM_ALL_MAJOR_OWNERS_ENTERED, CONFIRM_NO_INDIVIDUAL_OWNS_25_PCT
ownership_acknowledgement (anyOf 2)nullAlternative

Referenced models: Fetch a financing application — response body — applicant, Create a financing application — request body — body business address, business description, business name dba, business name legal, business name on card, business website, incorporation, phone, Create a financing application — request body — body controlling officer address, birth date, email, first name, is beneficial owner, last name, ownership percentage, passport last 4, phone, ssn last 4, title, Create a financing application — request body — body financial details estimated monthly ap spend amount, estimated monthly spend amount, Create a financing application — request body — body manual bank account account number, account subtype, balance, routing number, Create a financing application — request body — body oauth authorize params code challenge, redirect uri, state, Create a financing application — request body — 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
Create a financing application — request body — 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 Create a financing application — request body — 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, Create a financing application — request body — 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

Create a financing application — request body — body manual bank account account number, account subtype, balance, routing number
FieldTypePresenceDescription and constraints
$objectRoot
account_numberstringRequired within parentBank account number.
account_subtypestringRequired within parentBank account subtype, such as checking or savings.
balanceJSONRequired within parentCurrent account balance.
balance (oneOf 1)stringAlternativeFormat: decimal
balance (oneOf 2)numberAlternative
routing_numberstringRequired within parentABA routing number.

SDK function policy ID: ramp.post_application_resource. Catalog operation: post_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.

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.