How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Deel Subpackage Hrx Documents API

The subpackage_hrxDocuments API from Deel — 2 operation(s) for subpackage_hrxdocuments.

Deel Subpackage Hrx Documents API is one of 128 APIs that Deel publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include subpackage_hrxDocuments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 2 operations across 2 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.letsdeel.com/rest/v2, https://api-staging.letsdeel.com/rest/v2.

2 operations 2 paths 15 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.letsdeel.com/rest/v2
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Deel Subpackage Hrx Documents API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (deelToken). It accepts HTTP bearer tokens (oauth2).

  • deelToken — Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authenticatio…
  • oauth2 — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

subpackage_hrxDocuments 2
GET
/eor/contracts/{contract_id}/hrx-documents/{document_id}
Download HRX documents
download-hrx-documents 3 params → 200400401403404500
GET
/eor/contracts/{contract_id}/hrx-documents
Retrieve HRX documents
retrieve-hrx-documents 4 params → 200400401403404500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaDataItems (8 properties), ApiErrorRequest (7 properties), HRX_Documents_retrieveHrxDocuments_Response_200 (4 properties), EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems (3 properties). Each schema is shown below with its type and property counts.

DownloadHrxDocumentsRequestBadRequestError
object
1 property
DownloadHrxDocumentsRequestUnauthorizedError
object
1 property
EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
ApiErrorRequest
object
7 properties
RetrieveHrxDocumentsRequestBadRequestError
object
1 property
EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaDataItemsCategoryType
string
Type of the document category
ApiError
object
2 properties
HRX_Documents_retrieveHrxDocuments_Response_200
object
4 properties 4 required
RetrieveHrxDocumentsRequestUnauthorizedError
object
1 property
ApiErrorContainer
object
2 properties
RetrieveHrxDocumentsRequestInternalServerError
object
1 property
HRX_Documents_downloadHrxDocuments_Response_200
object
1 property 1 required
EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaDataItems
object
8 properties 8 required
EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaData
object
Download information for the HRX document
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deel-com-subpackage-hrxdocuments-api-openapi.yml Raw ↑

Other APIs Deel publishes across the network.

Deel Adjustments API
Deel Applications API
Deel Candidates API
Deel Contractor Amendments API
Deel Contractor Hiring API
Deel Contracts API
Deel Custom Fields API
Deel IT API
Deel EOR Amendments API
Deel EOR Benefits API
Deel EOR Cost Calculator API
Deel EOR Hiring API
Where this information came from

This is an independent, third-party profile of Deel Subpackage Hrx Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.