Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Remote Contract Documents API

The Contract Documents API from Remote — 3 operation(s) for contract documents.

Remote Contract Documents API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 3 paths, and defines 17 schemas. It is described by OpenAPI 3.0.0, at version 0.1.0.

Requests are made against 2 base URLs: https://gateway.remote.com/, https://gateway.remote-sandbox.com/.

3 operations 3 paths 17 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1.0
Base URL
https://gateway.remote.com/v1/
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 7

Remote Contract Documents API declares 7 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (ClientToken). It accepts HTTP bearer tokens (CustomerAPIToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 77 scopes. It supports OAuth 2.0 (OAuth2Assertion) using the clientCredentials flow, exposing 21 scopes. It supports OAuth 2.0 (OAuth2AuthorizationCode) using the authorizationCode flow, exposing 73 scopes. It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 18 scopes. By default, every request must be authenticated.

  • BasicAuth — Authenticate using the basic authentication for partners. Use the CLIENTID as login and CLIENTSECRET as password.
  • ClientToken — Authenticate a partner using only the the provided clienttoken. This authentication method only allows accessing marketing endpoints.
  • CustomerAPIToken — Authenticate using API Key generated by the customer in their Integration Settings page.
  • OAuth2 — Authenticate using OAuth 2.0 protocol.
  • OAuth2Assertion — Authenticate as the employee using the urn:ietf:params:oauth:grant-type:jwt-bearer grant in the OAuth2 protocol.
  • OAuth2AuthorizationCode — Authenticate as the token authorizer using authorizationcode / refreshtoken grants in the OAuth 2.0 protocol.
  • OAuth2ClientCredentials — Authenticate using clientcredentials grant in the OAuth 2.0 protocol.

Paths & Operations 3

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

Contract Documents 3
GET
/v1/contractors/employments/{employment_id}/contract-documents/{id}
Return a base64 encoded version of the contract document
get_v1_contractors_employments_employment_id_contract-documents_id 2 params → 200401404422
POST
/v1/contractors/employments/{employment_id}/contract-documents
Create a contract document for a contractor
post_v1_contractors_employments_employment_id_contract-documents 1 param body → 200401404422
POST
/v1/contractors/employments/{employment_id}/contract-documents/{contract_document_id}/sign
Sign a document for a contractor
post_v1_contractors_employments_employment_id_contract-documents_contract_document_id_sign 2 params body → 200400403

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Signatory (9 properties), ActionError (3 properties), ParameterError (3 properties), CreateContractDocument (2 properties). Each schema is shown below with its type and property counts.

SignatoryType
string
The role of this signatory in the contract signing process
CreateContractDocumentResponse
object
Contract document response
1 property 1 required
SignContractDocument
object
SignContractDocument schema
1 property 1 required
ParameterError
object
3 properties 3 required
SignatoryStatus
string
Current signing status of this signatory
UnauthorizedResponse
object
Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorizati…
1 property 1 required
ForbiddenResponse
object
Returned when the authenticated user or token does not have permission to perform the requested action. Check that the token has the required OAuth2 scopes and…
1 property 1 required
UnprocessableEntityResponse
object
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
Signatory
object
A signatory on a contract document. For company and employee signatories, userid is provided. For other signatory types, userid is null.
9 properties 2 required
CreateContractDocument
object
Parameters for creating a contract document
2 properties 1 required
BadRequestResponse
object
Returned when the request is malformed or contains invalid parameters. The message may be a simple string or a structured object with a code and detailed messa…
ContractDocument
object
A contract document for a contractor employment, tracking its signing status.
2 properties 2 required
ContractDocumentResponse
object
Return a base64 encoded contract document
1 property 1 required
SuccessResponse
object
A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).
1 property 1 required
ActionError
object
3 properties 3 required
ContractorContractDocumentStatus
string
The signing status of a contract document. - draft: The document is being prepared and has not been sent for signing. - awaitingsignatures: The document has be…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-contract-documents-api-openapi.yml Raw ↑

Other APIs Remote publishes across the network.

Remote Address Details API
Remote Administrative Details API
Remote Background Checks API
Remote Bank Account Details API
Remote Basic Information API
Remote Benefit Offers API
Remote Benefit Offers By Employment API
Remote Benefit Renewals API
Remote Benefits API
Remote Billing Address Details API
Remote Billing API
Remote Billing Documents API