Send Business Invite

curl --request POST \
  --url https://api.joinworth.com/case/api/v1/customers/{customerID}/businesses/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "business": {
    "name": "Jim Tester's Electronics",
    "mobile": "6078379283",
    "address_line_1": "123 Main St",
    "address_city": "Orlando",
    "address_state": "FL",
    "address_postal_code": "32801"
  },
  "applicants": [
    {
      "first_name": "Jim",
      "last_name": "Tester",
      "email": "jim.tester@email.com",
      "mobile": "6078379283"
    }
  ]
}
EOF

import requests

url = "https://api.joinworth.com/case/api/v1/customers/{customerID}/businesses/invite"

payload = {
    "business": {
        "name": "Jim Tester's Electronics",
        "mobile": "6078379283",
        "address_line_1": "123 Main St",
        "address_city": "Orlando",
        "address_state": "FL",
        "address_postal_code": "32801"
    },
    "applicants": [
        {
            "first_name": "Jim",
            "last_name": "Tester",
            "email": "jim.tester@email.com",
            "mobile": "6078379283"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    business: {
      name: 'Jim Tester\'s Electronics',
      mobile: '6078379283',
      address_line_1: '123 Main St',
      address_city: 'Orlando',
      address_state: 'FL',
      address_postal_code: '32801'
    },
    applicants: [
      {
        first_name: 'Jim',
        last_name: 'Tester',
        email: 'jim.tester@email.com',
        mobile: '6078379283'
      }
    ]
  })
};

fetch('https://api.joinworth.com/case/api/v1/customers/{customerID}/businesses/invite', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.joinworth.com/case/api/v1/customers/{customerID}/businesses/invite",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'business' => [
        'name' => 'Jim Tester\'s Electronics',
        'mobile' => '6078379283',
        'address_line_1' => '123 Main St',
        'address_city' => 'Orlando',
        'address_state' => 'FL',
        'address_postal_code' => '32801'
    ],
    'applicants' => [
        [
                'first_name' => 'Jim',
                'last_name' => 'Tester',
                'email' => 'jim.tester@email.com',
                'mobile' => '6078379283'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.joinworth.com/case/api/v1/customers/{customerID}/businesses/invite"

	payload := strings.NewReader("{\n  \"business\": {\n    \"name\": \"Jim Tester's Electronics\",\n    \"mobile\": \"6078379283\",\n    \"address_line_1\": \"123 Main St\",\n    \"address_city\": \"Orlando\",\n    \"address_state\": \"FL\",\n    \"address_postal_code\": \"32801\"\n  },\n  \"applicants\": [\n    {\n      \"first_name\": \"Jim\",\n      \"last_name\": \"Tester\",\n      \"email\": \"jim.tester@email.com\",\n      \"mobile\": \"6078379283\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.joinworth.com/case/api/v1/customers/{customerID}/businesses/invite")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"business\": {\n    \"name\": \"Jim Tester's Electronics\",\n    \"mobile\": \"6078379283\",\n    \"address_line_1\": \"123 Main St\",\n    \"address_city\": \"Orlando\",\n    \"address_state\": \"FL\",\n    \"address_postal_code\": \"32801\"\n  },\n  \"applicants\": [\n    {\n      \"first_name\": \"Jim\",\n      \"last_name\": \"Tester\",\n      \"email\": \"jim.tester@email.com\",\n      \"mobile\": \"6078379283\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.joinworth.com/case/api/v1/customers/{customerID}/businesses/invite")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"business\": {\n    \"name\": \"Jim Tester's Electronics\",\n    \"mobile\": \"6078379283\",\n    \"address_line_1\": \"123 Main St\",\n    \"address_city\": \"Orlando\",\n    \"address_state\": \"FL\",\n    \"address_postal_code\": \"32801\"\n  },\n  \"applicants\": [\n    {\n      \"first_name\": \"Jim\",\n      \"last_name\": \"Tester\",\n      \"email\": \"jim.tester@email.com\",\n      \"mobile\": \"6078379283\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "Business invited successfully",
  "data": {
    "business_id": "e6fbc974-a9d3-4d1b-bd99-90a618758d6d",
    "applicant_email": "jim.tester@email.com",
    "invitation_id": "76fd24c2-c75a-4ab0-8ee7-a1d287d8951b",
    "invitation_url": "https://app.joinworth.com/invite/76fd24c2-c75a-4ab0-8ee7-a1d287d8951b",
    "customer_id": "22f210e4-4455-4107-b132-97e8478546ea"
  }
}

{
  "status": "error",
  "message": "This business was not onboarded by the current customer.",
  "errorCode": "UNKNOWN_ERROR",
  "data": {
    "errorName": "BusinessApiError",
    "data": {
      "data": {}
    }
  }
}

POST

customers

{customerID}

businesses

invite

Send Business Invite

curl --request POST \
  --url https://api.joinworth.com/case/api/v1/customers/{customerID}/businesses/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "business": {
    "name": "Jim Tester's Electronics",
    "mobile": "6078379283",
    "address_line_1": "123 Main St",
    "address_city": "Orlando",
    "address_state": "FL",
    "address_postal_code": "32801"
  },
  "applicants": [
    {
      "first_name": "Jim",
      "last_name": "Tester",
      "email": "jim.tester@email.com",
      "mobile": "6078379283"
    }
  ]
}
EOF

import requests

url = "https://api.joinworth.com/case/api/v1/customers/{customerID}/businesses/invite"

