Skip to main content
PATCH
Update Business

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
customerID
string
required

A unique identifier (UUID) representing the customer instance to PATCH into.

Example:

"1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d"

Query Parameters

​
businessID
string

A unique identifier (UUID) representing the business to update.

Example:

"1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d"

Body

application/json
​
name
string
required

The official business name.

Example:

"Acme Corporation"

​
external_id
string

A unique identifier for this record off of Worth's platform, sometimes from other, external systems. Spaces will be removed from the string.

Example:

"1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d"

​
tin
string

Taxpayer Identification Number issued by the government. Nine numeric digits with or without dash(es).

Example:

"123456789"

​
address_line_1
string

Primary street address of the business.

Example:

"123 Main St"

​
address_line_2
string

Secondary address information (suite, apt, etc.).

Example:

"Suite 400"

​
address_city
string

City of the business address.

Example:

"Metropolis"

​
address_state
string

State or region of the business address.

Example:

"NY"

​
address_country
string

Country of the business address.

Example:

"USA"

​
address_postal_code
string

Postal or ZIP code for the business address.

Example:

"10101"

​
mobile
string

Company's primary contact number.

Example:

"5551234567"

​
official_website
string

URL of the company's official website.

Example:

"https://www.acme-corp.com"

​
naics_code
number

North American Industry Classification System code. To find a particular code, please use https://www.naics.com/search/

Example:

541330

​
naics_title
string

Title corresponding to the NAICS code.

Example:

"Engineering Services"

​
mcc_code
number

Merchant Category Code used for classifying business activities.

Example:

1234

​
industry
string

General industry classification.

Example:

"Finance and Insurance"

​
is_monitoring_enabled
boolean

Whether ongoing monitoring is enabled for this business.

Example:

true

​
applicant_id
string

Identifier for the loan or service applicant.

Example:

"1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d"

​
send_invitation
boolean

Whether to send an invitation email to the applicant.

Example:

false

​
generate_invite_link
boolean

Whether to generate an invite link for the applicant.

Example:

false

​
applicant_first_name
string

First name of the applicant.

Example:

"John"

​
applicant_last_name
string

Last name of the applicant.

Example:

"Doe"

​
applicant_email
string

Email address of the applicant.

Example:

"john.doe@example.com"

​
applicant_subrole_code
enum<string>

Subrole code of the applicant.

Available options:
owner,
user
Example:

"owner"

​
dba1_name
string

"Doing Business As" name, if different from legal name. Supports up to 5 DBAs using the pattern dba{n}_name (e.g., dba2_name, dba3_name).

Example:

"Acme Trading"

​
address1_line_1
string

Primary street address for an additional location. Supports up to 5 addresses using the pattern address{n}_{field} (e.g., address2_line_1, address3_city).

Example:

"456 Elm St"

​
address1_apartment
string

Apartment or suite number for the DBA address.

Example:

"Apt 12B"

​
address1_city
string

City for the DBA address.

Example:

"Gotham"

​
address1_state
string

State for the DBA address (Two-letter abbreviation).

Example:

"CA"

​
address1_country
string

Country for the DBA address.

Example:

"USA"

​
address1_postal_code
string

Postal code for the DBA address.

Example:

"90210"

​
address1_mobile
string

Contact number for the DBA location.

Example:

"5559876543"

​
year_created
number

Year the business was established.

Example:

2015

​
annual_total_income
number

Total revenue in the last fiscal year.

Example:

500000

​
total_wages
number

Total wages paid to employees last year.

Example:

200000

​
annual_net_income
number

Net profit after expenses last year.

Example:

300000

​
cost_of_goods_sold
number

Direct costs attributable to goods sold.

Example:

150000

​
total_liabilities
number

Sum of all current and non-current liabilities.

Example:

100000

​
total_assets
number

Sum of all current and non-current assets.

Example:

600000

​
total_equity
number

Sum of all current equity.

Example:

500000

​
total_accounts_payable
number

Amount owed to suppliers and vendors.

Example:

25000

​
total_accounts_recievable
number

Outstanding amounts owed by customers.

Example:

30000

​
total_cash_and_cash_equivalents
number

Liquid assets on hand.

Example:

50000

​
total_short_term_investments
number

Investments easily convertible to cash within a year.

Example:

10000

​
total_current_assets
number

Assets expected to be used or sold within one year.

Example:

120000

​
total_current_liabilities
number

Obligations due within one year.

Example:

40000

​
non_current_liablities
number

Long-term obligations not due within one year.

Example:

60000

​
annual_cost_of_goods_sold
number

COGS aggregated over the fiscal year.

Example:

150000

​
annual_gross_profit
number

Revenue minus cost of goods sold.

Example:

350000

​
annual_taxes_paid
number

Total taxes paid in the fiscal year.

Example:

50000

​
annual_interest_expenses
number

Interest paid on debts during the year.

Example:

10000

​
number_of_employees
number

Total full-time equivalent employees.

Example:

25

​
business_type
string

Legal structure of the business.

Example:

"LLC"

​
sic_code
number

Standard Industrial Classification code. Codes may be found here: https://www.osha.gov/data/sic-search

Example:

5812

​
score_retrieval_date
string

