> ## Documentation Index > Fetch the complete documentation index at: https://docs.worthai.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml patch /businesses/customers/{customerID} openapi: 3.1.0 info: title: Add Business description: This collection is for the Add Business of businesses. contact: {} version: '1.0' servers: - url: https://api.joinworth.com/case/api/v1 variables: {} security: [] tags: - name: Add Business paths: /businesses/customers/{customerID}: patch: tags: - Update Business summary: Update Business description: >- 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. operationId: UpdateBusiness parameters: - name: customerID in: path description: >- A unique identifier (UUID) representing the customer instance to PATCH into. required: true style: simple schema: type: string examples: - 1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d - name: businessID in: query description: A unique identifier (UUID) representing the business to update. required: false style: form schema: type: string examples: - 1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/ImportBusinessRequest' example: external_id: Dwight-business-specific-identifier-42dd22 name: Dunder Mifflin tin: '138519094' address_line_1: 2232 Harry Brooks Dr NW address_line_2: Suite 200 address_city: Scranton address_state: PA address_country: USA address_postal_code: '30318' mobile: '5043228579' official_website: https://dundermifflin.com naics_code: 424120 naics_title: Stationery and Office Supplies mcc_code: 5111 industry: Office Supplies is_monitoring_enabled: true applicant_id: 1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d send_invitation: true generate_invite_link: false applicant_first_name: Dwight applicant_last_name: Schrute applicant_email: dschrute@dundermifflin.com applicant_subrole_code: owner dba1_name: Michael Scott Paper Company address1_line_1: 1725 Slough Avenue address1_apartment: Closet address1_city: Scranton address1_state: PA address1_country: USA address1_postal_code: '18504' address1_mobile: '5551234567' year_created: 2021 annual_total_income: 20000 total_wages: 15000 annual_net_income: 5000 cost_of_goods_sold: 2000 total_liabilities: 1000 total_assets: 25000 total_equity: 24000 total_accounts_payable: 500 total_accounts_recievable: 1500 total_cash_and_cash_equivalents: 10000 total_short_term_investments: 0 total_current_assets: 11500 total_current_liabilities: 500 non_current_liablities: 500 annual_cost_of_goods_sold: 2000 annual_gross_profit: 18000 annual_taxes_paid: 1000 annual_interest_expenses: 0 number_of_employees: 15 business_type: Corporation sic_code: 5112 score_retrieval_date: '2026-04-07' business_liens: 0 business_liens_file_date: '2023-01-01' business_liens_status: none business_liens_status_date: '2023-01-01' business_bankruptcies: 0 business_bankruptcies_file_date: '2023-01-01' business_bankruptcies_chapter: none business_bankruptcies_voluntary: none business_bankruptcies_status: none business_bankruptcies_status_date: '2023-01-01' business_judgements: 0 business_judgements_file_date: '2023-01-01' business_judgements_status: none business_judgements_status_date: '2023-01-01' business_judgements_amount: 0 social_review_count: 45 social_review_score: 4.5 owner1_title: Manager owner1_first_name: Michael owner1_last_name: Scott owner1_email: gavin@bionicpanda.net owner1_mobile: '5043228579' owner1_ssn: '123456789' owner1_dob: '1992-10-08' owner1_address_line_1: 2232 Harry Brooks Dr NW owner1_address_line_2: Suite 100 owner1_address_city: Atlanta owner1_address_state: GA owner1_address_postal: '30318' owner1_address_country: USA owner1_owner_type: CONTROL owner1_ownership_percentage: 100 bank_account_number: '99909578' bank_name: Scranton Credit Union institution_name: Scranton Credit Union bank_routing_number: '211370150' bank_wire_routing_number: '211370151' bank_official_name: Scranton CU NA bank_account_type: checking bank_account_subtype: business bank_account_balance_current: 50000 bank_account_balance_available: 45000 bank_account_balance_limit: 5000 deposit_account: true bank_account_holder_type: business bank_account_holder_name: Dunder Mifflin npi: '1234567890' npi_first_name: Michael npi_last_name: Scott skip_credit_check: false bypass_ssn: false canada_business_number: 123456789 RC 0001 canada_corporate_id: '123456789' aging_config: thresholds: low: 7 medium: 14 high: 30 custom_messages: low: Please complete your application soon. medium: Your application requires immediate attention. high: Final notice to complete your application. required: true responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Tue, 26 Nov 2024 09:32:39 GMT Content-Length: content: text/plain: schema: type: string contentMediaType: text/plain example: '6426' Connection: content: text/plain: schema: type: string contentMediaType: text/plain example: keep-alive Content-Security-Policy: content: text/plain: schema: type: string contentMediaType: text/plain example: >- default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests Cross-Origin-Opener-Policy: content: text/plain: schema: type: string contentMediaType: text/plain example: same-origin Cross-Origin-Resource-Policy: content: text/plain: schema: type: string contentMediaType: text/plain example: same-origin Origin-Agent-Cluster: content: text/plain: schema: type: string contentMediaType: text/plain example: '?1' Referrer-Policy: content: text/plain: schema: type: string contentMediaType: text/plain example: no-referrer Strict-Transport-Security: content: text/plain: schema: type: string contentMediaType: text/plain example: max-age=15552000; includeSubDomains X-Content-Type-Options: content: text/plain: schema: type: string contentMediaType: text/plain example: nosniff X-DNS-Prefetch-Control: content: text/plain: schema: type: string contentMediaType: text/plain example: 'off' X-Download-Options: content: text/plain: schema: type: string contentMediaType: text/plain example: noopen X-Frame-Options: content: text/plain: schema: type: string contentMediaType: text/plain example: SAMEORIGIN X-Permitted-Cross-Domain-Policies: content: text/plain: schema: type: string contentMediaType: text/plain example: none X-XSS-Protection: content: text/plain: schema: type: string contentMediaType: text/plain example: '0' Vary: content: text/plain: schema: type: string contentMediaType: text/plain example: Origin Access-Control-Allow-Credentials: content: text/plain: schema: type: string contentMediaType: text/plain example: 'true' ETag: content: text/plain: schema: type: string contentMediaType: text/plain example: W/"191a-0Am+j4ht+QAJ79KNLWzQXPZxvAk" content: application/json; charset=utf-8: schema: allOf: - $ref: '#/components/schemas/Success' contentMediaType: application/json; charset=utf-8 example: status: success message: Bulk process succeeded data: runId: af6fbea4-5e7e-4f69-9652-e60af794fd63 result: '0': warnings: [] userID: a4a66475-3cca-45f0-ba7c-ffd6d28737a2 customerID: 1ced981d-5cf3-4cd9-adb9-97fba3c5677d businessID: e7c95c9b-54d1-40e0-ab84-da48d286885c riskMonitoring: false async: true applicantID: 020ba463-5283-4afb-bef5-a07b30b5715a controlOwner: 1 businessValidationResponse: Business Validated Successfully data_businesses: id: e7c95c9b-54d1-40e0-ab84-da48d286885c name: Duner Mifflin tin: XXXXX9094 mobile: '+15043228579' official_website: DunderMifflin.net public_website: null social_account: null address_line_1: 2232 Harry Brooks Dr NW address_line_2: null address_city: Scranton address_state: PA address_postal_code: '30318' address_country: US created_at: '2026-04-07T23:55:01.524Z' created_by: a4a66475-3cca-45f0-ba7c-ffd6d28737a2 updated_at: '2026-04-07T23:55:02.997Z' updated_by: a4a66475-3cca-45f0-ba7c-ffd6d28737a2 status: UNVERIFIED industry: null mcc_id: null naics_id: null naics_code: null naics_title: null mcc_code: null mcc_title: null external_id: null customer_id: null is_monitoring_enabled: null deleted_by: null deleted_at: null subscription: status: null created_at: null updated_at: null business_names: - name: Duner Mifflin is_primary: true business_addresses: - line_1: 2232 Harry Brooks Dr NW apartment: null city: Scranton state: PA country: US postal_code: '30318' mobile: '+15043228579' is_primary: true data_cases: - id: 6ffacd4d-9301-4d27-b684-1284aba8d3cc applicant_id: 020ba463-5283-4afb-bef5-a07b30b5715a customer_id: 1ced981d-5cf3-4cd9-adb9-97fba3c5677d business_id: e7c95c9b-54d1-40e0-ab84-da48d286885c status: 3 created_at: '2026-04-07T23:55:02.221Z' created_by: a4a66475-3cca-45f0-ba7c-ffd6d28737a2 updated_at: '2026-04-07T23:55:02.221Z' updated_by: a4a66475-3cca-45f0-ba7c-ffd6d28737a2 case_type: 1 assignee: null assigner: null customer_initiated: true owners: - id: a7f07a09-5cb9-4486-ae81-0b35c5c3af29 title: id: 16 title: Owner first_name: Michael last_name: Scott ssn: XXXXX6789 email: gavin@bionicpanda.net mobile: '+15043228579' date_of_birth: 1992-XX-XX address_apartment: null address_line_1: 2232 Harry Brooks Dr NW address_line_2: null address_city: Atlanta address_state: GA address_postal_code: '30318' address_country: US created_at: '2026-04-07T23:55:03.138Z' created_by: a4a66475-3cca-45f0-ba7c-ffd6d28737a2 updated_at: '2026-04-07T23:55:03.138Z' updated_by: a4a66475-3cca-45f0-ba7c-ffd6d28737a2 business_id: e7c95c9b-54d1-40e0-ab84-da48d286885c owner_type: CONTROL ownership_percentage: '0.00' external_id: null last_four_of_ssn: '6789' year_of_birth: '1992' integration_data: dba1_name: null dba2_name: null dba3_name: null dba4_name: null dba5_name: null address1_line_1: null address2_line_1: null address3_line_1: null address4_line_1: null address5_line_1: null address1_apartment: null address2_apartment: null address3_apartment: null address4_apartment: null address5_apartment: null address1_city: null address2_city: null address3_city: null address4_city: null address5_city: null address1_state: null address2_state: null address3_state: null address4_state: null address5_state: null address1_country: null address2_country: null address3_country: null address4_country: null address5_country: null address1_postal_code: null address2_postal_code: null address3_postal_code: null address4_postal_code: null address5_postal_code: null address1_mobile: null address2_mobile: null address3_mobile: null address4_mobile: null address5_mobile: null id: null name: Duner Mifflin tin: '138519094' address_line_1: 2232 Harry Brooks Dr NW address_line_2: null address_city: Scranton state: PA address_country: null address_postal_code: '30318' mobile: '15043228579' official_website: DunderMifflin.net naics_code: null naics_title: null mcc_code: null industry: null quick_add: null skip_credit_check: null bypass_ssn: null is_corporate_entity: null aging_config: null external_id: Dwight-business-specific-identifier-42dd22 metadata: null owner1_id: null owner2_id: null owner3_id: null owner4_id: null owner5_id: null owner1_title: Owner owner2_title: null owner3_title: null owner4_title: null owner5_title: null owner1_first_name: Michael owner2_first_name: null owner3_first_name: null owner4_first_name: null owner5_first_name: null owner1_last_name: Scott owner2_last_name: null owner3_last_name: null owner4_last_name: null owner5_last_name: null owner1_email: gavin@bionicpanda.net owner2_email: null owner3_email: null owner4_email: null owner5_email: null owner1_mobile: '15043228579' owner2_mobile: null owner3_mobile: null owner4_mobile: null owner5_mobile: null owner1_ssn: '123456789' owner2_ssn: null owner3_ssn: null owner4_ssn: null owner5_ssn: null owner1_dob: '1992-10-08' owner2_dob: null owner3_dob: null owner4_dob: null owner5_dob: null owner1_address_line_1: 2232 Harry Brooks Dr NW owner2_address_line_1: null owner3_address_line_1: null owner4_address_line_1: null owner5_address_line_1: null owner1_address_line_2: null owner2_address_line_2: null owner3_address_line_2: null owner4_address_line_2: null owner5_address_line_2: null owner1_address_city: Atlanta owner2_address_city: null owner3_address_city: null owner4_address_city: null owner5_address_city: null owner1_address_state: GA owner2_address_state: null owner3_address_state: null owner4_address_state: null owner5_address_state: null owner1_address_postal: '30318' owner2_address_postal: null owner3_address_postal: null owner4_address_postal: null owner5_address_postal: null owner1_address_country: null owner2_address_country: null owner3_address_country: null owner4_address_country: null owner5_address_country: null owner1_owner_type: CONTROL owner2_owner_type: null owner3_owner_type: null owner4_owner_type: null owner5_owner_type: null owner1_ownership_percentage: null owner2_ownership_percentage: null owner3_ownership_percentage: null owner4_ownership_percentage: null owner5_ownership_percentage: null owner1_external_id: null owner2_external_id: null owner3_external_id: null owner4_external_id: null owner5_external_id: null send_invitation: null applicant_first_name: null applicant_last_name: null applicant_email: null generate_invite_link: null applicant_subrole_code: null year: 2021 npi_provider_number: null npi_first_name: null npi_last_name: null canada_business_number: null canada_corporate_id: null is_revenue: 20000 is_operatingexpenses: null is_netincome: null is_cost_of_goods_sold: null bs_totalliabilities: null bs_totalassets: null bs_totalequity: null bs_accountspayable: null bs_accountsreceivable: null bs_cashandcashequivalents: null bs_shortterminvestments: null bs_totalcurrentassets: null bs_totalcurrentliabilities: null bs_totalnoncurrentliabilities: null is_costofgoodsold: null is_grossprofit: null is_incometaxexpense: null is_interestexpense: null number_of_employees: null business_type: null sic_code: null date_of_observation: null lien_count: null business_liens_file_date: null business_liens_status: null business_liens_status_date: null bankruptcy_count: null business_bankruptcies_file_date: null business_bankruptcies_chapter: null business_bankruptcies_voluntary: null business_bankruptcies_status: null business_bankruptcies_status_date: null judgement_count: null business_judgements_file_date: null business_judgements_status: null business_judgements_status_date: null business_judgements_amount: null review_cnt: null review_score: null bank_account_number: '99909578' bank_name: null institution_name: null bank_routing_number: '211370150' bank_wire_routing_number: null bank_official_name: null bank_account_type: null bank_account_subtype: Checking bank_account_balance_current: null bank_account_balance_available: null bank_account_balance_limit: null deposit_account: null bank_account_holder_type: null bank_account_holder_name: null general_monthly_volume: null general_annual_volume: null general_average_ticket_size: null general_high_ticket_size: null general_desired_limit: null monthly_occurrence_of_high_ticket: null explanation_of_high_ticket: null visa_mastercard_discover_monthly_volume: null visa_mastercard_discover_annual_volume: null visa_mastercard_discover_average_ticket_size: null visa_mastercard_discover_high_ticket_size: null visa_mastercard_discover_desired_limit: null american_express_monthly_volume: null american_express_annual_volume: null american_express_average_ticket_size: null american_express_high_ticket_size: null american_express_desired_limit: null is_seasonal_business: null high_volume_months: null explanation_of_high_volume_months: null swiped_cards: null typed_cards: null e_commerce: null mail_telephone: null /^custom:.*/: null business_customer: business_id: e7c95c9b-54d1-40e0-ab84-da48d286885c customer_id: 1ced981d-5cf3-4cd9-adb9-97fba3c5677d created_at: '2026-04-07T23:55:03.124Z' created_by: a4a66475-3cca-45f0-ba7c-ffd6d28737a2 is_monitoring_enabled: false external_id: Dwight-business-specific-identifier-42dd22 metadata: null '400': description: Bad Request headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Tue, 26 Nov 2024 09:33:10 GMT Content-Length: content: text/plain: schema: type: string contentMediaType: text/plain example: '328' Connection: content: text/plain: schema: type: string contentMediaType: text/plain example: keep-alive Content-Security-Policy: content: text/plain: schema: type: string contentMediaType: text/plain example: >- default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests Cross-Origin-Opener-Policy: content: text/plain: schema: type: string contentMediaType: text/plain example: same-origin Cross-Origin-Resource-Policy: content: text/plain: schema: type: string contentMediaType: text/plain example: same-origin Origin-Agent-Cluster: content: text/plain: schema: type: string contentMediaType: text/plain example: '?1' Referrer-Policy: content: text/plain: schema: type: string contentMediaType: text/plain example: no-referrer Strict-Transport-Security: content: text/plain: schema: type: string contentMediaType: text/plain example: max-age=15552000; includeSubDomains X-Content-Type-Options: content: text/plain: schema: type: string contentMediaType: text/plain example: nosniff X-DNS-Prefetch-Control: content: text/plain: schema: type: string contentMediaType: text/plain example: 'off' X-Download-Options: content: text/plain: schema: type: string contentMediaType: text/plain example: noopen X-Frame-Options: content: text/plain: schema: type: string contentMediaType: text/plain example: SAMEORIGIN X-Permitted-Cross-Domain-Policies: content: text/plain: schema: type: string contentMediaType: text/plain example: none X-XSS-Protection: content: text/plain: schema: type: string contentMediaType: text/plain example: '0' Vary: content: text/plain: schema: type: string contentMediaType: text/plain example: Origin Access-Control-Allow-Credentials: content: text/plain: schema: type: string contentMediaType: text/plain example: 'true' ETag: content: text/plain: schema: type: string contentMediaType: text/plain example: W/"148-/2HSFsAO91RX4rlW5j4SYEvc07k" content: application/json; charset=utf-8: schema: allOf: - $ref: '#/components/schemas/ErrorBadRequest1' contentMediaType: application/json; charset=utf-8 example: status: fail message: Bulk process had errors errorCode: null data: runId: 1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d failed_rows: '0': message: >- Error with 1 fields. First error: 'The business external ID already exists for this customer (business ID: 9d75fc32-6770-4586-8dd6-9a9a0b6596b2)' --- Please execute /validate first for more details data: {} result: {} '401': description: Unauthorized headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Tue, 26 Nov 2024 09:49:07 GMT Content-Length: content: text/plain: schema: type: string contentMediaType: text/plain example: '145' Connection: content: text/plain: schema: type: string contentMediaType: text/plain example: keep-alive Content-Security-Policy: content: text/plain: schema: type: string contentMediaType: text/plain example: >- default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests Cross-Origin-Opener-Policy: content: text/plain: schema: type: string contentMediaType: text/plain example: same-origin Cross-Origin-Resource-Policy: content: text/plain: schema: type: string contentMediaType: text/plain example: same-origin Origin-Agent-Cluster: content: text/plain: schema: type: string contentMediaType: text/plain example: '?1' Referrer-Policy: content: text/plain: schema: type: string contentMediaType: text/plain example: no-referrer Strict-Transport-Security: content: text/plain: schema: type: string contentMediaType: text/plain example: max-age=15552000; includeSubDomains X-Content-Type-Options: content: text/plain: schema: type: string contentMediaType: text/plain example: nosniff X-DNS-Prefetch-Control: content: text/plain: schema: type: string contentMediaType: text/plain example: 'off' X-Download-Options: content: text/plain: schema: type: string contentMediaType: text/plain example: noopen X-Frame-Options: content: text/plain: schema: type: string contentMediaType: text/plain example: SAMEORIGIN X-Permitted-Cross-Domain-Policies: content: text/plain: schema: type: string contentMediaType: text/plain example: none X-XSS-Protection: content: text/plain: schema: type: string contentMediaType: text/plain example: '0' Vary: content: text/plain: schema: type: string contentMediaType: text/plain example: Origin Access-Control-Allow-Credentials: content: text/plain: schema: type: string contentMediaType: text/plain example: 'true' ETag: content: text/plain: schema: type: string contentMediaType: text/plain example: W/"91-HsCbOafj9k+6lDkP+i911e5MFNs" content: application/json; charset=utf-8: schema: allOf: - 96161ab6-9000-449c-8a5a-dcbd17358692 contentMediaType: application/json; charset=utf-8 example: status: fail message: Authorization header not present errorCode: UNAUTHENTICATED data: errorName: AuthenticationMiddlewareError deprecated: false security: - bearer: [] components: schemas: ImportBusinessRequest: title: ImportBusinessRequest required: - name type: object properties: external_id: type: string description: >- 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 name: type: string description: The official business name. example: Acme Corporation tin: type: string description: >- Taxpayer Identification Number issued by the government. Nine numeric digits with or without dash(es). example: '123456789' address_line_1: type: string description: Primary street address of the business. example: 123 Main St address_line_2: type: string description: Secondary address information (suite, apt, etc.). example: Suite 400 address_city: type: string description: City of the business address. example: Metropolis address_state: type: string description: State or region of the business address. example: NY address_country: type: string description: Country of the business address. example: USA address_postal_code: type: string description: Postal or ZIP code for the business address. example: '10101' mobile: type: string description: Company's primary contact number. example: '5551234567' official_website: type: string description: URL of the company's official website. example: https://www.acme-corp.com naics_code: type: number description: >- North American Industry Classification System code. To find a particular code, please use https://www.naics.com/search/ example: 541330 naics_title: type: string description: Title corresponding to the NAICS code. example: Engineering Services mcc_code: type: number description: Merchant Category Code used for classifying business activities. example: 1234 industry: type: string description: General industry classification. example: Finance and Insurance is_monitoring_enabled: type: boolean description: Whether ongoing monitoring is enabled for this business. example: true applicant_id: type: string description: Identifier for the loan or service applicant. example: 1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d send_invitation: type: boolean description: Whether to send an invitation email to the applicant. example: false generate_invite_link: type: boolean description: Whether to generate an invite link for the applicant. example: false applicant_first_name: type: string description: First name of the applicant. example: John applicant_last_name: type: string description: Last name of the applicant. example: Doe applicant_email: type: string description: Email address of the applicant. example: john.doe@example.com applicant_subrole_code: type: string description: Subrole code of the applicant. example: owner enum: - owner - user dba1_name: type: string description: >- "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: type: string description: >- 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: type: string description: Apartment or suite number for the DBA address. example: Apt 12B address1_city: type: string description: City for the DBA address. example: Gotham address1_state: type: string description: State for the DBA address (Two-letter abbreviation). example: CA address1_country: type: string description: Country for the DBA address. example: USA address1_postal_code: type: string description: Postal code for the DBA address. example: '90210' address1_mobile: type: string description: Contact number for the DBA location. example: '5559876543' year_created: type: number description: Year the business was established. example: 2015 annual_total_income: type: number description: Total revenue in the last fiscal year. example: 500000 total_wages: type: number description: Total wages paid to employees last year. example: 200000 annual_net_income: type: number description: Net profit after expenses last year. example: 300000 cost_of_goods_sold: type: number description: Direct costs attributable to goods sold. example: 150000 total_liabilities: type: number description: Sum of all current and non-current liabilities. example: 100000 total_assets: type: number description: Sum of all current and non-current assets. example: 600000 total_equity: type: number description: Sum of all current equity. example: 500000 total_accounts_payable: type: number description: Amount owed to suppliers and vendors. example: 25000 total_accounts_recievable: type: number description: Outstanding amounts owed by customers. example: 30000 total_cash_and_cash_equivalents: type: number description: Liquid assets on hand. example: 50000 total_short_term_investments: type: number description: Investments easily convertible to cash within a year. example: 10000 total_current_assets: type: number description: Assets expected to be used or sold within one year. example: 120000 total_current_liabilities: type: number description: Obligations due within one year. example: 40000 non_current_liablities: type: number description: Long-term obligations not due within one year. example: 60000 annual_cost_of_goods_sold: type: number description: COGS aggregated over the fiscal year. example: 150000 annual_gross_profit: type: number description: Revenue minus cost of goods sold. example: 350000 annual_taxes_paid: type: number description: Total taxes paid in the fiscal year. example: 50000 annual_interest_expenses: type: number description: Interest paid on debts during the year. example: 10000 number_of_employees: type: number description: Total full-time equivalent employees. example: 25 business_type: type: string description: Legal structure of the business. example: LLC sic_code: type: number description: >- Standard Industrial Classification code. Codes may be found here: https://www.osha.gov/data/sic-search example: 5812 score_retrieval_date: type: string description: Date on which credit or risk score was fetched. example: '2025-06-16' business_liens: type: number business_liens_file_date: type: string business_liens_status: type: string business_liens_status_date: type: string business_bankruptcies: type: number business_bankruptcies_file_date: type: string business_bankruptcies_chapter: type: string business_bankruptcies_voluntary: type: string business_bankruptcies_status: type: string business_bankruptcies_status_date: type: string business_judgements: type: number business_judgements_file_date: type: string business_judgements_status: type: string business_judgements_status_date: type: string business_judgements_amount: type: number social_review_count: type: number social_review_score: type: number owner1_title: type: string description: >- 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.). example: Partner enum: - 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 owner1_external_id: type: string description: External ID of the first owner. example: abc123 owner1_first_name: type: string description: First name of the first owner. example: Jane owner1_last_name: type: string description: Last name of the first owner. example: Smith owner1_email: type: string description: Email of the first owner. example: jane.smith@example.com owner1_mobile: type: string description: Mobile phone of the first owner. example: +1-555-765-4321 owner1_ssn: type: string description: Social Security Number of the first owner. example: '123456789' owner1_dob: type: string description: Date of birth of the first owner. example: '1980-01-01' owner1_address_line_1: type: string description: Primary street address of the first owner. example: 789 Oak Ave owner1_address_line_2: type: string description: Secondary address information for the first owner. example: Floor 2 owner1_address_city: type: string description: City for the first owner’s address. example: Star City owner1_address_state: type: string description: State for the first owner’s address. example: IL owner1_address_postal: type: string description: Postal code for the first owner’s address. example: '60601' owner1_address_country: type: string description: Country for the first owner’s address. example: USA owner1_owner_type: type: string enum: - BENEFICIARY - CONTROL description: >- Role of the first owner (beneficiary or controlling party). Only one owner may be of type CONTROL example: BENEFICIARY owner1_ownership_percentage: type: number description: Percentage ownership held by the first owner. example: 100 bank_account_number: type: string description: Identifier for the company’s bank account. example: '000123456789' bank_name: type: string description: Name of the bank where the account is held. example: First National Bank institution_name: type: string description: Official institution name for banking relationships. example: Acme Financial Institution bank_routing_number: type: string description: ABA routing number for the bank. example: '111000025' bank_wire_routing_number: type: string description: Wire transfer routing number. example: '111000026' bank_official_name: type: string description: Legal name of the bank entity. example: First National Bank, NA bank_account_type: type: string description: Type of bank account. example: checking bank_account_subtype: type: string description: Subtype of the bank account. example: business bank_account_balance_current: type: number description: Current recorded balance of the account. example: 250000 bank_account_balance_available: type: number description: Available balance for withdrawal. example: 240000 bank_account_balance_limit: type: number description: Overdraft or credit limit on the account. example: 5000 deposit_account: type: boolean description: Whether this account is used for deposits. example: true bank_account_holder_type: type: string description: Type of the bank account holder. example: business enum: - business - personal bank_account_holder_name: type: string description: Name of the bank account holder. example: John Doe npi: type: string description: National Provider Identifier (for healthcare entities). example: '1234567890' npi_first_name: type: string description: First name of the NPI holder. example: John npi_last_name: type: string description: Last name of the NPI holder. example: Doe skip_credit_check: type: boolean description: >- 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: type: boolean description: Whether to bypass the Social Security Number check. example: false canada_business_number: type: string description: Canada Business Number (for Canadian businesses). example: 123456789 RC 0001 canada_corporate_id: type: string description: Name of the Canadian business. example: '123456789' aging_config: type: object description: >- 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. properties: thresholds: type: object properties: low: type: integer minimum: 0 medium: type: integer minimum: 0 high: type: integer minimum: 0 custom_messages: type: object properties: low: type: string medium: type: string high: type: string examples: [] Success: title: Success type: object properties: status: type: string message: type: string data: $ref: '#/components/schemas/Data' examples: [] ErrorBadRequest1: title: ErrorBadRequest1 type: object properties: status: type: string message: type: string errorCode: type: - string - 'null' data: $ref: '#/components/schemas/Data3' examples: [] Data: title: Data type: object properties: runId: type: string result: type: object additionalProperties: $ref: '#/components/schemas/Record' description: '' examples: [] Data3: title: Data3 type: object properties: runId: type: string failed_rows: type: object additionalProperties: $ref: '#/components/schemas/generatedObject1' result: type: object examples: [] Record: title: Record type: object properties: warnings: type: array items: type: string description: >- List of warning messages (e.g., missing fields for optional enrichment features). userID: type: string description: Identifier for the user who initiated the request. customerID: type: string description: Identifier for the customer. businessID: type: - string - 'null' description: >- Identifier for the created or matched business. May be null when processing asynchronously. applicantID: type: string description: Identifier for the applicant associated with this business. riskMonitoring: type: boolean description: Whether risk monitoring is enabled for this business. async: type: boolean description: Whether the request was processed asynchronously. data_businesses: $ref: '#/components/schemas/DataBusinesses' data_cases: type: array items: $ref: '#/components/schemas/DataCases' description: >- Array of case objects associated with the business. For PATCH requests, this may be a single object rather than an array. owners: type: array items: $ref: '#/components/schemas/Owner' description: Array of owner objects associated with the business. integration_data: $ref: '#/components/schemas/IntegrationData' business_customer: $ref: '#/components/schemas/BusinessCustomer' examples: [] generatedObject1: title: generatedObject1 type: object properties: message: type: string data: type: object examples: [] DataBusinesses: title: DataBusinesses type: object properties: id: type: string name: type: string tin: type: string address_line_1: type: string address_line_2: type: - string - 'null' address_city: type: string address_state: type: string address_postal_code: type: string address_country: type: - string - 'null' created_at: type: string created_by: type: string updated_at: type: string updated_by: type: string mobile: type: - string - 'null' official_website: type: - string - 'null' public_website: type: - string - 'null' social_account: type: - string - 'null' status: type: string industry: type: - object - 'null' properties: id: type: number name: type: string code: type: string sector_code: type: string created_at: type: string updated_at: type: string mcc_id: type: - number - 'null' naics_id: type: - number - 'null' naics_code: type: - number - 'null' naics_title: type: - string - 'null' mcc_code: type: - number - 'null' mcc_title: type: - string - 'null' external_id: type: - string - 'null' description: The unique external identifier provided during business creation. customer_id: type: - string - 'null' description: Identifier for the customer. is_monitoring_enabled: type: - boolean - 'null' deleted_by: type: - string - 'null' deleted_at: type: - string - 'null' subscription: $ref: '#/components/schemas/Subscription' business_names: type: array items: $ref: '#/components/schemas/BusinessName' description: '' business_addresses: type: array items: $ref: '#/components/schemas/BusinessAddress' description: '' examples: [] DataCases: title: DataCases type: object properties: id: type: string applicant_id: type: string customer_id: type: string status: type: integer contentEncoding: int32 created_at: type: string created_by: type: string updated_at: type: string updated_by: type: string business_id: type: string case_type: type: integer contentEncoding: int32 assignee: type: - string - 'null' assigner: type: - string - 'null' customer_initiated: type: boolean examples: [] Owner: title: Owner type: object properties: id: type: string description: Unique owner identifier. external_id: type: - string - 'null' description: External ID of the owner. title: type: - object - 'null' description: Owner title structure. properties: id: type: integer title: type: string first_name: type: - string - 'null' description: Owner first name. last_name: type: - string - 'null' description: Owner last name. ssn: type: - string - 'null' description: Social Security Number (encrypted). email: type: - string - 'null' description: Owner email address. mobile: type: - string - 'null' description: Owner mobile phone number. date_of_birth: type: - string - 'null' description: Date of birth in ISO 8601 format. address_apartment: type: - string - 'null' description: Apartment or suite number. address_line_1: type: - string - 'null' description: Primary street address. address_line_2: type: - string - 'null' description: Secondary street address. address_city: type: - string - 'null' description: City. address_state: type: - string - 'null' description: State/province. address_postal_code: type: - string - 'null' description: Postal/ZIP code. address_country: type: - string - 'null' description: Country code. created_at: type: string description: Creation timestamp. created_by: type: - string - 'null' updated_at: type: string description: Last update timestamp. updated_by: type: - string - 'null' ownership_percentage: type: - number - string - 'null' description: Percentage of ownership (0-100). owner_type: type: - string - 'null' description: Role type (BENEFICIARY or CONTROL). IntegrationData: title: IntegrationData type: object properties: dba1_name: type: - string - 'null' dba2_name: type: - string - 'null' dba3_name: type: - string - 'null' dba4_name: type: - string - 'null' dba5_name: type: - string - 'null' address1_line_1: type: - string - 'null' address2_line_1: type: - string - 'null' address3_line_1: type: - string - 'null' address4_line_1: type: - string - 'null' address5_line_1: type: - string - 'null' address1_apartment: type: - string - 'null' address2_apartment: type: - string - 'null' address3_apartment: type: - string - 'null' address4_apartment: type: - string - 'null' address5_apartment: type: - string - 'null' address1_city: type: - string - 'null' address2_city: type: - string - 'null' address3_city: type: - string - 'null' address4_city: type: - string - 'null' address5_city: type: - string - 'null' state: type: - string - 'null' address1_country: type: - string - 'null' address2_country: type: - string - 'null' address3_country: type: - string - 'null' address4_country: type: - string - 'null' address5_country: type: - string - 'null' address1_postal_code: type: - string - 'null' address2_postal_code: type: - string - 'null' address3_postal_code: type: - string - 'null' address4_postal_code: type: - string - 'null' address5_postal_code: type: - string - 'null' address1_mobile: type: - string - 'null' address2_mobile: type: - string - 'null' address3_mobile: type: - string - 'null' address4_mobile: type: - string - 'null' address5_mobile: type: - string - 'null' id: type: - string - 'null' name: type: string tin: type: - string - 'null' address_line_1: type: - string - 'null' address_line_2: type: - string - 'null' address_city: type: - string - 'null' address_country: type: - string - 'null' address_postal_code: type: - string - 'null' mobile: type: - string - 'null' official_website: type: - string - 'null' naics_code: type: - number - 'null' - string naics_title: type: - string - 'null' mcc_code: type: - number - 'null' - string industry: type: - string - 'null' quick_add: type: - string - 'null' external_id: type: - string - 'null' metadata: type: - string - 'null' owner1_title: type: - string - 'null' owner2_title: type: - string - 'null' owner3_title: type: - string - 'null' owner4_title: type: - string - 'null' owner5_title: type: - string - 'null' owner1_external_id: type: - string - 'null' owner2_external_id: type: - string - 'null' owner3_external_id: type: - string - 'null' owner4_external_id: type: - string - 'null' owner5_external_id: type: - string - 'null' owner1_first_name: type: - string - 'null' owner2_first_name: type: - string - 'null' owner3_first_name: type: - string - 'null' owner4_first_name: type: - string - 'null' owner5_first_name: type: - string - 'null' owner1_last_name: type: - string - 'null' owner2_last_name: type: - string - 'null' owner3_last_name: type: - string - 'null' owner4_last_name: type: - string - 'null' owner5_last_name: type: - string - 'null' owner1_email: type: - string - 'null' owner2_email: type: - string - 'null' owner3_email: type: - string - 'null' owner4_email: type: - string - 'null' owner5_email: type: - string - 'null' owner1_mobile: type: - string - 'null' owner2_mobile: type: - string - 'null' owner3_mobile: type: - string - 'null' owner4_mobile: type: - string - 'null' owner5_mobile: type: - string - 'null' owner1_ssn: type: - string - 'null' owner2_ssn: type: - string - 'null' owner3_ssn: type: - string - 'null' owner4_ssn: type: - string - 'null' owner5_ssn: type: - string - 'null' owner1_dob: type: - string - 'null' owner2_dob: type: - string - 'null' owner3_dob: type: - string - 'null' owner4_dob: type: - string - 'null' owner5_dob: type: - string - 'null' owner1_address_line_1: type: - string - 'null' owner2_address_line_1: type: - string - 'null' owner3_address_line_1: type: - string - 'null' owner4_address_line_1: type: - string - 'null' owner5_address_line_1: type: - string - 'null' owner1_address_line_2: type: - string - 'null' owner2_address_line_2: type: - string - 'null' owner3_address_line_2: type: - string - 'null' owner4_address_line_2: type: - string - 'null' owner5_address_line_2: type: - string - 'null' owner1_address_city: type: - string - 'null' owner2_address_city: type: - string - 'null' owner3_address_city: type: - string - 'null' owner4_address_city: type: - string - 'null' owner5_address_city: type: - string - 'null' owner1_address_state: type: - string - 'null' owner2_address_state: type: - string - 'null' owner3_address_state: type: - string - 'null' owner4_address_state: type: - string - 'null' owner5_address_state: type: - string - 'null' owner1_address_postal: type: - string - 'null' owner2_address_postal: type: - string - 'null' owner3_address_postal: type: - string - 'null' owner4_address_postal: type: - string - 'null' owner5_address_postal: type: - string - 'null' owner1_address_country: type: - string - 'null' owner2_address_country: type: - string - 'null' owner3_address_country: type: - string - 'null' owner4_address_country: type: - string - 'null' owner5_address_country: type: - string - 'null' owner1_owner_type: type: - string - 'null' owner2_owner_type: type: - string - 'null' owner3_owner_type: type: - string - 'null' owner4_owner_type: type: - string - 'null' owner5_owner_type: type: - string - 'null' owner1_ownership_percentage: type: - string - 'null' owner2_ownership_percentage: type: - string - 'null' owner3_ownership_percentage: type: - string - 'null' owner4_ownership_percentage: type: - string - 'null' owner5_ownership_percentage: type: - string - 'null' send_invitation: type: - string - 'null' - boolean applicant_first_name: type: - string - 'null' applicant_last_name: type: - string - 'null' applicant_email: type: - string - 'null' year: type: - integer - string - 'null' is_revenue: type: - integer - number - 'null' contentEncoding: int32 is_operatingexpenses: type: - string - 'null' is_netincome: type: - string - 'null' is_cost_of_goods_sold: type: - string - 'null' bs_totalliabilities: type: - string - 'null' bs_totalassets: type: - string - 'null' bs_totalequity: type: - string - 'null' bs_accountspayable: type: - string - 'null' bs_accountsreceivable: type: - string - 'null' bs_cashandcashequivalents: type: - string - 'null' bs_shortterminvestments: type: - string - 'null' bs_totalcurrentassets: type: - string - 'null' bs_totalcurrentliabilities: type: - string - 'null' bs_totalnoncurrentliabilities: type: - string - 'null' is_costofgoodsold: type: - string - 'null' is_grossprofit: type: - string - 'null' is_incometaxexpense: type: - string - 'null' is_interestexpense: type: - string - 'null' number_of_employees: type: - string - 'null' business_type: type: - string - 'null' sic_code: type: - string - 'null' date_of_observation: type: - string - 'null' lien_count: type: - string - 'null' business_liens_file_date: type: - string - 'null' business_liens_status: type: - string - 'null' business_liens_status_date: type: - string - 'null' bankruptcy_count: type: - string - 'null' business_bankruptcies_file_date: type: - string - 'null' business_bankruptcies_chapter: type: - string - 'null' business_bankruptcies_voluntary: type: - string - 'null' business_bankruptcies_status: type: - string - 'null' business_bankruptcies_status_date: type: - string - 'null' judgement_count: type: - string - 'null' business_judgements_file_date: type: - string - 'null' business_judgements_status: type: - string - 'null' business_judgements_status_date: type: - string - 'null' business_judgements_amount: type: - string - 'null' review_cnt: type: - string - 'null' review_score: type: - string - 'null' bank_account_number: type: - string - 'null' bank_name: type: - string - 'null' institution_name: type: - string - 'null' bank_routing_number: type: - number - string - 'null' bank_wire_routing_number: type: - number - string - 'null' bank_official_name: type: - string - 'null' bank_account_type: type: - string - 'null' bank_account_subtype: type: - string - 'null' bank_account_balance_current: type: - number - string - 'null' bank_account_balance_available: type: - number - string - 'null' bank_account_balance_limit: type: - number - string - 'null' deposit_account: type: - boolean - string - 'null' npi_provider_number: type: - string - 'null' npi_first_name: type: - string - 'null' npi_last_name: type: - string - 'null' canada_business_number: type: - string - 'null' canada_corporate_id: type: - string - 'null' bank_account_holder_type: type: - string - 'null' bank_account_holder_name: type: - string - 'null' general_monthly_volume: type: - number - 'null' general_annual_volume: type: - number - 'null' general_average_ticket_size: type: - number - 'null' general_high_ticket_size: type: - number - 'null' general_desired_limit: type: - number - 'null' monthly_occurrence_of_high_ticket: type: - integer - 'null' explanation_of_high_ticket: type: - string - 'null' visa_mastercard_discover_monthly_volume: type: - number - 'null' visa_mastercard_discover_annual_volume: type: - number - 'null' visa_mastercard_discover_average_ticket_size: type: - number - 'null' visa_mastercard_discover_high_ticket_size: type: - number - 'null' visa_mastercard_discover_desired_limit: type: - number - 'null' american_express_monthly_volume: type: - number - 'null' american_express_annual_volume: type: - number - 'null' american_express_average_ticket_size: type: - number - 'null' american_express_high_ticket_size: type: - number - 'null' american_express_desired_limit: type: - number - 'null' is_seasonal_business: type: - boolean - 'null' high_volume_months: type: - string - 'null' explanation_of_high_volume_months: type: - string - 'null' swiped_cards: type: - number - 'null' typed_cards: type: - number - 'null' e_commerce: type: - number - 'null' mail_telephone: type: - number - 'null' /^custom:.*/: type: - string - 'null' examples: [] BusinessCustomer: title: BusinessCustomer type: object properties: business_id: type: string customer_id: type: string created_at: type: string created_by: type: string is_monitoring_enabled: type: boolean external_id: type: string metadata: type: - string - 'null' examples: [] Subscription: title: Subscription type: object properties: status: type: - string - 'null' created_at: type: - string - 'null' updated_at: type: - string - 'null' examples: [] BusinessName: title: BusinessName type: object properties: name: type: string is_primary: type: boolean examples: - name: Test Business is_primary: false BusinessAddress: title: BusinessAddress type: object properties: line_1: type: string apartment: type: - string - 'null' city: type: string state: type: string country: type: string postal_code: type: string mobile: type: - string - 'null' is_primary: type: boolean examples: [] securitySchemes: bearer: type: http scheme: bearer ````