---
title: "Download Order Payload"
method: GET
path: "/orders/{orderId}/download"
tags: ["Orders"]
---

# Download Order Payload

`GET /orders/{orderId}/download`

## Request

- Base URL: `https://api.kyckr.com/v2`
- URL: `https://api.kyckr.com/v2/orders/{orderId}/download`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/kyckr/apis/kyckr-companies-v2-api/docs/orders/:orderId/download/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve the order result as either a structured JSON payload or a PDF document. The JSON body follows the product that was ordered (the order's `productDetails.productName`). For an Enhanced Profile order it is the Enhanced Profile shown below. For a beneficial ownership order (`UBO_Register_Profile`) it is the beneficial ownership profile, returned as the whole response body and carrying `_payloadType: BOProfile_v2`; see the UBO Register API reference for its schema. The order's `links.data` points to the JSON and `links.document` to the PDF.

## Query parameters

- `format` 'json' | 'pdf', required

## Response `200`

OK

- object: The structured payload for the ordered product: the `EnhancedProfile` schema for an Enhanced Profile order (see GET Enhanced Profile), or the beneficial ownership profile for a `UBO_Register_Profile` order.

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

## Changes

- **2026-11-03** `43819cfabfed`: 4 breaking, 3 warning, 1 info
  - the `allOf[subschema #1: BaseResponse]/orderId` response's property type changed from `number` to `string` for status `400`
  - the `allOf[subschema #1: BaseResponse]/orderId` response's property type changed from `number` to `string` for status `401`
  - the `allOf[subschema #1: BaseResponse]/orderId` response's property type changed from `number` to `string` for status `403`
  - the `allOf[subschema #1: BaseResponse]/orderId` response's property type changed from `number` to `string` for status `404`
  - …4 more

[Operation history](https://skmtc.dev/kyckr/apis/kyckr-companies-v2-api/changes/orders/:orderId/download/get.md)

---

[API](https://skmtc.dev/kyckr/apis/kyckr-companies-v2-api.md) - [All operations](https://skmtc.dev/kyckr/apis/kyckr-companies-v2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kyckr/apis/kyckr-companies-v2-api/revisions/b5008b331ed7?raw)