GuidesAPI ReferenceChangelog
Changelog
added

v2.1.74

🚀 New EOR Worker API Endpoints Added

We are introducing a set of new API endpoints to enhance support for Employer of Record (EOR) worker operations, including compliance document management and bank account handling.


📌 New Endpoints

🗂️ Compliance Documents

  • GET /v2/eor/workers/compliance-documents
    Returns a list of required and optional compliance documents associated with an EOR employee.
    Scopes: worker:read
    Allowed tokens: OAUTH2:PERSONAL

  • GET /v2/eor/workers/compliance-documents/:document_id/templates/download
    Retrieves a downloadable template for a specific compliance document, if available.
    Scopes: worker:read
    Allowed tokens: OAUTH2:PERSONAL

  • POST /v2/eor/workers/compliance-documents/:document_id
    Uploads an employee compliance document.
    Scopes: worker:write
    Allowed tokens: OAUTH2:PERSONAL

🏦 Bank Account Operations

  • GET /v2/eor/workers/banks/guide
    Provides a structured guide (form schema) for submitting bank account details.
    Scopes: worker:read
    Allowed tokens: OAUTH2:PERSONAL

  • POST /v2/eor/workers/banks
    Allows submission of bank account details for an EOR employee.
    Scopes: worker:write
    Allowed tokens: OAUTH2:PERSONAL

✍️ Contract Agreement Operations

  • POST /v2/eor/workers/contracts/:contract_id/signatures
    Enables workers to sign a contract by submitting a typed signature.
    Scopes: worker:write
    Allowed tokens: OAUTH2:PERSONAL

  • GET /v2/eor/workers/contracts/:contract_id/offer-letter
    Returns a rendered HTML preview of the job offer letter for a specific EOR contract.
    Scopes: worker:read
    Allowed tokens: OAUTH2:PERSONAL

  • GET /v2/eor/workers/contracts/:contract_id/employee-agreement/download
    Provides a downloadable PDF link to the employee agreement associated with the given EOR contract.
    Scopes: worker:read
    Allowed tokens: OAUTH2:PERSONAL


📋 Key Highlights

  • 🔍 Dynamic Field Support
    Bank account forms are now dynamically defined via the guide endpoint, enabling country-specific validations and input schemas.

  • 📎 Template-Driven Document Submission
    Workers can now download blank templates for required compliance documents directly via the API.

  • 🖊️ Contract Signing
    Sign employment contracts digitally with a simple string-based signature submission.

  • 📄 Offer Letter Rendering
    Allows workers to preview the HTML-formatted job offer letter for EOR contracts.

  • 📃 Employee Agreement Download
    Enables clients to preview or download the finalized employee agreement, giving full transparency and access to finalized contractual documentation.