Sign in

v1

latestOpenAPI 3.1.12026-07-2452287575.4 KB
Companies

Update a Company

Update a previously created Company.

patch/v1/companies/{company_id}

Path parameters

company_idstring uuid required
Example:8c581d79-bb84-4bc1-b1c5-8c073264a569

The Company ID.

Request body

OR

Response

OK

object'Company' required

The object’s type (Company).

idstring uuid required

The Company ID.

business_namestring required

The Company's business name for banking and tax purposes.

collect_tax_formboolean

Defaults to true if you use tax collection in your Routable workspace, false otherwise.

country_code'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MX' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VI' | 'VN' | 'VU' | 'XK' | 'WF' | 'WS' | 'XX' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW'

Country code in ISO 3166-1 Alpha-2 format.

created_atstring date-time required

The date the Company was created.

display_namestring required

The Company's name for display in the Routable Dashboard.

external_idstring nullable required

A unique ID from your system to identify this Company.

is_archivedboolean

Whether this Company has been archived.

is_customerboolean required

Whether this Company is a customer.

is_vendorboolean required

Whether this Company is a vendor.

risk_summary'cant_validate' | 'dismissed' | 'not_evaluated' | 'outdated' | 'passed' | 'queued' | 'review_required'

Compliance Check status for a Company:

  • cant_validate: An error happened and the verification couldn't be finished.
  • dismissed: There were issues found (review_required), but they were dismissed by a team member.
  • not_evaluated: Not enrolled for risk monitoring.
  • outdated: When legal data changes outside of the tax flows.
  • passed: Risk checks are all clear.
  • queued: Company was queued for enrollment in risk monitoring.
  • review_required: Identified issues for the entity - Watchlist hits or a TIN mismatch.
status'accepted' | 'added' | 'invited' required

The status of the Company's onboarding.

  • When set to added, this indicates that you have added the Company to Routable. This will be the starting status.
  • When set to invited, this indicates that you have also sent this Company an invitation to submit their business and banking information with Routable.
  • When set to accepted, this indicates that the Company has accepted your invitation and submitted their business and banking information with Routable.
tax_form_status'archived' | 'completed' | 'expired' | 'none' required

Current status of company's tax form.

tax_form_type'w9' | 'w8ben' | 'w8ben_e' nullable

Type of the tax form that the vendor can submit.

type'business' | 'personal' required

The type of Company.