Docs
Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status
API Reference
Onboarding Surveys

Call this endpoint within one day of the Entity’s first Account being created.

The Onboarding Survey object
{
  "account_id": "account_in71c4amph0vgo2qllky",
  "archived_at": null,
  "created_at": "2020-01-31T23:59:59Z",
  "engages_in_loans_secured_by_cash_collateral_and_marketable_securities": false,
  "id": "onboarding_survey_xkvnq4g2q67stijcpvol",
  "idempotency_key": null,
  "is_auctioneer": false,
  "is_broker_or_dealer_in_securities": false,
  "is_cash_intensive_business": false,
  "is_casino": false,
  "is_chartering_or_operation_of_ships_buses_or_aircraft": false,
  "is_check_casher": false,
  "is_dealer_in_antiquities": false,
  "is_dealer_in_precious_metals_stones_and_jewels": false,
  "is_dealer_or_broker_in_virtual_currency": false,
  "is_deposit_broker": false,
  "is_financial_services_provider": false,
  "is_gaming": false,
  "is_internet_gambling_related": false,
  "is_marijuana_related": false,
  "is_non_bank_financial_institution": false,
  "is_non_profit_organization_or_charity": false,
  "is_pawn_broker": false,
  "is_professional_service_provider": false,
  "is_purchaser_or_seller_of_vehicles": false,
  "is_senior_foreign_political_figure_or_associate": false,
  "is_title_insurance_operations_and_real_estate_closing": false,
  "is_trade_union": false,
  "issues_negotiable_instruments": false,
  "issues_stored_value_cards": false,
  "monthly_ach_origination_amount": "zero",
  "monthly_deposit_amount": "zero",
  "monthly_domestic_wire_amount": "zero",
  "monthly_international_wire_amount": "zero",
  "receives_credit_debit_or_stored_value_card_payments": false,
  "type": "onboarding_survey"
}
Attributes
account_id
string

The identifier for the associated Account.

More about Accounts.
archived_at
string
Nullable

The ISO 8601 time at which the survey was archived.

created_at
string

The ISO 8601 time at which the survey was submitted.

engages_in_loans_secured_by_cash_collateral_and_marketable_securities
boolean

Does the business engage in loans secured by cash collateral and marketable securities?

id
string

The Onboarding Survey’s identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

is_auctioneer
boolean

Is the business characterized as auctioneering?

is_broker_or_dealer_in_securities
boolean

Is the business characterized as a broker/dealer in securities?

is_cash_intensive_business
boolean

Is the business characterized as a cash-intensive business?

is_casino
boolean

Is the business characterized as a casino?

is_chartering_or_operation_of_ships_buses_or_aircraft
boolean

Is the business characterized as chartering or operation of ships, buses, or aircraft?

is_check_casher
boolean

Does this business cash checks?

is_dealer_in_antiquities
boolean

Is the business characterized as a dealer in antiquities?

is_dealer_in_precious_metals_stones_and_jewels
boolean

Is the business characterized as a dealer in precious metals, stones, and jewels?

is_dealer_or_broker_in_virtual_currency
boolean

Is the business characterized as a dealer or broker in virtual currency?

is_deposit_broker
boolean

Is the business characterized as a deposit broker?

is_financial_services_provider
boolean

Does this business provide financial services?

is_gaming
boolean

Is the business characterized as gaming of any kind?

Does this business engage in making or accepting payments related to internet gambling?

Does the business conduct business in the marijuana industry?

is_non_bank_financial_institution
boolean

Is the business characterized as a non-bank financial institution including money service businesses, casinos, and card clubs?

is_non_profit_organization_or_charity
boolean

Is the business characterized as a non-profit organization or charity?

is_pawn_broker
boolean

Is the business characterized as a pawn broker?

is_professional_service_provider
boolean

Is the business characterized as a professional service provider such as a doctor, attorney, accountant, or real estate broker?

is_purchaser_or_seller_of_vehicles
boolean

Is the business characterized as a purchaser or seller of motor vehicles?

is_senior_foreign_political_figure_or_associate
boolean

Does the business leadership include senior foreign political figures, their immediate families, or close associates (PEPs)?

is_title_insurance_operations_and_real_estate_closing
boolean

Is the business characterized as a title insurance operations and real estate closing business?

is_trade_union
boolean

Is the business characterized as a trade union?

issues_negotiable_instruments
boolean

Does this business issue negotiable instruments (i.e. money orders, cashier’s checks, travelers checks, etc.)?

issues_stored_value_cards
boolean

Does this business issue stored value cards?

monthly_ach_origination_amount
enum

Monthly ACH origination amount (credits and debits sent).

