Do not miss any Penfold Partner API changes, ever again

Subscribe to the Penfold Partner API changelog to be up to date on recent changes.

RSS
Penfold Partner API

Jun 12, 2026

dev
4.0
Compare

API structure has changed

45 structure changes including:
25 Breaking changes
19 Additions
1 Modification
25 Removals
Modified 1 Breaking
GET /healthz
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204, 500 responses Added
Removed 25 Breaking
GET /employers/{employerId}/contributions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/employees
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/employees/{employeeId}/contributions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/employees/{employeeId}/documents
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/employees/{employeeId}/documents/{documentId}/download
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/employees/{employeeId}/pension-summary
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/employees/{employeeId}/transfers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/payments
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/uploads
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/uploads/{uploadId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/uploads/{uploadId}/contributions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/uploads/{uploadId}/enrolments
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}/uploads/{uploadId}/errors
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /employers/{employerId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /employers/{employerId}/employees/{employeeId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /employers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /employers/{employerId}/agreement-signing-sessions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /employers/{employerId}/contributions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /employers/{employerId}/employees
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /employers/{employerId}/employees/{employeeId}/transfers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /employers/{employerId}/uploads
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST EmployerAgreementSigningCompletedwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers/{employerId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /employers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Bearer authauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 19
O auth2 client credentialsauthentication method
GET /employers
GET /employers/{employer_id}
GET /employers/{employer_id}/agreement-signing-sessions/{signing_session_id}
GET /employers/{employer_id}/contributions
GET /employers/{employer_id}/employees
GET /employers/{employer_id}/employees/{employee_id}/contributions
GET /uploads
GET /uploads/{upload_id}
GET /uploads/{upload_id}/contributions
GET /uploads/{upload_id}/enrolments
GET /uploads/{upload_id}/errors
PATCH /employers/{employer_id}
PATCH /employers/{employer_id}/employees/{employee_id}
POST /employers
POST /employers/{employer_id}/agreement-signing-sessions
POST /employers/{employer_id}/contributions
POST /employers/{employer_id}/employees
POST /uploads