Verify Retirement Partners API reachability for the authenticated caller.
Partner OAuth integrations only
The Background Checks API is for approved HiBob Marketplace partners with Developer Portal access and OAuth credentials. Service users are not supported for this integration.
Bob customers building integrations for their own company should use Service users and the general Hiring API, not this partner contract.
Before you begin
- Read Integrate with Retirement Partners API to learn how to use this API.
Retirement Partners API endpoints
| Resource | Endpoint |
|---|---|
| Connection status | Get connection status |
Rate limiting
Rate limits are restrictions that our API imposes on the number of times a user can access our endpoints within a specified period of time. To learn more about rate limiting best practices, see Rate limiting.
| Method | Endpoint | Limit |
|---|---|---|
| GET | Get connection status | 5 requests per minute |
Required permissions and scopes
To use this endpoint, your OAuth app requires the following scope:
| Name | Scope | Description |
|---|---|---|
| Payroll Hub > Partner integration > Fetch pay cycle metadata, paystub information, and payroll-related employee data | payrollhub.payroll:read | Verify connectivity and read payroll data for the authenticated company. |