# PayFit — HRIS API: overview

> Canonical URL: https://developers.apideck.com/apis/hris/payfit/overview

HMRC certified, PayFit automates everything from RTI submissions and employee payslips to leaves and expenses.
- Status: live
- Authentication: oauth2

- **beta:** false
- **rate limits:** 50 requests per second for reads and 20 per second for writes, per client application.
- **sandbox available:** true
- **difficulty:** involved
- **sandbox note:** Test company credentials are issued to accepted partners; PayFit documents no self-serve signup.
- **partnership portal name:** PayFit Developer Portal
- **authentication note:** Authorization Code flow.
- **partnership note:** Joining gives you a client ID and secret plus a test company; PayFit validates each use case first.
- **webhooks:** Virtual webhooks - employee created, updated and terminated events
- **apideck credentials available:** false
- **consumer access level:** A PayFit admin of the company, since only an admin can approve access.
- **responsibility matrix:**   - **customer:** ✓
  - **area:** Become a PayFit product partner
  - **customer:** ✓
  - **area:** Agree the scope whitelist with PayFit
  - **apideck:** ✓ Stores securely
  - **customer:** ✓
  - **area:** Enter the client ID and secret in the Apideck Dashboard
  - **customer:** ✓ Guides the consumer
  - **consumer:** ✓ (PayFit admin)
  - **area:** Authorise access to the company
  - **apideck:** ✓ Hosts the flow in Vault
  - **area:** Capture the Company ID
  - **apideck:** ✓ Automatic
  - **area:** Sync changes
  - **apideck:** ✓ Polls via virtual webhooks
- **apideck credentials note:** PayFit issues client credentials only to its own product partners.
- **important to know:** PayFit has temporarily stopped accepting new API integration requests and gives no reopening date. If you are not yet a PayFit product partner, you cannot start the partner process until PayFit reopens intake.
PayFit whitelists the scopes each partner may request, and a request outside that whitelist is rejected. Settle your use cases with PayFit up front, because the connector can only read what your approved scopes allow.
- **external guides:**   - **url:** https://developers.payfit.io/
  - **source:** PayFit
  - **title:** PayFit API documentation
- **environment notes:**   - **description:** The connector calls one API host, partner-api.payfit.com, with authorisation at oauth.payfit.com, and declares no separate sandbox host. A connection to a live company reads real employee data.
  - **environment:** Single environment
- **supported resource categories:**   - **resources:** employees
  - **name:** People
  - **name:** Company Structure
  - **resources:** companies
  - **resources:** time-off-requests
  - **name:** Time Off
- **difficulty reason:** Required PayFit Product Partnership + Per-Partner Scope Approval
- **partnership url:** https://developers.payfit.io/docs/how-to-become-a-partner
- **sandbox url:** https://developers.payfit.io/docs/how-to-become-a-partner
- **partnership required:** true
- **account type required:** A PayFit company in France, the UK or Spain; some endpoints exist only in specific markets.

## Supported resources

- **downstream name:** Collaborators
- **status:** live
- **custom field support:** false
- **downstream id:** collaborators
- **id:** employees
- **name:** Employees
- **custom field support:** false
- **name:** Companies
- **id:** companies
- **downstream name:** Companies
- **status:** live
- **downstream id:** companies
- **id:** time-off-requests
- **downstream name:** Worked Time
- **custom field support:** false
- **name:** Time Off Requests
- **status:** live
- **downstream id:** worked-time

An omitted operation list does not establish operation support. Verify the selected operation in the coverage matrix.

[API reference](https://developers.apideck.com/apis/hris/reference.md) · [Coverage matrix](https://developers.apideck.com/apis/hris/coverage)