Kausate

https://docs.openregisters.com/
Admin
Kausate provides access to an authoritative legal-entity database, offering company data from...
Tokens:26,198
Snippets:70
Trust Score:5.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start OpenRegisters Services

Source: https://docs.openregisters.com/documentation/bulk-data

This command starts the OpenRegisters services in detached mode using Docker Compose.

```docker
docker-compose up -d
```

--------------------------------

### Shareholder Data Structure Example

Source: https://docs.openregisters.com/api-reference/companies/retrieve-shareholders-real-time

This snippet demonstrates the JSON structure for shareholder information, including company name, number of shares, percentage ownership, total nominal value, and source of the data. It also includes an example of person-based shareholder data with name, address, and date of birth.

```json
{
  "name": "Example Tech UG (haftungsbeschränkt)"
}
{
  "numberOfShares": 24250,
  "percentage": 97,
  "totalNominalValue": {
    "amount": "24250",
    "iso4217CurrencyCode": "EUR"
  },
  "source": "handelsregister_shareholder_******"
}
{
  "type": "person",
  "person": {
    "address": {
      "type": "business",
      "original": "wohnhaft in München"
    },
    "jurisdictionCode": "de",
    "dateOfBirth": {
      "original": "1985-01-01",
      "normalized": "1985-01-01"
    },
    "name": {
      "firstName": "John",
      "lastName": "Doe",
      "fullName": "John Doe"
    }
  },
  "numberOfShares": 750,
  "percentage": 3,
  "totalNominalValue": {
    "amount": "750",
    "iso4217CurrencyCode": "EUR"
  },
  "source": "handelsregister_shareholder_******"
}
```

--------------------------------

### Configure OpenRegisters Environment

Source: https://docs.openregisters.com/documentation/bulk-data

This command copies the example environment file and instructs to edit it with custom configurations. It's a common step for setting up services that rely on environment variables.

```bash
cp .env.example .env
# Edit .env with your configuration
```

--------------------------------

### OpenRegisters Data Schema Example

Source: https://docs.openregisters.com/documentation/bulk-data

This JSON object defines the structure of the company data provided by OpenRegisters, including details like ID, name, address, and directors.

```json
{
  "companies": [
    {
      "id": "string",
      "name": "string",
      "register_number": "string",
      "jurisdiction": "string",
      "status": "string",
      "registered_address": {
        "street": "string",
        "city": "string",
        "postal_code": "string",
        "country": "string"
      },
      "registration_date": "string",
      "legal_form": "string",
      "business_purpose": "string",
      "directors": [...],
      "shareholders": [...] 
    }
  ]
}
```

--------------------------------

### API Key Authentication Header

Source: https://docs.openregisters.com/api-reference/companies/retrieve-shareholders-real-time

This example shows the required HTTP header for authenticating API requests. An API key obtained from Kausate.com must be included in the 'X-API-Key' header.

```http
X-API-Key: string
```

--------------------------------

### Organization Details API

Source: https://docs.openregisters.com/documentation/handelsregister-api

Get comprehensive details about an organization using its openregisters ID.

```APIDOC
## GET /organizations/{id}

### Description
Retrieves comprehensive details about a specific organization using its unique openregisters ID.

### Method
GET

### Endpoint
/organizations/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique openregisters ID of the organization.

### Response
#### Success Response (200)
- **organizationDetails** (object) - Contains detailed information about the organization.

#### Response Example
{
  "organizationDetails": {
    "name": "Example Corp",
    "openregistersId": "12345",
    "legalForm": "GmbH",
    "status": "Active",
    "registeredAddress": {
      "street": "Example Street 1",
      "city": "Example City",
      "postalCode": "12345",
      "country": "Germany"
    }
  }
}
```

--------------------------------

### GET /v2/companies/search/indexed

Source: https://docs.openregisters.com/api-reference/companies/search-companies-indexed

Searches for companies in the indexed database. Requires an API key for authentication.