Date on which credit or risk score was fetched.

Example:

"2025-06-16"

​
business_liens
number
​
business_liens_file_date
string
​
business_liens_status
string
​
business_liens_status_date
string
​
business_bankruptcies
number
​
business_bankruptcies_file_date
string
​
business_bankruptcies_chapter
string
​
business_bankruptcies_voluntary
string
​
business_bankruptcies_status
string
​
business_bankruptcies_status_date
string
​
business_judgements
number
​
business_judgements_file_date
string
​
business_judgements_status
string
​
business_judgements_status_date
string
​
business_judgements_amount
number
​
social_review_count
number
​
social_review_score
number
​
owner1_title
enum<string>

Official title of the first owner. The API supports up to 5 owners using the pattern owner{n}_{field} (e.g., owner2_title, owner3_first_name, etc.).

Available options:
Partner,
Limited Partner,
Director,
Chief Accounting Officer,
Chief Executive Officer,
Chief Operations Officer,
President,
Vice President,
Treasurer,
Assistant Treasurer,
1% Shareholder,
Shareholder,
Controller,
Managing Member,
Owner,
Sole Proprietor,
Executor,
Beneficiary,
Trustee,
Administrator,
Assistant Secretary,
Authorized Person,
Chairman of the Board,
Chief Compliance Officer,
Chief Financial Officer,
Chief Legal Officer,
Chief Technology Officer,
Co-Founder,
Founder,
General Partner,
Managing Partner,
Manager,
Member,
Principal,
Registered Agent,
Secretary,
Chairperson
Example:

"Partner"

​
owner1_external_id
string

External ID of the first owner.

Example:

"abc123"

​
owner1_first_name
string

First name of the first owner.

Example:

"Jane"

​
owner1_last_name
string

Last name of the first owner.

Example:

"Smith"

​
owner1_email
string

Email of the first owner.

Example:

"jane.smith@example.com"

​
owner1_mobile
string

Mobile phone of the first owner.

Example:

"+1-555-765-4321"

​
owner1_ssn
string

Social Security Number of the first owner.

Example:

"123456789"

​
owner1_dob
string

Date of birth of the first owner.

Example:

"1980-01-01"

​
owner1_address_line_1
string

Primary street address of the first owner.

Example:

"789 Oak Ave"

​
owner1_address_line_2
string

Secondary address information for the first owner.

Example:

"Floor 2"

​
owner1_address_city
string

City for the first owner’s address.

Example:

"Star City"

​
owner1_address_state
string

State for the first owner’s address.

Example:

"IL"

​
owner1_address_postal
string

Postal code for the first owner’s address.

Example:

"60601"

​
owner1_address_country
string

Country for the first owner’s address.

Example:

"USA"

​
owner1_owner_type
enum<string>

Role of the first owner (beneficiary or controlling party). Only one owner may be of type CONTROL

Available options:
BENEFICIARY,
CONTROL
Example:

"BENEFICIARY"

​
owner1_ownership_percentage
number

Percentage ownership held by the first owner.

Example:

100

​
bank_account_number
string

Identifier for the company’s bank account.

Example:

"000123456789"

​
bank_name
string

Name of the bank where the account is held.

Example:

"First National Bank"

​
institution_name
string

Official institution name for banking relationships.

Example:

"Acme Financial Institution"

​
bank_routing_number
string

ABA routing number for the bank.

Example:

"111000025"

​
bank_wire_routing_number
string

Wire transfer routing number.

Example:

"111000026"

​
bank_official_name
string

Legal name of the bank entity.

Example:

"First National Bank, NA"

​
bank_account_type
string

Type of bank account.

Example:

"checking"

​
bank_account_subtype
string

Subtype of the bank account.

Example:

"business"

​
bank_account_balance_current
number

Current recorded balance of the account.

Example:

250000

​
bank_account_balance_available
number

Available balance for withdrawal.

Example:

240000

​
bank_account_balance_limit
number

Overdraft or credit limit on the account.

Example:

5000

​
deposit_account
boolean

Whether this account is used for deposits.

Example:

true

​
bank_account_holder_type
enum<string>

Type of the bank account holder.

Available options:
business,
personal
Example:

"business"

​
bank_account_holder_name
string

Name of the bank account holder.

Example:

"John Doe"

​
npi
string

National Provider Identifier (for healthcare entities).

Example:

"1234567890"

​
npi_first_name
string

First name of the NPI holder.

Example:

"John"

​
npi_last_name
string

Last name of the NPI holder.

Example:

"Doe"

​
skip_credit_check
boolean

OPTIONAL functionality when personal credit checks are enabled. A flag to indicate whether personal credit checks on the business owner should be skipped. Default is false.

Example:

false

​
bypass_ssn
boolean

Whether to bypass the Social Security Number check.

Example:

false

​
canada_business_number
string

Canada Business Number (for Canadian businesses).

Example:

"123456789 RC 0001"

​
canada_corporate_id
string

Name of the Canadian business.

Example:

"123456789"

​
aging_config
object

If enabled, the reminder thresholds and their severity set for applicant cases. If configured, a webhook event will be emitted with the custom messages at the specified allotted number of days.

Response

OK

​
status
string
​
message
string
​
data
Data · object