payload = {
    "business": {
        "name": "Jim Tester's Electronics",
        "mobile": "6078379283",
        "address_line_1": "123 Main St",
        "address_city": "Orlando",
        "address_state": "FL",
        "address_postal_code": "32801"
    },
    "applicants": [
        {
            "first_name": "Jim",
            "last_name": "Tester",
            "email": "jim.tester@email.com",
            "mobile": "6078379283"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    business: {
      name: 'Jim Tester\'s Electronics',
      mobile: '6078379283',
      address_line_1: '123 Main St',
      address_city: 'Orlando',
      address_state: 'FL',
      address_postal_code: '32801'
    },
    applicants: [
      {
        first_name: 'Jim',
        last_name: 'Tester',
        email: 'jim.tester@email.com',
        mobile: '6078379283'
      }
    ]
  })
};

fetch('https://api.joinworth.com/case/api/v1/customers/{customerID}/businesses/invite', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.joinworth.com/case/api/v1/customers/{customerID}/businesses/invite",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'business' => [
        'name' => 'Jim Tester\'s Electronics',
        'mobile' => '6078379283',
        'address_line_1' => '123 Main St',
        'address_city' => 'Orlando',
        'address_state' => 'FL',
        'address_postal_code' => '32801'
    ],
    'applicants' => [
        [
                'first_name' => 'Jim',
                'last_name' => 'Tester',
                'email' => 'jim.tester@email.com',
                'mobile' => '6078379283'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.joinworth.com/case/api/v1/customers/{customerID}/businesses/invite"

	payload := strings.NewReader("{\n  \"business\": {\n    \"name\": \"Jim Tester's Electronics\",\n    \"mobile\": \"6078379283\",\n    \"address_line_1\": \"123 Main St\",\n    \"address_city\": \"Orlando\",\n    \"address_state\": \"FL\",\n    \"address_postal_code\": \"32801\"\n  },\n  \"applicants\": [\n    {\n      \"first_name\": \"Jim\",\n      \"last_name\": \"Tester\",\n      \"email\": \"jim.tester@email.com\",\n      \"mobile\": \"6078379283\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.joinworth.com/case/api/v1/customers/{customerID}/businesses/invite")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"business\": {\n    \"name\": \"Jim Tester's Electronics\",\n    \"mobile\": \"6078379283\",\n    \"address_line_1\": \"123 Main St\",\n    \"address_city\": \"Orlando\",\n    \"address_state\": \"FL\",\n    \"address_postal_code\": \"32801\"\n  },\n  \"applicants\": [\n    {\n      \"first_name\": \"Jim\",\n      \"last_name\": \"Tester\",\n      \"email\": \"jim.tester@email.com\",\n      \"mobile\": \"6078379283\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.joinworth.com/case/api/v1/customers/{customerID}/businesses/invite")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"business\": {\n    \"name\": \"Jim Tester's Electronics\",\n    \"mobile\": \"6078379283\",\n    \"address_line_1\": \"123 Main St\",\n    \"address_city\": \"Orlando\",\n    \"address_state\": \"FL\",\n    \"address_postal_code\": \"32801\"\n  },\n  \"applicants\": [\n    {\n      \"first_name\": \"Jim\",\n      \"last_name\": \"Tester\",\n      \"email\": \"jim.tester@email.com\",\n      \"mobile\": \"6078379283\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "Business invited successfully",
  "data": {
    "business_id": "e6fbc974-a9d3-4d1b-bd99-90a618758d6d",
    "applicant_email": "jim.tester@email.com",
    "invitation_id": "76fd24c2-c75a-4ab0-8ee7-a1d287d8951b",
    "invitation_url": "https://app.joinworth.com/invite/76fd24c2-c75a-4ab0-8ee7-a1d287d8951b",
    "customer_id": "22f210e4-4455-4107-b132-97e8478546ea"
  }
}

{
  "status": "error",
  "message": "This business was not onboarded by the current customer.",
  "errorCode": "UNKNOWN_ERROR",
  "data": {
    "errorName": "BusinessApiError",
    "data": {
      "data": {}
    }
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

customerID

string<uuid>

required

Unique identifier of the customer sending the invitation

Example:

"22f210e4-4455-4107-b132-97e8478546ea"

Body

application/json

Business and applicant details for the invitation. Provide either a business object to create a new business, or an existing_business_id / existing_business object to invite applicants to an existing business.

applicants

Applicant · object[]

required

List of applicants to invite. At least one applicant is required.

Minimum array length: 1

Show child attributes

business

object

Details for creating a new business with the invitation. Cannot be used together with existing_business_id or existing_business.

Show child attributes

existing_business_id

string<uuid>

UUID of an existing business to send the invitation for. Cannot be used together with business or existing_business.

existing_business

object

Reference to an existing business with additional context. Cannot be used together with business or existing_business_id.

Show child attributes

case_id

string<uuid>

UUID of an existing case to associate with the invitation. Only applicable when using existing_business_id or existing_business.

existing_applicant_ids

string<uuid>[]

UUIDs of existing applicants to include in the invitation

esign_template_id

string<uuid>

UUID of an e-sign template to attach to the invitation

esign_templates

string<uuid>[]

List of e-sign template UUIDs to attach to the invitation

custom_field_template_id

string<uuid>

UUID of a custom field template to apply to the invitation

custom_fields

object

Custom field values to prefill on the invitation, keyed by field identifier

Response

status

string

message

string

data

object

Show child attributes

Update Business Get Customer Businesses

⌘I

Sign In

Forgot Password

Customers

Customer Users

Business

Cases

Business Details

Worth 360 Report

NPI

Custom Fields

Match Pro

Send Business Invite

Authorizations

Path Parameters

Body

Response