API Reference

Find or create a document for a pre-onboarding requirement

post
https://gateway.remote.com/v1/onboarding/employments//pre-onboarding-requirements//documents

Finds an existing unsigned pre-onboarding document for the given document requirement, or
creates a new one. Idempotent: repeated calls return the same document until it is signed.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage employment documents (employment_documents)-Manage documents (document:write)
Company-scoped access token (assertion)Manage employment documents (employment_documents)-Manage documents (document:write)
Customer API tokenManage employment documents (employment_documents)-Manage documents (document:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Employment ID

string
required

Pre-onboarding requirement slug

Query Params
boolean

When true, skips the email that asks the company signatory to sign the
newly created document. Signature reminders are still sent while the
document remains unsigned.

The company signatory is the authenticated user when they are allowed to
sign, otherwise the company's legal representative or owner. This parameter
only takes effect when the signatory is the authenticated user, who is about
to sign the document themselves. When the signatory is someone else, they
are emailed right away as usual, since they still need to know about the
document.

Responses

Callback

Updated 4 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?