Kantwert REST api API Reference

Welcome to the kantwert API documentation!
Get easy access to our data and use our logics with the integration of our REST services to your existing systems. You can decide which information you want to use according to your personal use case. From master data to complex ultimate benefial owner relationships – our API provides you the information you need.

API Endpoint
http://b2b-external-rest-service/api/v1/
Contact: jakub.kubiczak@kantwert.de
Response Content-Types: application/json
Schemes: http
Version: v1.0

Search

Returns list of companies/persons that match to specified search criteria. Unique or multiple results are possible.

Returns companies for specified search criteria.

GET /companies/search
name: string
in query

(no description)

legalNumber: string
in query

(no description)

bankruptcyNumber: string
in query

(no description)

countryCode: string
in query

(no description)

zip: string
in query

(no description)

city: string
in query

(no description)

streetHouseNumber: string
in query

(no description)

email: string
in query

(no description)

url: string
in query

(no description)

telephone: string
in query

(no description)

zipRegistrationCourt: string
in query

(no description)

cityRegistrationCourt: string
in query

(no description)

zipBankruptcyCourt: string
in query

(no description)

cityBankruptcyCourt: string
in query

(no description)

sort: string
in query

(no description)

status: string ACTIVE, INACTIVE
in query

(no description)

searchProfile: string STANDARD, PRECISE, CANDIDATES
in query

(no description)

page: integer 0
in query

Fist page has number 0

pageSize: integer 25
in query

(no description)

Authorization: string
in header

(no description)

400 Bad Request

Invalid request

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "content": [
    {
      "addresses": [
        [
          {
            "street": "Rügenwalder Str. 123 b",
            "city": "Bremen",
            "zip": "28195",
            "country": "DE",
            "type": "GE",
            "current": false
          },
          {
            "street": "Bachstraße 123",
            "city": "Bremen",
            "zip": "28199",
            "country": "DE",
            "type": "GE",
            "current": true
          }
        ]
      ],
      "id": "string (uuid)",
      "name": "kantwert GmbH",
      "status": "string",
      "telephones": [
        "string"
      ],
      "faxes": [
        "string"
      ],
      "websites": [
        "string"
      ],
      "currentStreet": "Rügenwalder Str. 123 b",
      "currentCity": "Brement",
      "currentZip": "28199",
      "currentCountry": "DE",
      "registrationNumber": "HRB 12345",
      "registrationCourtCity": "Hamburg",
      "registrationCourtZipCode": "22765"
    }
  ],
  "page": "integer (int32)",
  "pageSize": 25
}

Returns persons for specified search criteria.

GET /persons/search
firstName: string
in query

(no description)

lastName: string
in query

(no description)

dateOfBirth: string (date)
in query

(no description)

yearOfBirth: integer
in query

(no description)

countryCode: string
in query

(no description)

zip: string
in query

(no description)

city: string
in query

(no description)

streetNumber: string
in query

(no description)

email: string
in query

(no description)

telephone: string
in query

(no description)

companyName: string
in query

(no description)

enrichWithTags: boolean false
in query

(no description)

sort: string
in query

(no description)

searchProfile: string STANDARD, PRECISE, CANDIDATES
in query

(no description)

page: integer 0
in query

Fist page has number 0

pageSize: integer 25
in query

(no description)

Authorization: string
in header

(no description)

400 Bad Request

Invalid request

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "content": [
    {
      "id": "string (uuid)",
      "firstName": "John",
      "lastName": "Doe",
      "dateOfBirth": "1985-02-14",
      "addresses": [
        [
          {
            "street": "Rügenwalder Str. 123 b",
            "city": "Bremen",
            "zip": "28195",
            "country": "DE",
            "type": "GE",
            "current": false
          },
          {
            "street": "Bachstraße 123",
            "city": "Bremen",
            "zip": "28199",
            "country": "DE",
            "type": "GE",
            "current": true
          }
        ]
      ],
      "currentCity": "string"
    }
  ],
  "page": "integer (int32)",
  "pageSize": 25
}

Select

Returns list of companies/persons that match to specified parameters. Unique or multiple results are possible.

Returns companies that match

POST /companies/select

undefined

page: integer 0
in query

Fist page has number 0

pageSize: integer 25
in query

(no description)

Request Example
{
  "city": "Bonn",
  "countryCode": "DE",
  "insolvent": true,
  "status": "string",
  "foundingYears": [
    {
      "from": 1980,
      "to": 1985
    }
  ],
  "legalTypes": [
    "G"
  ],
  "capital": [
    {
      "from": 3000,
      "to": 5000
    }
  ],
  "industryCodePrefixes": [
    "62"
  ],
  "employeeClasses": [
    "6-50"
  ],
  "turnoverClasses": [
    "500-999"
  ],
  "riskInfo": "F1_R3",
  "zipCodePrefixes": [
    "422"
  ]
}
400 Bad Request

Wrong request

500 Internal Server Error

Backing server failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "content": [
    {
      "addresses": [
        [
          {
            "street": "Rügenwalder Str. 123 b",
            "city": "Bremen",
            "zip": "28195",
            "country": "DE",
            "type": "GE",
            "current": false
          },
          {
            "street": "Bachstraße 123",
            "city": "Bremen",
            "zip": "28199",
            "country": "DE",
            "type": "GE",
            "current": true
          }
        ]
      ],
      "legalType": "UG",
      "wz08Codes": [
        "701",
        "70102"
      ],
      "employees": 4,
      "employeeClass": "0-5",
      "turnover": 567,
      "turnoverClass": "500-999",
      "turnoverCurrency": "EUR",
      "currentStreet": "Rügenwalder Str. 123 b",
      "currentCity": "Brement",
      "currentZip": "28199",
      "currentCountry": "DE",
      "registrationNumber": "HRB 12345",
      "registrationCourtCity": "Hamburg",
      "registrationCourtZipCode": "22765"
    }
  ],
  "page": "integer (int32)",
  "pageSize": 25
}

Returns CSV file with companies that match

POST /companies/select/csv

undefined

page: integer 0
in query

Fist page has number 0

pageSize: integer 25
in query

(no description)

Request Example
{
  "city": "Bonn",
  "countryCode": "DE",
  "insolvent": true,
  "status": "string",
  "foundingYears": [
    {
      "from": 1980,
      "to": 1985
    }
  ],
  "legalTypes": [
    "G"
  ],
  "capital": [
    {
      "from": 3000,
      "to": 5000
    }
  ],
  "industryCodePrefixes": [
    "62"
  ],
  "employeeClasses": [
    "6-50"
  ],
  "turnoverClasses": [
    "500-999"
  ],
  "riskInfo": "F1_R3",
  "zipCodePrefixes": [
    "422"
  ]
}
200 OK

A CSV file

type
file
400 Bad Request

Wrong request

500 Internal Server Error

Backing server failure

Response Content-Types: text/csv
Response Example (200 OK)
"file"

Returns persons that match

POST /persons/select

undefined

page: integer 0
in query

Fist page has number 0

pageSize: integer 25
in query

(no description)

Request Example
{
  "birthYears": [
    {
      "from": 1980,
      "to": 1985
    }
  ],
  "city": "Bonn",
  "countryCode": "DE",
  "deceased": false,
  "functions": [
    "SHAREHOLDER",
    "MANAGING_DIRECTOR",
    "PARTNER_WITH_UNLIMITED_LIABILITY"
  ],
  "numberOfFunctions": [
    {
      "from": 3,
      "to": 10
    }
  ],
  "zipCodePrefixes": [
    "422"
  ]
}
400 Bad Request

Wrong request

500 Internal Server Error

Backing server failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "content": [
    {
      "uuid": "d062d18c-abd5-4ad9-a7e7-5fc35994caaf",
      "firstName": "Jörg",
      "lastName": "Müller",
      "dateOfBirth": "1985-03-21",
      "alive": "boolean",
      "academicDegree": "Dr.",
      "addresses": [
        [
          {
            "street": "Rügenwalder Str. 123 b",
            "city": "Bremen",
            "zip": "28195",
            "country": "DE",
            "type": "GE",
            "current": false
          },
          {
            "street": "Bachstraße 123",
            "city": "Bremen",
            "zip": "28199",
            "country": "DE",
            "type": "GE",
            "current": true
          }
        ]
      ],
      "tags": [
        {
          "tagName": "KUNDE",
          "ownerId": "676f3993-3dde-486c-904d-468d0e1dbc39",
          "ownerType": "CLIENT",
          "ownerName": "Foobar GmbH"
        }
      ],
      "hrInformations": [
        {
          "datePublished": "2015-05-18",
          "text": "string",
          "type": "string"
        }
      ],
      "historicalDatesOfBirth": [
        "1985-03-20"
      ],
      "historicalNames": [
        {
          "firstName": "Jörg",
          "lastName": "Mahler"
        }
      ],
      "currentStreet": "Rügenwalder Str. 123 b",
      "currentCity": "Brement",
      "currentZip": "28199",
      "currentCountry": "DE"
    }
  ],
  "page": "integer (int32)",
  "pageSize": 25
}

Returns CSV file with persons that match

POST /persons/select/csv

undefined

page: integer 0
in query

Fist page has number 0

pageSize: integer 25
in query

(no description)

Request Example
{
  "birthYears": [
    {
      "from": 1980,
      "to": 1985
    }
  ],
  "city": "Bonn",
  "countryCode": "DE",
  "deceased": false,
  "functions": [
    "SHAREHOLDER",
    "MANAGING_DIRECTOR",
    "PARTNER_WITH_UNLIMITED_LIABILITY"
  ],
  "numberOfFunctions": [
    {
      "from": 3,
      "to": 10
    }
  ],
  "zipCodePrefixes": [
    "422"
  ]
}
200 OK

A CSV file

type
file
400 Bad Request

Wrong request

500 Internal Server Error

Backing server failure

Response Content-Types: text/csv
Response Example (200 OK)
"file"

Tags

Tags can be assigned by a user to a company or person. Following tag types are pre-defined for companies:

KUNDE
Customer
INTERESSENT
Lead
LIEFERANT
Supplier
OUT_OF_SCOPE
TROUBLE_SPOT
Following tag types are pre-defined for persons:
KONTAKT
Contact
OUT_OF_SCOPE
TROUBLE_SPOT
Furthermore, freetext tags can be created for companies or persons.

Return tag names for current user.

GET /users/current/tagNames

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Person not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "userTagsForCompanies": [
    "LIEFERANT"
  ],
  "userTagsForPersons": [],
  "clientTagsForCompanies": [
    "INTERESSENT",
    "KUNDE"
  ],
  "clientTagsForPersons": [
    "KONTAKT"
  ]
}

Creates new tag.

POST /users/current/tags

undefined

Request Example
{
  "asClient": false,
  "taggedNodeId": "d7912742-eb2c-4027-ab4e-36f9f7bd9efe",
  "name": "KUNDE"
}
201 Created

Tag created

400 Bad Request

Invalid ID supplied

404 Not Found

entity not found

500 Internal Server Error

Backing server failure

Response Example (201 Created)
{
  "tagName": "KUNDE",
  "ownerId": "676f3993-3dde-486c-904d-468d0e1dbc39",
  "ownerType": "CLIENT",
  "ownerName": "Foobar GmbH"
}

Deletes tag.

DELETE /users/current/tags
asClient: boolean false
in query

(no description)

taggedNodeId: string (uuid)
in query

(no description)

name: string
in query

Tag name

200 OK

Tag was deleted

400 Bad Request

Wrong request

404 Not Found

entity not found

500 Internal Server Error

Backing server failure

Master data

