Patch business

patch https://api-sandbox.synctera.com/v0/businesses/{business_id}

Update business by ID.

Path Params

business_id

string

required

Business's unique identifier.

Body Params

compliance_restrictions

array of strings

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.

compliance_restrictions

ein

string

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

string

Business's email.

entity_name

string

Business's legal name.

formation_date

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

is_customer

boolean

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.

legal_address

object

Legal address

metadata

object

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.

status

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.

structure

string

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

array of strings

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

trade_names

website

string

Business's website.

Headers

Idempotency-Key

string

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.

Responses

Response body

object

addresses

array of objects

All of the customer's addresses

addresses

object

address_line_1

string

required

Street address line 1

address_line_2

string

Street address line 2

address_type

string

Specifies the address type.

BILLING LEGAL OPERATING OTHER SHIPPING

city

string

City

country_code

string

required

ISO-3166-1 Alpha-2 country code

string

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

array of strings

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

classifications

compliance_restrictions

array of strings

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.

compliance_restrictions

creation_time

date-time

The date and time the resource was created.

customer_active

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.

string

Business's email.

entity_name

string

Business's legal name.

formation_date

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.

string

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

date-time

The date and time the resource was last updated.

legal_address

object

Legal address

address_line_1

string

required

Street address line 1

address_line_2

string

Street address line 2

address_type

string

Specifies the address type.

BILLING LEGAL OPERATING OTHER SHIPPING

city

string

City

country_code

string

required

ISO-3166-1 Alpha-2 country code

string

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

metadata

object

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

Has additional fields

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.

status

string

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.

ACTIVE CANCELLED CONVERTED DISSOLVED FROZEN INACTIVE MERGED PROSPECT SANCTION SUSPENDED

structure

string

Business's legal structure.

CORPORATION LLC NON_PROFIT OTHER PARTNERSHIP SOLE_PROPRIETORSHIP S_CORPORATION

tenant

string

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

trade_names

array of strings

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

trade_names

verification_last_run

date-time

Date and time KYB verification was last run on the business.

verification_status

string

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.

ACCEPTED PENDING PROVISIONAL REJECTED REVIEW UNVERIFIED

website

string

Business's website.

Language

Credentials

Bearer

api_key

URL


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api-sandbox.synctera.com/v0/businesses/business_id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Updated business representation.

400BadRequest

401Unauthorized

403Forbidden error

404Resource not found

500Internal server error