Skip to main content
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"
  },
  "applicants": [
    {
      "first_name": "Jim",
      "last_name": "Tester",
      "email": "[email protected]",
      "mobile": "6078379283"
    }
  ],
  "is_lightning_verification": false
}
EOF
{
  "status": "success",
  "message": "Business invited successfully",
  "data": {
    "business_id": "e6fbc974-a9d3-4d1b-bd99-90a618758d6d",
    "applicant_email": "[email protected]",
    "invitation_id": "76fd24c2-c75a-4ab0-8ee7-a1d287d8951b",
    "customer_id": "22f210e4-4455-4107-b132-97e8478546ea"
  }
}

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:

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

Body

application/json
​
business
Business · object
​
applicants
Applicant · object[]
​
is_lightning_verification
boolean
  • When using this feature, Lightning Verification will send the applicant an email to invite the business. This flow captures and verifies company details, ONLY.
  • Please reach out to your customer success team in order to enable this feature.
Example:
{
  "business": { "name": "Jim Tester's Electronics" },
  "applicants": [
    {
      "first_name": "Jim",
      "last_name": "Tester",
      "email": "[email protected]"
    }
  ],
  "is_lightning_verification": true
}

Response

OK

​
status
string
​
message
string
​
data
object