Base URL
Staging
https://partner-api.getpenfold.dev/v4
Unified API for payroll partners to onboard employers, manage employees, contributions, and file uploads.
Authentication
OAuth2 client credentials via Azure AD B2C.
- POST to the Azure AD B2C token endpoint with
grant_type=client_credentialsand the configured scope. - Include the access token as a Bearer token in the Authorization header.
The token's client_id is mapped to your organisation, which scopes all
requests to your employers only.
Identifier conventions
- Employer ID (
id): UUID assigned by Penfold when the employer is created. Used as the{employerId}path parameter. - External reference (
externalReference): The Penfold employer reference (e.g.PEN12345678). This isPEN+ the Companies House number. Returned alongsideidin employer responses for cross-referencing. - Employee ID: Unique identifier assigned by Penfold when the employee is enrolled.
This is version 4.0 of this API documentation. Last update on May 12, 2026.