Employments
Pre-Onboarding Documents
Retrieve a pre-onboarding document with its rendered PDF content
Changed onReturns the rendered contract PDF (base64-encoded) and the list of signatories for the given pre-onboarding document. The content field is prefixed with data:application/pdf;base64, so it can be embedded directly in a document viewer.
Authentication
This endpoint accepts any one of the following token types:
- Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
- Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.
Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employment documents (employment_documents) | View documents (document:read) | Manage documents (document:write) |
get/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}
Request
- Base URL: https://gateway.remote.com
- URL: https://gateway.remote.com/v1/onboarding/employments/{employment_id}/pre-onboarding-documents/{id}
- Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, document:read, document:write, employment_documents, all:write, all:read)
Path parameters
employment_idstring required
Employment ID
idstring required
Pre-onboarding document ID
Response
Success
Example response
{
"data": {
"pre_onboarding_document": {
"content": "data:application/pdf;base64,JVBERi0xLjQK...",
"name": "Master Service Agreement.pdf",
"signatories": [
{
"email": "john@example.com",
"name": "John Doe",
"signature": "data:image/png;base64,iVBORw0KGgo...",
"signed_at": "2024-01-15T10:30:00Z",
"status": "signed",
"type": "employee",
"user_id": "0073fcb5-b669-4e4a-b963-2a47744e75a1"
}
],
"status": "draft"
}
}
}Changes
- warning
added the new
deadline_passedenum value to the//response property for the response status
- warning