---
title: "List business"
method: GET
path: "/businesses"
tags: ["Businesses"]
---

# List business

`GET /businesses`

Retrieves paginated list of businesses associated with the authorized requester.

## Query parameters

- `is_customer` boolean
- `sort_by` string[]
- `id` string[]
- `has_accounts` boolean
- `classifications` Classification[] — Specifies the classification of a party for banks. This may contain multiple values for a combined classifications list of customers.
- `phone_number` string — Only return resources where the phone_number field matches the specified string. Phone numbers use the E.164 format e.g. +19178675309. Any * characters in the string are wildcards, and match any characters.
- `page_token` string — Optional pagination token to be provided to retrieve subsequent pages, returned from previous get
- `status` 'ACTIVE' | 'CANCELLED' | 'CONVERTED' | 'DISSOLVED' | 'FROZEN' | 'INACTIVE' | 'MERGED' | 'PROSPECT' | 'SANCTION' | 'SUSPENDED' — Status of the business. One of the following: * `PROSPECT` – a potential customer, used for information-gathering and disclosures. * `ACTIVE` – is an integrator defined status. Integrators should set a business to active if they believe the person to be qualified for conducting business. Synctera will combine this status with other statuses such a verification to determine if the business is eligible for specific actions such as initiating transactions or issuing a card. * `FROZEN` – business's actions are blocked for security, legal, or other reasons. * `SANCTION` – business is on a sanctions list and should be carefully monitored. * `DISSOLVED` – an inactive status indicating a business entity has filed articles of dissolution or a certificate of termination to terminate its existence. * `CANCELLED` – an inactive status indicating that a business entity has filed a cancellation or has failed to file its periodic report after notice of forfeiture of its rights to do business. * `SUSPENDED` – an inactive status indicating that the business entity has lost the right to operate in it's registered jurisdiction. * `MERGED` – an inactive status indicating that the business entity has terminated existence by merging into another entity. * `INACTIVE` – an inactive status indicating that the business entity is no longer active. * `CONVERTED` – An inactive status indicating that the business entity has been converted to another type of business entity in the same jurisdiction.
- `limit` integer — Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.
- `entity_name` string — Only return resources where the `entity_name` field matches the specified string. Any `*` characters in the string are wildcards, and match any characters.

## Response `200`

List of businesses.

