CHcheckhq

Authorize an integration partner for an employee

Changed on

Creates an employee consent record that authorizes (or revokes authorization for) an integration partner to access the employee's payroll data.

This endpoint is used to manage the employee-level authorization lifecycle for integration partners such as earned wage access (EWA) providers. Each call creates a new consent record for audit purposes.

🚧 This endpoint is currently only callable by integration partners using their own OAuth credentials. Support for platform API keys is planned.

post/employees/{employee}/authorize_partner

Request

Path parameters

employeestring required

The ID of the employee to authorize

Request body

emailstring required

The email address of the employee providing consent.

ip_addressstring required

The IP address of the employee at the time of consent.

consent_title'INTEGRATED' | 'DISCONNECTED' | 'CLOSED' required

The consent action to record. INTEGRATED authorizes the partner. DISCONNECTED revokes the employee's consent. CLOSED closes the employee's account with the partner.

Example request

{
  "email": "employee@example.com",
  "ip_address": "203.0.113.1",
  "consent_title": "INTEGRATED"
}

Response

201 - Consent record created successfully. No response body is returned.

Changes