Download a payslip as a base64 data URI

Given a Payslip ID, downloads a payslip.
It is important to note that each country has a different payslip format and they are not authored by Remote.

The response body is text, not the file's bytes: a data URI such as data:application/pdf;base64,
followed by the base64-encoded file. Strip the prefix and decode the rest to get the file.
To get the file's bytes directly, use GET /v1/payslips/{payslip_id}/download.

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:read and all:write work too.

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

Payslip ID

Headers
string
enum
Defaults to application/json

Generated from available response content types

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/msword
application/pdf
application/vnd.ms-excel
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.openxmlformats-officedocument.wordprocessingml.document
image/jpeg
image/png
application/json