Orders
Retrieve Order
Retrieve detailed information about a specific order.
Authorization
api_key X-API-Key<token>
Sign up at Kausate.com to get an API key
In: header
Path Parameters
orderId*string
Order ID to retrieve details for
Query Parameters
customerPartnerId?|
Optional customer partner ID for validation
includeIntermediateResult?boolean
If true, return the intermediate result for running shareholder graph workflows. This is a paid action — each request with this flag consumes API credits.
Default
falseResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.kausate.com/v2/orders/string"{
"orderId": "report-4JFFrsbQ99t1nmRw2JgzmG-DEHRSI-20240319143022",
"customerReference": "my-ref-123",
"status": "completed",
"requestTime": "2024-03-19T14:30:22.787045Z",
"responseTime": "2024-03-19T14:32:45.108791Z",
"result": {
"companyReport": {
"sources": {
"registrar": {
"type": "registrar",
"name": "Handelsregister Structured Information",
"jurisdictionCode": "de",
"retrievalTime": "2024-03-19T14:30:49+0000",
"downloadUrl": "https://example.com/path/to/document.xml",
"fileHash": "abc123def456...",
"fileName": "2024-03-19T14-30-49+0000_abc123def456.xml"
}
},
"basicInformation": {
"type": "organization",
"legalName": "Example Solutions GmbH",
"legalForm": {
"original": "GmbH (exkl. gGmbH)",
"normalized": "Gesellschaft mit beschränkter Haftung",
"iso20275LegalFormCode": "2HBR"
},
"signatoryRules": {
"original": "General rule: Ist nur ein Geschäftsführer bestellt, so vertritt er die Gesellschaft allein. Sind mehrere Geschäftsführer bestellt, so wird die Gesellschaft durch zwei Geschäftsführer oder durch einen Geschäftsführer gemeinsam mit einem Prokuristen vertreten.; Specific rule: einzelvertretungsberechtigt; mit der Befugnis, im Namen der Gesellschaft mit sich im eigenen Namen oder als Vertreter eines Dritten Rechtsgeschäfte abzuschließen"
},
"capital": {
"currency": {
"amount": "25000.0",
"iso4217CurrencyCode": "EUR"
}
},
"identifiers": [
{
"value": "HRB ******",
"type": "de_registernumber_weak",
"description": "German commercial register number (weak identifier)"
},
{
"value": "4JFFrsbQ99t1nmRw2JgzmG",
"type": "de_registernumber_full",
"description": "German commercial register number with court code"
}
],
"addresses": [
{
"type": "registered",
"source": "registrar",
"original": "München",
"normalized": {
"city": "München"
}
},
{
"type": "business",
"source": "registrar",
"original": "Musterstraße, 1, 10115, Berlin",
"normalized": {
"houseNumber": "1",
"road": "Musterstraße",
"postcode": "10115",
"city": "Berlin"
}
}
],
"activities": [
{
"scheme": "free_text",
"description": "Software development and consulting services",
"source": "registrar"
}
]
},
"relationships": {
"legalRepresentatives": [
{
"type": "person",
"person": {
"address": {
"type": "physical",
"source": "registrar",
"original": "Berlin",
"normalized": {
"city": "Berlin"
}
},
"dateOfBirth": {
"original": "1985-01-01",
"normalized": "1985-01-01"
},
"name": {
"firstName": "John",
"lastName": "Doe",
"fullName": "John Doe"
}
},
"role": {
"original": "Geschäftsführer(in)",
"englishTranslation": "Managing Director"
},
"source": "registrar"
}
]
}
}
}
}{
"detail": "Invalid order ID format"
}{
"detail": "Invalid API key"
}{
"detail": "Order not found"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}{
"detail": "An internal error occurred"
}Last updated on