Zentry.Employers.Api v1.0

Base URLs:

• https://api.employer.zentrypass.com

Authentication

• API Key (API_KEY)
  • Parameter Name: Api-Key Authentication, in: header.

Admin

AddUserRole

POST /Admin/role

Body parameter

{
  "contact": {
    "name": "John Smith",
    "email": "johnsmith@zentrypass.com",
    "phone": "5555555555"
  },
  "role": "EmployeeAdmin",
  "employerId": "686d3163ee1ffbbdb38b6a74"
}

Parameters

Name	In	Type	Required	Description
body	body	AddUserRoleRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

RemoveUserRole

DELETE /Admin/role

Body parameter

{
  "email": "johnsmit@zentrypass.com",
  "role": "EmployeeAdmin",
  "employerId": "686d3163ee1ffbbdb38b6a74"
}

Parameters

Name	In	Type	Required	Description
body	body	RemoveUserRoleRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

GetUsersWithRole

GET /Admin/{tenantId}/role/{role}

Parameters

Name	In	Type	Required	Description
getUsersWithRoleRequest	header	GetUsersWithRoleRequest	false	none
tenantId	path	string	true	none
role	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	UserIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

Application

CreateApplication

POST /Application/create

Body parameter

{
  "name": "string",
  "contact": {
    "name": "John Smith",
    "email": "johnsmith@zentrypass.com",
    "phone": "5555555555"
  },
  "description": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Application

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

GetApplications

POST /Application

Body parameter

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "ownerIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetApplicationsRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	ApplicationIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

UpdateApplication

PUT /Application

Body parameter

{
  "id": "string",
  "name": "string",
  "description": "string",
  "address": {
    "line1": "11 N 4th St",
    "line2": "string",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	UpdateApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Application

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

ApproveApplicationInquiry

PUT /Application/approve-inquiry

Body parameter

{
  "applicationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ApproveApplicationInquiryRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Application

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

SubmitApplication

PUT /Application/submit

Body parameter

{
  "applicationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	SubmitApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Application

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

ApproveApplication

PUT /Application/approve

Body parameter

{
  "applicationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ApproveApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Employer

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

DenyApplication

PUT /Application/deny

Body parameter

{
  "applicationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	DenyApplicationRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Application

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

Employee

CreateEmployeeInquiry

POST /Employee/inquiry

Body parameter

{
  "companyName": "string",
  "employeeName": "string",
  "email": "string",
  "title": "string",
  "referralContact": {
    "name": "string",
    "email": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	CreateEmployeeInquiryRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	EmployeeInquiry

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

InviteEmployee

POST /Employee/invite

Body parameter

{
  "contact": {
    "name": "John Smith",
    "email": "johnsmith@zentrypass.com",
    "phone": "5555555555"
  },
  "employerId": "686d3163ee1ffbbdb38b6a74",
  "employerUserId": "[AN ID IN YOUR SYSTEM]",
  "employerBillingPlanId": "926d3163ee1ffbbdb47b6a76"
}

Parameters

Name	In	Type	Required	Description
body	body	InviteEmployeeRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Employee

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

GetEmployees

POST /Employee

Body parameter

{
  "offset": 0,
  "limit": 25,
  "employerIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "userIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "employerUserIds": [
    "AN ID IN YOUR SYSTEM"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetEmployeesRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	EmployeeIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

UpdateEmployeeStatus

PUT /Employee/status

Body parameter

{
  "employerId": "514d3163ee1ffbbdb38b6c51",
  "userId": "686d3163ee1ffbbdb38b6a74",
  "status": "Active"
}

Parameters

Name	In	Type	Required	Description
body	body	UpdateEmployeeStatusRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Employee

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

UpdateEmployeeBillingPlan

PUT /Employee/billing-plan

Body parameter

{
  "employerId": "514d3163ee1ffbbdb38b6c51",
  "userId": "686d3163ee1ffbbdb38b6a74",
  "billingPlanId": "926d3163ee1ffbbdb47b6a76"
}

Parameters

Name	In	Type	Required	Description
body	body	UpdateEmployeeBillingPlanRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Employee

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

Employer

GetEmployers

POST /Employer

Body parameter

{
  "offset": 0,
  "limit": 25,
  "employerIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetEmployersRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	EmployerIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

Schemas

AddUserRoleRequest

{
  "contact": {
    "name": "John Smith",
    "email": "johnsmith@zentrypass.com",
    "phone": "5555555555"
  },
  "role": "EmployeeAdmin",
  "employerId": "686d3163ee1ffbbdb38b6a74"
}

Name	Type	Required	Restrictions	Description
contact	Contact	true	none	Information about the employee
role	string	true	none	The name of the role to add
employerId	string	true	none	Zentry Pass Employer Id

Address

{
  "line1": "11 N 4th St",
  "line2": "string",
  "state": "Missouri",
  "city": "St. Louis",
  "zipCode": "63102"
}

Name	Type	Required	Restrictions	Description
line1	string	true	none	The main address
line2	string¦null	false	none	none
state	string	true	none	The state
city	string	true	none	The city
zipCode	string	true	none	The zip code

Application

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "status": "Inquiry",
  "name": "string",
  "contact": {
    "name": "John Smith",
    "email": "johnsmith@zentrypass.com",
    "phone": "5555555555"
  },
  "description": "string",
  "address": {
    "line1": "11 N 4th St",
    "line2": "string",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  },
  "ownerId": "string",
  "ownerEmail": "string"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
status	ApplicationStatus	true	none	none
name	string	true	none	none
contact	Contact	true	none	Information about the employee
description	string	true	none	none
address	Address	false	none	none
ownerId	string¦null	false	none	none
ownerEmail	string¦null	false	none	none

ApplicationIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "status": "Inquiry",
      "name": "string",
      "contact": {
        "name": "John Smith",
        "email": "johnsmith@zentrypass.com",
        "phone": "5555555555"
      },
      "description": "string",
      "address": {
        "line1": "11 N 4th St",
        "line2": "string",
        "state": "Missouri",
        "city": "St. Louis",
        "zipCode": "63102"
      },
      "ownerId": "string",
      "ownerEmail": "string"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[Application]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

ApplicationQuery

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "ownerIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
ids	[string]¦null	false	none	none
ownerIds	[string]¦null	false	none	none

ApplicationStatus

"Inquiry"

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Inquiry
anonymous	Pending
anonymous	Submitted
anonymous	Approved
anonymous	Denied

ApproveApplicationInquiryRequest

{
  "applicationId": "string"
}

Name	Type	Required	Restrictions	Description
applicationId	string	true	none	none

ApproveApplicationRequest

{
  "applicationId": "string"
}

Name	Type	Required	Restrictions	Description
applicationId	string	true	none	none

BillingPlanHistory

{
  "employerBillingPlanId": "string",
  "from": "2019-08-24T14:15:22Z",
  "to": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Restrictions	Description
employerBillingPlanId	string	true	none	none
from	string(date-time)	true	none	none
to	string(date-time)¦null	false	none	none

Contact

{
  "name": "John Smith",
  "email": "johnsmith@zentrypass.com",
  "phone": "5555555555"
}

Information about the employee

Name	Type	Required	Restrictions	Description
name	string	true	none	Should be the First and Last name
email	string	true	none	The employee's email
phone	string¦null	false	none	The employee's phone number. Optional.

CreateApplicationRequest

{
  "name": "string",
  "contact": {
    "name": "John Smith",
    "email": "johnsmith@zentrypass.com",
    "phone": "5555555555"
  },
  "description": "string"
}

Name	Type	Required	Restrictions	Description
name	string	true	none	none
contact	Contact	true	none	Information about the employee
description	string	true	none	none

CreateEmployeeInquiryRequest

{
  "companyName": "string",
  "employeeName": "string",
  "email": "string",
  "title": "string",
  "referralContact": {
    "name": "string",
    "email": "string"
  }
}

Name	Type	Required	Restrictions	Description
companyName	string	true	none	none
employeeName	string	true	none	none
email	string	true	none	none
title	string	true	none	none
referralContact	Referral	false	none	none

DenyApplicationRequest

{
  "applicationId": "string"
}

Name	Type	Required	Restrictions	Description
applicationId	string	true	none	none

Employee

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "employerId": "514d3163ee1ffbbdb38b6c51",
  "userId": "686d3163ee1ffbbdb38b6a74",
  "employerUserId": "johnsmith@zentrypass.com",
  "employerBillingPlanId": "926d3163ee1ffbbdb47b6a76",
  "billingPlanHistory": [
    {
      "employerBillingPlanId": "string",
      "from": "2019-08-24T14:15:22Z",
      "to": "2019-08-24T14:15:22Z"
    }
  ],
  "status": "Active",
  "statusUpdatedDate": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
employerId	string	true	none	A Zentry Pass Employer Identifier.
userId	string	true	none	Zentry Pass User Identifier.
employerUserId	string	true	none	This is an identifier from the Employer's source system. Used to identify employees more easily. Default value is the employee's email.
employerBillingPlanId	string	true	none	Zentry Pass Employer Billing Plan Identifier.
billingPlanHistory	[BillingPlanHistory]	true	none	This is a list of billing plans this user has had in the past
status	EmployeeStatus	true	none	none
statusUpdatedDate	string(date-time)	true	none	The last time the employee's status was updated

EmployeeIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "employerId": "514d3163ee1ffbbdb38b6c51",
      "userId": "686d3163ee1ffbbdb38b6a74",
      "employerUserId": "johnsmith@zentrypass.com",
      "employerBillingPlanId": "926d3163ee1ffbbdb47b6a76",
      "billingPlanHistory": [
        {
          "employerBillingPlanId": "string",
          "from": "2019-08-24T14:15:22Z",
          "to": "2019-08-24T14:15:22Z"
        }
      ],
      "status": "Active",
      "statusUpdatedDate": "2019-08-24T14:15:22Z"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[Employee]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

EmployeeInquiry

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "companyName": "string",
  "employeeName": "string",
  "email": "string",
  "title": "string",
  "referralContact": {
    "name": "string",
    "email": "string"
  }
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
companyName	string	true	none	none
employeeName	string	true	none	none
email	string	true	none	none
title	string	true	none	none
referralContact	Referral	false	none	none

EmployeeQuery

{
  "offset": 0,
  "limit": 25,
  "employerIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "userIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "employerUserIds": [
    "AN ID IN YOUR SYSTEM"
  ]
}

Get employees

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
employerIds	[string]¦null	false	none	A list of Zentry Pass Employer Identifiers
userIds	[string]¦null	false	none	A list of Zentry Pass User Identifiers
employerUserIds	[string]¦null	false	none	These are identifiers from the Employer's source system

EmployeeStatus

"Active"

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Active
anonymous	Inactive

Employer

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "name": "Zentry Pass",
  "address": {
    "line1": "11 N 4th St",
    "line2": "string",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  },
  "email": "employer@zentrypass.com"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
name	string	true	none	The name of this employer
address	Address	true	none	none
email	string	true	none	The email used for communicating with this employer

EmployerIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "name": "Zentry Pass",
      "address": {
        "line1": "11 N 4th St",
        "line2": "string",
        "state": "Missouri",
        "city": "St. Louis",
        "zipCode": "63102"
      },
      "email": "employer@zentrypass.com"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[Employer]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

EmployerQuery

{
  "offset": 0,
  "limit": 25,
  "employerIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
employerIds	[string]¦null	false	none	none

GetApplicationsRequest

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "ownerIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	ApplicationQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetEmployeesRequest

{
  "offset": 0,
  "limit": 25,
  "employerIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "userIds": [
    "686d3163ee1ffbbdb38b6a74"
  ],
  "employerUserIds": [
    "AN ID IN YOUR SYSTEM"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	EmployeeQuery	false	none	Get employees

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetEmployersRequest

{
  "offset": 0,
  "limit": 25,
  "employerIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	EmployerQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetUsersWithRoleRequest

{
  "role": "string",
  "tenantId": "string"
}

Name	Type	Required	Restrictions	Description
role	string	true	none	none
tenantId	string	true	none	none

IPagedRequest

{
  "offset": 0,
  "limit": 25
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	read-only	How far to skip into a collection
limit	integer(int32)	true	read-only	How many results to return

InviteEmployeeRequest

{
  "contact": {
    "name": "John Smith",
    "email": "johnsmith@zentrypass.com",
    "phone": "5555555555"
  },
  "employerId": "686d3163ee1ffbbdb38b6a74",
  "employerUserId": "[AN ID IN YOUR SYSTEM]",
  "employerBillingPlanId": "926d3163ee1ffbbdb47b6a76"
}

Name	Type	Required	Restrictions	Description
contact	Contact	true	none	Information about the employee
employerId	string	true	none	Zentry Pass Employer Identifier
employerUserId	string¦null	false	none	This is an identifier from the Employer's source system. Used to identify employees more easily. Default value is the provided email.
employerBillingPlanId	string	true	none	Zentry Pass Employer Billing Plan Identifier.

Referral

{
  "name": "string",
  "email": "string"
}

Name	Type	Required	Restrictions	Description
name	string	true	none	none
email	string	true	none	none

RemoveUserRoleRequest

{
  "email": "johnsmit@zentrypass.com",
  "role": "EmployeeAdmin",
  "employerId": "686d3163ee1ffbbdb38b6a74"
}

Name	Type	Required	Restrictions	Description
email	string	true	none	The email of the admin
role	string	true	none	The name of the role to remove
employerId	string	true	none	Zentry Pass Employer Id

SubmitApplicationRequest

{
  "applicationId": "string"
}

Name	Type	Required	Restrictions	Description
applicationId	string	true	none	none

UpdateApplicationRequest

{
  "id": "string",
  "name": "string",
  "description": "string",
  "address": {
    "line1": "11 N 4th St",
    "line2": "string",
    "state": "Missouri",
    "city": "St. Louis",
    "zipCode": "63102"
  }
}

Name	Type	Required	Restrictions	Description
id	string	true	none	none
name	string	true	none	none
description	string	true	none	none
address	Address	true	none	none

UpdateEmployeeBillingPlanRequest

{
  "employerId": "514d3163ee1ffbbdb38b6c51",
  "userId": "686d3163ee1ffbbdb38b6a74",
  "billingPlanId": "926d3163ee1ffbbdb47b6a76"
}

Name	Type	Required	Restrictions	Description
employerId	string	true	none	Zentry Pass Employer Identifier.
userId	string	true	none	Zentry Pass User Identifier.
billingPlanId	string	true	none	Zentry Pass Employer Billing Plan Identifier.

UpdateEmployeeStatusRequest

{
  "employerId": "514d3163ee1ffbbdb38b6c51",
  "userId": "686d3163ee1ffbbdb38b6a74",
  "status": "Active"
}

Name	Type	Required	Restrictions	Description
employerId	string	true	none	Zentry Pass Employer Identifier.
userId	string	true	none	Zentry Pass User Identifier.
status	EmployeeStatus	true	none	none

User

{
  "id": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "pictureUrl": "string"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	none
email	string	true	none	none
firstName	string	true	none	none
lastName	string	true	none	none
pictureUrl	string¦null	false	none	none

UserIPagedResponse

{
  "data": [
    {
      "id": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "pictureUrl": "string"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[User]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available