- BusinessList
  - `businesses` BusinessResponse[], required — Array of businesses.
    - `addresses` Address[] — All of the customer's addresses
      - `address_line_1` string, required — Street address line 1
      - `address_line_2` string — Street address line 2
      - `address_type` 'BILLING' | 'LEGAL' | 'OPERATING' | 'OTHER' | 'SHIPPING' — Specifies the address type.
      - `city` string — City
      - `country_code` string, required — ISO-3166-1 Alpha-2 country code
      - `id` string, uuid — The unique identifier for this resource.
      - `is_registered_agent` boolean — Indicates whether an address is a registered agent. Omitted if the address is not a registered agent.
      - `nickname` string — A nickname for the address. This is used to identify the address in the UI.
      - `postal_code` string — Postal code. For US, formats of 12345 or 12345-1234 are accepted. For CA, formats of A1A 1A1 or A1A1A1 (regardless of case) are accepted, and will be converted to A1A 1A1 format.
      - `state` string — State, region, province, or prefecture. This is the ISO-3166-2 subdivision code, excluding the country prefix. For example, TX for Texas USA or TAM for Tamaulipas Mexico. Its length varies by country, e.g. 2 characters for US, 3 for MX.
    - `classifications` Classification[] — Specifies the classification of a party for banks. This may contain multiple values for a combined classifications list of customers.
    - `compliance_restrictions` string[] — The types of compliance that the business needs to adhere to * `LICENSED_CANNABIS` – A type of compliance restriction where the business would need a cannabis license in order to operate.
    - `creation_time` string, date-time — The date and time the resource was created.
    - `customer_active` string, date-time — The date and time this business became a bank customer.
    - `ein` string — U.S. Employer Identification Number (EIN) for this business, in the format xx-xxxxxxx.
    - `email` string — Business's email.
    - `entity_name` string — Business's legal name.
    - `formation_date` string, date — Date the business was legally registered in RFC 3339 full-date format (YYYY-MM-DD).
    - `formation_state` string — U.S. state where the business is legally registered (2-letter abbreviation).
    - `has_accounts` boolean — This flag indicates whether the person or business has accounts.
    - `id` string, uuid — Business's unique identifier.
    - `is_customer` boolean, required — True for personal and business customers with a direct relationship with the fintech or bank. Set this to true for any customer related to an account.
    - `last_updated_time` string, date-time — The date and time the resource was last updated.
    - `legal_address` LegalAddress — Legal address
      - `address_line_1` string, required — Street address line 1
      - `address_line_2` string — Street address line 2
      - `address_type` 'BILLING' | 'LEGAL' | 'OPERATING' | 'OTHER' | 'SHIPPING' — Specifies the address type.
      - `city` string — City
      - `country_code` string, required — ISO-3166-1 Alpha-2 country code
      - `id` string, uuid — The unique identifier for this resource.
      - `is_registered_agent` boolean — Indicates whether an address is a registered agent. Omitted if the address is not a registered agent.
      - `nickname` string — A nickname for the address. This is used to identify the address in the UI.
      - `postal_code` string — Postal code. For US, formats of 12345 or 12345-1234 are accepted. For CA, formats of A1A 1A1 or A1A1A1 (regardless of case) are accepted, and will be converted to A1A 1A1 format.
      - `state` string — State, region, province, or prefecture. This is the ISO-3166-2 subdivision code, excluding the country prefix. For example, TX for Texas USA or TAM for Tamaulipas Mexico. Its length varies by country, e.g. 2 characters for US, 3 for MX.
    - `metadata` Metadata — Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
    - `phone_number` string — Business's phone number with country code in E.164 format. Must have a valid country code. Area code and local phone number are not validated.
    - `spend_control_ids` string[] — List of spend control IDs to control spending for the customer
    - `status` 'ACTIVE' | 'CANCELLED' | 'CONVERTED' | 'DISSOLVED' | 'FROZEN' | 'INACTIVE' | 'MERGED' | 'PROSPECT' | 'SANCTION' | 'SUSPENDED', required — Status of the business. One of the following: * `PROSPECT` – a potential customer, used for information-gathering and disclosures. * `ACTIVE` – is an integrator defined status. Integrators should set a business to active if they believe the person to be qualified for conducting business. Synctera will combine this status with other statuses such a verification to determine if the business is eligible for specific actions such as initiating transactions or issuing a card. * `FROZEN` – business's actions are blocked for security, legal, or other reasons. * `SANCTION` – business is on a sanctions list and should be carefully monitored. * `DISSOLVED` – an inactive status indicating a business entity has filed articles of dissolution or a certificate of termination to terminate its existence. * `CANCELLED` – an inactive status indicating that a business entity has filed a cancellation or has failed to file its periodic report after notice of forfeiture of its rights to do business. * `SUSPENDED` – an inactive status indicating that the business entity has lost the right to operate in it's registered jurisdiction. * `MERGED` – an inactive status indicating that the business entity has terminated existence by merging into another entity. * `INACTIVE` – an inactive status indicating that the business entity is no longer active. * `CONVERTED` – An inactive status indicating that the business entity has been converted to another type of business entity in the same jurisdiction.
    - `structure` 'CORPORATION' | 'LLC' | 'NON_PROFIT' | 'OTHER' | 'PARTNERSHIP' | 'SOLE_PROPRIETORSHIP' | 'S_CORPORATION' — Business's legal structure.
    - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
    - `trade_names` string[] — All registered 'doing business as' (DBA) or trade names for this business.
    - `verification_last_run` string, date-time — Date and time KYB verification was last run on the business.
    - `verification_status` 'ACCEPTED' | 'PENDING' | 'PROVISIONAL' | 'REJECTED' | 'REVIEW' | 'UNVERIFIED' — The result of a KYC/KYB verification. One of the following: * `UNVERIFIED` – verification has not been completed for this customer. * `PENDING` – verification is in progress for this customer. * `PROVISIONAL` – partially verified or verified with restrictions. * `ACCEPTED` – the customer has been verified. * `REVIEW` – verification has run and issues have been identified and require review. * `REJECTED` – the customer was rejected and should not be allowed to take certain actions e.g., open an account.
    - `website` string — Business's website.
    - `vendor_info` PartyVendorInfo — Vendor information for external account management systems
      - `vendor_data` PartyVendorData, required — Vendor-specific data
        - `loanpro` PartyLoanproVendorData — LoanPro-specific vendor data
          - `customer_id` integer, required — LoanPro customer ID
      - `vendor_type` 'LOANPRO', required — Vendor type
  - `next_page_token` string — If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden error
- `500` — Internal server error

---

[API](https://skmtc.net/synctera/apis/synctera-api.md) · [All operations](https://skmtc.net/synctera/apis/synctera-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/synctera/synctera-api/revisions/b0d812e6cdd0/schema)