Retrieve Company Report

Return result synchronously with 300s timeout. Not recommended: government registries are unreliable and timeouts are common. Use default async mode with webhooks (recommended) or polling using the orderId instead.

Defaultfalse

batch?boolean

Set to true for bulk, non-interactive requests. They run at lower priority than interactive requests.

Defaultfalse

Header Parameters

Kausate-Version?string

Default"2025-04-01"

Formatdate

X-Customer-Id?|

Optional customer ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://api.kausate.com/v2/companies/string/report" \  -H "Kausate-Version: 2025-04-01" \  -H "Content-Type: application/json" \  -d '{}'

{
  "orderId": "co_de_4JFFrsbQ99t1nmRw2JgzmG-report-org_01ABC-20240319",
  "customerReference": "my-ref-123",
  "status": "completed",
  "requestTime": "2024-03-19T14:30:22.787045Z",
  "responseTime": "2024-03-19T14:32:45.108791Z",
  "result": {
    "companyReport": {
      "sources": {
        "de-handelsregister": {
          "dataSource": "de-handelsregister",
          "type": "officialRegister",
          "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",
          "normalized": "Gesellschaft mit beschränkter Haftung",
          "iso20275LegalFormCode": "2HBR"
        },
        "representationPolicy": {
          "rules": [
            {
              "options": [],
              "original": "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.",
              "originalLanguage": "de",
              "source": "registrar"
            }
          ]
        },
        "capital": {
          "currency": {
            "amount": "25000.0",
            "iso4217CurrencyCode": "EUR"
          }
        },
        "identifiers": [
          {
            "value": "HRB ******",
            "type": "de_registernumber_weak",
            "description": "German commercial register number (weak identifier)",
            "source": "de-handelsregister",
            "jurisdiction": "de"
          },
          {
            "value": "4JFFrsbQ99t1nmRw2JgzmG",
            "type": "de_registernumber_full",
            "description": "German commercial register number with court code",
            "source": "de-handelsregister",
            "jurisdiction": "de"
          }
        ],
        "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 company ID format",
  "code": "request.invalid",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "API key is required",
  "code": "auth.unauthorized",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "Invalid API key",
  "code": "auth.forbidden",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "Company not found",
  "code": "company.not_found",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "The order did not complete within the timeout. Retry asynchronously and poll for the result.",
  "code": "request.timeout",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": [
    {
      "loc": [
        "body",
        "kausateId"
      ],
      "msg": "Field required",
      "type": "missing"
    }
  ],
  "code": "request.invalid",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "The data source is rate-limiting requests right now, please try again later",
  "code": "source.rate_limited",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "An unexpected error occurred. If this persists, please contact support@kausate.com",
  "code": "internal.unexpected",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "This capability is offered for the requested jurisdiction but is not usable right now because of a fault on our side. Please contact support@kausate.com",
  "code": "capability.not_available",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "Network error while reaching the data source",
  "code": "source.network_error",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "Data source temporarily unavailable",
  "code": "source.unavailable",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

Authorization

api_key

X-API-Key<token>

In: header

Path Parameters

kausateId*string

Company ID

Query Parameters

sync?boolean

Defaultfalse

batch?boolean

Set to true for bulk, non-interactive requests. They run at lower priority than interactive requests.

Defaultfalse

Header Parameters

Kausate-Version?string

Default"2025-04-01"

Formatdate

X-Customer-Id?|

Optional customer ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customerReference?|

metadata?|

Optional customer-supplied JSON metadata echoed back in order responses. Serialized JSON must be at most 4096 bytes.

bypassCache?boolean

If true, bypass daily deduplication and force a fresh request.

Defaultfalse

dataSections?array<>|

Sections to include in the report. Omit (or pass null) to receive the jurisdiction's default report; requested sections are additive to any sections the jurisdiction returns by default. Use allAvailable to request every section available for the company jurisdiction. basicInformation is part of every report and is always billed: the other sections are sold together with it. For Ontario Business Corporations, requesting legalRepresentatives (including allAvailable) retrieves a Profile Report and extracts directors and officers; its registry cost is included in the legalRepresentatives section price.

Response Body

`application/json`

curl -X POST "https://api.kausate.com/v2/companies/string/report" \  -H "Kausate-Version: 2025-04-01" \  -H "Content-Type: application/json" \  -d '{}'

{
  "orderId": "co_de_4JFFrsbQ99t1nmRw2JgzmG-report-org_01ABC-20240319",
  "customerReference": "my-ref-123",
  "status": "completed",
  "requestTime": "2024-03-19T14:30:22.787045Z",
  "responseTime": "2024-03-19T14:32:45.108791Z",
  "result": {
    "companyReport": {
      "sources": {
        "de-handelsregister": {
          "dataSource": "de-handelsregister",
          "type": "officialRegister",
          "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",
          "normalized": "Gesellschaft mit beschränkter Haftung",
          "iso20275LegalFormCode": "2HBR"
        },
        "representationPolicy": {
          "rules": [
            {
              "options": [],
              "original": "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.",
              "originalLanguage": "de",
              "source": "registrar"
            }
          ]
        },
        "capital": {
          "currency": {
            "amount": "25000.0",
            "iso4217CurrencyCode": "EUR"
          }
        },
        "identifiers": [
          {
            "value": "HRB ******",
            "type": "de_registernumber_weak",
            "description": "German commercial register number (weak identifier)",
            "source": "de-handelsregister",
            "jurisdiction": "de"
          },
          {
            "value": "4JFFrsbQ99t1nmRw2JgzmG",
            "type": "de_registernumber_full",
            "description": "German commercial register number with court code",
            "source": "de-handelsregister",
            "jurisdiction": "de"
          }
        ],
        "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 company ID format",
  "code": "request.invalid",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "API key is required",
  "code": "auth.unauthorized",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "Invalid API key",
  "code": "auth.forbidden",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "Company not found",
  "code": "company.not_found",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "The order did not complete within the timeout. Retry asynchronously and poll for the result.",
  "code": "request.timeout",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": [
    {
      "loc": [
        "body",
        "kausateId"
      ],
      "msg": "Field required",
      "type": "missing"
    }
  ],
  "code": "request.invalid",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "The data source is rate-limiting requests right now, please try again later",
  "code": "source.rate_limited",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "An unexpected error occurred. If this persists, please contact support@kausate.com",
  "code": "internal.unexpected",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "This capability is offered for the requested jurisdiction but is not usable right now because of a fault on our side. Please contact support@kausate.com",
  "code": "capability.not_available",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "Network error while reaching the data source",
  "code": "source.network_error",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

{
  "detail": "Data source temporarily unavailable",
  "code": "source.unavailable",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

Retrieve Company Report

200application/json

400application/json

401application/json

403application/json

404application/json

408application/json

422application/json

429application/json

500application/json

501application/json

502application/json

503application/json

Completed company report (via GET /v2/companies/report/runs/{orderId})

Initial order response

Retrieve Company Report

200application/json

400application/json

401application/json

403application/json

404application/json

408application/json

422application/json

429application/json

500application/json

501application/json

502application/json

503application/json

Completed company report (via GET /v2/companies/report/runs/{orderId})

Initial order response

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`