POST
/
v2
/
companies
/
{kausateId}
/
shareholders
Retrieve Shareholders (real-time)
curl --request POST \
  --url https://api.openregisters.com/v2/companies/{kausateId}/shareholders \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "customerReference": "<string>"
}'
{
  "orderId": "shareholders-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": {
    "shareholderReport": {
      "sources": {
        "handelsregister_shareholder_******": {
          "type": "registrar",
          "name": "Handelsregister Deutschland",
          "jurisdictionCode": "de",
          "retrievalTime": "2024-03-19T14:30:50.996406",
          "downloadUrl": "https://example.com/path/to/shareholders.pdf",
          "fileHash": "abc123def456...",
          "fileName": "List_of_shareholders_entry_abc123def456.pdf",
          "date": {
            "original": "2024-03-19",
            "normalized": "2024-03-19"
          }
        }
      },
      "shareholders": [
        {
          "type": "company",
          "company": {
            "address": {
              "type": "registered",
              "original": "München"
            },
            "jurisdictionCode": "de",
            "identifier": [
              {
                "value": "HRB ******",
                "type": "de_registernumber_weak",
                "description": "Register: AG München"
              },
              {
                "value": "D2601V_HRB******",
                "type": "de_registernumber_full",
                "description": "Register: AG München"
              }
            ],
            "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_******"
        }
      ]
    }
  }
}

Authorizations

​
X-API-Key
string
header
required

Sign up at Kausate.com to get an API key

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 shareholder extraction.

Response

Shareholder extraction order successfully placed

Response model for product order.