Sign in

v1

latestOpenAPI 3.1.12026-07-2452287575.4 KB
Companies

Invite a Company

After creating a company, you may invite the company to use Routable's vendor onboarding flow to add additional contact information and payment method details to their vendor profile. This can be done in two ways: via email and/or via an embedded link.

To send the invitation via email, set the send_invite_email parameter to true. The recipients of the email will be based on the Company's Contacts and their default_contact_for_company_management value:

  • When actionable, the contact will receive an email with a clickable link that allows them to submit information.
  • When read_only, the contact will only be notified of the invitation.
  • When none, the contact will not receive an email notification.

To use the embedded link flow, use the get_links parameter with a value of true. You may also specify a confirmation_redirect_url to route the user to after completion of the Routable onboarding flow.

After inviting a company, their status will change to invited. After the contact enters their information, the company's status will change to accepted. Attempting to send an invitation to a Company that is already accepted will generate a 400 Bad Request error.

For more information, see our help docs.

post/v1/companies/{company_id}/invite

Path parameters

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

The Company ID.

Request body

acting_team_memberstring uuid required

The ID of the TeamMember performing this action. This will be displayed in the Routable Dashboard and also used as the sender of any invitation emails sent to your Company's actionable Contacts.

confirmation_redirect_urlstring uri

A URL on your site that users will be redirected to after completing the onboarding external flow. For use with get_links: true.

get_linksboolean

If true, links to an embeddable onboarding flow will be returned in the response. These links contain JWT authentication tokens for each actionable Contact on the Company. Exactly one of get_links or send_invite_email must be true.

messagestring

A custom message to include in the invitation email, if send_invite_email is true. A limited subset of HTML tags are permitted for formatting.

send_invite_emailboolean

If true, invitation links will be sent via email to all actionable Contacts belonging to this Company. Exactly one of get_links or send_invite_email must be true.

Example request

{
  "confirmation_redirect_url": "https://example.com/thank-you-for-onboarding"
}

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.