> ## Documentation Index > Fetch the complete documentation index at: https://docs.synctera.com/llms.txt > Use this file to discover all available pages before exploring further. # List business > Retrieves paginated list of businesses associated with the authorized requester. ## OpenAPI ````yaml openapi.json get /businesses openapi: 3.0.3 info: description: >- This is the official reference documentation for Synctera APIs. If you need something specific or have a question, contact us.

license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: 0.208.0 servers: - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v0 - description: Production url: https://api.synctera.com/v0 security: - bearerAuth: [] tags: - description: Lookup merchant information name: Merchants - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: >- Account programs define configurations for payment rails and transaction capabilities across different account types. name: Account Programs - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - description: Requests for risk evaluation and decisioning name: Risk Evaluations - description: Requests to link and manage External Cards name: External Cards - description: | The disclosures resource is used to track the status of disclosures and ensure that all parties have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures - description: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: Requests to initiate customer verification. name: KYC Verification (deprecated) - description: Request to create and manage users name: Users - description: See balance history name: BalanceHistory - description: >- Migration mappings associate resources from an old tenant identity with a new tenant identity. name: Migration Mappings - description: | The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem. name: External Accounts - description: Requests to create and manage account products, including fees, interest. name: Account Products - description: Requests to create and manage webhooks name: Webhooks - description: Create and manage documents. name: Documents - description: >- Create and manage same currency and multi-currency international wire transfers name: International Wires (alpha) - description: Requests for transaction risk detection name: Transaction risk - description: >- Used to configure bank accounts for which synctera accounts are considered a "subledger" to name: Bank Account - description: Request to create and manage party groups and party group members name: Party Groups - description: Requests to manage addresses name: Addresses - description: Requests to manage monitoring subscriptions and alerts for customers. name: Monitoring - description: Requests to search and manage compliance searches name: Compliance Searches - description: Requests to create and manage customers name: Customers - description: | The internal account resource is used for managing links to internal accounts where the funds are managed by integrators. name: Internal Accounts - description: Create and manage spending controls name: Spend Controls - description: Retrieve user identity information name: Identity - description: Requests to manage banks name: Banks - description: | The Disclosures resource is used to track the status of disclosures and ensure that customers have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures (deprecated) - description: Create and manage wire transfers name: Wires - description: Requests to issue and manage Cards name: Cards - description: Request to create and manage edd name: Trust - description: Request to enroll, renew, or cancel watchlist monitors name: Watchlist (deprecated) - description: Endpoints for modifying or fetching posting dates name: Posting Dates - description: Transaction lines API name: transactions - description: Request to create and manage accounts name: Accounts - description: Requests to create and manage notes name: Notes - description: Account Template name: Account Templates - description: API for effective balances name: effective_balances - description: Requests to create and manage personal ID configurations name: Personal ID Configuration - description: > A natural person (individual human) that is relevant to the Synctera platform in some way: e.g. a personal customer or a director/officer/owner of a business. name: Persons - description: > Represents the relationships between parties. A relationship can exist between personal customers, business customers, or non-customer persons/organizations. name: Relationships - description: > A legal entity (corporation, partnership, etc.) that is relevant to the Synctera platform in some way: a business customer or some other organization that has an ownership share in such a business customer. name: Businesses - description: Request to create and manage payment_schedules name: Cronut - description: Requests to manage partners name: Partners - description: Request to create and manage deposits using remote deposit capture name: Remote Check Deposit - description: Requests to create and manage API keys name: API Keys - description: Requests to create and manage ban rules name: Ban Rules - description: Admin API for Middesk configuration using the tenants API keys. name: Middesk - description: Request to create and manage exclusions name: Stately - description: Request to create and manage partner configurations name: Quickstart - description: Manage contacts for bank and fintech partners name: Contacts - description: Create and manage transactions name: Transactions - description: Request to create and manage rdc configurations name: RDC Config - description: Create and manage holds name: Hold - description: Requests to create and manage roles name: Roles - description: Simulate receiving Wire transactions and returns name: Wire Transaction Simulations - description: Requests to create licenses name: Licenses - description: Requests to Admins to grant permissions to user name: Request Permissions - description: Configure vendor secrets for egress requests name: Egress Gateway Vendor Secret CRUD API - description: Requests to screen parties against sanctions watchlists name: Sanctions Screening - description: Create and manage payments name: ACH - description: Requests to calculate and manage CRR name: CRR - description: Requests to search financial institutions name: Institutions (Beta) - description: Create and manage tenant configurations name: Tenant Configs - description: Create and manage sweep configurations name: Configs - description: > Represents the compliance rules that are used to verify certain kinds of money movement. name: Compliance Rules - description: Configure webhook secrets for egress requests name: Egress Gateway Webhook Secret CRUD API - description: Create and manage transactions name: Transactions (internal) - description: History name: History - description: Create and manage EFT Canada transfers name: EFT Canada (Beta) - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Requests to initiate customer verification. name: KYC/KYB Verifications paths: /businesses: summary: Businesses get: tags: - Businesses summary: List business description: >- Retrieves paginated list of businesses associated with the authorized requester. operationId: listBusinesses parameters: - $ref: '#/components/parameters/is_customer' - $ref: '#/components/parameters/business_sort_by_query' - $ref: '#/components/parameters/uuid_query' - $ref: '#/components/parameters/has_accounts_query' - $ref: '#/components/parameters/classifications' - $ref: '#/components/parameters/phone_number' - $ref: '#/components/parameters/page_token' - $ref: '#/components/parameters/business_status' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/entity_name' responses: '200': content: application/json: schema: $ref: '#/components/schemas/business_list' description: List of businesses. '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '500': $ref: '#/components/responses/internal_server_error' components: parameters: is_customer: description: If true, show only customers. If false, show non-customer parties. in: query name: is_customer schema: type: boolean business_sort_by_query: description: | Specifies the sort order for the returned businesses. explode: false in: query name: sort_by schema: items: enum: - creation_time:asc - creation_time:desc - entity_name:asc - entity_name:desc - last_updated_time:asc - last_updated_time:desc type: string type: array style: form uuid_query: description: > Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list. explode: false in: query name: id schema: example: >- 64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157 items: format: uuid type: string type: array style: form has_accounts_query: description: | Filter on resources that have an account(s) in: query name: has_accounts schema: type: boolean classifications: description: >- Specifies the classification of a party for banks. It can contain multiple values. example: BANK_CUSTOMER,AUTHORIZED_USER,PROSPECT explode: false in: query name: classifications schema: $ref: '#/components/schemas/classifications' style: form phone_number: in: query name: phone_number schema: description: >- 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. example: '+12065550100' type: string page_token: in: query name: page_token schema: description: >- Optional pagination token to be provided to retrieve subsequent pages, returned from previous get example: a8937a0d type: string business_status: in: query name: status schema: description: > 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. enum: - ACTIVE - CANCELLED - CONVERTED - DISSOLVED - FROZEN - INACTIVE - MERGED - PROSPECT - SANCTION - SUSPENDED type: string limit: in: query name: limit schema: default: 100 description: > Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100. example: 100 minimum: 1 type: integer entity_name: in: query name: entity_name schema: description: >- Only return resources where the `entity_name` field matches the specified string. Any `*` characters in the string are wildcards, and match any characters. example: Apex Corporation type: string schemas: business_list: allOf: - properties: businesses: description: Array of businesses. items: $ref: '#/components/schemas/business_response' type: array required: - businesses type: object - $ref: '#/components/schemas/paginated_response' classifications: description: > Specifies the classification of a party for banks. This may contain multiple values for a combined classifications list of customers. items: $ref: '#/components/schemas/classification' readOnly: true type: array business_response: allOf: - $ref: '#/components/schemas/business' - properties: vendor_info: $ref: '#/components/schemas/party_vendor_info' description: Represents a business customer. type: object paginated_response: properties: next_page_token: description: >- If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows. example: a8937a0d type: string title: Paginated List response type: object error: description: >- Synctera error responses in API v0 follow [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807). Following that standard, the field for a machine-readable "error code" in API v0 is `type`. In our future API v1, we are phasing out RFC 7807 and adopting a custom error format. That format will be documented in our API v1 spec. But you may see some v0 error responses with a machine-readable `code` field while we are making the transition from v0 to v1. properties: code: description: >- An optional “sneak preview” of our future API v1 error responses. This is provided to give integrators a chance to work with our future error codes. Error codes for the same error may change between v0 and v1. example: BAD_REQUEST_BODY type: string detail: description: | A human-readable string explaining this particular error. example: 'missing required fields: first_name, dob' type: string status: description: the HTTP status code for this response example: 400 type: integer title: description: > A human-readable string for this general category of error, which corresponds 1-to-1 with error types (`title` is the human-readable version of `type`). There can be multiple distinct titles for the same HTTP status code, and the same `title` can result in many different `detail` strings. This field will be removed in API v1. example: Bad Request Body type: string type: description: > A machine-readable string that identifies the error for programmatic use. This is a URI, i.e. a globally unique identifier. It is _not_ necessarily a URL, so do not expect it to resolve to a web page. You can use this whole string as an error code, or just everything after the last slash. This field will be removed in API v1. example: https://dev.synctera.com/errors/bad-request-body type: string title: Standard error response (RFC 7807 problem report) type: object classification: description: | Specifies the classification of a party. enum: - AUTHORIZED_USER - BANK_CUSTOMER - INACTIVE_BANK_CUSTOMER - PROSPECT type: string business: allOf: - required: - is_customer - status - $ref: '#/components/schemas/base' description: Represents a business customer. type: object party_vendor_info: description: Vendor information for external account management systems properties: vendor_data: $ref: '#/components/schemas/party_vendor_data' vendor_type: $ref: '#/components/schemas/party_vendor_type' required: - vendor_data - vendor_type type: object base: properties: addresses: description: All of the customer's addresses items: $ref: '#/components/schemas/address' readOnly: true type: array classifications: $ref: '#/components/schemas/classifications' compliance_restrictions: description: > 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. items: enum: - LICENSED_CANNABIS type: string type: array creation_time: description: The date and time the resource was created. example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string customer_active: description: The date and time this business became a bank customer. example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string ein: description: >- U.S. Employer Identification Number (EIN) for this business, in the format xx-xxxxxxx. example: 12-3456789 type: string email: description: Business's email. example: alice@example.com type: string entity_name: description: Business's legal name. example: Apex Corporation type: string formation_date: description: >- Date the business was legally registered in RFC 3339 full-date format (YYYY-MM-DD). example: '2000-01-01' format: date type: string formation_state: description: >- U.S. state where the business is legally registered (2-letter abbreviation). example: NY type: string has_accounts: $ref: '#/components/schemas/has_accounts' id: description: Business's unique identifier. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true type: string is_customer: $ref: '#/components/schemas/is_customer' last_updated_time: description: The date and time the resource was last updated. example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string legal_address: $ref: '#/components/schemas/legal_address' metadata: $ref: '#/components/schemas/metadata' phone_number: description: >- 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. example: '+14374570680' pattern: ^\+[1-9]\d{1,14}$ type: string spend_control_ids: $ref: '#/components/schemas/spend_control_ids1' status: description: > 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. enum: - ACTIVE - CANCELLED - CONVERTED - DISSOLVED - FROZEN - INACTIVE - MERGED - PROSPECT - SANCTION - SUSPENDED type: string structure: description: Business's legal structure. enum: - CORPORATION - LLC - NON_PROFIT - OTHER - PARTNERSHIP - SOLE_PROPRIETORSHIP - S_CORPORATION example: CORPORATION type: string tenant: $ref: '#/components/schemas/tenant_id' trade_names: description: >- All registered 'doing business as' (DBA) or trade names for this business. example: - Apex - Apex LLC - CorporationID#77231 items: type: string type: array verification_last_run: description: Date and time KYB verification was last run on the business. example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string verification_status: $ref: '#/components/schemas/verification_status' website: description: Business's website. example: https://example.com type: string type: object party_vendor_data: description: Vendor-specific data properties: loanpro: $ref: '#/components/schemas/party_loanpro_vendor_data' type: object party_vendor_type: description: Vendor type enum: - LOANPRO type: string address: properties: address_line_1: description: Street address line 1 example: 100 Main St. type: string address_line_2: description: Street address line 2 example: Suite 99 type: string address_type: description: | Specifies the address type. enum: - BILLING - LEGAL - OPERATING - OTHER - SHIPPING example: SHIPPING readOnly: true type: string city: description: City example: New York type: string country_code: description: ISO-3166-1 Alpha-2 country code example: US pattern: ^[A-Z]{2}$ type: string id: $ref: '#/components/schemas/id' is_registered_agent: description: >- Indicates whether an address is a registered agent. Omitted if the address is not a registered agent. example: true type: boolean nickname: description: > A nickname for the address. This is used to identify the address in the UI. example: Home type: string postal_code: description: > 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. example: '28620' type: string state: description: > 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. example: NY type: string required: - address_line_1 - country_code type: object has_accounts: description: This flag indicates whether the person or business has accounts. readOnly: true type: boolean is_customer: description: > 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. example: true type: boolean legal_address: allOf: - description: Legal address - $ref: '#/components/schemas/address' metadata: description: > Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data. type: object spend_control_ids1: description: List of spend control IDs to control spending for the customer items: example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string maxItems: 100 type: array tenant_id: description: > The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces. example: abcdef_ghijkl type: string verification_status: description: > 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. enum: - ACCEPTED - PENDING - PROVISIONAL - REJECTED - REVIEW - UNVERIFIED example: ACCEPTED readOnly: true type: string party_loanpro_vendor_data: description: LoanPro-specific vendor data properties: customer_id: description: LoanPro customer ID example: 12345 format: int64 minimum: 1 type: integer required: - customer_id type: object id: description: The unique identifier for this resource. example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true type: string responses: unauthorized: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Forbidden error internal_server_error: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````