Returns short master data information for persons or companies. For persons address or DOB information will be returned. For companies address, contact, trade register, key numbers and risk information will be returned.

Returns short master data information

GET /companies/{uuid}/masterData/short
uuid: string (uuid)
in path

ID of company to return master data of

400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "name": "Foobar GmbH",
  "address": {
    "street": "string",
    "plz": "string",
    "country": "string",
    "city": "string"
  },
  "status": "boolean",
  "insolvencyInfoPresent": "boolean",
  "riskInfo": "string",
  "uuid": "string (uuid)"
}

Returns short master data information

GET /persons/{uuid}/masterData/short
uuid: string (uuid)
in path

ID of company to return master data of

400 Bad Request

Invalid ID supplied

404 Not Found

Person not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "address": {
    "street": "string",
    "plz": "string",
    "country": "string",
    "city": "string"
  },
  "dateOfBirth": "1985-03-01",
  "alive": "boolean",
  "uuid": "string (uuid)"
}

Returns master data information

GET /companies/{uuid}/masterData
uuid: string (uuid)
in path

ID of company to return master data of

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "name": "Foobar GmbH",
  "lei": "UWJKFUJFZ02DKWI3RY53",
  "address": {
    "street": "string",
    "plz": "string",
    "country": "string",
    "city": "string"
  },
  "contact": {
    "website": [
      "string"
    ],
    "emails": [
      "string (email)"
    ],
    "fax": [
      {
        "number": "string",
        "description": "string"
      }
    ],
    "phones": [
      {
        "number": "string",
        "description": "string"
      }
    ]
  },
  "tradeRegister": {
    "status": "boolean",
    "foundingDate": "2011-21-07",
    "form": "string",
    "registryNumber": "string",
    "registryCity": "string",
    "registryZip": "string ([0-9]{5})",
    "capital": "number",
    "capitalCurrency": "string",
    "vatId": "string"
  },
  "keyFigures": {
    "employees": "integer",
    "employeeClass": "string ([0-9]+ - [0-9]+)",
    "turnover": "number",
    "turnoverCurrency": "string",
    "turnoverClass": "string"
  },
  "wz03Codes": [
    "string"
  ],
  "wz08Codes": [
    "string"
  ],
  "industry": "string",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ],
  "insolvencyInfoPresent": "boolean",
  "riskInfo": "string",
  "riskInfoDate": "2017-07-20",
  "uuid": "string (uuid)"
}

Returns master data information

GET /persons/{uuid}/masterData
uuid: string (uuid)
in path

ID of person to return master data of

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Person not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "address": {
    "street": "string",
    "plz": "string",
    "country": "string",
    "city": "string"
  },
  "dateOfBirth": "1985-03-01",
  "alive": "boolean",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ],
  "uuid": "string (uuid)"
}

UBO list

Returns information about the Ultimate beneficial owners of given company or UBO-relationships of given person. Furthermore, detailed information such as shares and company or person information are delivered. An UBO holds shares ≥ 25%, directly or controlled, of a company. The UBO is calculated by the domination method.

Returns person UBOs for company.

GET /companies/{uuid}/uboList
uuid: string (uuid)
in path

ID of company to query UBO list

offset: integer (int32) 0
in query

Offset

limit: integer (int32) 25
in query

Results in query.

Authorization: string
in header

(no description)

200 OK

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Person not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "list": [
    {
      "uuid": "string (uuid)",
      "firstName": "string",
      "lastName": "string",
      "currentCity": "string",
      "currentCountryCode": "string",
      "dateOfBirth": "1985-03-20",
      "controlledShares": "number",
      "shares": "number"
    }
  ]
}

Returns companies which this person is UBO.

GET /persons/{uuid}/uboList
uuid: string (uuid)
in path

ID of person to create ubo list for

offset: integer (int32) 0
in query

Offset

limit: integer (int32) 25
in query

Results in query.

Authorization: string
in header

(no description)

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Person not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "list": [
    {
      "uuid": "string (uuid)",
      "name": "string",
      "currentCity": "string",
      "currentCountryCode": "string",
      "turnoverClass": "string",
      "wz08Codes": [
        "string"
      ],
      "controlledShares": "number",
      "shares": "number",
      "status": "boolean",
      "hasInsolvencyInfo": "boolean",
      "riskInfo": "string"
    }
  ]
}

UBO network

Returns either the network of a person and the institutions where one is ultimate beneficial owner of, or it shows the network of an institution and the relation to its UBO´s. Furthermore, UBO relationships are counted of entities within network. An UBO holds shares ≥ 25%, directly or controlled, of a company. The UBO is calculated by the domination method.

Returns simple ubo network description.

GET /companies/{uuid}/uboNetwork
uuid: string (uuid)
in path

ID of company to generated ownership UBO

expanded: string[]
in query

(no description)

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Person not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "nodes": [
    {
      "uuid": "string (uuid)",
      "type": "string",
      "name": "string",
      "currentCity": "string",
      "currentCountry": "string",
      "relationshipCount": "integer (int32)",
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ]
    }
  ],
  "edges": [
    {
      "fromUuid": "string (uuid)",
      "toUuid": "string (uuid)",
      "controlledShares": "number (double)"
    }
  ]
}

Returns simple ubo network description.

GET /persons/{uuid}/uboNetwork
uuid: string (uuid)
in path

ID of person to generated ownership UBO

expanded: string[]
in query

(no description)

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Person not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "nodes": [
    {
      "uuid": "string (uuid)",
      "type": "string",
      "name": "string",
      "currentCity": "string",
      "currentCountry": "string",
      "relationshipCount": "integer (int32)",
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ]
    }
  ],
  "edges": [
    {
      "fromUuid": "string (uuid)",
      "toUuid": "string (uuid)",
      "controlledShares": "number (double)"
    }
  ]
}

UBO structure

Returns the structural view of UBO relationships from either a person or a company. Additionally to the UBO relationships, subsidiaries and shareholdings are returned. Besides the shareholder relation, general partner relations are considered as well.

Returns simple ubo structure description.

GET /companies/{uuid}/uboStructure
uuid: string (uuid)
in path

ID of company to generated ownership UBO

expanded: string[]
in query

(no description)

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Person not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "nodes": [
    {
      "uuid": "string (uuid)",
      "name": "string",
      "city": "string",
      "country": "string",
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ],
      "relationshipCount": "integer (int32)",
      "controlledShares": "number (double)",
      "type": "string"
    }
  ],
  "edges": [
    {
      "fromUuid": "string (uuid)",
      "toUuid": "string (uuid)",
      "type": "string",
      "shares": "number (double)",
      "isUboEdge": "boolean"
    }
  ]
}

Returns simple ubo structure description.

GET /persons/{uuid}/uboStructure
uuid: string (uuid)
in path

ID of company to generated ownership UBO

expanded: string[]
in query

(no description)

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Person not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "nodes": [
    {
      "uuid": "string (uuid)",
      "name": "string",
      "city": "string",
      "country": "string",
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ],
      "relationshipCount": "integer (int32)",
      "controlledShares": "number (double)",
      "type": "string"
    }
  ],
  "edges": [
    {
      "fromUuid": "string (uuid)",
      "toUuid": "string (uuid)",
      "type": "string",
      "shares": "number (double)",
      "isUboEdge": "boolean"
    }
  ]
}

Contacts network

Returns the contacts network overview of a person. The contacts network shows the relations to persons which the given person knows. The relations of persons are calculated according to their functions in institutions. Besides the KNOWS-relations between persons, the companies returned to which the connected persons have a active and/or historic relation to.

Returns contacts network description.

GET /persons/{uuid}/contactsNetwork
uuid: string (uuid)
in path

ID of person to contacts network for

400 Bad Request

Invalid ID supplied

404 Not Found

Person not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "nodes": [
    {
      "uuid": "string (uuid)",
      "name": "string",
      "alive": "boolean",
      "dateOfBirth": "1985-03-20",
      "currentCity": "string",
      "currentCountry": "string",
      "relationshipCount": "integer (int32)",
      "companiesWorking": [
        "string (uuid)"
      ],
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ]
    }
  ],
  "edges": [
    {
      "uuid": "string (uuid)",
      "start": "string (uuid)",
      "end": "string (uuid)",
      "probability": "string",
      "relations": [
        {
          "companyAtTime": "string (uuid)",
          "positionAtTime": "string",
          "contactCompany": "string (uuid)",
          "contactPosition": "string",
          "start": "2015-03-01",
          "end": "2015-10-31"
        }
      ]
    }
  ],
  "companies": [
    {
      "uuid": "string (uuid)",
      "name": "string",
      "city": "string",
      "country": "string",
      "wz08Codes": [
        "string"
      ],
      "personsWorking": [
        "string (uuid)"
      ],
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ]
    }
  ]
}

Customer network

Returns the customer network overview. Returns the network either of a person or an institution. The relations between persons and institutions are displayed according to their functions. The relations between institutions are displayed according to their legal affiliations.

Returns simple network description.

POST /companies/customerNetwork

Query for desired network. One can provide filter of active/inactive connections and entities, relations which should be excluded and nodes which can be expanded.

Request Example
{
  "includeActiveNodes": "boolean",
  "includeInactiveNodes": "boolean",
  "includeActiveRelationships": "boolean",
  "includeInactiveRelationships": "boolean",
  "excludeRelationships": [
    "string"
  ],
  "expandedNodes": [
    "7297bf4a-212a-4a5c-ae79-dee5676cc81a"
  ]
}
400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "cefd6c7e-2270-49dd-a5c7-d87488e97aa2",
  "nodes": [
    {
      "uuid": "3c4d1e2e-aaf2-46cd-9895-39138c7b3308",
      "type": "string",
      "name": "string",
      "relationshipCount": "integer (int32)",
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ]
    }
  ],
  "edges": [
    {
      "uuid": "fa2e8758-61cd-4fbe-a330-0fc9b4982cdd",
      "fromUuid": "5e90eab7-096e-4de2-a86f-c976c3412c84",
      "toUuid": "20ffd0fa-c4ad-40f5-8ccf-dba25fef28ed",
      "type": "string",
      "startDate": "2015-03-01",
      "endDate": "2016-10-31",
      "shares": "number (double)"
    }
  ]
}

Returns simple network description.

POST /persons/customerNetwork

Query for desired network. One can provide filter of active/inactive connections and entities, relations which should be excluded and nodes which can be expanded.

Request Example
{
  "includeActiveNodes": "boolean",
  "includeInactiveNodes": "boolean",
  "includeActiveRelationships": "boolean",
  "includeInactiveRelationships": "boolean",
  "excludeRelationships": [
    "string"
  ],
  "expandedNodes": [
    "7297bf4a-212a-4a5c-ae79-dee5676cc81a"
  ]
}
400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "cefd6c7e-2270-49dd-a5c7-d87488e97aa2",
  "nodes": [
    {
      "uuid": "3c4d1e2e-aaf2-46cd-9895-39138c7b3308",
      "type": "string",
      "name": "string",
      "relationshipCount": "integer (int32)",
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ]
    }
  ],
  "edges": [
    {
      "uuid": "fa2e8758-61cd-4fbe-a330-0fc9b4982cdd",
      "fromUuid": "5e90eab7-096e-4de2-a86f-c976c3412c84",
      "toUuid": "20ffd0fa-c4ad-40f5-8ccf-dba25fef28ed",
      "type": "string",
      "startDate": "2015-03-01",
      "endDate": "2016-10-31",
      "shares": "number (double)"
    }
  ]
}

Ownership network

Ownership network overview. Retruns the structure of ownership networks between persons and institutions. The relations give information about the shares or function that a person or company holds or has at another company.

