curl --request GET \
--url https://api.godiligent.ai/companies/identify \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.godiligent.ai/companies/identify"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.godiligent.ai/companies/identify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.godiligent.ai/companies/identify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.godiligent.ai/companies/identify"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.godiligent.ai/companies/identify")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.godiligent.ai/companies/identify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"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": "QUADERNOAQUADRETTISRL@ARUBAPEC.IT",
"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"
}
]
}
][
{
"errors": [
{
"path": [
"<string>"
],
"message": "<string>",
"code": "<string>"
}
]
}
]Identify Company
Get company by various data points
curl --request GET \
--url https://api.godiligent.ai/companies/identify \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.godiligent.ai/companies/identify"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.godiligent.ai/companies/identify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.godiligent.ai/companies/identify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.godiligent.ai/companies/identify"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.godiligent.ai/companies/identify")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.godiligent.ai/companies/identify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"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": "QUADERNOAQUADRETTISRL@ARUBAPEC.IT",
"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"
}
]
}
][
{
"errors": [
{
"path": [
"<string>"
],
"message": "<string>",
"code": "<string>"
}
]
}
]Authorizations
Query Parameters
The legal_name of the company
"CrossLend GmbH"
The address of the business, partial or full address
"CrossLend GmbH"
The VAT number of the business
"DE123456789"
The level of details to be returned
FULL, BASIC "FULL"
The country code of the business, in alpha-2 format (ISO 3166-1 alpha-2)
"DE"
The company registration number (e.g. Companies House number for UK, SIRET for FR, P.IVA or REA code for IT). Must be combined with country_code.
"12345678"
When true, enables the Infocamere registry source for Italian companies. Only relevant when identifying Italian companies via register_number or vat_number.
true
When true, validates and normalises the returned address against a reference dataset.
false
Response
OK
"XYZZ GmbH"
"GmbH"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
ACTIVE, REGISTERED, INACTIVE, SUSPENDED, IN_REGISTRATION, TERMINATED "ACTIVE"
"SOFTWARE CONSULTANCY"
"This is a placeholder for representation rules."
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"QUADERNOAQUADRETTISRL@ARUBAPEC.IT"
"128207"
Show child attributes
Show child attributes
Show child attributes
Show child attributes