Update Business
Update an existing business record based on the provided details. One of businessID or external_id MUST be provided to identify a business to update.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
A unique identifier (UUID) representing the customer instance to PATCH into.
"1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d"
Query Parameters
A unique identifier (UUID) representing the business to update.
"1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d"
Body
The official business name.
"Acme Corporation"
A unique identifier for this record off of Worth's platform, sometimes from other, external systems. Spaces will be removed from the string.
"1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d"
Taxpayer Identification Number issued by the government. Nine numeric digits with or without dash(es).
"123456789"
Primary street address of the business.
"123 Main St"
Secondary address information (suite, apt, etc.).
"Suite 400"
City of the business address.
"Metropolis"
State or region of the business address.
"NY"
Country of the business address.
"USA"
Postal or ZIP code for the business address.
"10101"
Company's primary contact number.
"5551234567"
URL of the company's official website.
"https://www.acme-corp.com"
North American Industry Classification System code. To find a particular code, please use https://www.naics.com/search/
541330
Title corresponding to the NAICS code.
"Engineering Services"
Merchant Category Code used for classifying business activities.
1234
General industry classification.
"Finance and Insurance"
Whether ongoing monitoring is enabled for this business.
true
Identifier for the loan or service applicant.
"1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d"
Whether to send an invitation email to the applicant.
false
Whether to generate an invite link for the applicant.
false
First name of the applicant.
"John"
Last name of the applicant.
"Doe"
Email address of the applicant.
"john.doe@example.com"
Subrole code of the applicant.
owner, user "owner"
"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).
"Acme Trading"
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).
"456 Elm St"
Apartment or suite number for the DBA address.
"Apt 12B"
City for the DBA address.
"Gotham"
State for the DBA address (Two-letter abbreviation).
"CA"
Country for the DBA address.
"USA"
Postal code for the DBA address.
"90210"
Contact number for the DBA location.
"5559876543"
Year the business was established.
2015
Total revenue in the last fiscal year.
500000
Total wages paid to employees last year.
200000
Net profit after expenses last year.
300000
Direct costs attributable to goods sold.
150000
Sum of all current and non-current liabilities.
100000
Sum of all current and non-current assets.
600000
Sum of all current equity.
500000
Amount owed to suppliers and vendors.
25000
Outstanding amounts owed by customers.
30000
Liquid assets on hand.
50000
Investments easily convertible to cash within a year.
10000
Assets expected to be used or sold within one year.
120000
Obligations due within one year.
40000
Long-term obligations not due within one year.
60000
COGS aggregated over the fiscal year.
150000
Revenue minus cost of goods sold.
350000
Total taxes paid in the fiscal year.
50000
Interest paid on debts during the year.
10000
Total full-time equivalent employees.
25
Legal structure of the business.
"LLC"
Standard Industrial Classification code. Codes may be found here: https://www.osha.gov/data/sic-search
5812
Date on which credit or risk score was fetched.
"2025-06-16"
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.).
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 "Partner"
External ID of the first owner.
"abc123"
First name of the first owner.
"Jane"
Last name of the first owner.
"Smith"
Email of the first owner.
"jane.smith@example.com"
Mobile phone of the first owner.
"+1-555-765-4321"
Social Security Number of the first owner.
"123456789"
Date of birth of the first owner.
"1980-01-01"
Primary street address of the first owner.
"789 Oak Ave"
Secondary address information for the first owner.
"Floor 2"
City for the first owner’s address.
"Star City"
State for the first owner’s address.
"IL"
Postal code for the first owner’s address.
"60601"
Country for the first owner’s address.
"USA"
Role of the first owner (beneficiary or controlling party). Only one owner may be of type CONTROL
BENEFICIARY, CONTROL "BENEFICIARY"
Percentage ownership held by the first owner.
100
Identifier for the company’s bank account.
"000123456789"
Name of the bank where the account is held.
"First National Bank"
Official institution name for banking relationships.
"Acme Financial Institution"
ABA routing number for the bank.
"111000025"
Wire transfer routing number.
"111000026"
Legal name of the bank entity.
"First National Bank, NA"
Type of bank account.
"checking"
Subtype of the bank account.
"business"
Current recorded balance of the account.
250000
Available balance for withdrawal.
240000
Overdraft or credit limit on the account.
5000
Whether this account is used for deposits.
true
Type of the bank account holder.
business, personal "business"
Name of the bank account holder.
"John Doe"
National Provider Identifier (for healthcare entities).
"1234567890"
First name of the NPI holder.
"John"
Last name of the NPI holder.
"Doe"
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.
false
Whether to bypass the Social Security Number check.
false
Canada Business Number (for Canadian businesses).
"123456789 RC 0001"
Name of the Canadian business.
"123456789"
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.