Returns ownership network description.

GET /companies/{uuid}/ownership
uuid: string (uuid)
in path

ID of person to generate ownership network for

incomingDepth: integer (int32) x ≥ 0 1
in query

(no description)

outgoingDepth: integer (int32) x ≥ 0 1
in query

(no description)

minShares: number (double) 0 ≤ x ≤ 100 0
in query

(no description)

maxShares: number (double) 0 ≤ x ≤ 100 0
in query

(no description)

excludedRelationships: string[]
in query

(no description)

expanded: string[]
in query

(no description)

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Person not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "nodes": [
    {
      "uuid": "string (uuid)",
      "type": "string",
      "name": "string",
      "city": "string",
      "countryCode": "string",
      "relationshipCount": "integer (int32)",
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ]
    }
  ],
  "edges": [
    {
      "uuid": "string (uuid)",
      "fromUuid": "string (uuid)",
      "toUuid": "string (uuid)",
      "type": "string",
      "shares": "number (double)"
    }
  ]
}

Returns ownership network description.

GET /persons/{uuid}/ownership
uuid: string (uuid)
in path

ID of person to generate ownership network for

incomingDepth: integer (int32) x ≥ 0 1
in query

(no description)

outgoingDepth: integer (int32) x ≥ 0 1
in query

(no description)

minShares: number (double) 0 ≤ x ≤ 100 0
in query

(no description)

maxShares: number (double) 0 ≤ x ≤ 100 0
in query

(no description)

excludedRelationships: string[]
in query

(no description)

expanded: string[]
in query

(no description)

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Person not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "nodes": [
    {
      "uuid": "string (uuid)",
      "type": "string",
      "name": "string",
      "city": "string",
      "countryCode": "string",
      "relationshipCount": "integer (int32)",
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ]
    }
  ],
  "edges": [
    {
      "uuid": "string (uuid)",
      "fromUuid": "string (uuid)",
      "toUuid": "string (uuid)",
      "type": "string",
      "shares": "number (double)"
    }
  ]
}

Shortest path

Returns the shortest path between current user and given object. If user has a connection to given object, it is calculated by KNOWS algorithm on the one hand and user´s tags on the other hand. The KNOWS algorithm calculates relations between persons by considering the time range where persons worked together at the same company and by considering their functions.

Returns simple shortest path description.

GET /companies/{uuid}/shortestPath
uuid: string (uuid)
in path

ID of company to return path for

probability: string HIGH, MEDIUM, LOW
in query

KNOWS lowest level

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "paths": [
    {
      "nodes": [
        {
          "uuid": "string (uuid)",
          "type": "string",
          "name": "string",
          "status": "boolean",
          "tags": [
            {
              "tagName": "string",
              "ownerUUID": "string (uuid)",
              "ownerName": "string"
            }
          ]
        }
      ],
      "edges": [
        {
          "fromUuid": "string (uuid)",
          "toUuid": "string (uuid)",
          "type": "string"
        }
      ]
    }
  ]
}

Returns simple network description.

GET /persons/{uuid}/shortestPath
uuid: string (uuid)
in path

ID of company to return path for

probability: string HIGH, MEDIUM, LOW
in query

KNOWS lowest level

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Person not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "paths": [
    {
      "nodes": [
        {
          "uuid": "string (uuid)",
          "type": "string",
          "name": "string",
          "status": "boolean",
          "tags": [
            {
              "tagName": "string",
              "ownerUUID": "string (uuid)",
              "ownerName": "string"
            }
          ]
        }
      ],
      "edges": [
        {
          "fromUuid": "string (uuid)",
          "toUuid": "string (uuid)",
          "type": "string"
        }
      ]
    }
  ]
}

Returns simple shortest path description.

GET /companies/{uuid}/shortestPath/to/{target}
uuid: string (uuid)
in path

ID to start path from

target: string (uuid)
in path

ID of the end

probability: string HIGH, MEDIUM, LOW
in query

KNOWS lowest level

400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "start": "string (uuid)",
  "end": "string (uuid)",
  "paths": [
    {
      "nodes": [
        {
          "uuid": "string (uuid)",
          "type": "string",
          "name": "string",
          "status": "boolean",
          "tags": [
            {
              "tagName": "string",
              "ownerUUID": "string (uuid)",
              "ownerName": "string"
            }
          ]
        }
      ],
      "edges": [
        {
          "fromUuid": "string (uuid)",
          "toUuid": "string (uuid)",
          "type": "string"
        }
      ]
    }
  ]
}

Returns simple network description.

GET /persons/{uuid}/shortestPath/to/{target}
uuid: string (uuid)
in path

ID to start path from

target: string (uuid)
in path

ID of the end

probability: string HIGH, MEDIUM, LOW
in query

KNOWS lowest level

400 Bad Request

Invalid ID supplied

404 Not Found

Person not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "start": "string (uuid)",
  "end": "string (uuid)",
  "paths": [
    {
      "nodes": [
        {
          "uuid": "string (uuid)",
          "type": "string",
          "name": "string",
          "status": "boolean",
          "tags": [
            {
              "tagName": "string",
              "ownerUUID": "string (uuid)",
              "ownerName": "string"
            }
          ]
        }
      ],
      "edges": [
        {
          "fromUuid": "string (uuid)",
          "toUuid": "string (uuid)",
          "type": "string"
        }
      ]
    }
  ]
}

Relations

Returns information of the relations of the given company or person. The information is split into groups according to the type of the relation. The groups such as professional career and subsidiaries for persons or managers, subsidiaries, shareholders and mergers are delivered with detailed information for each relation.

Returns simple network description.

GET /companies/{uuid}/relations/groups
uuid: string (uuid)
in path

ID of company to return relations of

400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "groups": [
    "string"
  ]
}

Returns simple network description.

GET /persons/{uuid}/relations/groups
uuid: string (uuid)
in path

ID of person to return relations of

400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "groups": [
    "string"
  ]
}

Returns network description.

GET /companies/{uuid}/relations
uuid: string (uuid)
in path

ID of company to return relations of

Authorization: string
in header

(no description)

400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "groups": [
    {
      "type": "string",
      "relations": [
        {
          "uuid": "string (uuid)",
          "targetType": "string",
          "discriminator": "string",
          "name": "string"
        }
      ]
    }
  ]
}

Returns network description.

GET /persons/{uuid}/relations
uuid: string (uuid)
in path

ID of person to return relations of

Authorization: string
in header

(no description)

400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "groups": [
    {
      "type": "string",
      "relations": [
        {
          "uuid": "string (uuid)",
          "targetType": "string",
          "discriminator": "string",
          "name": "string",
          "entryDate": "2015-03-01",
          "exitDate": "2017-10-31",
          "city": "string",
          "countryCode": "string",
          "function": "string",
          "turnoverClass": "string",
          "wz08Codes": [
            "string"
          ],
          "status": "boolean"
        }
      ]
    }
  ]
}

Risk management

Returns available risk information of companies. The risk information consists of information about insolvencies and according events of the insolvency proceeding which is sourced from public registers. Besides that, deletions, dissolutions or announced deletions by authorities information will be returned.

Returns only the newest risk managment entry for company.

GET /companies/{uuid}/riskManagement/latest
uuid: string (uuid)
in path

ID of company to query entries for

400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "latest": {
    "dateIssued": "2015-03-20",
    "info": "string"
  },
  "riskInfo": {
    "riskInfo": "string",
    "riskInfoDate": "2015-03-20"
  }
}

Get all risk managment entries for company.

GET /companies/{uuid}/riskManagement
uuid: string (uuid)
in path

ID of company to query entries for

400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "groups": [
    {
      "caseId": "string",
      "list": [
        {
          "dateIssued": "2015-03-20",
          "info": "string"
        }
      ]
    }
  ],
  "riskInfoHistory": [
    {
      "riskInfo": "string",
      "riskInfoDate": "2015-03-20"
    }
  ]
}

Connections risk info

Shows information of connections to persons or companies of a given object. Returns detailed information of connections to inactive companies, companies with risk information such as insolvencies or deletions/dissolutions by authorities. Furthermore, information about connected persons or companies which are tagged as Trouble Spot is returned.

Returns the risk information aggregate with stats.

GET /companies/{uuid}/connectionsRiskInfo/aggregate
uuid: string (uuid)
in path

ID of company to return stats for.

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Data not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "levels": [
    {
      "companies": {
        "total": "integer (int32)",
        "inactive": "integer (int32)",
        "risky": "integer (int32)"
      },
      "persons": {
        "total": "integer (int32)"
      }
    }
  ]
}

Returns the risk information aggregate with stats.

GET /persons/{uuid}/connectionsRiskInfo/aggregate
uuid: string (uuid)
in path

ID of person to return stats for.

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Data not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "levels": [
    {
      "companies": {
        "total": "integer (int32)",
        "inactive": "integer (int32)",
        "risky": "integer (int32)"
      },
      "persons": {
        "total": "integer (int32)"
      }
    }
  ]
}

Returns the risk information full information.

GET /companies/{uuid}/connectionsRiskInfo
uuid: string (uuid)
in path

ID of company to return stats for.

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Data not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "levels": [
    {
      "companies": [
        {
          "uuid": "string (uuid)",
          "name": "string",
          "city": "string",
          "deletionDate": "2015-03-20",
          "status": "boolean",
          "insolvency": "boolean",
          "deleted": "boolean",
          "dissolved": "boolean",
          "announced": "boolean",
          "tags": [
            {
              "tagName": "string",
              "ownerUUID": "string (uuid)",
              "ownerName": "string"
            }
          ]
        }
      ],
      "persons": [
        {
          "uuid": "string (uuid)",
          "name": "string",
          "city": "string",
          "dateOfBirth": "1985-03-20",
          "tags": [
            {
              "tagName": "string",
              "ownerUUID": "string (uuid)",
              "ownerName": "string"
            }
          ],
          "personConnectedToInsolventCompany": "boolean"
        }
      ]
    }
  ]
}

Returns the risk information full information.

GET /persons/{uuid}/connectionsRiskInfo
uuid: string (uuid)
in path

ID of person to return stats for.

OK

400 Bad Request

Invalid ID supplied

404 Not Found

Data not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "levels": [
    {
      "companies": [
        {
          "uuid": "string (uuid)",
          "name": "string",
          "city": "string",
          "deletionDate": "2015-03-20",
          "status": "boolean",
          "insolvency": "boolean",
          "deleted": "boolean",
          "dissolved": "boolean",
          "announced": "boolean",
          "tags": [
            {
              "tagName": "string",
              "ownerUUID": "string (uuid)",
              "ownerName": "string"
            }
          ]
        }
      ],
      "persons": [
        {
          "uuid": "string (uuid)",
          "name": "string",
          "city": "string",
          "dateOfBirth": "1985-03-20",
          "tags": [
            {
              "tagName": "string",
              "ownerUUID": "string (uuid)",
              "ownerName": "string"
            }
          ],
          "personConnectedToInsolventCompany": "boolean"
        }
      ]
    }
  ]
}

Trade register messages

Returns trade register messages chronologically for institutions or persons. TR messages can consist of new registration, deletion, alterations or corrections. The TR messages are extracted from public sources.

Returns lates trade register information

GET /companies/{uuid}/tradeRegister/latest
uuid: string (uuid)
in path

ID of company to return trade register message of

400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "latestMessage": {
    "datePublished": "2015-03-20",
    "type": "string",
    "text": "string"
  }
}

Returns lates trade register information

GET /persons/{uuid}/tradeRegister/latest
uuid: string (uuid)
in path

ID of person to return trade register message of

