v1

latestOpenAPI 3.0.3Kyckr API License2026-07-2293773.2 KB
Orders

Download Order Payload

Retrieve the order result as either a structured JSON payload or a PDF document. The JSON schema shown is the Enhanced Profile (the Company V2 company payload). Other products (e.g. Beneficial Ownership) return their own payload — documented in that product's reference — identified by an optional _payloadType field. 🚧 Structured payloads for products other than Enhanced Profile are in preview and not yet available in production.

get/orders/{orderId}/download

Query parameters

format'json' | 'pdf' required

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

Response

OK

_payloadTypestring

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