Order documents

The product order call allows ordering filings from the registry. This POST call requires details to be provided in the body.

To order a filing from the registry, the following variables are needed:

Required fields

• 2 digit ISO code https://www.iso.org/iso-3166-country-codes.html
• productKey (the idField from the search)

Optional

• companyName
• orderRef

[ Product order API reference ]

Order Reference

To help organise all orders, provide a reference for each order placed. This order reference appears in the response when the order is placed and can be used to retrieve the document at a later date.

Example

The below example uses a an order reference.

curl --location 'https://rest.kyckr.com/core/filing/order' \
--header 'Authorization:{{apiKey}}' \
--header 'Content-Type: application/json' \
--data '{
    "countryISO": "GB",
    "productKey": "CHON_Q0hfQ29tcGFueU1vcnRnYWdlc18x_MTE2NTUyOTA=", 
    "companyName": "Kyckr UK LTD", 
    "orderRef": "Example 1"  
}'

Response

Requesting the document using this POST returns a response confirming the order was successful.

{
    "Result": true,
    "Message": "Order Successful",
    "orderRef": "Example 1"
}