400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "latestMessage": {
    "datePublished": "2015-03-20",
    "type": "string",
    "text": "string"
  }
}

Returns trade register information of company

GET /companies/{uuid}/tradeRegister
uuid: string (uuid)
in path

ID of company to return trade register message of

offset: integer (int32) 0
in query

Offset

limit: integer (int32) 25
in query

Results in query.

400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "messages": [
    {
      "datePublished": "2015-03-20",
      "type": "string",
      "text": "string"
    }
  ]
}

Returns list of person's trade register messages.

GET /persons/{uuid}/tradeRegister
uuid: string (uuid)
in path

ID of person to return trade register message of

offset: integer (int32) 0
in query

Offset

limit: integer (int32) 25
in query

Results in query.

400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "messages": [
    {
      "datePublished": "2015-03-20",
      "type": "string",
      "text": "string"
    }
  ]
}

Annual reports

Annual reports from public sources can be called. Not all companies are obliged to publish their annual results. Depending on the overall availability several reports might be available. This occurs when reports needed corrections or if a company splits the reports into several files. Reports are available in HTML or CSV. HTML will show all, text and numbers. CSV files will show only numbers based on xbrl terminology.

Returns years from which annual reports are available

GET /companies/{uuid}/annualReports/years
uuid: string (uuid)
in path

ID of company to return annual reports of.

400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "reportYears": [
    "integer (int32)"
  ]
}

Returns aggregation of company annual reports.

GET /companies/{uuid}/annualReports
uuid: string (uuid)
in path

ID of company to return annual reports of

400 Bad Request

Invalid ID supplied

404 Not Found

Company not found

500 Internal Server Error

Backing server failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "uuid": "string (uuid)",
  "reportsByYears": [
    {
      "year": "integer",
      "reports": [
        {
          "id": "string (uuid)",
          "name": "string",
          "publicationDate": "2015-03-20",
          "balanceHeader": "string"
        }
      ]
    }
  ]
}

Returns company annual report.

GET /companies/{uuid}/annualReports/{year}/{reportId}
uuid: string (uuid)
in path

ID of company to return annual reports of

year: integer (int32)
in path

Year of report

reportId: string (uuid)
in path

ID of concrete report to return

200 OK

OK

type
string (binary)
400 Bad Request

Invalid ID supplied

404 Not Found

Company or annual report not found

500 Internal Server Error

Backing server failure

Response Content-Types: text/html
Response Example (200 OK)
"string (binary)"

Returns aggregation of company annual reports.

GET /companies/{uuid}/annualReports/{year}/{reportId}/csv
uuid: string (uuid)
in path

ID of company to return annual reports of

year: integer (int32)
in path

Year of report

reportId: string (uuid)
in path

ID of concrete report to return

200 OK

OK

type
string (binary)
400 Bad Request

Invalid ID supplied

404 Not Found

Company or annual report not found

500 Internal Server Error

Backing server failure

Response Content-Types: text/csv
Response Example (200 OK)
"string (binary)"

Schema Definitions

CompanyStatusInput: string

string ACTIVE, INACTIVE

PageOutput: object

page: integer (int32)
pageSize: integer (int32)
Example
{
  "page": "integer (int32)",
  "pageSize": 25
}

CurrentAddressOutput: object

currentStreet: string
currentCity: string
currentZip: string
currentCountry: string
Example
{
  "currentStreet": "Rügenwalder Str. 123 b",
  "currentCity": "Brement",
  "currentZip": "28199",
  "currentCountry": "DE"
}

AddressOutput: object

street: string
city: string
zip: string
country: string
type: string
current: boolean
Example
[
  {
    "street": "Rügenwalder Str. 123 b",
    "city": "Bremen",
    "zip": "28195",
    "country": "DE",
    "type": "GE",
    "current": false
  },
  {
    "street": "Bachstraße 123",
    "city": "Bremen",
    "zip": "28199",
    "country": "DE",
    "type": "GE",
    "current": true
  }
]

RegistrationDataOutput: object

registrationNumber: string
registrationCourtCity: string
registrationCourtZipCode: string
Example
{
  "registrationNumber": "HRB 12345",
  "registrationCourtCity": "Hamburg",
  "registrationCourtZipCode": "22765"
}

TagOutput: object

tagName: string
ownerId: string (uuid)
ownerType: string
ownerName: string
Example
{
  "tagName": "KUNDE",
  "ownerId": "676f3993-3dde-486c-904d-468d0e1dbc39",
  "ownerType": "CLIENT",
  "ownerName": "Foobar GmbH"
}

CommonEntityType: string

string COMPANY, PERSON, GRAPH_PERSON

CommonRiskInfo: string

string DELETED, DISSOLVED, ANNOUNCED

CommonFullTag: object

tagName: string
ownerUUID: string (uuid)
ownerName: string
Example
{
  "tagName": "string",
  "ownerUUID": "string (uuid)",
  "ownerName": "string"
}

SearchCompanyOutput: object

addresses: AddressOutput
AddressOutput
id: string (uuid)
name: string
status: string
telephones: string[]
string
faxes: string[]
string
websites: string[]
string
Example
{
  "addresses": [
    [
      {
        "street": "Rügenwalder Str. 123 b",
        "city": "Bremen",
        "zip": "28195",
        "country": "DE",
        "type": "GE",
        "current": false
      },
      {
        "street": "Bachstraße 123",
        "city": "Bremen",
        "zip": "28199",
        "country": "DE",
        "type": "GE",
        "current": true
      }
    ]
  ],
  "id": "string (uuid)",
  "name": "kantwert GmbH",
  "status": "string",
  "telephones": [
    "string"
  ],
  "faxes": [
    "string"
  ],
  "websites": [
    "string"
  ],
  "currentStreet": "Rügenwalder Str. 123 b",
  "currentCity": "Brement",
  "currentZip": "28199",
  "currentCountry": "DE",
  "registrationNumber": "HRB 12345",
  "registrationCourtCity": "Hamburg",
  "registrationCourtZipCode": "22765"
}

SearchCompanyPageOutput: object

Example
{
  "content": [
    {
      "addresses": [
        [
          {
            "street": "Rügenwalder Str. 123 b",
            "city": "Bremen",
            "zip": "28195",
            "country": "DE",
            "type": "GE",
            "current": false
          },
          {
            "street": "Bachstraße 123",
            "city": "Bremen",
            "zip": "28199",
            "country": "DE",
            "type": "GE",
            "current": true
          }
        ]
      ],
      "id": "string (uuid)",
      "name": "kantwert GmbH",
      "status": "string",
      "telephones": [
        "string"
      ],
      "faxes": [
        "string"
      ],
      "websites": [
        "string"
      ],
      "currentStreet": "Rügenwalder Str. 123 b",
      "currentCity": "Brement",
      "currentZip": "28199",
      "currentCountry": "DE",
      "registrationNumber": "HRB 12345",
      "registrationCourtCity": "Hamburg",
      "registrationCourtZipCode": "22765"
    }
  ],
  "page": "integer (int32)",
  "pageSize": 25
}

SearchPersonOutput: object

id: string (uuid)
firstName: string
lastName: string
dateOfBirth: string (date)
addresses: AddressOutput
AddressOutput
currentCity: string
Example
{
  "id": "string (uuid)",
  "firstName": "John",
  "lastName": "Doe",
  "dateOfBirth": "1985-02-14",
  "addresses": [
    [
      {
        "street": "Rügenwalder Str. 123 b",
        "city": "Bremen",
        "zip": "28195",
        "country": "DE",
        "type": "GE",
        "current": false
      },
      {
        "street": "Bachstraße 123",
        "city": "Bremen",
        "zip": "28199",
        "country": "DE",
        "type": "GE",
        "current": true
      }
    ]
  ],
  "currentCity": "string"
}

SearchPersonPageOutput: object

Example
{
  "content": [
    {
      "id": "string (uuid)",
      "firstName": "John",
      "lastName": "Doe",
      "dateOfBirth": "1985-02-14",
      "addresses": [
        [
          {
            "street": "Rügenwalder Str. 123 b",
            "city": "Bremen",
            "zip": "28195",
            "country": "DE",
            "type": "GE",
            "current": false
          },
          {
            "street": "Bachstraße 123",
            "city": "Bremen",
            "zip": "28199",
            "country": "DE",
            "type": "GE",
            "current": true
          }
        ]
      ],
      "currentCity": "string"
    }
  ],
  "page": "integer (int32)",
  "pageSize": 25
}

SelectCompanyInput: object

city: string
countryCode: string
insolvent: boolean
status: CompanyStatusInput
foundingYears: object[]
object
from: integer
to: integer
legalTypes: string[]
string
capital: object[]
object
from: integer
to: integer
industryCodePrefixes: string[]
string
employeeClasses: string[]
string
turnoverClasses: string[]
string
riskInfo: string
zipCodePrefixes: string[]
string
Example
{
  "city": "Bonn",
  "countryCode": "DE",
  "insolvent": true,
  "status": "string",
  "foundingYears": [
    {
      "from": 1980,
      "to": 1985
    }
  ],
  "legalTypes": [
    "G"
  ],
  "capital": [
    {
      "from": 3000,
      "to": 5000
    }
  ],
  "industryCodePrefixes": [
    "62"
  ],
  "employeeClasses": [
    "6-50"
  ],
  "turnoverClasses": [
    "500-999"
  ],
  "riskInfo": "F1_R3",
  "zipCodePrefixes": [
    "422"
  ]
}

SelectCompanyOutput: object

addresses: AddressOutput
AddressOutput
legalType: string
wz08Codes: string[]
string
employees: integer (int64)
employeeClass: string
turnover: integer (int64)
turnoverClass: string
turnoverCurrency: string
Example
{
  "addresses": [
    [
      {
        "street": "Rügenwalder Str. 123 b",
        "city": "Bremen",
        "zip": "28195",
        "country": "DE",
        "type": "GE",
        "current": false
      },
      {
        "street": "Bachstraße 123",
        "city": "Bremen",
        "zip": "28199",
        "country": "DE",
        "type": "GE",
        "current": true
      }
    ]
  ],
  "legalType": "UG",
  "wz08Codes": [
    "701",
    "70102"
  ],
  "employees": 4,
  "employeeClass": "0-5",
  "turnover": 567,
  "turnoverClass": "500-999",
  "turnoverCurrency": "EUR",
  "currentStreet": "Rügenwalder Str. 123 b",
  "currentCity": "Brement",
  "currentZip": "28199",
  "currentCountry": "DE",
  "registrationNumber": "HRB 12345",
  "registrationCourtCity": "Hamburg",
  "registrationCourtZipCode": "22765"
}

SelectCompanyPageOutput: object

Example
{
  "content": [
    {
      "addresses": [
        [
          {
            "street": "Rügenwalder Str. 123 b",
            "city": "Bremen",
            "zip": "28195",
            "country": "DE",
            "type": "GE",
            "current": false
          },
          {
            "street": "Bachstraße 123",
            "city": "Bremen",
            "zip": "28199",
            "country": "DE",
            "type": "GE",
            "current": true
          }
        ]
      ],
      "legalType": "UG",
      "wz08Codes": [
        "701",
        "70102"
      ],
      "employees": 4,
      "employeeClass": "0-5",
      "turnover": 567,
      "turnoverClass": "500-999",
      "turnoverCurrency": "EUR",
      "currentStreet": "Rügenwalder Str. 123 b",
      "currentCity": "Brement",
      "currentZip": "28199",
      "currentCountry": "DE",
      "registrationNumber": "HRB 12345",
      "registrationCourtCity": "Hamburg",
      "registrationCourtZipCode": "22765"
    }
  ],
  "page": "integer (int32)",
  "pageSize": 25
}

