Skip to main content
POST
/
v2
/
companies
/
{kausateId}
/
documents
Retrieve Company Document
curl --request POST \
  --url https://api.kausate.com/v2/companies/{kausateId}/documents/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "customerReference": "<string>",
  "sku": "<string>",
  "kausateDocumentId": "<string>",
  "outputFormat": "pdf"
}
'
{
  "orderId": "order-co_de_D2601V_HRB******-DEHRAD-20240319143022",
  "customerReference": "doc-order-123",
  "partnerCustomerId": "partner-berlin-001"
}

Authorizations

​
X-API-Key
string
header
required

Sign up at Kausate.com to get an API key

Headers

​
X-Partner-Customer-Id
string | null

Optional partner customer ID

Path Parameters

​
kausateId
string
required

Company ID

Query Parameters

​
sync
boolean
default:false

Return result synchronously with 300s timeout

Body

application/json

Request model for ordering a product (documents only).

Provide either sku OR kausateDocumentId, not both:

  • Use sku to order a document by SKU code (e.g., DEHRAD, DEHRSI)
  • Use kausateDocumentId to download a specific document from /documents/list response
​
customerReference
string | null
Maximum string length: 150
​
sku
string | null

Product SKU code (e.g., DEHRAD, DEHRSI). Required if kausateDocumentId not provided.

​
kausateDocumentId
string | null

Document ID from /documents/list response (e.g., doc_deur_abc123). Required if sku not provided.

​
outputFormat
enum<string>
default:pdf

Output format. 'pdf' converts TIFF files to PDF (default). 'raw' keeps original format.

Available options:
pdf,
raw

Response

Order successfully placed

  • ProductOrderResponse
  • ExecutionResponse

Response model for product order.

​
orderId
string
required
​
customerReference
string | null
Maximum string length: 150
​
partnerCustomerId
string | null
Maximum string length: 150