PATCH
/
businesses
/
customers
/
{customerID}
curl --request PATCH \
  --url https://api.joinworth.com/case/api/v1/businesses/customers/{customerID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "external_id": "77388994455034",
  "address_line_1": "480 s Ronald Reagan Blvd",
  "address_city": "Longwood",
  "address_state": "FL",
  "address_postal_code": "32850",
  "official_website": "https://abc.com"
}'
{
  "status": "success",
  "message": "Bulk process succeeded",
  "data": {
    "runId": "13267172-07d0-4483-932b-4d851441eab2",
    "result": {
      "0": {
        "warnings": [],
        "userID": "dc2bf5c0-8c39-41aa-b1f2-658991a0deb2",
        "customerID": "a2cdd2f9-bcb8-48d8-924b-7bf70d3f8a45",
        "riskMonitoring": true,
        "data_businesses": {
          "id": "1f19291e-2d2c-4f05-bf61-c7888383ae3f",
          "name": "Test Business",
          "tin": "XXXXX4685",
          "address_apartment": null,
          "address_line_1": "480 s Ronald Reagan Blvd",
          "address_line_2": null,
          "address_city": "Longwood",
          "address_state": "FL",
          "address_postal_code": "32850",
          "address_country": null,
          "created_at": "2024-11-26T09:32:35.719Z",
          "created_by": "dc2bf5c0-8c39-41aa-b1f2-658991a0deb2",
          "updated_at": "2024-11-26T09:32:39.814Z",
          "updated_by": "f83f60a0-55fc-4c30-a93b-8613f99a55e1",
          "mobile": null,
          "official_website": null,
          "public_website": null,
          "social_account": null,
          "status": "VERIFIED",
          "industry": null,
          "mcc_id": null,
          "naics_id": null,
          "naics_code": null,
          "naics_title": null,
          "mcc_code": null,
          "mcc_title": null,
          "is_monitoring_enabled": null,
          "subscription": {
            "status": null,
            "created_at": null,
            "updated_at": null
          },
          "business_names": [
            {
              "name": "Test Business",
              "is_primary": false
            },
            {
              "name": "Test Business",
              "is_primary": true
            }
          ],
          "business_addresses": [
            {
              "line_1": "480 s Ronald Reagan Blvd",
              "apartment": null,
              "city": "Longwood",
              "state": "FL",
              "country": "USA",
              "postal_code": "32850",
              "mobile": null,
              "is_primary": true
            }
          ]
        },
        "data_cases": {
          "id": "9068687a-3842-469f-84dd-bcd9dcc37ea3",
          "applicant_id": "f83f60a0-55fc-4c30-a93b-8613f99a55e1",
          "customer_id": "a2cdd2f9-bcb8-48d8-924b-7bf70d3f8a45",
          "status": 3,
          "created_at": "2024-11-26T09:32:38.620Z",
          "created_by": "f83f60a0-55fc-4c30-a93b-8613f99a55e1",
          "updated_at": "2024-11-26T09:32:38.620Z",
          "updated_by": "f83f60a0-55fc-4c30-a93b-8613f99a55e1",
          "business_id": "1f19291e-2d2c-4f05-bf61-c7888383ae3f",
          "case_type": 1,
          "assignee": null,
          "assigner": null
        },
        "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,
          "state": "FL",
          "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": "Test Business",
          "tin": "333444685",
          "address_line_1": "480 s Ronald Reagan Blvd",
          "address_line_2": null,
          "address_city": "Longwood",
          "address_country": null,
          "address_postal_code": "32850",
          "mobile": null,
          "official_website": null,
          "naics_code": null,
          "naics_title": null,
          "mcc_code": null,
          "industry": null,
          "quick_add": null,
          "external_id": "77388994455034",
          "metadata": null,
          "owner1_title": null,
          "owner2_title": null,
          "owner3_title": null,
          "owner4_title": null,
          "owner5_title": null,
          "owner1_first_name": null,
          "owner2_first_name": null,
          "owner3_first_name": null,
          "owner4_first_name": null,
          "owner5_first_name": null,
          "owner1_last_name": null,
          "owner2_last_name": null,
          "owner3_last_name": null,
          "owner4_last_name": null,
          "owner5_last_name": null,
          "owner1_email": null,
          "owner2_email": null,
          "owner3_email": null,
          "owner4_email": null,
          "owner5_email": null,
          "owner1_mobile": null,
          "owner2_mobile": null,
          "owner3_mobile": null,
          "owner4_mobile": null,
          "owner5_mobile": null,
          "owner1_ssn": null,
          "owner2_ssn": null,
          "owner3_ssn": null,
          "owner4_ssn": null,
          "owner5_ssn": null,
          "owner1_dob": null,
          "owner2_dob": null,
          "owner3_dob": null,
          "owner4_dob": null,
          "owner5_dob": null,
          "owner1_address_line_1": null,
          "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": null,
          "owner2_address_city": null,
          "owner3_address_city": null,
          "owner4_address_city": null,
          "owner5_address_city": null,
          "owner1_address_state": null,
          "owner2_address_state": null,
          "owner3_address_state": null,
          "owner4_address_state": null,
          "owner5_address_state": null,
          "owner1_address_postal": null,
          "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": null,
          "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,
          "send_invitation": null,
          "applicant_first_name": null,
          "applicant_last_name": null,
          "applicant_email": null,
          "year": null,
          "is_revenue": 1022233,
          "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": null,
          "bank_name": null,
          "institution_name": null,
          "bank_routing_number": null,
          "bank_wire_routing_number": null,
          "bank_official_name": null,
          "bank_account_type": null,
          "bank_account_subtype": null,
          "bank_account_balance_current": null,
          "bank_account_balance_available": null,
          "bank_account_balance_limit": null,
          "deposit_account": null
        },
        "business_customer": {
          "business_id": "1f19291e-2d2c-4f05-bf61-c7888383ae3f",
          "customer_id": "a2cdd2f9-bcb8-48d8-924b-7bf70d3f8a45",
          "created_at": "2024-11-26T09:32:39.870Z",
          "created_by": "dc2bf5c0-8c39-41aa-b1f2-658991a0deb2",
          "is_monitoring_enabled": true,
          "external_id": "77388994455034",
          "metadata": null
        }
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
customerID
string
required
Example:

"f17295d4-5237-4079-8b18-8786eddf49f3"

Body

application/json
​
external_id
string
required
​
address_line_1
string
​
address_line_2
string
​
address_city
string
​
address_state
string
​
address_country
string
​
address_postal_code
string
​
mobile
string
​
official_website
string
​
naics_code
number
​
naics_title
string
​
mcc_code
number
​
industry
string
​
is_monitoring_enabled
boolean
​
applicant_id
string
​
send_invitation
boolean
​
applicant_first_name
string
​
applicant_last_name
string
​
applicant_email
string
​
dba1_name
string
​
address1_line_1
string
​
address1_apartment
string
​
address1_city
string
​
address1_state
string
​
address1_country
string
​
address1_postal_code
string
​
address1_mobile
string
​
year_created
number
​
annual_total_income
number
​
total_wages
number
​
annual_net_income
number
​
cost_of_goods_sold
number
​
total_liabilities
number
​
total_assets
number
​
total_equity
number
​
total_accounts_payable
number
​
total_accounts_recievable
number
​
total_cash_and_cash_equivalents
number
​
total_short_term_investments
number
​
total_current_assets
number
​
total_current_liabilities
number
​
non_current_liablities
number
​
annual_cost_of_goods_sold
number
​
annual_gross_profit
number
​
annual_taxes_paid
number
​
annual_interest_expenses
number
​
number_of_employees
number
​
business_type
string
​
sic_code
number
​
score_retrieval_date
string
​
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
string
​
owner1_first_name
string
​
owner1_last_name
string
​
owner1_email
string
​
owner1_mobile
string
​
owner1_ssn
string
​
owner1_dob
string
​
owner1_address_line_1
string
​
owner1_address_line_2
string
​
owner1_address_city
string
​
owner1_address_state
string
​
owner1_address_postal
string
​
owner1_address_country
string
​
owner1_owner_type
string
​
owner1_ownership_percentage
number
​
bank_account_number
string
​
bank_name
string
​
institution_name
string
​
bank_routing_number
number
​
bank_wire_routing_number
number
​
bank_official_name
string
​
bank_account_type
string
​
bank_account_subtype
string
​
bank_account_balance_current
number
​
bank_account_balance_available
number
​
bank_account_balance_limit
number
​
deposit_account
boolean

Response

200
application/json; charset=utf-8
OK
​
status
string
required
​
message
string
required
​
data
object
required
Example:
{
  "runId": "13267172-07d0-4483-932b-4d851441eab2",
  "result": {
    "0": {
      "warnings": [],
      "userID": "dc2bf5c0-8c39-41aa-b1f2-658991a0deb2",
      "customerID": "a2cdd2f9-bcb8-48d8-924b-7bf70d3f8a45",
      "riskMonitoring": true,
      "data_businesses": {
        "id": "1f19291e-2d2c-4f05-bf61-c7888383ae3f",
        "name": "Test Business",
        "tin": "XXXXX4685",
        "address_apartment": null,
        "address_line_1": "480 s Ronald Reagan Blvd",
        "address_line_2": null,
        "address_city": "Longwood",
        "address_state": "FL",
        "address_postal_code": "32850",
        "address_country": null,
        "created_at": "2024-11-26T09:32:35.719Z",
        "created_by": "dc2bf5c0-8c39-41aa-b1f2-658991a0deb2",
        "updated_at": "2024-11-26T09:32:39.814Z",
        "updated_by": "f83f60a0-55fc-4c30-a93b-8613f99a55e1",
        "mobile": null,
        "official_website": null,
        "public_website": null,
        "social_account": null,
        "status": "VERIFIED",
        "industry": null,
        "mcc_id": null,
        "naics_id": null,
        "naics_code": null,
        "naics_title": null,
        "mcc_code": null,
        "mcc_title": null,
        "is_monitoring_enabled": null,
        "subscription": {
          "status": null,
          "created_at": null,
          "updated_at": null
        },
        "business_names": [
          {
            "name": "Test Business",
            "is_primary": false
          },
          {
            "name": "Test Business",
            "is_primary": true
          }
        ],
        "business_addresses": [
          {
            "line_1": "480 s Ronald Reagan Blvd",
            "apartment": null,
            "city": "Longwood",
            "state": "FL",
            "country": "USA",
            "postal_code": "32850",
            "mobile": null,
            "is_primary": true
          }
        ]
      },
      "data_cases": {
        "id": "9068687a-3842-469f-84dd-bcd9dcc37ea3",
        "applicant_id": "f83f60a0-55fc-4c30-a93b-8613f99a55e1",
        "customer_id": "a2cdd2f9-bcb8-48d8-924b-7bf70d3f8a45",
        "status": 3,
        "created_at": "2024-11-26T09:32:38.620Z",
        "created_by": "f83f60a0-55fc-4c30-a93b-8613f99a55e1",
        "updated_at": "2024-11-26T09:32:38.620Z",
        "updated_by": "f83f60a0-55fc-4c30-a93b-8613f99a55e1",
        "business_id": "1f19291e-2d2c-4f05-bf61-c7888383ae3f",
        "case_type": 1,
        "assignee": null,
        "assigner": null
      },
      "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,
        "state": "FL",
        "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": "Test Business",
        "tin": "333444685",
        "address_line_1": "480 s Ronald Reagan Blvd",
        "address_line_2": null,
        "address_city": "Longwood",
        "address_country": null,
        "address_postal_code": "32850",
        "mobile": null,
        "official_website": null,
        "naics_code": null,
        "naics_title": null,
        "mcc_code": null,
        "industry": null,
        "quick_add": null,
        "external_id": "77388994455034",
        "metadata": null,
        "owner1_title": null,
        "owner2_title": null,
        "owner3_title": null,
        "owner4_title": null,
        "owner5_title": null,
        "owner1_first_name": null,
        "owner2_first_name": null,
        "owner3_first_name": null,
        "owner4_first_name": null,
        "owner5_first_name": null,
        "owner1_last_name": null,
        "owner2_last_name": null,
        "owner3_last_name": null,
        "owner4_last_name": null,
        "owner5_last_name": null,
        "owner1_email": null,
        "owner2_email": null,
        "owner3_email": null,
        "owner4_email": null,
        "owner5_email": null,
        "owner1_mobile": null,
        "owner2_mobile": null,
        "owner3_mobile": null,
        "owner4_mobile": null,
        "owner5_mobile": null,
        "owner1_ssn": null,
        "owner2_ssn": null,
        "owner3_ssn": null,
        "owner4_ssn": null,
        "owner5_ssn": null,
        "owner1_dob": null,
        "owner2_dob": null,
        "owner3_dob": null,
        "owner4_dob": null,
        "owner5_dob": null,
        "owner1_address_line_1": null,
        "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": null,
        "owner2_address_city": null,
        "owner3_address_city": null,
        "owner4_address_city": null,
        "owner5_address_city": null,
        "owner1_address_state": null,
        "owner2_address_state": null,
        "owner3_address_state": null,
        "owner4_address_state": null,
        "owner5_address_state": null,
        "owner1_address_postal": null,
        "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": null,
        "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,
        "send_invitation": null,
        "applicant_first_name": null,
        "applicant_last_name": null,
        "applicant_email": null,
        "year": null,
        "is_revenue": 1022233,
        "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": null,
        "bank_name": null,
        "institution_name": null,
        "bank_routing_number": null,
        "bank_wire_routing_number": null,
        "bank_official_name": null,
        "bank_account_type": null,
        "bank_account_subtype": null,
        "bank_account_balance_current": null,
        "bank_account_balance_available": null,
        "bank_account_balance_limit": null,
        "deposit_account": null
      },
      "business_customer": {
        "business_id": "1f19291e-2d2c-4f05-bf61-c7888383ae3f",
        "customer_id": "a2cdd2f9-bcb8-48d8-924b-7bf70d3f8a45",
        "created_at": "2024-11-26T09:32:39.870Z",
        "created_by": "dc2bf5c0-8c39-41aa-b1f2-658991a0deb2",
        "is_monitoring_enabled": true,
        "external_id": "77388994455034",
        "metadata": null
      }
    }
  }
}

Was this page helpful?