Jump to Content

Guides API Reference

v1.0.0

API Reference

stableGuides API Reference

All

Pages

Start typing to search…

Getting Started

Welcome to Remote API

Authentication

OAuth2
- Tokenpost
Identity
- Get token identityget
SSO Configuration
Magic link
- Magic links generatorpost

Company Management

Companies
Compliance
- Get Company Compliance Profileget
- Get Onboarding Reserves Status for Employmentget
Company Token
- Create a new token for a companypost
Legal entities
- List Company Legal Entititesget
- Show contractor eligibility and COR-supported countries for legal entityget
Pricing Plans
Company Currencies
- List company supported currenciesget
Company Department
- List Company Departmentsget
- Create New Departmentpost
Company Managers
Employment Company Structure Node
- List company structure nodesget
- employment_company_structure_node.updatedpost
Risk Reserve
- Create risk reservepost

Country Management

Countries

Customization & Integrations

Webhook Callbacks
Webhook Events
- List Webhook Eventsget
- Replay Webhook Eventspost
Help Center Articles
- Get Help Center Articleget
Custom Fields

Employee Onboarding

Cost Calculator
Onboarding
- Cancel onboardingpost
Identity Verification
Probation Extensions

Employee Probation

Probation
- employment.probation.period_ending_reminder_sentpost
Probation Completion Letters

Employment Management

Employments
Employment Job
- Show employment jobget
Federal Taxes
- Update federal taxespost
Background Checks
- Show Background Checkget
- background_check.status.updatedpost
Onboarding
- Show onboarding steps for an employmentget

Employee Actions

Documents
- Indexes all the documents for the employeeget
- Download a document for the employeeget
Time Off

Employee Offboarding

Offboarding
Resignation
Employment Contracts
- contract.termination_date_reachedpost

Contracts & Legal

Contract Amendments
Employment Contracts
Travel Letters
Work Authorization
Contract Eligibility
- Create contract eligibilitypost
Contract documents
- contract_document.status.changedpost

Contractor Management

Contractor Invoice Schedules
Contractor Invoices
- List Contractor Invoicesget
- Show Contractor Invoiceget

Payroll

Incentives
Recurring Incentives
Payroll Calendars
- List EOR Payroll Calendarget
- List Company Payroll Calendarget
Payroll Runs
Payslips

Benefits

Benefit Offers By Employment
- List Benefit Offers By Employmentget
Benefit Offers
Benefit Renewal Requests

HRIS

Expenses
Leave Policies
- List Leave Policies Detailsget
- List Leave Policies Summaryget
Time Off
Time Off Balances
- Show Time Off Balanceget
Timesheets

Billing

Billing Documents

Documents

Files

Testing

Test Data Synchronization
- Get latest data sync eventsget
- Create test data sync jobpost
Sandbox
Test Json Schema
- Get a mock JSON Schemaget

Onboarding

Currency Conversion

Contractor Actions

Contractor Subscription
Eligibility Questionnaire
- Submit eligibility questionnairepost
- Get eligibility questionnaire schemaget
Documents
Contractor Currency
- List all currencies for the contractorget

Telemetry

Error Reporting
- Report SDK errorspost

Integrations

SCIM

Powered by

background_check.status.updated

wbhk

background_check.status.updated

This event is triggered when a background check request status is updated.