Skip to main content
GET
/
v2
/
orders
/
{orderId}
Retrieve Order
curl --request GET \
  --url https://api.kausate.com/v2/orders/{orderId} \
  --header 'X-API-Key: <api-key>'
{
  "orderId": "report-D2601V_HRB******-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": "D2601V_HRB******",
            "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"
          }
        ]
      }
    }
  }
}

Authorizations

X-API-Key
string
header
required

Sign up at Kausate.com to get an API key

Path Parameters

orderId
string
required

Order ID to retrieve details for

Query Parameters

customerPartnerId
string | null

Optional customer partner ID for validation

Response

Order details retrieved successfully

Response model for workflow execution status and results.

orderId
string
required

Order ID (temporal workflow id)

status
enum<string>
required

Order status

Available options:
running,
completed,
failed,
canceled,
terminated,
timedOut
requestTime
string<date-time>
required
customerReference
string | null

Customer reference

partnerCustomerId
string | null

Partner customer ID

responseTime
string<date-time> | null
result
DocumentResult · object

Document download result.

  • DocumentResult
  • CompanyReport
  • ShareholderReport
  • ShareholderGraphResult
  • UltimateBeneficialOwnerReport
  • LiveSearchResponse
error
string | null

Error message if the order failed

currentActivity
string | null

Currently running activity name