SelectPersonInput: object

birthYears: object[]
object
from: integer
to: integer
city: string
countryCode: string
deceased: boolean
functions: string[]
string
numberOfFunctions: object[]
object
from: integer
to: integer
zipCodePrefixes: string[]
string
Example
{
  "birthYears": [
    {
      "from": 1980,
      "to": 1985
    }
  ],
  "city": "Bonn",
  "countryCode": "DE",
  "deceased": false,
  "functions": [
    "SHAREHOLDER",
    "MANAGING_DIRECTOR",
    "PARTNER_WITH_UNLIMITED_LIABILITY"
  ],
  "numberOfFunctions": [
    {
      "from": 3,
      "to": 10
    }
  ],
  "zipCodePrefixes": [
    "422"
  ]
}

HrInformationOutput: object

datePublished: string (date)
text: string
type: string
Example
{
  "datePublished": "2015-05-18",
  "text": "string",
  "type": "string"
}

SelectPersonOutput: object

uuid: string (uuid)
firstName: string
lastName: string
dateOfBirth: string (date)
alive: boolean
academicDegree: string
addresses: AddressOutput
AddressOutput
tags: TagOutput
TagOutput
hrInformations: HrInformationOutput
HrInformationOutput
historicalDatesOfBirth: string[]
string (date)
historicalNames: object[]
object
firstName: string
lastName: string
Example
{
  "uuid": "d062d18c-abd5-4ad9-a7e7-5fc35994caaf",
  "firstName": "Jörg",
  "lastName": "Müller",
  "dateOfBirth": "1985-03-21",
  "alive": "boolean",
  "academicDegree": "Dr.",
  "addresses": [
    [
      {
        "street": "Rügenwalder Str. 123 b",
        "city": "Bremen",
        "zip": "28195",
        "country": "DE",
        "type": "GE",
        "current": false
      },
      {
        "street": "Bachstraße 123",
        "city": "Bremen",
        "zip": "28199",
        "country": "DE",
        "type": "GE",
        "current": true
      }
    ]
  ],
  "tags": [
    {
      "tagName": "KUNDE",
      "ownerId": "676f3993-3dde-486c-904d-468d0e1dbc39",
      "ownerType": "CLIENT",
      "ownerName": "Foobar GmbH"
    }
  ],
  "hrInformations": [
    {
      "datePublished": "2015-05-18",
      "text": "string",
      "type": "string"
    }
  ],
  "historicalDatesOfBirth": [
    "1985-03-20"
  ],
  "historicalNames": [
    {
      "firstName": "Jörg",
      "lastName": "Mahler"
    }
  ],
  "currentStreet": "Rügenwalder Str. 123 b",
  "currentCity": "Brement",
  "currentZip": "28199",
  "currentCountry": "DE"
}

SelectPersonPageOutput: object

Example
{
  "content": [
    {
      "uuid": "d062d18c-abd5-4ad9-a7e7-5fc35994caaf",
      "firstName": "Jörg",
      "lastName": "Müller",
      "dateOfBirth": "1985-03-21",
      "alive": "boolean",
      "academicDegree": "Dr.",
      "addresses": [
        [
          {
            "street": "Rügenwalder Str. 123 b",
            "city": "Bremen",
            "zip": "28195",
            "country": "DE",
            "type": "GE",
            "current": false
          },
          {
            "street": "Bachstraße 123",
            "city": "Bremen",
            "zip": "28199",
            "country": "DE",
            "type": "GE",
            "current": true
          }
        ]
      ],
      "tags": [
        {
          "tagName": "KUNDE",
          "ownerId": "676f3993-3dde-486c-904d-468d0e1dbc39",
          "ownerType": "CLIENT",
          "ownerName": "Foobar GmbH"
        }
      ],
      "hrInformations": [
        {
          "datePublished": "2015-05-18",
          "text": "string",
          "type": "string"
        }
      ],
      "historicalDatesOfBirth": [
        "1985-03-20"
      ],
      "historicalNames": [
        {
          "firstName": "Jörg",
          "lastName": "Mahler"
        }
      ],
      "currentStreet": "Rügenwalder Str. 123 b",
      "currentCity": "Brement",
      "currentZip": "28199",
      "currentCountry": "DE"
    }
  ],
  "page": "integer (int32)",
  "pageSize": 25
}

CompanyIdentificationOutput: object

uuid: string (uuid)
Example
{
  "uuid": "c3fd2418-e8c1-4334-a0aa-5a5ee2460217"
}

PersonIdentificationOutput: object

uuid: string (uuid)
firstName: string
lastName: string
Example
{
  "uuid": "1f96786f-86f9-436b-bfa3-4d7baf307209",
  "firstName": "John",
  "lastName": "Doe"
}

TagNamesOutput: object

userTagsForCompanies: string[]
string
userTagsForPersons: string[]
string
clientTagsForCompanies: string[]
string
clientTagsForPersons: string[]
string
Example
{
  "userTagsForCompanies": [
    "LIEFERANT"
  ],
  "userTagsForPersons": [],
  "clientTagsForCompanies": [
    "INTERESSENT",
    "KUNDE"
  ],
  "clientTagsForPersons": [
    "KONTAKT"
  ]
}

TagNameInput: string

string KONTAKT, KUNDE, LIEFERANT, INTERESSENT

NewTagInput: object

asClient: boolean false
taggedNodeId: string (uuid)
name: TagNameInput
Example
{
  "asClient": false,
  "taggedNodeId": "d7912742-eb2c-4027-ab4e-36f9f7bd9efe",
  "name": "KUNDE"
}

MasterDataAddress: object

street: string
plz: string
country: string
city: string
Example
{
  "street": "string",
  "plz": "string",
  "country": "string",
  "city": "string"
}

MasterDataCompanyKeyFigures: object

employees: integer
employeeClass: string ([0-9]+ - [0-9]+)
turnover: number
turnoverCurrency: string
turnoverClass: string
Example
{
  "employees": "integer",
  "employeeClass": "string ([0-9]+ - [0-9]+)",
  "turnover": "number",
  "turnoverCurrency": "string",
  "turnoverClass": "string"
}

MasterDataPhone: object

number: string
description: string
Example
{
  "number": "string",
  "description": "string"
}

MasterDataCompanyContact: object

website: string[]
string
emails: string[]
string (email)
fax: MasterDataPhone
MasterDataPhone
phones: MasterDataPhone
MasterDataPhone
Example
{
  "website": [
    "string"
  ],
  "emails": [
    "string (email)"
  ],
  "fax": [
    {
      "number": "string",
      "description": "string"
    }
  ],
  "phones": [
    {
      "number": "string",
      "description": "string"
    }
  ]
}

MasterDataObject: object

uuid: string (uuid)
Example
{
  "uuid": "string (uuid)"
}

MasterDataTradeRegister: object

status: boolean
foundingDate: string (date)
form: string
registryNumber: string
registryCity: string
registryZip: string ([0-9]{5})
capital: number x ≥ 0
capitalCurrency: string
vatId: string
Example
{
  "status": "boolean",
  "foundingDate": "2011-21-07",
  "form": "string",
  "registryNumber": "string",
  "registryCity": "string",
  "registryZip": "string ([0-9]{5})",
  "capital": "number",
  "capitalCurrency": "string",
  "vatId": "string"
}

PersonShortMasterData:

firstName: string
lastName: string
address: MasterDataAddress
dateOfBirth: string (date)
alive: boolean
Example
{
  "firstName": "string",
  "lastName": "string",
  "address": {
    "street": "string",
    "plz": "string",
    "country": "string",
    "city": "string"
  },
  "dateOfBirth": "1985-03-01",
  "alive": "boolean",
  "uuid": "string (uuid)"
}

CompanyShortMasterData:

name: string
address: MasterDataAddress
status: boolean
insolvencyInfoPresent: boolean
riskInfo: CommonRiskInfo
Example
{
  "name": "Foobar GmbH",
  "address": {
    "street": "string",
    "plz": "string",
    "country": "string",
    "city": "string"
  },
  "status": "boolean",
  "insolvencyInfoPresent": "boolean",
  "riskInfo": "string",
  "uuid": "string (uuid)"
}

PersonMasterData:

firstName: string
lastName: string
address: MasterDataAddress
dateOfBirth: string (date)
alive: boolean
tags: CommonFullTag
CommonFullTag
Example
{
  "firstName": "string",
  "lastName": "string",
  "address": {
    "street": "string",
    "plz": "string",
    "country": "string",
    "city": "string"
  },
  "dateOfBirth": "1985-03-01",
  "alive": "boolean",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ],
  "uuid": "string (uuid)"
}

CompanyMasterData:

name: string
lei: string

Legal Entity Identifier

address: MasterDataAddress
contact: MasterDataCompanyContact
tradeRegister: MasterDataTradeRegister
keyFigures: MasterDataCompanyKeyFigures
wz03Codes: string[]
string
wz08Codes: string[]
string
industry: string
tags: CommonFullTag
CommonFullTag
insolvencyInfoPresent: boolean
riskInfo: CommonRiskInfo
riskInfoDate: string (date)
Example
{
  "name": "Foobar GmbH",
  "lei": "UWJKFUJFZ02DKWI3RY53",
  "address": {
    "street": "string",
    "plz": "string",
    "country": "string",
    "city": "string"
  },
  "contact": {
    "website": [
      "string"
    ],
    "emails": [
      "string (email)"
    ],
    "fax": [
      {
        "number": "string",
        "description": "string"
      }
    ],
    "phones": [
      {
        "number": "string",
        "description": "string"
      }
    ]
  },
  "tradeRegister": {
    "status": "boolean",
    "foundingDate": "2011-21-07",
    "form": "string",
    "registryNumber": "string",
    "registryCity": "string",
    "registryZip": "string ([0-9]{5})",
    "capital": "number",
    "capitalCurrency": "string",
    "vatId": "string"
  },
  "keyFigures": {
    "employees": "integer",
    "employeeClass": "string ([0-9]+ - [0-9]+)",
    "turnover": "number",
    "turnoverCurrency": "string",
    "turnoverClass": "string"
  },
  "wz03Codes": [
    "string"
  ],
  "wz08Codes": [
    "string"
  ],
  "industry": "string",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ],
  "insolvencyInfoPresent": "boolean",
  "riskInfo": "string",
  "riskInfoDate": "2017-07-20",
  "uuid": "string (uuid)"
}

PersonUboList: object

uuid: string (uuid)
list: PersonUboListElement
PersonUboListElement
Example
{
  "uuid": "string (uuid)",
  "list": [
    {
      "uuid": "string (uuid)",
      "firstName": "string",
      "lastName": "string",
      "currentCity": "string",
      "currentCountryCode": "string",
      "dateOfBirth": "1985-03-20",
      "controlledShares": "number",
      "shares": "number"
    }
  ]
}

PersonUboListElement: object

uuid: string (uuid)
firstName: string
lastName: string
currentCity: string
currentCountryCode: string
dateOfBirth: string (date)
controlledShares: number x ≥ 0
shares: number x ≥ 0
Example
{
  "uuid": "string (uuid)",
  "firstName": "string",
  "lastName": "string",
  "currentCity": "string",
  "currentCountryCode": "string",
  "dateOfBirth": "1985-03-20",
  "controlledShares": "number",
  "shares": "number"
}

CompanyUboList: object

