Skip to main content
GET
/
orders
/
{orderId}
/
download
Download Order Payload
curl --request GET \
  --url https://api.kyckr.com/v2/orders/{orderId}/download \
  --header 'Authorization: Bearer <token>'
{
  "_payloadType": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orderId
string
required

Query Parameters

format
enum<string>
required

Response format. json returns a typed payload identified by _payloadType; pdf returns a binary document.

Available options:
json,
pdf

Response

OK

The structured payload for the ordered product. The exact schema depends on the product: an Enhanced Profile order returns the EnhancedProfile schema (see GET Enhanced Profile); a Beneficial Ownership order returns the BOProfile schema (see the Beneficial Ownership reference). Dispatch on the optional _payloadType field when present.

_payloadType
string

Optional discriminator identifying the product payload (e.g. EnhancedProfile_v2, BOProfile_v2).