Create Employee

Create an employee associated with the license_number provided.

SecurityApiKeyAuth and CustomAuth
Request
path Parameters
state
required
string

Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating.

Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"
header Parameters
x-api-key
required
string

Trace API key header

Example: b123x21wbHlkYXBpa2V5
Authorization
required
string

Company and user credentials authentication

Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5
Request Body schema: application/json
required
object (license_base)
required
object

The name of the employee.

email_address
required
string

The employee's email address.

phone_number
required
string

The phone number of the employee.

required
object

The type of employment (e.g. full-time, temporary, gig, etc.). List of available types can be obtained via the /employee_types endpoint).

required
Array of objects (facility_id_request)

The list of facilities the employee is authorized to work in.

Array of objects

A list of occupational licenses held by the employee.

Array of objects (employee_credentials)

The list of credentials the employee has for the track & trace system(s) (NOTE: not used in some states).
Required if this employee will be using track & trace system(s).

Array of objects

The list of permission groups the employee has been assigned. Required if this employee will be using track & trace system.

birthday
required
string

The employees birthday in ISO 8601 UTC format.

hire_date
required
string

The date the employee was hired in ISO 8601 UTC format.

Responses
200

OK

400

Bad Request

post/{state}/v1/config/employees
Request samples
application/json
{
  • "license": {
    },
  • "name": {
    },
  • "email_address": "jashita@greencheckverified.com",
  • "phone_number": "408-123-4567",
  • "type": {
    },
  • "facilities": [
    ],
  • "credentials": [
    ],
  • "permission_groups": [
    ],
  • "birthday": "2000-01-03T00:00:00Z",
  • "hire_date": "2019-01-03T00:00:00Z"
}
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}