uuid: string (uuid)
list: CompanyUboListElement
CompanyUboListElement
Example
{
  "uuid": "string (uuid)",
  "list": [
    {
      "uuid": "string (uuid)",
      "name": "string",
      "currentCity": "string",
      "currentCountryCode": "string",
      "turnoverClass": "string",
      "wz08Codes": [
        "string"
      ],
      "controlledShares": "number",
      "shares": "number",
      "status": "boolean",
      "hasInsolvencyInfo": "boolean",
      "riskInfo": "string"
    }
  ]
}

CompanyUboListElement: object

uuid: string (uuid)
name: string
currentCity: string
currentCountryCode: string
turnoverClass: string
wz08Codes: string[]
string
controlledShares: number x ≥ 0
shares: number x ≥ 0
status: boolean
hasInsolvencyInfo: boolean
riskInfo: string
Example
{
  "uuid": "string (uuid)",
  "name": "string",
  "currentCity": "string",
  "currentCountryCode": "string",
  "turnoverClass": "string",
  "wz08Codes": [
    "string"
  ],
  "controlledShares": "number",
  "shares": "number",
  "status": "boolean",
  "hasInsolvencyInfo": "boolean",
  "riskInfo": "string"
}

UboNetworkFull: object

uuid: string (uuid)
nodes: UboNetworkNode
UboNetworkNode
edges: UboNetworkEdge
UboNetworkEdge
Example
{
  "uuid": "string (uuid)",
  "nodes": [
    {
      "uuid": "string (uuid)",
      "type": "string",
      "name": "string",
      "currentCity": "string",
      "currentCountry": "string",
      "relationshipCount": "integer (int32)",
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ]
    }
  ],
  "edges": [
    {
      "fromUuid": "string (uuid)",
      "toUuid": "string (uuid)",
      "controlledShares": "number (double)"
    }
  ]
}

UboNetworkNode: object

uuid: string (uuid)
type: CommonEntityType
name: string
currentCity: string
currentCountry: string
relationshipCount: integer (int32)
tags: CommonFullTag
CommonFullTag
Example
{
  "uuid": "string (uuid)",
  "type": "string",
  "name": "string",
  "currentCity": "string",
  "currentCountry": "string",
  "relationshipCount": "integer (int32)",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ]
}

UboNetworkPersonNode: object

dateOfBirth: string (date)
alive: boolean
Example
{
  "dateOfBirth": "1985-03-20",
  "alive": "boolean",
  "uuid": "string (uuid)",
  "type": "string",
  "name": "string",
  "currentCity": "string",
  "currentCountry": "string",
  "relationshipCount": "integer (int32)",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ]
}

UboNetworkCompanyNode: object

turnoverClass: string
employeeClass: string
wz08Codes: string[]
string
legalForm: string
status: boolean
insolvencyInfoPresent: boolean
riskInfo: CommonRiskInfo
Example
{
  "turnoverClass": "string",
  "employeeClass": "string",
  "wz08Codes": [
    "string"
  ],
  "legalForm": "string",
  "status": "boolean",
  "insolvencyInfoPresent": "boolean",
  "riskInfo": "string",
  "uuid": "string (uuid)",
  "type": "string",
  "name": "string",
  "currentCity": "string",
  "currentCountry": "string",
  "relationshipCount": "integer (int32)",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ]
}

UboNetworkEdge: object

fromUuid: string (uuid)
toUuid: string (uuid)
controlledShares: number (double) x ≥ 0 0
Example
{
  "fromUuid": "string (uuid)",
  "toUuid": "string (uuid)",
  "controlledShares": "number (double)"
}

UboStructureNodeTypes: string

string COMPANY, COMPANY_UBO_OF, PERSON, PERSON_UBO

UboStructureFull: object

Example
{
  "uuid": "string (uuid)",
  "nodes": [
    {
      "uuid": "string (uuid)",
      "name": "string",
      "city": "string",
      "country": "string",
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ],
      "relationshipCount": "integer (int32)",
      "controlledShares": "number (double)",
      "type": "string"
    }
  ],
  "edges": [
    {
      "fromUuid": "string (uuid)",
      "toUuid": "string (uuid)",
      "type": "string",
      "shares": "number (double)",
      "isUboEdge": "boolean"
    }
  ]
}

UboStructureNode: object

uuid: string (uuid)
name: string
city: string
country: string
tags: CommonFullTag
CommonFullTag
relationshipCount: integer (int32)
controlledShares: number (double) x ≥ 0 0
type: UboStructureNodeTypes
Example
{
  "uuid": "string (uuid)",
  "name": "string",
  "city": "string",
  "country": "string",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ],
  "relationshipCount": "integer (int32)",
  "controlledShares": "number (double)",
  "type": "string"
}

UboStructurePersonNode: object

alive: boolean
dateOfBirth: string (date)
Example
{
  "alive": "boolean",
  "dateOfBirth": "1985-03-20",
  "uuid": "string (uuid)",
  "name": "string",
  "city": "string",
  "country": "string",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ],
  "relationshipCount": "integer (int32)",
  "controlledShares": "number (double)",
  "type": "string"
}

UboStructureCompanyNode: object

status: boolean
insolvencyInfoPresent: boolean
riskInfo: CommonRiskInfo
employeeClass: string
turnoverClass: string
Example
{
  "status": "boolean",
  "insolvencyInfoPresent": "boolean",
  "riskInfo": "string",
  "employeeClass": "string",
  "turnoverClass": "string",
  "uuid": "string (uuid)",
  "name": "string",
  "city": "string",
  "country": "string",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ],
  "relationshipCount": "integer (int32)",
  "controlledShares": "number (double)",
  "type": "string"
}

UboStructureEdge: object

fromUuid: string (uuid)
toUuid: string (uuid)
type: string
shares: number (double) x ≥ 0 0
isUboEdge: boolean
Example
{
  "fromUuid": "string (uuid)",
  "toUuid": "string (uuid)",
  "type": "string",
  "shares": "number (double)",
  "isUboEdge": "boolean"
}

ContactNetworkKnowsProbability: string

string LOW, MEDIUM, HIGH

ContactNetworkFullInfo: object

Example
{
  "uuid": "string (uuid)",
  "nodes": [
    {
      "uuid": "string (uuid)",
      "name": "string",
      "alive": "boolean",
      "dateOfBirth": "1985-03-20",
      "currentCity": "string",
      "currentCountry": "string",
      "relationshipCount": "integer (int32)",
      "companiesWorking": [
        "string (uuid)"
      ],
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ]
    }
  ],
  "edges": [
    {
      "uuid": "string (uuid)",
      "start": "string (uuid)",
      "end": "string (uuid)",
      "probability": "string",
      "relations": [
        {
          "companyAtTime": "string (uuid)",
          "positionAtTime": "string",
          "contactCompany": "string (uuid)",
          "contactPosition": "string",
          "start": "2015-03-01",
          "end": "2015-10-31"
        }
      ]
    }
  ],
  "companies": [
    {
      "uuid": "string (uuid)",
      "name": "string",
      "city": "string",
      "country": "string",
      "wz08Codes": [
        "string"
      ],
      "personsWorking": [
        "string (uuid)"
      ],
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ]
    }
  ]
}

ContactNetworkNode: object

uuid: string (uuid)
name: string
alive: boolean
dateOfBirth: string (date)
currentCity: string
currentCountry: string
relationshipCount: integer (int32) x ≥ 0 0
companiesWorking: string[]
string (uuid)
tags: CommonFullTag
CommonFullTag
Example
{
  "uuid": "string (uuid)",
  "name": "string",
  "alive": "boolean",
  "dateOfBirth": "1985-03-20",
  "currentCity": "string",
  "currentCountry": "string",
  "relationshipCount": "integer (int32)",
  "companiesWorking": [
    "string (uuid)"
  ],
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ]
}

ContactNetworkCompanyInfo: object

uuid: string (uuid)
name: string
city: string
country: string
wz08Codes: string[]
string
personsWorking: string[]
string (uuid)
tags: CommonFullTag
CommonFullTag
Example
{
  "uuid": "string (uuid)",
  "name": "string",
  "city": "string",
  "country": "string",
  "wz08Codes": [
    "string"
  ],
  "personsWorking": [
    "string (uuid)"
  ],
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ]
}

ContactNetworkEdge: object

uuid: string (uuid)
start: string (uuid)
end: string (uuid)
probability: ContactNetworkKnowsProbability
relations: ContactsNetworkRelationInfo
ContactsNetworkRelationInfo
Example
{
  "uuid": "string (uuid)",
  "start": "string (uuid)",
  "end": "string (uuid)",
  "probability": "string",
  "relations": [
    {
      "companyAtTime": "string (uuid)",
      "positionAtTime": "string",
      "contactCompany": "string (uuid)",
      "contactPosition": "string",
      "start": "2015-03-01",
      "end": "2015-10-31"
    }
  ]
}

ContactsNetworkRelationInfo: object

companyAtTime: string (uuid)
positionAtTime: string
contactCompany: string (uuid)
contactPosition: string
start: string (date)
end: string (date)
Example
{
  "companyAtTime": "string (uuid)",
  "positionAtTime": "string",
  "contactCompany": "string (uuid)",
  "contactPosition": "string",
  "start": "2015-03-01",
  "end": "2015-10-31"
}

CustomerNetworkPreview: object

Example
{
  "uuid": "1ab04503-387e-4c29-9116-7f311f790528",
  "nodes": [
    {
      "uuid": "737ce3c6-fa87-466d-b384-b21dc3311617",
      "type": "string",
      "tags": [
        "string"
      ]
    }
  ],
  "edges": [
    {
      "fromUuid": "213abb8f-3686-49a2-b666-69ba21f7d10c",
      "toUuid": "50b72713-1800-4ec1-a1a4-53dfefbd618b",
      "types": [
        "string"
      ]
    }
  ]
}

CustomerNetworkPreviewNode: object

uuid: string (uuid)
type: CommonEntityType
tags: string[]
string
Example
{
  "uuid": "737ce3c6-fa87-466d-b384-b21dc3311617",
  "type": "string",
  "tags": [
    "string"
  ]
}

CustomerNetworkPreviewEdge: object

fromUuid: string (uuid)
toUuid: string (uuid)
types: string[]
string
Example
{
  "fromUuid": "213abb8f-3686-49a2-b666-69ba21f7d10c",
  "toUuid": "50b72713-1800-4ec1-a1a4-53dfefbd618b",
  "types": [
    "string"
  ]
}

CustomerNetworkFullInfoQuery: object

includeActiveNodes: boolean true
includeInactiveNodes: boolean true
includeActiveRelationships: boolean true
includeInactiveRelationships: boolean true
excludeRelationships: string[]
string
expandedNodes: string[]
string (uuid)
Example
{
  "includeActiveNodes": "boolean",
  "includeInactiveNodes": "boolean",
  "includeActiveRelationships": "boolean",
  "includeInactiveRelationships": "boolean",
  "excludeRelationships": [
    "string"
  ],
  "expandedNodes": [
    "7297bf4a-212a-4a5c-ae79-dee5676cc81a"
  ]
}

CustomerNetworkFull: object

Example
{
  "uuid": "cefd6c7e-2270-49dd-a5c7-d87488e97aa2",
  "nodes": [
    {
      "uuid": "3c4d1e2e-aaf2-46cd-9895-39138c7b3308",
      "type": "string",
      "name": "string",
      "relationshipCount": "integer (int32)",
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ]
    }
  ],
  "edges": [
    {
      "uuid": "fa2e8758-61cd-4fbe-a330-0fc9b4982cdd",
      "fromUuid": "5e90eab7-096e-4de2-a86f-c976c3412c84",
      "toUuid": "20ffd0fa-c4ad-40f5-8ccf-dba25fef28ed",
      "type": "string",
      "startDate": "2015-03-01",
      "endDate": "2016-10-31",
      "shares": "number (double)"
    }
  ]
}

