# Create a new account

**POST /accounts**

At least one account should be created for customer of each of your products. Once created, you will be able to add `line_items` to the account.


## Servers
- Public Sandbox: https://sandbox-api.canopyservicing.com (Public Sandbox)
- Protected UAT Sandbox: https://uat-api.canopyservicing.com (Protected UAT Sandbox)
- Production: https://api.canopyservicing.com (Production)


## Authentication methods
- O auth2


## Parameters



### Body: application/json (object)
Create a new account
- **effective_at** (string(date-time))
  The `Date-Time` as of which this account is effective on the server.
- **account_id** (string)
  This is the ID used to identify the account in your system. For most use-cases, we strongly recommend using the ID from the system the account was originally created in -- for most use-cases, this is created as part of the origination system that approves a borrower. This will be the account that is used to refer to the borrower for all subsequent requests. Note: both strings and integers are accepted.
- **product_id** (string)
  The product ID that ties to the product onto which this account is being onboarded.
- **external_fields** (array[object] | null)
  External fields can be used to relate accounts created in Canopy to entities in your or any external system.
- **payment_processor_config** (object)

- **disbursements_config** (object)

- **payouts_config** (object)

- **cycle_type** (object)

- **discounts** (object)

- **summary** (object)

- **promo_overview** (object)

- **post_promo_overview** (object)

- **associated_entities** (object)
  (to be depricated) -- use `payout_entities` instead to provide more granular detail.
- **plaid_config** (object)
  Plaid configurations.
- **assign_customers** (array[object] | null)
  Array of existing customer IDs to be added to the account. Canopy recommends assigning a customer to the account during account creation.


## Responses
### 200
Successful query of information for a specific account

#### Body: application/json (object)
- **account_id** (string)
  This is the ID used to identify the account in your system. For most use-cases, we strongly recommend using the ID from the system the account was originally created in -- for most use-cases, this is created as part of the origination system that approves a borrower. This will be the account that is used to refer to the borrower for all subsequent requests. Note: both strings and integers are accepted.
- **created_at** (string(date-time))
  The `Date-Time` which the account was created in the API.
- **effective_at** (string(date-time))
  The `Date-Time` that this account became/becomes active.
- **account_overview** (object)

- **account_product** (object)
  The product associated with the account.
- **external_fields** (array[object])
  An Array of External Fields. These should be used to connect accounts created in Canopy to Users in your system and any connected external systems.
- **min_pay_due_cents** (object)

- **additional_statement_min_pay_details** (object)

- **payment_processor_config** (object)

- **disbursements_config** (object)

- **payouts_config** (object)

- **issuer_processor_details** (object)

- **cycle_type** (object)

- **discounts** (object)

- **summary** (object)

- **associated_entities** (object | null)
  (to be depricated) -- use `payout_entities` instead to provide more granular detail.
- **plaid_config** (object)
  Plaid configurations.
- **payout_entities** (array[object] | null)
  An array of payout entities who have been assigned to the account
- **customers** (array[object] | null)
  An array of customers who have been assigned to the account

### 401
Unauthorized.

### 403
Forbidden.

### 422
Invalid input

### 429
Too many requests.

### default
Unexpected Error.


[Powered by Bump.sh](https://bump.sh)