---
title: "Create probation completion letter"
method: POST
path: "/v1/probation-completion-letter"
tags: ["Probation Letters"]
---

# Create probation completion letter

`POST /v1/probation-completion-letter`

## Request

- Base URL: `https://gateway.remote.com`
- URL: `https://gateway.remote.com/v1/probation-completion-letter`
- Auth: one of:
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `https://gateway.remote.com/company.manage`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `probation_document:write`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `probation_document:write`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - HTTP bearer

Create a new probation completion letter request.

## 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](https://developer.remote.com/docs/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](https://developer.remote.com/docs/authorization-method-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](https://developer.remote.com/docs/authorization-for-customers).

## Scopes

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

| Token type | Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|---|
| Company-scoped access token | Manage employment documents (`employment_documents`) | - | Manage probation documents (`probation_document:write`) |
| Company-scoped access token (assertion) | Manage employment documents (`employment_documents`) | - | Manage probation documents (`probation_document:write`) |
| Customer API token | Manage employment documents (`employment_documents`) | - | Manage probation documents (`probation_document:write`) |

## Request body

- CreateProbationCompletionLetterParams
  - `employment_id` string, required: The employment ID.

## Response `200`

Success

- ProbationCompletionLetterResponse: Probation completion letter request response
  - `data` object, required
    - `probation_completion_letter` ProbationCompletionLetter, required: Probation completion letter request
      - `employment_id` string, required
      - `id` string, required
      - `letter` ProbationCompletionLetterFile, nullable, required: A file associated with an employment, such as a contract, tax document, or identity document.
        - `id` string, required: The unique identifier (UUID) of the file.
        - `inserted_at` string, date-time, required: UTC date time in [ISO 8601][] format. [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601
        - `name` string, required: The file name including extension (e.g., "id.pdf", "contract.pdf").
        - `sub_type` string, nullable: A more specific classification of the file within its type (e.g., "personal_id" within type "id", or "ir_35" within type "contract"). Null if no sub-type applies.
        - `type` string, required: The broad category of the file (e.g., "id", "contract", "tax_document").
      - `status` 'submitted' | 'in_review' | 'done' | 'canceled' | 'deleted', required
      - `submitted_at` string, date-time, required: UTC date time in [ISO 8601][] format. [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601
      - `zendesk_ticket_url` string, nullable, required

## Other responses

- `401`: Unauthorized
- `404`: Not Found
- `422`: Unprocessable Entity

---

[API](https://skmtc.dev/remote-com/apis/contracts.md) - [All operations](https://skmtc.dev/remote-com/apis/contracts/llms.txt) - [OpenAPI document](https://skmtc.dev/remote-com/apis/contracts/revisions/a2ac13920580?raw)