GET
/
businesses
List business
curl --request GET \
  --url https://api-sandbox.synctera.com/v0/businesses \
  --header 'Authorization: Bearer <token>'
{
  "next_page_token": "a8937a0d",
  "businesses": [
    {
      "addresses": [
        {
          "address_line_1": "100 Main St.",
          "address_line_2": "Suite 99",
          "address_type": "SHIPPING",
          "city": "New York",
          "country_code": "US",
          "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "nickname": "Home",
          "postal_code": "28620",
          "state": "NY"
        }
      ],
      "compliance_restrictions": [
        "LICENSED_CANNABIS"
      ],
      "creation_time": "2010-05-06T12:23:34.321Z",
      "ein": "12-3456789",
      "email": "alice@example.com",
      "entity_name": "Apex Corporation",
      "formation_date": "2000-01-01",
      "formation_state": "NY",
      "has_accounts": true,
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "is_customer": true,
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "legal_address": {
        "address_line_1": "100 Main St.",
        "address_line_2": "Suite 99",
        "address_type": "SHIPPING",
        "city": "New York",
        "country_code": "US",
        "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
        "nickname": "Home",
        "postal_code": "28620",
        "state": "NY"
      },
      "metadata": {},
      "phone_number": "+14374570680",
      "status": "ACTIVE",
      "structure": "CORPORATION",
      "tenant": "abcdef_ghijkl",
      "trade_names": [
        "Apex",
        "Apex LLC",
        "CorporationID#77231"
      ],
      "verification_last_run": "2010-05-06T12:23:34.321Z",
      "verification_status": "ACCEPTED",
      "website": "https://example.com"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
is_customer
boolean

If true, show only customers. If false, show non-customer parties.

​
sort_by
enum<string>[]

Specifies the sort order for the returned businesses.

​
id
string<uuid>[]

Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

​
has_accounts
boolean

Filter on resources that have an account(s)

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

Example:

"+12065550100"

​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

​
status
enum<string>

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.
Available options:
ACTIVE,
CANCELLED,
CONVERTED,
DISSOLVED,
FROZEN,
INACTIVE,
MERGED,
PROSPECT,
SANCTION,
SUSPENDED
​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

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.

Example:

"Apex Corporation"

Response

200
application/json

List of businesses.

The response is of type object.