Skip to content

Ramp: Application schemas

17 Ramp schemas with complete fields and constraints.

← Application operations · All schemas

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

Create a financing application — request body — body beneficial owners Beneficial owners of the business item

FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptional
address (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 address apt suite, city, country, postal code, state, street address
Residential address.
Default: null
address (anyOf 2)nullAlternative
birth_dateJSONOptional
birth_date (anyOf 1)stringAlternativeDate of birth in YYYY-MM-DD format.
Default: null
birth_date (anyOf 2)nullAlternative
emailJSONOptional
email (anyOf 1)stringAlternativeEmail address.
Default: null
Format: email
email (anyOf 2)nullAlternative
first_nameJSONOptional
first_name (anyOf 1)stringAlternativeFirst name.
Default: null
first_name (anyOf 2)nullAlternative
last_nameJSONOptional
last_name (anyOf 1)stringAlternativeLast name.
Default: null
last_name (anyOf 2)nullAlternative
ownership_percentageJSONOptional
ownership_percentage (anyOf 1)integerAlternativeBeneficial ownership percentage for this individual.
Default: null
Maximum: 100
Minimum: 0
ownership_percentage (anyOf 2)nullAlternative
passport_last_4JSONOptional
passport_last_4 (anyOf 1)stringAlternativeLast 4 digits of passport number.
Default: null
Maximum length: 4
Minimum length: 4
passport_last_4 (anyOf 2)nullAlternative
phoneJSONOptional
phone (anyOf 1)stringAlternativePhone number in E.164 format.
Default: null
phone (anyOf 2)nullAlternative
ssn_last_4JSONOptional
ssn_last_4 (anyOf 1)stringAlternativeLast 4 digits of SSN.
Default: null
Maximum length: 4
Minimum length: 4
ssn_last_4 (anyOf 2)nullAlternative
titleJSONOptional
title (anyOf 1)stringAlternativeJob title or role.
Default: null
title (anyOf 2)nullAlternative

Referenced models: 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 address apt suite, city, country, 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

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

FieldTypePresenceDescription and constraints
$objectRoot
date_of_incorporationJSONOptional
date_of_incorporation (anyOf 1)stringAlternativeDate of incorporation in YYYY-MM-DD format.
Default: null
Format: date
date_of_incorporation (anyOf 2)nullAlternative
ein_numberJSONOptional
ein_number (anyOf 1)stringAlternativeEmployer Identification Number.
Default: null
ein_number (anyOf 2)nullAlternative
entity_typeJSONOptional
entity_type (anyOf 1)stringAlternativeType of business entity.
Default: null
One of: COOPERATIVE, CORPORATION, LLC, NON_PROFIT_CORPORATION, OTHER, PARTNERSHIP, SOLE_PROPRIETORSHIP
entity_type (anyOf 2)nullAlternative
state_of_incorporationJSONOptional
state_of_incorporation (anyOf 1)stringAlternativeTwo-letter state code where the business is incorporated.
Default: null
Maximum length: 2
Minimum length: 2
state_of_incorporation (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptional
address (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 address apt suite, city, country, postal code, state, street address
Residential address.
Default: null
address (anyOf 2)nullAlternative
birth_dateJSONOptional
birth_date (anyOf 1)stringAlternativeDate of birth in YYYY-MM-DD format.
Default: null
birth_date (anyOf 2)nullAlternative
emailJSONOptional
email (anyOf 1)stringAlternativeEmail address.
Default: null
Format: email
email (anyOf 2)nullAlternative
first_nameJSONOptional
first_name (anyOf 1)stringAlternativeFirst name.
Default: null
first_name (anyOf 2)nullAlternative
is_beneficial_ownerbooleanOptionalWhether this officer is also a beneficial owner. Defaults to false.
Default: false
last_nameJSONOptional
last_name (anyOf 1)stringAlternativeLast name.
Default: null
last_name (anyOf 2)nullAlternative
ownership_percentageJSONOptional
ownership_percentage (anyOf 1)integerAlternativeBeneficial ownership percentage for this individual.
Default: null
Maximum: 100
Minimum: 0
ownership_percentage (anyOf 2)nullAlternative
passport_last_4JSONOptional
passport_last_4 (anyOf 1)stringAlternativeLast 4 digits of passport number.
Default: null
Maximum length: 4
Minimum length: 4
passport_last_4 (anyOf 2)nullAlternative
phoneJSONOptional
phone (anyOf 1)stringAlternativePhone number in E.164 format.
Default: null
phone (anyOf 2)nullAlternative
ssn_last_4JSONOptional
ssn_last_4 (anyOf 1)stringAlternativeLast 4 digits of SSN.
Default: null
Maximum length: 4
Minimum length: 4
ssn_last_4 (anyOf 2)nullAlternative
titleJSONOptional
title (anyOf 1)stringAlternativeJob title or role.
Default: null
title (anyOf 2)nullAlternative

Referenced models: 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 address apt suite, city, country, postal code, state, street address

Create a financing application — request body — 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)integerAlternativeEstimated monthly accounts payable spend amount in dollars.
Default: null
estimated_monthly_ap_spend_amount (anyOf 2)nullAlternative
estimated_monthly_spend_amountJSONOptional
estimated_monthly_spend_amount (anyOf 1)integerAlternativeEstimated monthly card spend amount in dollars.
Default: null
estimated_monthly_spend_amount (anyOf 2)nullAlternative

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.

Create a financing application — request body — body oauth authorize params code challenge, redirect uri, state

FieldTypePresenceDescription and constraints
$objectRoot
code_challengeJSONOptional
code_challenge (anyOf 1)stringAlternativeOptional PKCE code challenge. The partner must keep the matching code verifier for token exchange.
Default: null
Pattern: ^[A-Za-z0-9_-]{43}$
code_challenge (anyOf 2)nullAlternative
redirect_uristringRequired within parentThe URI to redirect the user to after accepting the invite.
statestringRequired within parentAn opaque value used by the client to maintain state between the request and callback.
Minimum length: 1

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 — beneficial owners Beneficial owners of the business item

FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptional
address (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 address apt suite, city, country, postal code, state, street address
Residential address.
Default: null
address (anyOf 2)nullAlternative
birth_dateJSONOptional
birth_date (anyOf 1)stringAlternativeDate of birth in YYYY-MM-DD format.
Default: null
birth_date (anyOf 2)nullAlternative
emailJSONOptional
email (anyOf 1)stringAlternativeEmail address.
Default: null
Format: email
email (anyOf 2)nullAlternative
first_nameJSONOptional
first_name (anyOf 1)stringAlternativeFirst name.
Default: null
first_name (anyOf 2)nullAlternative
last_nameJSONOptional
last_name (anyOf 1)stringAlternativeLast name.
Default: null
last_name (anyOf 2)nullAlternative
ownership_percentageJSONOptional
ownership_percentage (anyOf 1)JSONAlternative
ownership_percentage (anyOf 1) (anyOf 1)integerAlternativeBeneficial ownership percentage for this individual.
Default: null
Maximum: 100
Minimum: 0
ownership_percentage (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ownership_percentage (anyOf 2)nullAlternative
passport_last_4JSONOptional
passport_last_4 (anyOf 1)stringAlternativeLast 4 digits of passport number.
Default: null
Maximum length: 4
Minimum length: 4
passport_last_4 (anyOf 2)nullAlternative
phoneJSONOptional
phone (anyOf 1)stringAlternativePhone number in E.164 format.
Default: null
phone (anyOf 2)nullAlternative
ssn_last_4JSONOptional
ssn_last_4 (anyOf 1)stringAlternativeLast 4 digits of SSN.
Default: null
Maximum length: 4
Minimum length: 4
ssn_last_4 (anyOf 2)nullAlternative
titleJSONOptional
title (anyOf 1)stringAlternativeJob title or role.
Default: null
title (anyOf 2)nullAlternative

Referenced models: 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 address apt suite, city, country, 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

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 — 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

FieldTypePresenceDescription and constraints
$objectRoot
apt_suiteJSONOptional
apt_suite (anyOf 1)stringAlternativeApartment or suite number.
Default: null
apt_suite (anyOf 2)nullAlternative
cityJSONOptional
city (anyOf 1)stringAlternativeCity.
Default: null
city (anyOf 2)nullAlternative
postal_codeJSONOptional
postal_code (anyOf 1)stringAlternativePostal code.
Default: null
postal_code (anyOf 2)nullAlternative
stateJSONOptional
state (anyOf 1)stringAlternativeTwo-letter state code (e.g. CA).
Default: null
Maximum length: 2
Minimum length: 2
state (anyOf 2)nullAlternative
street_addressJSONOptional
street_address (anyOf 1)stringAlternativeStreet address.
Default: null
street_address (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 incorporation date of incorporation, ein number, entity type, state of incorporation

FieldTypePresenceDescription and constraints
$objectRoot
date_of_incorporationJSONOptional
date_of_incorporation (anyOf 1)stringAlternativeDate of incorporation in YYYY-MM-DD format.
Default: null
Format: date
date_of_incorporation (anyOf 2)nullAlternative
ein_numberJSONOptional
ein_number (anyOf 1)stringAlternativeEmployer Identification Number.
Default: null
ein_number (anyOf 2)nullAlternative
entity_typeJSONOptional
entity_type (anyOf 1)stringAlternativeType of business entity.
Known values: COOPERATIVE, CORPORATION, LLC, NON_PROFIT_CORPORATION, OTHER, PARTNERSHIP, SOLE_PROPRIETORSHIP
Default: null
entity_type (anyOf 2)nullAlternative
state_of_incorporationJSONOptional
state_of_incorporation (anyOf 1)stringAlternativeTwo-letter state code where the business is incorporated.
Default: null
Maximum length: 2
Minimum length: 2
state_of_incorporation (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptional
address (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 address apt suite, city, country, postal code, state, street address
Residential address.
Default: null
address (anyOf 2)nullAlternative
birth_dateJSONOptional
birth_date (anyOf 1)stringAlternativeDate of birth in YYYY-MM-DD format.
Default: null
birth_date (anyOf 2)nullAlternative
emailJSONOptional
email (anyOf 1)stringAlternativeEmail address.
Default: null
Format: email
email (anyOf 2)nullAlternative
first_nameJSONOptional
first_name (anyOf 1)stringAlternativeFirst name.
Default: null
first_name (anyOf 2)nullAlternative
is_beneficial_ownerbooleanOptionalWhether this officer is also a beneficial owner. Defaults to false.
Default: false
last_nameJSONOptional
last_name (anyOf 1)stringAlternativeLast name.
Default: null
last_name (anyOf 2)nullAlternative
ownership_percentageJSONOptional
ownership_percentage (anyOf 1)JSONAlternative
ownership_percentage (anyOf 1) (anyOf 1)integerAlternativeBeneficial ownership percentage for this individual.
Default: null
Maximum: 100
Minimum: 0
ownership_percentage (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ownership_percentage (anyOf 2)nullAlternative
passport_last_4JSONOptional
passport_last_4 (anyOf 1)stringAlternativeLast 4 digits of passport number.
Default: null
Maximum length: 4
Minimum length: 4
passport_last_4 (anyOf 2)nullAlternative
phoneJSONOptional
phone (anyOf 1)stringAlternativePhone number in E.164 format.
Default: null
phone (anyOf 2)nullAlternative
ssn_last_4JSONOptional
ssn_last_4 (anyOf 1)stringAlternativeLast 4 digits of SSN.
Default: null
Maximum length: 4
Minimum length: 4
ssn_last_4 (anyOf 2)nullAlternative
titleJSONOptional
title (anyOf 1)stringAlternativeJob title or role.
Default: null
title (anyOf 2)nullAlternative

Referenced models: 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 address apt suite, city, country, postal code, state, street address

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 address apt suite, city, country, postal code, state, street address

FieldTypePresenceDescription and constraints
$objectRoot
apt_suiteJSONOptional
apt_suite (anyOf 1)stringAlternativeApartment or suite number.
Default: null
apt_suite (anyOf 2)nullAlternative
cityJSONOptional
city (anyOf 1)stringAlternativeCity.
Default: null
city (anyOf 2)nullAlternative
countryJSONOptional
country (anyOf 1)stringAlternativeTwo-letter country code (e.g. US).
Default: null
Maximum length: 2
Minimum length: 2
country (anyOf 2)nullAlternative
postal_codeJSONOptional
postal_code (anyOf 1)stringAlternativePostal code.
Default: null
postal_code (anyOf 2)nullAlternative
stateJSONOptional
state (anyOf 1)stringAlternativeTwo-letter state code (e.g. CA).
Default: null
Maximum length: 2
Minimum length: 2
state (anyOf 2)nullAlternative
street_addressJSONOptional
street_address (anyOf 1)stringAlternativeStreet address.
Default: null
street_address (anyOf 2)nullAlternative

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

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.