KYkyckr
Orders

Download Order Payload

Changed on

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.

get/orders/{orderId}/download

Request

Query parameters

format'json' | 'pdf' required

Response format. json returns a structured payload; pdf returns a binary document.

Response

OK

object required

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.

Changes

  • 43819cfabfedRevision changes
    • breaking

      the / response's property type changed from number to string for status

    • breaking

      the / response's property type changed from number to string for status

    • breaking

      the / response's property type changed from number to string for status

    • breaking

      the / response's property type changed from number to string for status

    • warning

      the optional response header Deprecation removed for the status 200

    • warning

      the optional response header Sunset removed for the status 200

    • warning

      removed the optional property from the response with the status

    • info

      removed the non-success response with the status