Ramp: Application schemas
17 Ramp schemas with complete fields and constraints.
← Application operations · All schemas
Create a financing application — request body — 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 to create. Default: RAMP_SUITE One of: BILL_PAY_ONLY, RAMP_SUITE |
beneficial_owners | JSON | Optional | |
beneficial_owners (anyOf 1) | array | Alternative | Beneficial owners of the business. |
beneficial_owners (anyOf 1)[] | Model | Each item | Expand Create a financing application — request body — body beneficial owners Beneficial owners of the business item |
beneficial_owners (anyOf 2) | null | Alternative | |
business | JSON | Optional | |
business (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
controlling_officer | JSON | Optional | |
controlling_officer (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
country | string | Optional | Country 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_details | JSON | Optional | |
financial_details (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
lead_referral_partner_channel | JSON | Optional | |
lead_referral_partner_channel (anyOf 1) | string | Alternative | Optional unverified agent harness that reported the lead_referral_partner_code. Default: null One of: api, cli, mcp |
lead_referral_partner_channel (anyOf 2) | null | Alternative | |
lead_referral_partner_code | JSON | Optional | |
lead_referral_partner_code (anyOf 1) | string | Alternative | Optional 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) | null | Alternative | |
manual_bank_account | JSON | Optional | |
manual_bank_account (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
oauth_authorize_params | JSON | Optional | |
oauth_authorize_params (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
ownership_acknowledgement | JSON | Optional | |
ownership_acknowledgement (anyOf 1) | string | Alternative | Ownership 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | |
address (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 address apt suite, city, country, postal code, state, street address Residential address. Default: null |
address (anyOf 2) | null | Alternative | |
birth_date | JSON | Optional | |
birth_date (anyOf 1) | string | Alternative | Date of birth in YYYY-MM-DD format. Default: null |
birth_date (anyOf 2) | null | Alternative | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Email address. Default: null Format: email |
email (anyOf 2) | null | Alternative | |
first_name | JSON | Optional | |
first_name (anyOf 1) | string | Alternative | First name. Default: null |
first_name (anyOf 2) | null | Alternative | |
last_name | JSON | Optional | |
last_name (anyOf 1) | string | Alternative | Last name. Default: null |
last_name (anyOf 2) | null | Alternative | |
ownership_percentage | JSON | Optional | |
ownership_percentage (anyOf 1) | integer | Alternative | Beneficial ownership percentage for this individual. Default: null Maximum: 100 Minimum: 0 |
ownership_percentage (anyOf 2) | null | Alternative | |
passport_last_4 | JSON | Optional | |
passport_last_4 (anyOf 1) | string | Alternative | Last 4 digits of passport number. Default: null Maximum length: 4 Minimum length: 4 |
passport_last_4 (anyOf 2) | null | Alternative | |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Phone number in E.164 format. Default: null |
phone (anyOf 2) | null | Alternative | |
ssn_last_4 | JSON | Optional | |
ssn_last_4 (anyOf 1) | string | Alternative | Last 4 digits of SSN. Default: null Maximum length: 4 Minimum length: 4 |
ssn_last_4 (anyOf 2) | null | Alternative | |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | Job title or role. Default: null |
title (anyOf 2) | null | Alternative |
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
| 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 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) | 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, 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date_of_incorporation | JSON | Optional | |
date_of_incorporation (anyOf 1) | string | Alternative | Date of incorporation in YYYY-MM-DD format. Default: null Format: date |
date_of_incorporation (anyOf 2) | null | Alternative | |
ein_number | JSON | Optional | |
ein_number (anyOf 1) | string | Alternative | Employer Identification Number. Default: null |
ein_number (anyOf 2) | null | Alternative | |
entity_type | JSON | Optional | |
entity_type (anyOf 1) | string | Alternative | Type of business entity. Default: null One of: COOPERATIVE, CORPORATION, LLC, NON_PROFIT_CORPORATION, OTHER, PARTNERSHIP, SOLE_PROPRIETORSHIP |
entity_type (anyOf 2) | null | Alternative | |
state_of_incorporation | JSON | Optional | |
state_of_incorporation (anyOf 1) | string | Alternative | Two-letter state code where the business is incorporated. Default: null Maximum length: 2 Minimum length: 2 |
state_of_incorporation (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | |
address (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 address apt suite, city, country, postal code, state, street address Residential address. Default: null |
address (anyOf 2) | null | Alternative | |
birth_date | JSON | Optional | |
birth_date (anyOf 1) | string | Alternative | Date of birth in YYYY-MM-DD format. Default: null |
birth_date (anyOf 2) | null | Alternative | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Email address. Default: null Format: email |
email (anyOf 2) | null | Alternative | |
first_name | JSON | Optional | |
first_name (anyOf 1) | string | Alternative | First name. Default: null |
first_name (anyOf 2) | null | Alternative | |
is_beneficial_owner | boolean | Optional | Whether this officer is also a beneficial owner. Defaults to false. Default: false |
last_name | JSON | Optional | |
last_name (anyOf 1) | string | Alternative | Last name. Default: null |
last_name (anyOf 2) | null | Alternative | |
ownership_percentage | JSON | Optional | |
ownership_percentage (anyOf 1) | integer | Alternative | Beneficial ownership percentage for this individual. Default: null Maximum: 100 Minimum: 0 |
ownership_percentage (anyOf 2) | null | Alternative | |
passport_last_4 | JSON | Optional | |
passport_last_4 (anyOf 1) | string | Alternative | Last 4 digits of passport number. Default: null Maximum length: 4 Minimum length: 4 |
passport_last_4 (anyOf 2) | null | Alternative | |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Phone number in E.164 format. Default: null |
phone (anyOf 2) | null | Alternative | |
ssn_last_4 | JSON | Optional | |
ssn_last_4 (anyOf 1) | string | Alternative | Last 4 digits of SSN. Default: null Maximum length: 4 Minimum length: 4 |
ssn_last_4 (anyOf 2) | null | Alternative | |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | Job title or role. Default: null |
title (anyOf 2) | null | Alternative |
Create a financing application — request body — 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) | integer | Alternative | Estimated monthly accounts payable spend amount in dollars. Default: null |
estimated_monthly_ap_spend_amount (anyOf 2) | null | Alternative | |
estimated_monthly_spend_amount | JSON | Optional | |
estimated_monthly_spend_amount (anyOf 1) | integer | Alternative | Estimated monthly card spend amount in dollars. Default: null |
estimated_monthly_spend_amount (anyOf 2) | null | Alternative |
Create a financing application — request body — body manual bank account account number, account subtype, balance, routing number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_number | string | Required within parent | Bank account number. |
account_subtype | string | Required within parent | Bank account subtype, such as checking or savings. |
balance | JSON | Required within parent | Current account balance. |
balance (oneOf 1) | string | Alternative | Format: decimal |
balance (oneOf 2) | number | Alternative | |
routing_number | string | Required within parent | ABA routing number. |
Create a financing application — request body — body oauth authorize params code challenge, redirect uri, state
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code_challenge | JSON | Optional | |
code_challenge (anyOf 1) | string | Alternative | Optional 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) | null | Alternative | |
redirect_uri | string | Required within parent | The URI to redirect the user to after accepting the invite. |
state | string | Required within parent | An opaque value used by the client to maintain state between the request and callback. Minimum length: 1 |
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 — beneficial owners Beneficial owners of the business item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | |
address (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 address apt suite, city, country, postal code, state, street address Residential address. Default: null |
address (anyOf 2) | null | Alternative | |
birth_date | JSON | Optional | |
birth_date (anyOf 1) | string | Alternative | Date of birth in YYYY-MM-DD format. Default: null |
birth_date (anyOf 2) | null | Alternative | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Email address. Default: null Format: email |
email (anyOf 2) | null | Alternative | |
first_name | JSON | Optional | |
first_name (anyOf 1) | string | Alternative | First name. Default: null |
first_name (anyOf 2) | null | Alternative | |
last_name | JSON | Optional | |
last_name (anyOf 1) | string | Alternative | Last name. Default: null |
last_name (anyOf 2) | null | Alternative | |
ownership_percentage | JSON | Optional | |
ownership_percentage (anyOf 1) | JSON | Alternative | |
ownership_percentage (anyOf 1) (anyOf 1) | integer | Alternative | Beneficial ownership percentage for this individual. Default: null Maximum: 100 Minimum: 0 |
ownership_percentage (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
ownership_percentage (anyOf 2) | null | Alternative | |
passport_last_4 | JSON | Optional | |
passport_last_4 (anyOf 1) | string | Alternative | Last 4 digits of passport number. Default: null Maximum length: 4 Minimum length: 4 |
passport_last_4 (anyOf 2) | null | Alternative | |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Phone number in E.164 format. Default: null |
phone (anyOf 2) | null | Alternative | |
ssn_last_4 | JSON | Optional | |
ssn_last_4 (anyOf 1) | string | Alternative | Last 4 digits of SSN. Default: null Maximum length: 4 Minimum length: 4 |
ssn_last_4 (anyOf 2) | null | Alternative | |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | Job title or role. Default: null |
title (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 — 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
apt_suite | JSON | Optional | |
apt_suite (anyOf 1) | string | Alternative | Apartment or suite number. Default: null |
apt_suite (anyOf 2) | null | Alternative | |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | City. Default: null |
city (anyOf 2) | null | Alternative | |
postal_code | JSON | Optional | |
postal_code (anyOf 1) | string | Alternative | Postal code. Default: null |
postal_code (anyOf 2) | null | Alternative | |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | Two-letter state code (e.g. CA). Default: null Maximum length: 2 Minimum length: 2 |
state (anyOf 2) | null | Alternative | |
street_address | JSON | Optional | |
street_address (anyOf 1) | string | Alternative | Street address. Default: null |
street_address (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 incorporation date of incorporation, ein number, entity type, state of incorporation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date_of_incorporation | JSON | Optional | |
date_of_incorporation (anyOf 1) | string | Alternative | Date of incorporation in YYYY-MM-DD format. Default: null Format: date |
date_of_incorporation (anyOf 2) | null | Alternative | |
ein_number | JSON | Optional | |
ein_number (anyOf 1) | string | Alternative | Employer Identification Number. Default: null |
ein_number (anyOf 2) | null | Alternative | |
entity_type | JSON | Optional | |
entity_type (anyOf 1) | string | Alternative | Type of business entity. Known values: COOPERATIVE, CORPORATION, LLC, NON_PROFIT_CORPORATION, OTHER, PARTNERSHIP, SOLE_PROPRIETORSHIP Default: null |
entity_type (anyOf 2) | null | Alternative | |
state_of_incorporation | JSON | Optional | |
state_of_incorporation (anyOf 1) | string | Alternative | Two-letter state code where the business is incorporated. Default: null Maximum length: 2 Minimum length: 2 |
state_of_incorporation (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | |
address (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 address apt suite, city, country, postal code, state, street address Residential address. Default: null |
address (anyOf 2) | null | Alternative | |
birth_date | JSON | Optional | |
birth_date (anyOf 1) | string | Alternative | Date of birth in YYYY-MM-DD format. Default: null |
birth_date (anyOf 2) | null | Alternative | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Email address. Default: null Format: email |
email (anyOf 2) | null | Alternative | |
first_name | JSON | Optional | |
first_name (anyOf 1) | string | Alternative | First name. Default: null |
first_name (anyOf 2) | null | Alternative | |
is_beneficial_owner | boolean | Optional | Whether this officer is also a beneficial owner. Defaults to false. Default: false |
last_name | JSON | Optional | |
last_name (anyOf 1) | string | Alternative | Last name. Default: null |
last_name (anyOf 2) | null | Alternative | |
ownership_percentage | JSON | Optional | |
ownership_percentage (anyOf 1) | JSON | Alternative | |
ownership_percentage (anyOf 1) (anyOf 1) | integer | Alternative | Beneficial ownership percentage for this individual. Default: null Maximum: 100 Minimum: 0 |
ownership_percentage (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
ownership_percentage (anyOf 2) | null | Alternative | |
passport_last_4 | JSON | Optional | |
passport_last_4 (anyOf 1) | string | Alternative | Last 4 digits of passport number. Default: null Maximum length: 4 Minimum length: 4 |
passport_last_4 (anyOf 2) | null | Alternative | |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Phone number in E.164 format. Default: null |
phone (anyOf 2) | null | Alternative | |
ssn_last_4 | JSON | Optional | |
ssn_last_4 (anyOf 1) | string | Alternative | Last 4 digits of SSN. Default: null Maximum length: 4 Minimum length: 4 |
ssn_last_4 (anyOf 2) | null | Alternative | |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | Job title or role. Default: null |
title (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
apt_suite | JSON | Optional | |
apt_suite (anyOf 1) | string | Alternative | Apartment or suite number. Default: null |
apt_suite (anyOf 2) | null | Alternative | |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | City. Default: null |
city (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Two-letter country code (e.g. US). Default: null Maximum length: 2 Minimum length: 2 |
country (anyOf 2) | null | Alternative | |
postal_code | JSON | Optional | |
postal_code (anyOf 1) | string | Alternative | Postal code. Default: null |
postal_code (anyOf 2) | null | Alternative | |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | Two-letter state code (e.g. CA). Default: null Maximum length: 2 Minimum length: 2 |
state (anyOf 2) | null | Alternative | |
street_address | JSON | Optional | |
street_address (anyOf 1) | string | Alternative | Street address. Default: null |
street_address (anyOf 2) | null | Alternative |
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 |