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

An onboarding survey contains questions about the entity’s business and how they’ll use bank accounts in the program. This should be submitted one time per entity, per program.

The Commercial Onboarding Survey object
{
  "created_at": "2020-01-31T23:59:59Z",
  "entity_id": "entity_n8y8tnk2p9339ti393yi",
  "id": "onboarding_survey_xkvnq4g2q67stijcpvol",
  "idempotency_key": null,
  "is_check_casher": false,
  "is_financial_services_provider": false,
  "is_internet_gambling_related": false,
  "is_marijuana_related": 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",
  "program_id": "program_i2v2os4mwza1oetokh9i",
  "purpose": "Business checking",
  "receives_credit_debit_or_stored_value_card_payments": true,
  "type": "commercial_onboarding_survey"
}
Attributes
created_at
string

When the survey was created.

entity_id
string

The Entity’s identifier.

More about Entities.
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_check_casher
boolean

Whether or not the entity is a check casher.

is_financial_services_provider
boolean

Whether or not the entity is a financial services provider.

Whether or not the entity is involved in internet gambling.

Whether or not the entity is involved in marijuana.

issues_negotiable_instruments
boolean

Whether or not the entity issues negotiable instruments like money orders or cashier’s checks.

issues_stored_value_cards
boolean

Whether or not the entity issues stored value cards.

monthly_ach_origination_amount
enum

How much the entity will send each month using ACH in this Increase program.

monthly_deposit_amount
enum

How much the entity will deposit each month in this Increase program.

monthly_domestic_wire_amount
enum

How much the entity will send using wire transfers in this Increase program.

program_id
string

The Program’s identifier.

More about Programs.
purpose
string
Nullable

The purpose of the entity’s account.

receives_credit_debit_or_stored_value_card_payments
boolean

Whether or not the entity accepts payments via credit, debit, or stored value cards.

type
string

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

List commercial onboarding surveys
curl \
  --url "${INCREASE_URL}/commercial_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.

program_id
string

Filter surveys for those belonging to the specified Program.

More about Programs.
entity_id
string

Filter surveys for those belonging to the specified Entity.

More about Entities.
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
Create a commercial onboarding survey
curl -X "POST" \
  --url "${INCREASE_URL}/commercial_onboarding_surveys" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "entity_id": "entity_n8y8tnk2p9339ti393yi",
    "program_id": "program_i2v2os4mwza1oetokh9i",
    "survey": {
      "is_check_casher": false,
      "is_financial_services_provider": false,
      "is_internet_gambling_related": false,
      "is_marijuana_related": 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",
      "purpose": "Business checking.",
      "receives_credit_debit_or_stored_value_card_payments": false
    }
  }'
Parameters
entity_id
string
Required

The identifier of the Entity.

More about Entities.
program_id
string
Required

The identifier of the Program.

More about Programs.
survey
dictionary
Required

The survey data regarding this Entity’s expected use of Accounts in this Program.

Retrieve a commercial onboarding survey
curl \
  --url "${INCREASE_URL}/commercial_onboarding_surveys/onboarding_survey_xkvnq4g2q67stijcpvol" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
onboarding_survey_id
string
Required

The identifier of the Onboarding Survey.

More about Commercial Onboarding Surveys.