Identify Company - Godiligent API Documentation

identify

curl --request GET \
  --url https://api.godiligent.ai/companies/identify \
  --header 'X-API-KEY: <api-key>'

[
  {
    "name": "XYZZ GmbH",
    "legal_form": "GmbH",
    "register": {
      "id": "HRB 259538 B",
      "country": "DE",
      "city": "Charlottenburg (Berlin)",
      "foundation_date": "2023-12-04"
    },
    "address": {
      "formatted_address": "123 Imaginary St, 45678 Fictional City",
      "components": {
        "street": "Imaginary St",
        "street_number": "123",
        "state": "IS",
        "locality_code": "IS",
        "city": "Fictional City",
        "postal_code": "45678",
        "country_code": "FC",
        "country": "Fictionland"
      },
      "type": "residential",
      "is_valid": true,
      "is_verified": true,
      "is_suspicious": false,
      "is_blacklisted": false,
      "is_primary": true,
      "street_view": "<string>",
      "sources": [
        {
          "name": "Source Name",
          "link": "https://www.example.com"
        }
      ]
    },
    "ownership": {
      "shareholders": [
        {
          "name": "John Doe",
          "percentage": 100,
          "type": "INDIVIDUAL",
          "location": "City, Country",
          "is_major_shareholder": true,
          "is_ubo": true,
          "gender": "MALE",
          "tax_code": "123456789",
          "address": "123 Main St, City, Country"
        }
      ],
      "total_percentage": 100,
      "total_shareholders_count": 1,
      "total_major_shareholders_count": 1,
      "total_ubos_count": 1
    },
    "source": {
      "name": "Source Name",
      "link": "https://www.example.com"
    },
    "status": "ACTIVE",
    "commercial_name": "<string>",
    "is_blocked": false,
    "description": "SOFTWARE CONSULTANCY",
    "vat_number": "<string>",
    "representation_rules": "This is a placeholder for representation rules.",
    "signatory_powers": [
      {
        "first_name": "John",
        "last_name": "Doe",
        "date_of_birth": "1990-01-01",
        "entity_name": "Example GmbH",
        "location": "City, Country",
        "role": "ROLE",
        "effective_date": "2024-01-01",
        "representation": "Representation details",
        "role_local": "Role",
        "signatory_power": "POWER_TYPE"
      }
    ],
    "industry_classifications": {
      "ateco": [
        "47199"
      ],
      "nace": [
        "4719"
      ],
      "sic": [
        "5999"
      ]
    },
    "pec": "[email protected]",
    "rea_code": "128207",
    "financials": {
      "date": "2022-12-31",
      "items": [
        {
          "id": "share_capital",
          "note": "<string>",
          "unit": "EUR",
          "value": 100000
        }
      ]
    },
    "extras": [
      {
        "name": "website",
        "value": "www.example.eu"
      }
    ]
  }
]

GET

companies

identify

curl --request GET \
  --url https://api.godiligent.ai/companies/identify \
  --header 'X-API-KEY: <api-key>'

[
  {
    "name": "XYZZ GmbH",
    "legal_form": "GmbH",
    "register": {
      "id": "HRB 259538 B",
      "country": "DE",
      "city": "Charlottenburg (Berlin)",
      "foundation_date": "2023-12-04"
    },
    "address": {
      "formatted_address": "123 Imaginary St, 45678 Fictional City",
      "components": {
        "street": "Imaginary St",
        "street_number": "123",
        "state": "IS",
        "locality_code": "IS",
        "city": "Fictional City",
        "postal_code": "45678",
        "country_code": "FC",
        "country": "Fictionland"
      },
      "type": "residential",
      "is_valid": true,
      "is_verified": true,
      "is_suspicious": false,
      "is_blacklisted": false,
      "is_primary": true,
      "street_view": "<string>",
      "sources": [
        {
          "name": "Source Name",
          "link": "https://www.example.com"
        }
      ]
    },
    "ownership": {
      "shareholders": [
        {
          "name": "John Doe",
          "percentage": 100,
          "type": "INDIVIDUAL",
          "location": "City, Country",
          "is_major_shareholder": true,
          "is_ubo": true,
          "gender": "MALE",
          "tax_code": "123456789",
          "address": "123 Main St, City, Country"
        }
      ],
      "total_percentage": 100,
      "total_shareholders_count": 1,
      "total_major_shareholders_count": 1,
      "total_ubos_count": 1
    },
    "source": {
      "name": "Source Name",
      "link": "https://www.example.com"
    },
    "status": "ACTIVE",
    "commercial_name": "<string>",
    "is_blocked": false,
    "description": "SOFTWARE CONSULTANCY",
    "vat_number": "<string>",
    "representation_rules": "This is a placeholder for representation rules.",
    "signatory_powers": [
      {
        "first_name": "John",
        "last_name": "Doe",
        "date_of_birth": "1990-01-01",
        "entity_name": "Example GmbH",
        "location": "City, Country",
        "role": "ROLE",
        "effective_date": "2024-01-01",
        "representation": "Representation details",
        "role_local": "Role",
        "signatory_power": "POWER_TYPE"
      }
    ],
    "industry_classifications": {
      "ateco": [
        "47199"
      ],
      "nace": [
        "4719"
      ],
      "sic": [
        "5999"
      ]
    },
    "pec": "[email protected]",
    "rea_code": "128207",
    "financials": {
      "date": "2022-12-31",
      "items": [
        {
          "id": "share_capital",
          "note": "<string>",
          "unit": "EUR",
          "value": 100000
        }
      ]
    },
    "extras": [
      {
        "name": "website",
        "value": "www.example.eu"
      }
    ]
  }
]

