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
Magic link
- Magic links generatorpost
SSO Configuration
Magic link

Company Management

Companies
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
Pricing Plans
Company Token
- Create a new token for a companypost
Legal entities
- List Company Legal Entititesget
Pricing Plans
- Show product prices in the company's desired currencyget

Country Management

Countries

Customization & Integrations

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

Employee Onboarding

Onboarding
- Cancel onboardingpost
Cost Calculator
Identity Verification

Employee Probation

Probation Extensions
Probation
- employment.probation.period_ending_reminder_sentpost
Probation Completion Letters

Employment Management

Employments
Employments
Employment Job
- Show employment jobget
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
Currency Conversion
Employment Contracts
- contract.termination_date_reachedpost

Contracts & Legal

Contract Amendments
Employment Contracts
Travel Letters
Work Authorization
Contract Eligibility
- Create contract eligibilitypost

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 Summaryget
- List Leave Policies Detailsget
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

Documents
- Return a base64 encoded version of the contract documentget
- Sign a document for a contractorpost
Documents
- Create a contract document for a contractorpost
Contractor Subscription
Eligibility Questionnaire
- Submit eligibility questionnairepost
- Get eligibility questionnaire schemaget

Telemetry

Error Reporting
- Report SDK errorspost

Integrations

SCIM
- List users via SCIM v2.0get
- Get user by ID via SCIM v2.0get

Powered by

employment.user_status.initiated

wbhk

employment.user_status.initiated

This event is triggered whenever an employment user is updated to the initiated status.