# 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
### Example
```json
{
  "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.

- `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](https://increase.com/documentation/idempotency-keys).

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

- `is_internet_gambling_related` (boolean)
  Whether or not the entity is involved in internet gambling.

- `is_marijuana_related` (boolean)
  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.
  Cases:
  * `zero` ($0.)
  * `zero_to_ten_thousand_dollars` ($0 - $10,000)
  * `ten_thousand_to_fifty_thousand_dollars` ($10,000 - $50,000.)
  * `fifty_thousand_to_one_hundred_thousand_dollars` ($50,000 - $100,000.)
  * `more_than_one_hundred_thousand_dollars` (More than $100,000)

- `monthly_deposit_amount` (enum)
  How much the entity will deposit each month in this Increase program.
  Cases:
  * `zero` ($0.)
  * `zero_to_ten_thousand_dollars` ($0 - $10,000)
  * `ten_thousand_to_fifty_thousand_dollars` ($10,000 - $50,000.)
  * `fifty_thousand_to_one_hundred_thousand_dollars` ($50,000 - $100,000.)
  * `more_than_one_hundred_thousand_dollars` (More than $100,000)

- `monthly_domestic_wire_amount` (enum)
  How much the entity will send using wire transfers in this Increase program.
  Cases:
  * `zero` ($0.)
  * `zero_to_ten_thousand_dollars` ($0 - $10,000)
  * `ten_thousand_to_fifty_thousand_dollars` ($10,000 - $50,000.)
  * `fifty_thousand_to_one_hundred_thousand_dollars` ($50,000 - $100,000.)
  * `more_than_one_hundred_thousand_dollars` (More than $100,000)

- `program_id` (string)
  The Program's identifier.

- `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
GET /commercial_onboarding_surveys

### Example
```curl
curl \
  --url "${INCREASE_URL}/commercial_onboarding_surveys" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```

### Query Parameters
- `cursor` (string, optional)
  Return the page of entries after this one.

- `limit` (integer, optional)
  Limit the size of the list that is returned. The default (and maximum) is 100 objects.

- `program_id` (string, optional)
  Filter surveys for those belonging to the specified Program.

- `entity_id` (string, optional)
  Filter surveys for those belonging to the specified Entity.

- `idempotency_key` (string, optional)
  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](https://increase.com/documentation/idempotency-keys).

### Returns a Commercial Onboarding Survey List object:
```json
{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": "v57w5d"
}
```

## Create a commercial onboarding survey
POST /commercial_onboarding_surveys

### Example
```curl
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
    }
  }'
```

### Body Parameters
- `entity_id` (string, required)
  The identifier of the Entity.

- `program_id` (string, required)
  The identifier of the Program.

- `survey` (dictionary, required)
  The survey data regarding this Entity's expected use of Accounts in this Program.

  - `survey.is_check_casher` (boolean, required)
    Whether or not the Entity is a check casher.

  - `survey.is_financial_services_provider` (boolean, required)
    Whether or not the Entity is a financial services provider.

  - `survey.is_internet_gambling_related` (boolean, required)
    Whether or not the Entity is involved in internet gambling.

  - `survey.is_marijuana_related` (boolean, required)
    Whether or not the Entity is involved in marijuana.

  - `survey.issues_negotiable_instruments` (boolean, required)
    Whether or not the Entity issues negotiable instruments like money orders or cashier's checks.

  - `survey.issues_stored_value_cards` (boolean, required)
    Whether or not the Entity issues stored value cards.

  - `survey.monthly_ach_origination_amount` (enum, required)
    How much the entity will send each month using ACH in this Increase program.
    Cases:
    * `zero` ($0.)
    * `zero_to_ten_thousand_dollars` ($0 - $10,000)
    * `ten_thousand_to_fifty_thousand_dollars` ($10,000 - $50,000.)
    * `fifty_thousand_to_one_hundred_thousand_dollars` ($50,000 - $100,000.)
    * `more_than_one_hundred_thousand_dollars` (More than $100,000)

  - `survey.monthly_deposit_amount` (enum, required)
    How much the entity will deposit each month in this Increase program.
    Cases:
    * `zero` ($0.)
    * `zero_to_ten_thousand_dollars` ($0 - $10,000)
    * `ten_thousand_to_fifty_thousand_dollars` ($10,000 - $50,000.)
    * `fifty_thousand_to_one_hundred_thousand_dollars` ($50,000 - $100,000.)
    * `more_than_one_hundred_thousand_dollars` (More than $100,000)

  - `survey.monthly_domestic_wire_amount` (enum, required)
    How much the entity will send using wire transfers in this Increase program.
    Cases:
    * `zero` ($0.)
    * `zero_to_ten_thousand_dollars` ($0 - $10,000)
    * `ten_thousand_to_fifty_thousand_dollars` ($10,000 - $50,000.)
    * `fifty_thousand_to_one_hundred_thousand_dollars` ($50,000 - $100,000.)
    * `more_than_one_hundred_thousand_dollars` (More than $100,000)

  - `survey.purpose` (string, optional)
    The intended use of Accounts in this Program.

  - `survey.receives_credit_debit_or_stored_value_card_payments` (boolean, required)
    Whether or not the Entity accepts payments via credit, debit, or stored value cards.

## Retrieve a commercial onboarding survey
GET /commercial_onboarding_surveys/{onboarding_survey_id}

### Example
```curl
curl \
  --url "${INCREASE_URL}/commercial_onboarding_surveys/onboarding_survey_xkvnq4g2q67stijcpvol" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```
### Path Parameters
- `onboarding_survey_id` (string, required)
  The identifier of the Onboarding Survey.