Skip to main content
PATCH
Update an Order

Endpoint Overview

PATCH https://prod.transcrypts.com/v1/orders/{id}/ This endpoint modifies an existing order. Updates are only permitted when all employers maintain one of these statuses: pending or sent.

Authentication

The endpoint requires API credentials passed via headers:
  • ClientID (Header)
  • AccessKey (Header)

Parameters

Path Parameters

Key Constraint

Update is only available if all employers are in one of the following statuses: pending or sent. This means the order can only be modified while employers are in an early stage of the verification process.

Request Body

The request accepts a JSON payload with the order fields to update. Only the fields provided in the request body will be modified.

Response

Returns the updated order object in JSON format.