Upload employee file

Uploads a file owned by the authenticated employee, for example
identity documents or tax forms.

Authentication

This endpoint accepts any one of the following token types:

  • Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See OAuth Assertion.
  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by the employee through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.

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)
Employee-scoped access tokenManage employment documents (employment_documents)-Manage documents (document:write)
Company-scoped access tokenManage employment documents (employment_documents)-Manage documents (document:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

File

Parameters to upload a file from an employee-issued token. The employment is derived from the access token's subject, so no employment id is required in the body.

file
required

The file content, base64-encoded.

string

A more specific classification within the type.

string

The broad category of the file (e.g., "id", "tax_document").

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json