CustomerNetworkFullNode: object

uuid: string (uuid)
type: CommonEntityType
name: string
relationshipCount: integer (int32) x ≥ 0 0
tags: CommonFullTag
CommonFullTag
Example
{
  "uuid": "3c4d1e2e-aaf2-46cd-9895-39138c7b3308",
  "type": "string",
  "name": "string",
  "relationshipCount": "integer (int32)",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ]
}

CustomerNetworkFullPersonNode: object

alive: boolean
dateOfBirth: string (date)
city: string
country: string
Example
{
  "alive": "boolean",
  "dateOfBirth": "1987-12-20",
  "city": "Bonn",
  "country": "DE",
  "uuid": "3c4d1e2e-aaf2-46cd-9895-39138c7b3308",
  "type": "string",
  "name": "string",
  "relationshipCount": "integer (int32)",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ]
}

CustomerNetworkFullCompanyNode: object

status: boolean
insolvencyInfoPresent: boolean
riskInfo: CommonRiskInfo
city: string
country: string
turnoverClass: string
employeeClass: string
wz08Codes: string[]
string
Example
{
  "status": "boolean",
  "insolvencyInfoPresent": "boolean",
  "riskInfo": "string",
  "city": "Bonn",
  "country": "DE",
  "turnoverClass": "500-999",
  "employeeClass": "0-5",
  "wz08Codes": [
    "string"
  ],
  "uuid": "3c4d1e2e-aaf2-46cd-9895-39138c7b3308",
  "type": "string",
  "name": "string",
  "relationshipCount": "integer (int32)",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ]
}

CustomerNetworkFullEdge: object

uuid: string (uuid)
fromUuid: string (uuid)
toUuid: string (uuid)
type: string
startDate: string (date)
endDate: string (date)
shares: number (double) x ≥ 0 0
Example
{
  "uuid": "fa2e8758-61cd-4fbe-a330-0fc9b4982cdd",
  "fromUuid": "5e90eab7-096e-4de2-a86f-c976c3412c84",
  "toUuid": "20ffd0fa-c4ad-40f5-8ccf-dba25fef28ed",
  "type": "string",
  "startDate": "2015-03-01",
  "endDate": "2016-10-31",
  "shares": "number (double)"
}

OwnershipNetwork: object

Example
{
  "uuid": "string (uuid)",
  "nodes": [
    {
      "uuid": "string (uuid)",
      "type": "string",
      "name": "string",
      "city": "string",
      "countryCode": "string",
      "relationshipCount": "integer (int32)",
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ]
    }
  ],
  "edges": [
    {
      "uuid": "string (uuid)",
      "fromUuid": "string (uuid)",
      "toUuid": "string (uuid)",
      "type": "string",
      "shares": "number (double)"
    }
  ]
}

OwnershipNetworkNode: object

uuid: string (uuid)
type: CommonEntityType
name: string
city: string
countryCode: string
relationshipCount: integer (int32) x ≥ 0 0
tags: CommonFullTag
CommonFullTag
Example
{
  "uuid": "string (uuid)",
  "type": "string",
  "name": "string",
  "city": "string",
  "countryCode": "string",
  "relationshipCount": "integer (int32)",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ]
}

OwnershipNetworkCompanyNode: object

employeeClass: string
turnoverClass: string
status: boolean
insolvencyInfoPresent: boolean
riskInfo: CommonRiskInfo
Example
{
  "employeeClass": "string",
  "turnoverClass": "string",
  "status": "boolean",
  "insolvencyInfoPresent": "boolean",
  "riskInfo": "string",
  "uuid": "string (uuid)",
  "type": "string",
  "name": "string",
  "city": "string",
  "countryCode": "string",
  "relationshipCount": "integer (int32)",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ]
}

OwnershipNetworkPersonNode: object

dateOfBirth: string (date)
alive: boolean
Example
{
  "dateOfBirth": "1985-03-20",
  "alive": "boolean",
  "uuid": "string (uuid)",
  "type": "string",
  "name": "string",
  "city": "string",
  "countryCode": "string",
  "relationshipCount": "integer (int32)",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ]
}

OwnershipNetworkEdge: object

uuid: string (uuid)
fromUuid: string (uuid)
toUuid: string (uuid)
type: string
shares: number (double) 0 ≤ x ≤ 100 100
Example
{
  "uuid": "string (uuid)",
  "fromUuid": "string (uuid)",
  "toUuid": "string (uuid)",
  "type": "string",
  "shares": "number (double)"
}

ShortestPathMain: object

uuid: string (uuid)
paths: ShortestPath
ShortestPath
Example
{
  "uuid": "string (uuid)",
  "paths": [
    {
      "nodes": [
        {
          "uuid": "string (uuid)",
          "type": "string",
          "name": "string",
          "status": "boolean",
          "tags": [
            {
              "tagName": "string",
              "ownerUUID": "string (uuid)",
              "ownerName": "string"
            }
          ]
        }
      ],
      "edges": [
        {
          "fromUuid": "string (uuid)",
          "toUuid": "string (uuid)",
          "type": "string"
        }
      ]
    }
  ]
}

ShortestPathBetween: object

start: string (uuid)
end: string (uuid)
paths: ShortestPath
ShortestPath
Example
{
  "start": "string (uuid)",
  "end": "string (uuid)",
  "paths": [
    {
      "nodes": [
        {
          "uuid": "string (uuid)",
          "type": "string",
          "name": "string",
          "status": "boolean",
          "tags": [
            {
              "tagName": "string",
              "ownerUUID": "string (uuid)",
              "ownerName": "string"
            }
          ]
        }
      ],
      "edges": [
        {
          "fromUuid": "string (uuid)",
          "toUuid": "string (uuid)",
          "type": "string"
        }
      ]
    }
  ]
}

ShortestPath: object

Example
{
  "nodes": [
    {
      "uuid": "string (uuid)",
      "type": "string",
      "name": "string",
      "status": "boolean",
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ]
    }
  ],
  "edges": [
    {
      "fromUuid": "string (uuid)",
      "toUuid": "string (uuid)",
      "type": "string"
    }
  ]
}

ShortestPathNode: object

uuid: string (uuid)
type: CommonEntityType
name: string
status: boolean
tags: CommonFullTag
CommonFullTag
Example
{
  "uuid": "string (uuid)",
  "type": "string",
  "name": "string",
  "status": "boolean",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ]
}

ShortestPathEdge: object

fromUuid: string (uuid)
toUuid: string (uuid)
type: string
Example
{
  "fromUuid": "string (uuid)",
  "toUuid": "string (uuid)",
  "type": "string"
}

ShortestPathEdgeTimed:

startDate: string (date)
endDate: string (date)
Example
{
  "startDate": "2015-03-01",
  "endDate": "2017-10-31",
  "fromUuid": "string (uuid)",
  "toUuid": "string (uuid)",
  "type": "string"
}

ShortestPathEdgeKnows:

probability: ShortestPathEdgeKnowsProbability
companyAtTime: string
positionAtTime: string
contactCompany: string
contactPosition: string
Example
{
  "probability": "string",
  "companyAtTime": "string",
  "positionAtTime": "string",
  "contactCompany": "string",
  "contactPosition": "string",
  "startDate": "2015-03-01",
  "endDate": "2017-10-31",
  "fromUuid": "string (uuid)",
  "toUuid": "string (uuid)",
  "type": "string"
}

ShortestPathEdgeTag:

tagName: string
Example
{
  "tagName": "string",
  "fromUuid": "string (uuid)",
  "toUuid": "string (uuid)",
  "type": "string"
}

ShortestPathEdgeKnowsProbability: string

string HIGH, MEDIUM, LOW

CompanyRelationsGroupEnum: string

string MANAGERS, EMPLOYEES, SUBSIDIARIES, SHAREHOLDERS, AUDITORS, CHECKED_COMPANIES, PROFIT_RECEIVING, PROFIT_TRANSFERRING, MERGERS

PersonRelationsGroupEnum: string

string PROFESSIONAL_CAREER, SUBSIDIARIES

TargetType: string

string PERSON, COMPANY

PersonRelationsPreview: object

Example
{
  "uuid": "string (uuid)",
  "groups": [
    "string"
  ]
}

PersonRelationsFullInfo: object

uuid: string (uuid)
groups: PersonRelationsGrouping
PersonRelationsGrouping
Example
{
  "uuid": "string (uuid)",
  "groups": [
    {
      "type": "string",
      "relations": [
        {
          "uuid": "string (uuid)",
          "targetType": "string",
          "discriminator": "string",
          "name": "string",
          "entryDate": "2015-03-01",
          "exitDate": "2017-10-31",
          "city": "string",
          "countryCode": "string",
          "function": "string",
          "turnoverClass": "string",
          "wz08Codes": [
            "string"
          ],
          "status": "boolean"
        }
      ]
    }
  ]
}

PersonRelationsGrouping: object

Example
{
  "type": "string",
  "relations": [
    {
      "uuid": "string (uuid)",
      "targetType": "string",
      "discriminator": "string",
      "name": "string",
      "entryDate": "2015-03-01",
      "exitDate": "2017-10-31",
      "city": "string",
      "countryCode": "string",
      "function": "string",
      "turnoverClass": "string",
      "wz08Codes": [
        "string"
      ],
      "status": "boolean"
    }
  ]
}

PersonRelation: object

uuid: string (uuid)
targetType: TargetType
discriminator: string
name: string
entryDate: string (date)
exitDate: string (date)
city: string
countryCode: string
function: string
turnoverClass: string
wz08Codes: string[]
string
status: boolean
Example
{
  "uuid": "string (uuid)",
  "targetType": "string",
  "discriminator": "string",
  "name": "string",
  "entryDate": "2015-03-01",
  "exitDate": "2017-10-31",
  "city": "string",
  "countryCode": "string",
  "function": "string",
  "turnoverClass": "string",
  "wz08Codes": [
    "string"
  ],
  "status": "boolean"
}

PersonRelationProfessionCareer:

Example
{
  "uuid": "string (uuid)",
  "targetType": "string",
  "discriminator": "string",
  "name": "string",
  "entryDate": "2015-03-01",
  "exitDate": "2017-10-31",
  "city": "string",
  "countryCode": "string",
  "function": "string",
  "turnoverClass": "string",
  "wz08Codes": [
    "string"
  ],
  "status": "boolean"
}

PersonRelationSubsidiaries:

shares: number x ≥ 0
Example
{
  "shares": "number",
  "uuid": "string (uuid)",
  "targetType": "string",
  "discriminator": "string",
  "name": "string",
  "entryDate": "2015-03-01",
  "exitDate": "2017-10-31",
  "city": "string",
  "countryCode": "string",
  "function": "string",
  "turnoverClass": "string",
  "wz08Codes": [
    "string"
  ],
  "status": "boolean"
}

CompanyRelationsPreview: object

Example
{
  "uuid": "string (uuid)",
  "groups": [
    "string"
  ]
}

CompanyRelationsFullInfo: object

Example
{
  "uuid": "string (uuid)",
  "groups": [
    {
      "type": "string",
      "relations": [
        {
          "uuid": "string (uuid)",
          "targetType": "string",
          "discriminator": "string",
          "name": "string"
        }
      ]
    }
  ]
}

CompanyRelationsGrouping: object

Example
{
  "type": "string",
  "relations": [
    {
      "uuid": "string (uuid)",
      "targetType": "string",
      "discriminator": "string",
      "name": "string"
    }
  ]
}

CompanyRelation: object