monthly_deposit_amount
enum

Monthly deposit amount.

monthly_domestic_wire_amount
enum

Monthly domestic wire amount (sent and received).

monthly_international_wire_amount
enum

Monthly international wire amount (sent and received).

receives_credit_debit_or_stored_value_card_payments
boolean

Does this business currently receive or expect to receive payments from credit/debit or store valued cards?

type
string

A constant representing the object’s type. For this resource it will always be onboarding_survey.

List Expected Activity Surveys
curl \
  --url "${INCREASE_URL}/ramp_business_account_onboarding_surveys" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Expected Activity Surveys for those belonging to the specified Account.

More about Accounts.
idempotency_key
string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum
Submit an account onboarding survey
curl -X "POST" \
  --url "${INCREASE_URL}/ramp_business_account_onboarding_surveys" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "engages_in_loans_secured_by_cash_collateral_and_marketable_securities": false,
    "is_auctioneer": false,
    "is_broker_or_dealer_in_securities": false,
    "is_cash_intensive_business": false,
    "is_casino": false,
    "is_chartering_or_operation_of_ships_buses_or_aircraft": false,
    "is_check_casher": false,
    "is_dealer_in_antiquities": false,
    "is_dealer_in_precious_metals_stones_and_jewels": false,
    "is_dealer_or_broker_in_virtual_currency": false,
    "is_deposit_broker": false,
    "is_financial_services_provider": false,
    "is_gaming": false,
    "is_internet_gambling_related": false,
    "is_marijuana_related": false,
    "is_non_bank_financial_institution": false,
    "is_non_profit_organization_or_charity": false,
    "is_pawn_broker": false,
    "is_professional_service_provider": false,
    "is_purchaser_or_seller_of_vehicles": false,
    "is_senior_foreign_political_figure_or_associate": false,
    "is_title_insurance_operations_and_real_estate_closing": false,
    "is_trade_union": false,
    "issues_negotiable_instruments": false,
    "issues_stored_value_cards": false,
    "monthly_ach_origination_amount": "zero_to_ten_thousand_dollars",
    "monthly_deposit_amount": "zero_to_ten_thousand_dollars",
    "monthly_domestic_wire_amount": "zero_to_ten_thousand_dollars",
    "monthly_international_wire_amount": "zero",
    "receives_credit_debit_or_stored_value_card_payments": false
  }'
Parameters
account_id
string
Required

The identifier for the Account.

More about Accounts.
engages_in_loans_secured_by_cash_collateral_and_marketable_securities
boolean
Required

Survey response.

is_auctioneer
boolean
Required

Survey response.

is_broker_or_dealer_in_securities
boolean
Required

Survey response.

is_cash_intensive_business
boolean
Required

Survey response.

is_casino
boolean
Required

Survey response.

is_chartering_or_operation_of_ships_buses_or_aircraft
boolean
Required

Survey response.

is_check_casher
boolean
Required

Survey response.

is_dealer_in_antiquities
boolean
Required

Survey response.

is_dealer_in_precious_metals_stones_and_jewels
boolean
Required

Survey response.

is_dealer_or_broker_in_virtual_currency
boolean
Required

Survey response.

is_deposit_broker
boolean
Required

Survey response.

is_financial_services_provider
boolean
Required

Survey response.

is_gaming
boolean
Required

Survey response.

Survey response.

Survey response.

is_non_bank_financial_institution
boolean
Required

Survey response.

is_non_profit_organization_or_charity
boolean
Required

Survey response.

is_pawn_broker
boolean
Required

Survey response.

is_professional_service_provider
boolean
Required

Survey response.

is_purchaser_or_seller_of_vehicles
boolean
Required

Survey response.

is_senior_foreign_political_figure_or_associate
boolean
Required

Survey response.

is_title_insurance_operations_and_real_estate_closing
boolean
Required

Survey response.

is_trade_union
boolean
Required

Survey response.

issues_negotiable_instruments
boolean
Required

Survey response.

issues_stored_value_cards
boolean
Required

Survey response.

monthly_ach_origination_amount
enum
Required

Survey response.

monthly_deposit_amount
enum
Required

Survey response.

monthly_domestic_wire_amount
enum
Required

Survey response.

monthly_international_wire_amount
enum
Required

Survey response.

receives_credit_debit_or_stored_value_card_payments
boolean
Required

Survey response.

Retrieve an Expected Activity Survey
curl \
  --url "${INCREASE_URL}/ramp_business_account_onboarding_surveys/onboarding_survey_xkvnq4g2q67stijcpvol" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
onboarding_survey_id
string
Required

The identifier of the Account Onboarding Survey.

More about Onboarding Surveys.