Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Businesses

Create a business

Create a business who may act as a customer or a related business. You can then verify the identity of this customer and associate them with other people and accounts.

post/businesses

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Request body

classificationsClassification[]

Specifies the classification of a party for banks. This may contain multiple values for a combined classifications list of customers.

compliance_restrictionsstring[]

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_timestring date-time

The date and time the resource was created.

customer_activestring date-time

The date and time this business became a bank customer.

einstring

U.S. Employer Identification Number (EIN) for this business, in the format xx-xxxxxxx.

emailstring

Business's email.

entity_namestring

Business's legal name.

formation_datestring date

Date the business was legally registered in RFC 3339 full-date format (YYYY-MM-DD).

formation_statestring

U.S. state where the business is legally registered (2-letter abbreviation).

has_accountsboolean

This flag indicates whether the person or business has accounts.

idstring uuid

Business's unique identifier.

is_customerboolean 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_timestring date-time

The date and time the resource was last updated.

metadataMetadata

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

phone_numberstring

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_idsstring[]

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.

tenantstring

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

trade_namesstring[]

All registered 'doing business as' (DBA) or trade names for this business.

verification_last_runstring 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.
websitestring

Business's website.

Example request

{
  "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",
      "is_registered_agent": true,
      "nickname": "Home",
      "postal_code": "28620",
      "state": "NY"
    }
  ],
  "creation_time": "2010-05-06T12:23:34.321Z",
  "customer_active": "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",
  "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",
    "is_registered_agent": true,
    "nickname": "Home",
    "postal_code": "28620",
    "state": "NY"
  },
  "phone_number": "+14374570680",
  "spend_control_ids": [
    "7d943c51-e4ff-4e57-9558-08cab6b963c7"
  ],
  "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"
}

Response

The created business.

classificationsClassification[]

Specifies the classification of a party for banks. This may contain multiple values for a combined classifications list of customers.

compliance_restrictionsstring[]

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_timestring date-time

The date and time the resource was created.

customer_activestring date-time

The date and time this business became a bank customer.

einstring

U.S. Employer Identification Number (EIN) for this business, in the format xx-xxxxxxx.

emailstring

Business's email.

entity_namestring

Business's legal name.

formation_datestring date

Date the business was legally registered in RFC 3339 full-date format (YYYY-MM-DD).

formation_statestring

U.S. state where the business is legally registered (2-letter abbreviation).

has_accountsboolean

This flag indicates whether the person or business has accounts.

idstring uuid

Business's unique identifier.

is_customerboolean 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_timestring date-time

The date and time the resource was last updated.

metadataMetadata

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

phone_numberstring

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_idsstring[]

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.

tenantstring

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

trade_namesstring[]

All registered 'doing business as' (DBA) or trade names for this business.

verification_last_runstring 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.
websitestring

Business's website.

Example response

{
  "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",
      "is_registered_agent": true,
      "nickname": "Home",
      "postal_code": "28620",
      "state": "NY"
    }
  ],
  "creation_time": "2010-05-06T12:23:34.321Z",
  "customer_active": "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",
  "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",
    "is_registered_agent": true,
    "nickname": "Home",
    "postal_code": "28620",
    "state": "NY"
  },
  "phone_number": "+14374570680",
  "spend_control_ids": [
    "7d943c51-e4ff-4e57-9558-08cab6b963c7"
  ],
  "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",
  "vendor_info": {
    "vendor_data": {
      "loanpro": {
        "customer_id": 12345
      }
    }
  }
}