Authorizations

X-API-KEY

string

header

required

Query Parameters

legal_name

string

The legal_name of the company

Example:

"CrossLend GmbH"

address

string

The address of the business, partial or full address

Example:

"CrossLend GmbH"

vat_number

string

The VAT number of the business

Example:

"DE123456789"

registry_profile

enum<string>

The level of details to be returned

Available options:

FULL,

BASIC

Example:

"FULL"

country_code

string

The country code of the business, in alpha-2 format (ISO 3166-1 alpha-2)

Example:

"DE"

Response

name

string

required

Example:

"XYZZ GmbH"

legal_form

string

required

Example:

"GmbH"

object

required

Show child attributes

string

required

Example:

"HRB 259538 B"

string

required

Example:

"DE"

string

Example:

"Charlottenburg (Berlin)"

string

Example:

"2023-12-04"

address

object

required

Show child attributes

address.formatted_address

string

Example:

"123 Imaginary St, 45678 Fictional City"

address.components

object

Show child attributes

address.components.street

string

Example:

"Imaginary St"

address.components.street_number

string

Example:

"123"

address.components.state

string

Example:

"IS"

address.components.locality_code

string

Example:

"IS"

address.components.city

string

Example:

"Fictional City"

address.components.postal_code

string

Example:

"45678"

address.components.country_code

string

Example:

"FC"

address.components.country

string

Example:

"Fictionland"

address.type

enum<string>

Available options:

residential,

business,

unknown

Example:

"residential"

address.is_valid

boolean

Example:

true

address.is_verified

boolean

Example:

true

address.is_suspicious

boolean

Example:

false

address.is_blacklisted

boolean

Example:

false

address.is_primary

boolean

Example:

true

address.street_view

string

address.sources

object[]

Show child attributes

address.sources.name

string

required

Example:

"Source Name"

address.sources.link

string

Example:

"https://www.example.com"

ownership

object

required

Show child attributes

ownership.shareholders

object[]

Show child attributes

ownership.shareholders.name

string

Example:

"John Doe"

ownership.shareholders.percentage

integer

Example:

100

ownership.shareholders.type

string

Example:

"INDIVIDUAL"

ownership.shareholders.location

string

Example:

"City, Country"

ownership.shareholders.is_major_shareholder

boolean

Example:

true

ownership.shareholders.is_ubo

boolean

Example:

true

ownership.shareholders.gender

string

Example:

"MALE"

ownership.shareholders.tax_code

string

Example:

"123456789"

ownership.shareholders.address

string

Example:

"123 Main St, City, Country"

ownership.total_percentage

integer

Example:

100

ownership.total_shareholders_count

integer

Example:

1

ownership.total_major_shareholders_count

integer

Example:

1

ownership.total_ubos_count

integer

Example:

1

source

object

required

Show child attributes

source.name

string

required

Example:

"Source Name"

source.link

string

Example:

"https://www.example.com"

status

enum<string>

Available options:

ACTIVE,

REGISTERED,

INACTIVE,

SUSPENDED,

IN_REGISTRATION,

TERMINATED

Example:

"ACTIVE"

commercial_name

string

is_blocked

boolean

default:false

description

string

Example:

"SOFTWARE CONSULTANCY"

vat_number

string

representation_rules

string

Example:

"This is a placeholder for representation rules."

signatory_powers

object[]

Show child attributes

signatory_powers.first_name

string

Example:

"John"

signatory_powers.last_name

string

Example:

"Doe"

signatory_powers.date_of_birth

string

Example:

"1990-01-01"

signatory_powers.entity_name

string

Example:

"Example GmbH"

signatory_powers.location

string

Example:

"City, Country"

signatory_powers.role

string

Example:

"ROLE"

signatory_powers.effective_date

string

Example:

"2024-01-01"

signatory_powers.representation

string

Example:

"Representation details"

signatory_powers.role_local

string

Example:

"Role"

signatory_powers.signatory_power

string

Example:

"POWER_TYPE"

industry_classifications

object

Show child attributes

industry_classifications.ateco

string[]

industry_classifications.nace

string[]

industry_classifications.sic

string[]

pec

string

Example:

"[email protected]"

rea_code

string

Example:

"128207"

financials

object

Show child attributes

financials.date

string

Example:

"2022-12-31"

financials.items

object[]

Show child attributes

financials.items.id

enum<string>

Available options:

turnover,

share_capital,

net_worth

Example:

"share_capital"

financials.items.note

string

The note of the financial item

financials.items.unit

string

Example:

"EUR"

financials.items.value

number<int64>

Example:

100000

extras

object[]

Show child attributes

extras.name

string

Example:

"website"

extras.value

string

Example:

"www.example.eu"

Run risk checks Block Company

⌘I

API Reference

Authorizations

Query Parameters

Response