POST
/
v1
/
employers
Create Employer
curl --request POST \
  --url https://api.bluehive.com/v1/employers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "address": {
    "street1": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipCode": "<string>",
    "country": "<string>"
  },
  "billingAddress": {
    "street1": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipCode": "<string>",
    "country": "<string>"
  },
  "phones": [
    {
      "number": "<string>",
      "type": "<string>",
      "primary": true
    }
  ],
  "website": "<string>",
  "email": "jsmith@example.com",
  "onsiteClinic": true,
  "demo": true,
  "employeeConsent": true,
  "checkr": {
    "id": "<string>",
    "status": "<string>"
  },
  "metadata": {}
}'
{
  "_id": "<string>",
  "name": "<string>",
  "address": {
    "street1": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipCode": "<string>",
    "country": "<string>"
  },
  "billingAddress": {
    "street1": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipCode": "<string>",
    "country": "<string>"
  },
  "phones": [
    {
      "number": "<string>",
      "type": "<string>",
      "primary": true
    }
  ],
  "website": "<string>",
  "email": "<string>",
  "onsiteClinic": true,
  "demo": true,
  "employeeConsent": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "checkr": {
    "id": "<string>",
    "status": "<string>"
  }
}

Authorizations

Authorization
string
header
required

API key for accessing BlueHive API endpoints. Format: "ApiKey <your-api-key>" or "Bearer <your-api-key>"

Body

application/json

Response

201
application/json

Default Response

The response is of type object.