Benbase

Employer Status

Look up an employer's status and payroll connection state.

Employer Status

GET /employer/{id}/status — Returns the current status of an employer and whether their payroll integration is connected. The endpoint always responds 200; employers we have no record of return INACTIVE.

Path parameters

FieldTypeRequiredDescription
idstringYesThe employer ID. For API-driven integrations, use your own employer ID. For native payroll integrations, use the payroll provider's company ID (e.g. for Check this is the com_XXXX ID).
curl https://embed-sandbox.benbase.com/api/employer/<employer-id>/status \
  -H "Authorization: Bearer <your-api-key>"

Response

{
  "status": "ACTIVE",
  "payroll": { "connected": true }
}
FieldTypeDescription
statusstringEmployer enrollment status. INACTIVE, PENDING, ONBOARDING, or ACTIVE.
payrollobjectPayroll connection state.
payroll.connectedbooleantrue when the provider's payroll system is connected for this employer.

Status values

ValueDescription
INACTIVEThe employer has not started yet.
PENDINGThe employer is in process.
ONBOARDINGThe employer is in the process of onboarding.
ACTIVEThe employer has active benefits. At this stage the employee component can be shown in the UI for employees to manage existing benefits or select them.