post
https://sandbox.checkhq.com/employees//authorize_partner
Creates an employee consent record that authorizes (or revokes authorization for) an integration partner to access the employee's payroll data.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
This endpoint is used to manage the employee-level authorization lifecycle for integration partners such as earned wage access (EWA) providers.
Access restrictionsThis endpoint is currently only callable by integration partners using their own OAuth credentials. Support for platform API keys to call this endpoint directly is planned.
Consent Titles
The consent_title field determines the type of consent being recorded:
| Value | Description |
|---|---|
INTEGRATED | Authorizes the integration partner to access the employee's payroll data. Sets has_consented to true. |
DISCONNECTED | Revokes the employee's consent. The integration partner can no longer access the employee's data. |
CLOSED | Closes the employee's account with the integration partner. |
Behavior
- Each call creates a new consent record (records are immutable for audit purposes).
- The most recent consent record for a given employee + integration partner pair determines the current authorization state.
- Returns HTTP 200 with no response body on success.
201 - Consent record created successfully. No response body is returned.