uuid: string (uuid)
targetType: TargetType
discriminator: string
name: string
Example
{
  "uuid": "string (uuid)",
  "targetType": "string",
  "discriminator": "string",
  "name": "string"
}

CompanyRelationManager:

entryDate: string (date)
exitDate: string (date)
city: string
countryCode: string
function: string
Example
{
  "entryDate": "2015-03-01",
  "exitDate": "2017-10-31",
  "city": "string",
  "countryCode": "string",
  "function": "string",
  "uuid": "string (uuid)",
  "targetType": "string",
  "discriminator": "string",
  "name": "string"
}

CompanyRelationEmployee:

entryDate: string (date)
exitDate: string (date)
city: string
countryCode: string
function: string
Example
{
  "entryDate": "2015-03-01",
  "exitDate": "2017-10-31",
  "city": "string",
  "countryCode": "string",
  "function": "string",
  "uuid": "string (uuid)",
  "targetType": "string",
  "discriminator": "string",
  "name": "string"
}

CompanyRelationAuditor:

entryDate: string (date)
exitDate: string (date)
Example
{
  "entryDate": "2015-03-01",
  "exitDate": "2017-10-31",
  "uuid": "string (uuid)",
  "targetType": "string",
  "discriminator": "string",
  "name": "string"
}

CompanyRelationCheckedCompanies:

entryDate: string (date)
exitDate: string (date)
Example
{
  "entryDate": "2015-03-01",
  "exitDate": "2017-10-31",
  "uuid": "string (uuid)",
  "targetType": "string",
  "discriminator": "string",
  "name": "string"
}

CompanyRelationSubsidiaries:

entryDate: string (date)
exitDate: string (date)
city: string
countryCode: string
function: string
shares: number x ≥ 0
turnoverClass: string
status: boolean
wz08Codes: string[]
string
Example
{
  "entryDate": "2015-03-01",
  "exitDate": "2017-10-31",
  "city": "string",
  "countryCode": "string",
  "function": "string",
  "shares": "number",
  "turnoverClass": "string",
  "status": "boolean",
  "wz08Codes": [
    "string"
  ],
  "uuid": "string (uuid)",
  "targetType": "string",
  "discriminator": "string",
  "name": "string"
}

CompanyRelationShareholders:

entryDate: string (date)
exitDate: string (date)
city: string
countryCode: string
function: string
shares: number x ≥ 0
turnoverClass: string
status: boolean
wz08Codes: string[]
string
Example
{
  "entryDate": "2015-03-01",
  "exitDate": "2017-10-31",
  "city": "string",
  "countryCode": "string",
  "function": "string",
  "shares": "number",
  "turnoverClass": "string",
  "status": "boolean",
  "wz08Codes": [
    "string"
  ],
  "uuid": "string (uuid)",
  "targetType": "string",
  "discriminator": "string",
  "name": "string"
}

CompanyRelationProfitReceiving:

entryDate: string (date)
exitDate: string (date)
city: string
countryCode: string
turnoverClass: string
status: boolean
wz08Codes: string[]
string
Example
{
  "entryDate": "2015-03-01",
  "exitDate": "2017-10-31",
  "city": "string",
  "countryCode": "string",
  "turnoverClass": "string",
  "status": "boolean",
  "wz08Codes": [
    "string"
  ],
  "uuid": "string (uuid)",
  "targetType": "string",
  "discriminator": "string",
  "name": "string"
}

CompanyRelationProfitTransfering:

entryDate: string (date)
exitDate: string (date)
city: string
countryCode: string
turnoverClass: string
status: boolean
wz08Codes: string[]
string
Example
{
  "entryDate": "2015-03-01",
  "exitDate": "2017-10-31",
  "city": "string",
  "countryCode": "string",
  "turnoverClass": "string",
  "status": "boolean",
  "wz08Codes": [
    "string"
  ],
  "uuid": "string (uuid)",
  "targetType": "string",
  "discriminator": "string",
  "name": "string"
}

CompanyRelationMergers:

city: string
countryCode: string
turnoverClass: string
status: boolean
wz08Codes: string[]
string
Example
{
  "city": "string",
  "countryCode": "string",
  "turnoverClass": "string",
  "status": "boolean",
  "wz08Codes": [
    "string"
  ],
  "uuid": "string (uuid)",
  "targetType": "string",
  "discriminator": "string",
  "name": "string"
}

RiskManagementPreviewOutput: object

uuid: string (uuid)
latest: RiskManagementListElement
riskInfo: RiskInfoType
Example
{
  "uuid": "string (uuid)",
  "latest": {
    "dateIssued": "2015-03-20",
    "info": "string"
  },
  "riskInfo": {
    "riskInfo": "string",
    "riskInfoDate": "2015-03-20"
  }
}

RiskManagementFullInfoOutput: object

uuid: string (uuid)
groups: RiskManagementCase
RiskManagementCase
riskInfoHistory: RiskInfoType
RiskInfoType
Example
{
  "uuid": "string (uuid)",
  "groups": [
    {
      "caseId": "string",
      "list": [
        {
          "dateIssued": "2015-03-20",
          "info": "string"
        }
      ]
    }
  ],
  "riskInfoHistory": [
    {
      "riskInfo": "string",
      "riskInfoDate": "2015-03-20"
    }
  ]
}

RiskInfoType: object

riskInfo: CommonRiskInfo
riskInfoDate: string (date)
Example
{
  "riskInfo": "string",
  "riskInfoDate": "2015-03-20"
}

RiskManagementCase: object

Example
{
  "caseId": "string",
  "list": [
    {
      "dateIssued": "2015-03-20",
      "info": "string"
    }
  ]
}

RiskManagementListElement: object

dateIssued: string (date)
info: string
Example
{
  "dateIssued": "2015-03-20",
  "info": "string"
}

RiskAggregateStats: object

uuid: string (uuid)
levels: RiskLevelStats
RiskLevelStats
Example
{
  "uuid": "string (uuid)",
  "levels": [
    {
      "companies": {
        "total": "integer (int32)",
        "inactive": "integer (int32)",
        "risky": "integer (int32)"
      },
      "persons": {
        "total": "integer (int32)"
      }
    }
  ]
}

RiskLevelStats: object

Example
{
  "companies": {
    "total": "integer (int32)",
    "inactive": "integer (int32)",
    "risky": "integer (int32)"
  },
  "persons": {
    "total": "integer (int32)"
  }
}

CompanyRiskLevelStats: object

total: integer (int32) x ≥ 0 0
inactive: integer (int32) x ≥ 0 0
risky: integer (int32) x ≥ 0 0
Example
{
  "total": "integer (int32)",
  "inactive": "integer (int32)",
  "risky": "integer (int32)"
}

PersonRiskLevelStats: object

total: integer (int32) x ≥ 0 0
Example
{
  "total": "integer (int32)"
}

RiskAggregateFull: object

uuid: string (uuid)
levels: RiskLevelFull
RiskLevelFull
Example
{
  "uuid": "string (uuid)",
  "levels": [
    {
      "companies": [
        {
          "uuid": "string (uuid)",
          "name": "string",
          "city": "string",
          "deletionDate": "2015-03-20",
          "status": "boolean",
          "insolvency": "boolean",
          "deleted": "boolean",
          "dissolved": "boolean",
          "announced": "boolean",
          "tags": [
            {
              "tagName": "string",
              "ownerUUID": "string (uuid)",
              "ownerName": "string"
            }
          ]
        }
      ],
      "persons": [
        {
          "uuid": "string (uuid)",
          "name": "string",
          "city": "string",
          "dateOfBirth": "1985-03-20",
          "tags": [
            {
              "tagName": "string",
              "ownerUUID": "string (uuid)",
              "ownerName": "string"
            }
          ],
          "personConnectedToInsolventCompany": "boolean"
        }
      ]
    }
  ]
}

RiskLevelFull: object

Example
{
  "companies": [
    {
      "uuid": "string (uuid)",
      "name": "string",
      "city": "string",
      "deletionDate": "2015-03-20",
      "status": "boolean",
      "insolvency": "boolean",
      "deleted": "boolean",
      "dissolved": "boolean",
      "announced": "boolean",
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ]
    }
  ],
  "persons": [
    {
      "uuid": "string (uuid)",
      "name": "string",
      "city": "string",
      "dateOfBirth": "1985-03-20",
      "tags": [
        {
          "tagName": "string",
          "ownerUUID": "string (uuid)",
          "ownerName": "string"
        }
      ],
      "personConnectedToInsolventCompany": "boolean"
    }
  ]
}

CompanyRiskFull: object

uuid: string (uuid)
name: string
city: string
deletionDate: string (date)
status: boolean
insolvency: boolean
deleted: boolean
dissolved: boolean
announced: boolean
tags: CommonFullTag
CommonFullTag
Example
{
  "uuid": "string (uuid)",
  "name": "string",
  "city": "string",
  "deletionDate": "2015-03-20",
  "status": "boolean",
  "insolvency": "boolean",
  "deleted": "boolean",
  "dissolved": "boolean",
  "announced": "boolean",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ]
}

PersonRiskFull: object

uuid: string (uuid)
name: string
city: string
dateOfBirth: string (date)
tags: CommonFullTag
CommonFullTag
personConnectedToInsolventCompany: boolean
Example
{
  "uuid": "string (uuid)",
  "name": "string",
  "city": "string",
  "dateOfBirth": "1985-03-20",
  "tags": [
    {
      "tagName": "string",
      "ownerUUID": "string (uuid)",
      "ownerName": "string"
    }
  ],
  "personConnectedToInsolventCompany": "boolean"
}

TradeRegisterPreviewResult: object

uuid: string (uuid)
latestMessage: TradeRegisterMessage
Example
{
  "uuid": "string (uuid)",
  "latestMessage": {
    "datePublished": "2015-03-20",
    "type": "string",
    "text": "string"
  }
}

TradeRegisterResult: object

uuid: string (uuid)
messages: TradeRegisterMessage

Messages sorted by time.

TradeRegisterMessage
Example
{
  "uuid": "string (uuid)",
  "messages": [
    {
      "datePublished": "2015-03-20",
      "type": "string",
      "text": "string"
    }
  ]
}

TradeRegisterMessage: object

datePublished: string (date)
type: string NEUEINTRAGUNG, VERAENDERUNG, LOESCHUNG, KORREKTUR, SONSTIGE, INVALID
text: string
Example
{
  "datePublished": "2015-03-20",
  "type": "string",
  "text": "string"
}

CompanyAnnualReportsPreview: object

uuid: string (uuid)
reportYears: integer[]
integer (int32)
Example
{
  "uuid": "string (uuid)",
  "reportYears": [
    "integer (int32)"
  ]
}

CompanyAnnualReportsFullInfo: object

uuid: string (uuid)
reportsByYears: CompanyAnnualReportYear
CompanyAnnualReportYear
Example
{
  "uuid": "string (uuid)",
  "reportsByYears": [
    {
      "year": "integer",
      "reports": [
        {
          "id": "string (uuid)",
          "name": "string",
          "publicationDate": "2015-03-20",
          "balanceHeader": "string"
        }
      ]
    }
  ]
}

CompanyAnnualReportYear: object

Example
{
  "year": "integer",
  "reports": [
    {
      "id": "string (uuid)",
      "name": "string",
      "publicationDate": "2015-03-20",
      "balanceHeader": "string"
    }
  ]
}

CompanyAnnualReportId: object

id: string (uuid)
name: string
publicationDate: string (date)
balanceHeader: string
Example
{
  "id": "string (uuid)",
  "name": "string",
  "publicationDate": "2015-03-20",
  "balanceHeader": "string"
}