```APIDOC
## GET /v2/companies/search/indexed

### Description
Searches for companies using indexed data. Requires an API key for authentication and allows filtering by jurisdiction code, name, and pagination parameters.

### Method
GET

### Endpoint
/v2/companies/search/indexed

### Parameters
#### Path Parameters
None

#### Query Parameters
- **jurisdictionCode** (string) - Optional - Defaults to 'de'. Filters results by jurisdiction.
- **name** (string) - Required - Minimum length: 1. The name of the company to search for.
- **limit** (integer) - Optional - Defaults to 10. Maximum number of results per page. Required range: 1 to 1000.
- **page** (integer) - Optional - Defaults to 0. The page number for pagination. Required range: >= 0.

#### Request Body
None

### Request Example
```curl
curl --request GET \
  --url https://api.openregisters.com/v2/companies/search/indexed \
  --header 'X-API-Key: <api-key>'
```

### Response
#### Success Response (200)
- **searchResults** (CompanySearchResult[]) - Required - An array of company search results.
  - **kausateId** (string) - Required
  - **jurisdictionCode** (string) - Required - ISO 3166-1 alpha-2 country code.
  - **name** (string) - Required
  - **alternativeNames** (string[] | null) - All alternative names (former names) for this company from the index.
  - **identifiers** (Identifier[]) - Company identifiers (e.g., HR number for German companies).
    - **value** (string)
    - **type** (string)
    - **description** (string)
- **pagination** (object) - Required - Pagination information for search results.
  - **page** (integer) - Required
  - **limit** (integer) - Required
  - **hasMore** (boolean) - Required

#### Response Example
```json
{
  "searchResults": [
    {
      "kausateId": "<string>",
      "jurisdictionCode": "<string>",
      "name": "<string>",
      "alternativeNames": [
        "<string>"
      ],
      "identifiers": [
        {
          "value": "<string>",
          "type": "<string>",
          "description": "<string>"
        }
      ]
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "hasMore": true
  }
}
```

#### Error Response
- **422**: Unprocessable Entity
```

--------------------------------

### Sample Completed Company Report Response

Source: https://docs.openregisters.com/api-reference/companies/retrieve-company-report-real-time

This is an example of a successful response from the OpenRegisters API when requesting a company report. It contains details such as order ID, status, request/response times, and comprehensive company information including basic details, identifiers, addresses, activities, and legal representatives.

```json
{
  "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"
          }
        ]
      }
    }
  }
}
```

--------------------------------

### Example JSON Request Body for Shareholder Graph Extraction

Source: https://docs.openregisters.com/api-reference/companies/extract-multi-level-shareholder-graph-real-time

This JSON object represents the body of a POST request to the shareholder graph API. It includes a `customerReference` for tracking and `maxDepth` to define how many levels of ownership to include in the graph.

```json
{
  "customerReference": "<string>",
  "maxDepth": 3
}
```

--------------------------------

### Shareholder Graph API Response Example

Source: https://docs.openregisters.com/api-reference/companies/extract-multi-level-shareholder-graph-real-time

This is a sample JSON response from the OpenRegisters API after a successful request to extract a shareholder graph. It includes order details, status, timestamps, and the resulting graph structure with nodes (companies and persons) and edges representing ownership relationships.

```JSON
{
  "orderId": "shareholder-graph-co_de_abc123-20240319143022",
  "customerReference": "my-ref-123",
  "status": "completed",
  "requestTime": "2024-03-19T14:30:22.787045Z",
  "responseTime": "2024-03-19T14:35:45.108791Z",
  "result": {
    "graph": {
      "nodes": [
        {
          "id": "co_de_abc123",
          "type": "rootEntity",
          "data": {
            "kausateId": "co_de_abc123",
            "legalName": "Parent Company GmbH",
            "jurisdictionCode": "de",
            "identifiers": [
              {
                "value": "co_de_abc123",
                "type": "kausate_id",
                "description": "Kausate universal company identifier"
              },
              {
                "value": "D2601V_HRB123456",
                "type": "de_registernumber_full",
                "description": "German commercial register number with court code"
              }
            ],
            "cumulativeOwnership": 100,
            "shareholderReport": {
              "sources": {
                "handelsregister_shareholder_abc123": {
                  "type": "registrar",
                  "name": "Handelsregister Deutschland",
                  "jurisdictionCode": "de",
                  "retrievalTime": "2024-03-19T14:30:00Z",
                  "downloadUrl": "https://www.kausate.com/downloads/sample.pdf",
                  "fileHash": "abc123...",
                  "fileName": "sample.pdf",
                  "date": {
                    "original": "2024-03-15",
                    "normalized": "2024-03-15"
                  }
                }
              },
              "shareholders": [
                {
                  "type": "company",
                  "company": {
                    "name": "Subsidiary AG",
                    "jurisdictionCode": "de",
                    "identifier": [
                      {
                        "value": "HRB 98765",
                        "type": "de_registernumber_weak",
                        "description": "AG Frankfurt"
                      },
                      {
                        "value": "co_de_xyz789",
                        "type": "kausate_id",
                        "description": "Kausate Universal Identifier"
                      }
                    ]
                  },
                  "numberOfShares": 750,
                  "percentage": 75,
                  "totalNominalValue": {
                    "amount": "75000",
                    "iso4217CurrencyCode": "EUR"
                  },
                  "source": "handelsregister_shareholder_abc123"
                },
                {
                  "type": "person",
                  "person": {
                    "jurisdictionCode": "de",
                    "name": {
                      "firstName": "John",
                      "lastName": "Doe",
                      "fullName": "John Doe"
                    }
                  },
                  "numberOfShares": 250,
                  "percentage": 25,
                  "totalNominalValue": {
                    "amount": "25000",
                    "iso4217CurrencyCode": "EUR"
                  },
                  "source": "handelsregister_shareholder_abc123"
                }
              ]
            }
          }
        },
        {
          "id": "co_de_xyz789",
          "type": "company",
          "data": {
            "kausateId": "co_de_xyz789",
            "legalName": "Subsidiary AG",
            "jurisdictionCode": "de",
            "identifiers": [
              {
                "value": "co_de_xyz789",
                "type": "kausate_id",
                "description": "Kausate universal company identifier"
              },
              {
                "value": "HRB 98765",
                "type": "de_registernumber_weak",
                "description": "German commercial register number"
              }
            ],
            "cumulativeOwnership": 75
          }
        },
        {
          "id": "person_John_Doe",
          "type": "person",
          "data": {
            "name": "John Doe",
            "cumulativeOwnership": 25
          }
        }
      ],
      "edges": [
        {
          "id": "co_de_abc123-co_de_xyz789",
          "source": "co_de_abc123",
          "target": "co_de_xyz789"
        }
      ]
    }
  }
}
```

--------------------------------

### Company ID Path Parameter

Source: https://docs.openregisters.com/api-reference/companies/retrieve-shareholders-real-time

This example defines the 'kausateId' path parameter, which is a required string representing the company ID for API requests.

```http
kausateId: string (required)
```

--------------------------------

### Example JSON Response for Completed Shareholder Graph

Source: https://docs.openregisters.com/api-reference/companies/extract-multi-level-shareholder-graph-real-time

This is a successful JSON response from the Open Registers API after requesting a shareholder graph. It includes details about the request, status, timestamps, and the extracted graph data, including nodes with company and person information, ownership percentages, and total nominal values.

```json
{
  "orderId": "shareholder-graph-co_de_abc123-20240319143022",
  "customerReference": "my-ref-123",
  "status": "completed",
  "requestTime": "2024-03-19T14:30:22.787045Z",
  "responseTime": "2024-03-19T14:35:45.108791Z",
  "result": {
    "graph": {
      "nodes": [
        {
          "id": "co_de_abc123",
          "type": "rootEntity",
          "data": {
            "kausateId": "co_de_abc123",
            "legalName": "Parent Company GmbH",
            "jurisdictionCode": "de",
            "identifiers": [
              {
                "value": "co_de_abc123",
                "type": "kausate_id",
                "description": "Kausate universal company identifier"
              },
              {
                "value": "D2601V_HRB123456",
                "type": "de_registernumber_full",
                "description": "German commercial register number with court code"
              }
            ],
            "cumulativeOwnership": 100,
            "shareholderReport": {
              "sources": {
                "handelsregister_shareholder_abc123": {
                  "type": "registrar",
                  "name": "Handelsregister Deutschland",
                  "jurisdictionCode": "de",
                  "retrievalTime": "2024-03-19T14:30:00Z",
                  "downloadUrl": "https://www.kausate.com/downloads/sample.pdf",
                  "fileHash": "abc123...",
                  "fileName": "sample.pdf",
                  "date": {
                    "original": "2024-03-15",
                    "normalized": "2024-03-15"
                  }
                }
              },
              "shareholders": [
                {
                  "type": "company",
                  "company": {
                    "name": "Subsidiary AG",
                    "jurisdictionCode": "de",
                    "identifier": [
                      {
                        "value": "HRB 98765",
                        "type": "de_registernumber_weak",
                        "description": "AG Frankfurt"
                      },
                      {
                        "value": "co_de_xyz789",
                        "type": "kausate_id",
                        "description": "Kausate Universal Identifier"
                      }
                    ]
                  },
                  "numberOfShares": 750,
                  "percentage": 75,
                  "totalNominalValue": {
                    "amount": "75000",
                    "iso4217CurrencyCode": "EUR"
                  },
                  "source": "handelsregister_shareholder_abc123"
                },
                {
                  "type": "person",
                  "person": {
                    "jurisdictionCode": "de",
                    "name": {
                      "firstName": "John",
                      "lastName": "Doe",
                      "fullName": "John Doe"
                    }
                  },
                  "numberOfShares": 250,
                  "percentage": 25,
                  "totalNominalValue": {
                    "amount": "25000",
                    "iso4217CurrencyCode": "EUR"
                  },
                  "source": "handelsregister_shareholder_abc123"
                }
              ]
            }
          }
        },
        {
          "id": "co_de_xyz789",
          "type": "company",
          "data": {
            "percentage": 75,
            "numberOfShares": 750,
            "totalNominalValue": {
              "amount": "75000",
              "iso4217CurrencyCode": "EUR"
            }
          }
        },
        {
          "id": "co_de_abc123-person_John_Doe",
          "source": "co_de_abc123",
          "target": "person_John_Doe",
          "data": {
            "percentage": 25,
            "numberOfShares": 250,
            "totalNominalValue": {
              "amount": "25000",
              "iso4217CurrencyCode": "EUR"
            }
          }
        }
      ],
      "rootCompanyId": "co_de_abc123",
      "maxDepth": 3,
      "extractionTimestamp": "2024-03-19T14:30:22Z"
    }
  },
  "errors": [],
  "warnings": [],
  "extractedCompanies": [
    "co_de_abc123",
    "co_de_xyz789"
  ]
}
```

--------------------------------

### Set up OpenRegisters Database

Source: https://docs.openregisters.com/documentation/bulk-data

This command runs a Docker container to set up the database for OpenRegisters.

```docker
docker run openregisters/db-setup
```

--------------------------------

### Download OpenRegisters Docker Images

Source: https://docs.openregisters.com/documentation/bulk-data

This command sequence downloads the necessary Docker images for the OpenRegisters API, matcher, and updater services.

```docker
docker pull openregisters/api
docker pull openregisters/matcher
docker pull openregisters/updater
```

--------------------------------

### Get Order Details

Source: https://docs.openregisters.com/api-reference/orders/retrieve-order

Retrieves the details and execution status of a specific order using its unique Order ID.

```APIDOC
## GET /orders/{orderId}

### Description
Retrieves the details and execution status of a specific order using its unique Order ID.

### Method
GET

### Endpoint
/orders/{orderId}

### Parameters
#### Path Parameters
- **orderId** (string) - Required - Order ID to retrieve details for

#### Query Parameters
- **customerPartnerId** (string | null) - Optional - Customer partner ID for validation

#### Headers
- **X-API-Key** (string) - Required - Sign up at Kausate.com to get an API key

### Response
#### Success Response (200)
- **orderId** (string) - Order ID (temporal workflow id)
- **status** (enum<string>) - Order status. Available options: `running`, `completed`, `failed`, `canceled`, `terminated`, `timedOut`
- **requestTime** (string<date-time>) - Timestamp when the order was requested
- **customerReference** (string | null) - Customer reference
- **partnerCustomerId** (string | null) - Partner customer ID
- **responseTime** (string<date-time> | null) - Timestamp when the order response was generated
- **result** (any) - Order result
- **error** (string | null) - Error message if the order failed
- **currentActivity** (string | null) - Currently running activity name

### Response Example
```json
{
  "orderId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "status": "completed",
  "requestTime": "2023-10-27T10:00:00Z",
  "customerReference": "CUST123",
  "partnerCustomerId": "PARTNER456",
  "responseTime": "2023-10-27T10:05:00Z",
  "result": {
    "message": "Order processed successfully"
  },
  "error": null,
  "currentActivity": null
}
```
```

--------------------------------

### POST /v2/companies/{kausateId}/products/order

Source: https://docs.openregisters.com/api-reference/companies/retrieve-company-document-real-time

Places an order for a product (documents only) for a specific company. Requires authentication via an API key.

```APIDOC
## POST /v2/companies/{kausateId}/products/order

### Description
Places an order for a product (documents only) for a specific company. Requires authentication via an API key.

### Method
POST

### Endpoint
/v2/companies/{kausateId}/products/order

### Parameters
#### Path Parameters
- **kausateId** (string) - Required - Company ID

#### Query Parameters
- **sync** (boolean) - Optional - Default:false - Return result synchronously with 300s timeout

#### Headers
- **X-API-Key** (string) - Required - Sign up at Kausate.com to get an API key
- **X-Partner-Customer-Id** (string | null) - Optional - Optional partner customer ID

#### Request Body
- **sku** (string) - Required - 
- **customerReference** (string | null) - Optional - Maximum length: 255

### Request Example
```json
{
  "customerReference": "<string>",
  "sku": "<string>"
}
```

### Response
#### Success Response (200)
- **orderId** (string) - Required - 
- **customerReference** (string | null) - Maximum length: 255
- **partnerCustomerId** (string | null) - Maximum length: 255

#### Response Example
```json
{
  "orderId": "<string>",
  "customerReference": "<string>",
  "partnerCustomerId": "<string>"
}
```
```

--------------------------------

### Order Product via cURL

Source: https://docs.openregisters.com/api-reference/companies/retrieve-company-document-real-time

This snippet demonstrates how to order a product (documents only) from the Open Registers API using cURL. It requires an API key and specifies the company ID, customer reference, and SKU in the request body. The response includes an order ID and customer details.

```cURL
curl --request POST \
  --url https://api.openregisters.com/v2/companies/{kausateId}/products/order \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{ \
  "customerReference": "<string>", \
  "sku": "<string>" \
}'
```

--------------------------------

### GET /websites/openregisters/orders/{orderId}

Source: https://docs.openregisters.com/api-reference/companies/extract-multi-level-shareholder-graph-real-time

Retrieves the status and results of a previously placed shareholder extraction order. Use the order ID obtained from the POST request.

```APIDOC
## GET /websites/openregisters/orders/{orderId}

### Description
Retrieves the status and results of a previously placed shareholder extraction order. Use the order ID obtained from the POST request.

### Method
GET

### Endpoint
/websites/openregisters/orders/{orderId}

### Parameters
#### Path Parameters
- **orderId** (string) - Required - The unique identifier for the extraction order.

#### Headers
- **X-API-Key** (string) - Required - Sign up at Kausate.com to get an API key

### Response
#### Success Response (200)
- **data** (object) - Contains the extracted shareholder graph data.
  - **nodes** (array) - List of entities (companies or persons) in the ownership graph.
    - **id** (string) - Unique identifier for the entity.
    - **type** (string) - Type of the entity ('company' or 'person').
    - **data** (object) - Specific data for the entity.
      - **kausateId** (string) - For company type, the Kausate ID.
      - **legalName** (string) - For company type, the legal name.
      - **jurisdictionCode** (string) - For company type, the jurisdiction code.
      - **identifiers** (array) - List of identifiers for the company.
        - **value** (string) - The identifier value.
        - **type** (string) - The type of identifier.
        - **description** (string) - Description of the identifier.
      - **cumulativeOwnership** (integer) - For company or person, their cumulative ownership percentage in the root company.
      - **name** (string) - For person type, the name of the person.
  - **edges** (array) - List of ownership relationships between entities.
    - **id** (string) - Unique identifier for the relationship.
    - **source** (string) - The ID of the entity providing ownership.
    - **target** (string) - The ID of the entity receiving ownership.
    - **data** (object) - Details of the ownership relationship.
      - **percentage** (integer) - Ownership percentage.
      - **numberOfShares** (integer) - Number of shares.
      - **totalNominalValue** (object) - Total nominal value of shares.
        - **amount** (string) - The monetary amount.
        - **iso4217CurrencyCode** (string) - The ISO 4217 currency code.
  - **rootCompanyId** (string) - The ID of the root company for this ownership graph.
  - **maxDepth** (integer) - The maximum depth of ownership levels extracted.
  - **extractionTimestamp** (string) - The timestamp when the extraction was performed.
- **errors** (array) - List of errors encountered during extraction.
- **warnings** (array) - List of warnings encountered during extraction.
- **extractedCompanies** (array) - List of company IDs extracted in this process.

#### Response Example
```json
{
  "data": {
    "nodes": [
      {
        "id": "co_de_abc123",
        "type": "company",
        "data": {
          "kausateId": "co_de_abc123",
          "legalName": "Parent Corp",
          "jurisdictionCode": "de",
          "identifiers": [
            {
              "value": "co_de_abc123",
              "type": "kausate_id",
              "description": "Kausate universal company identifier"
            }
          ],
          "cumulativeOwnership": 100
        }
      },
      {
        "id": "co_de_xyz789",
        "type": "company",
        "data": {
          "kausateId": "co_de_xyz789",
          "legalName": "Subsidiary AG",
          "jurisdictionCode": "de",
          "identifiers": [
            {
              "value": "co_de_xyz789",
              "type": "kausate_id",
              "description": "Kausate universal company identifier"
            },
            {
              "value": "HRB 98765",
              "type": "de_registernumber_weak",
              "description": "German commercial register number"
            }
          ],
          "cumulativeOwnership": 75
        }
      },
      {
        "id": "person_John_Doe",
        "type": "person",
        "data": {
          "name": "John Doe",
          "cumulativeOwnership": 25
        }
      }
    ],
    "edges": [
      {
        "id": "co_de_abc123-co_de_xyz789",
        "source": "co_de_abc123",
        "target": "co_de_xyz789",
        "data": {
          "percentage": 75,
          "numberOfShares": 750,
          "totalNominalValue": {
            "amount": "75000",
            "iso4217CurrencyCode": "EUR"
          }
        }
      },
      {
        "id": "co_de_abc123-person_John_Doe",
        "source": "co_de_abc123",
        "target": "person_John_Doe",
        "data": {
          "percentage": 25,
          "numberOfShares": 250,
          "totalNominalValue": {
            "amount": "25000",
            "iso4217CurrencyCode": "EUR"
          }
        }
      }
    ],
    "rootCompanyId": "co_de_abc123",
    "maxDepth": 3,
    "extractionTimestamp": "2024-03-19T14:30:22Z"
  },
  "errors": [],
  "warnings": [],
  "extractedCompanies": [
    "co_de_abc123",
    "co_de_xyz789"
  ]
}
```

#### Error Handling
- 400 Bad Request: Invalid order ID format.
- 401 Unauthorized: Invalid or missing API key.
- 404 Not Found: The specified orderId does not exist or has expired.
- 500 Internal Server Error: An unexpected error occurred on the server.
```

--------------------------------

### POST /v2/companies/search/live

Source: https://docs.openregisters.com/api-reference/companies/search-companies-real-time

Performs a real-time search for companies based on the provided company name and jurisdiction code.

```APIDOC
## POST /v2/companies/search/live

### Description
Performs a real-time search for companies. You can optionally specify a jurisdiction code. The search is performed against an indexed database for faster results.

### Method
POST

### Endpoint
/v2/companies/search/live

### Parameters
#### Path Parameters
None

#### Query Parameters
- **sync** (boolean) - Optional - Defaults to true. If true, the request waits for results. If false, it returns a workflow ID immediately.

#### Request Body
- **companyName** (string) - Required - The name of the company to search for. Minimum length: 1.
- **jurisdictionCode** (string) - Optional - Defaults to 'de'. The ISO 3166-1 alpha-2 country code (e.g., 'de' for Germany).
- **customerReference** (string | null) - Optional - A customer reference for tracking. Maximum length: 255.

### Request Example
```json
{
  "companyName": "Lindt",
  "jurisdictionCode": "de"
}
```

### Response
#### Success Response (200)
- **searchResults** (object[]) - Required - An array of company search results.
  - **kausateId** (string) - Required - Unique identifier for the company.
  - **jurisdictionCode** (string) - Required - ISO 3166-1 alpha-2 country code.
  - **name** (string) - Required - The name of the company.
  - **alternativeNames** (string[] | null) - Optional - All alternative or former names for the company.
  - **identifiers** (object[] | null) - Optional - Company identifiers such as HR numbers.
    - **value** (string) - The identifier value.
    - **type** (string) - The type of identifier.
    - **description** (string) - A description of the identifier.

#### Response Example
```json
{
  "searchResults": [
    {
      "kausateId": "<string>",
      "jurisdictionCode": "<string>",
      "name": "<string>",
      "alternativeNames": [
        "<string>"
      ],
      "identifiers": [
        {
          "value": "<string>",
          "type": "<string>",
          "description": "<string>"
        }
      ]
    }
  ]
}
```

#### Headers
- **X-API-Key** (string) - Required - Your API key obtained from Kausate.com.
- **X-Partner-Customer-Id** (string | null) - Optional - Your partner customer ID.
```

--------------------------------

### Shareholder Extraction Request Body

Source: https://docs.openregisters.com/api-reference/companies/retrieve-shareholders-real-time

This example defines the JSON request body for initiating a shareholder extraction. It includes an optional 'customerReference' field with a maximum length of 255 characters.

```json
{
  "customerReference": "string | null" (Maximum length: 255)
}
```

--------------------------------

### Search Companies (Indexed) using cURL

Source: https://docs.openregisters.com/api-reference/companies/search-companies-indexed

This snippet demonstrates how to perform an indexed search for companies using cURL. It requires an API key in the header and specifies the endpoint for the search. The response includes company details and pagination information.

```bash
curl --request GET \
  --url https://api.openregisters.com/v2/companies/search/indexed \
  --header 'X-API-Key: <api-key>'
```

--------------------------------

### API Key Authentication

Source: https://docs.openregisters.com/api-reference/companies/extract-multi-level-shareholder-graph-real-time

Authentication for the Kausate API is handled via an API key provided in the 'X-API-Key' header. Users need to sign up at Kausate.com to obtain their key. This is a required header for all requests.

```text
X-API-Key: string
header
required
Sign up at Kausate.com to get an API key
```
Tokens:
Raw