API - Zephira.ai

Authentication

The HTTP Authorization request header contains the credentials to authenticate a user agent with a server, usually after the server has responded with a 401 Unauthorized status

Syntax:
Authorization: Token

Example:
Authorization: Token 00000000-0000-0000-0000-000000000000

Authorization: Token your-api-key
Get credentials
Visit Zephira.ai Profile or contact your account manager

				
					Authorization: Token your-api-key

Errors

The API uses conventional Python and HTTP responses for successes or failures of each individual API request.

TokenVerificationError
- This error will appear when the introduces token is invalid.
InvalidRequest
- This error will appear for any

TokenVerificationError

Auth error

				
					Response

{
    "detail": "Invalid token"
}

InvalidRequest

Validation error

				
					
Response

{
    "field_name": [
        "This field is required."
    ]
}

InternalError

Generic api error

				
					
Response

{
    "detail": "A server error occurred."
}

LimitError

Limit api error

				
					Response

{
    "access": {
        "permission": "code_permission",
        "permission_name": "Name permission",
        "module": "code_module",
        "module_name": "Name Module",
        "app": "api",
        "app_name": "Api"
    },
    "error_guard": "limits.daily", // or limit
    "message_guard": "You have reached your daily online browsing limit"
}

Metrics

You can review how much information you have viewed and received from Global Database as well as check the total limits and how many more credits you have left.

Usage Metrics

GET https://api.zephira.ai/v2/metrics

Metrics Permissions

				
					Code samples

import requests

headers = {
  "Authorization": "Token 00000000-0000-0000-0000-000000000000"
}

r = requests.get("https://api.zephira.ai/v2/metrics", headers = headers)

print(r.json())

Success Response

[
    {
        "name": "Executives Company",
        "codename": "executives_company",
        "metrics": [
            {
                "name": "Executives Company",
                "codename": "executives_company",
                "used": 10,
                "total": 100
            }
        ]
    },
    //...
]

Usage Metrics Contacts

GET https://api.zephira.ai/v2/metrics/contacts

Metrics Permissions Contacts by Date Range

Parameters

Parameter	In	Type	Required	Description
date_from	params	datetime	true	Date From
date_to	params	datetime	true	Date To

				
					Code samples

import requests

headers = {
  "Authorization": "Token 00000000-0000-0000-0000-000000000000"
}

r = requests.get("https://api.zephira.ai/v2/metrics/contacts", params={
                "date_from": "2025-03-27 05:30:00",
                "date_to": "2025-04-27 05:30:00",
    }, headers = headers)

print(r.json())
Success Response

{
    "email_count": 317,
    "phone_count": 792
}

Prospecting API

The Prospecting API allows you to browse all companies based on specific parameters and will provide one or more results based on input that can then be further used to derive company details. You can search for companies in a specific location, of a specific size or turnover, or that are part of a particular industry.

Prospecting Companies

POST https://api.zephira.ai/v2/prospecting

Prospecting companies based on search criteria

Parameters

Parameter	In	Type	Required	Description
page	body	int	false	Page number (Maximum page value is 10)
per_page	body	int	false	Number of results per page
filters	body	string	false	Filter criteria json encoded

Fields: filters

Parameter	Type	Required	Description
company_status	array of int	false	Company status, available in nomenclatures
number_of_employees	object	false	Company size “gte” – “lte” range
trading_activity	array of string	false	Trading activity, available in nomenclatures
activity_type	array of int	false	Company activity type, available in nomenclatures
company_type	array of int	false	Company type, available in nomenclatures
company_incorporation	object	false	Company Incorporation “gte” – “lte” range
legal_form	array of int	false	Company form type, available in nomenclatures
industry_focus	array of string	false	Company industries, available in nomenclatures
website_keywords	array of string	false	Company website keywords
nace	array of string	false	NACE Rev. 2, available in nomenclatures
isic	array of string	false	International SIC Code, available in nomenclatures
sic_code_be	array of strings	false	Company Belgium SIC Codes, available in nomenclatures
sic_code_de	array of strings	false	Company Germany SIC Codes, available in nomenclatures
sic_code_dk	array of strings	false	Company Denmark SIC Codes, available in nomenclatures
sic_code_fr	array of strings	false	Company France SIC Codes, available in nomenclatures
sic_code_gb	array of strings	false	Company United Kingdom SIC Codes, available in nomenclatures
sic_code_ie	array of strings	false	Company Ireland SIC Codes, available in nomenclatures
sic_code_it	array of strings	false	Company Italy SIC Codes, available in nomenclatures
sic_code_lu	array of strings	false	Company Luxembourg SIC Codes, available in nomenclatures
sic_code_nl	array of strings	false	Company Netherlands SIC Codes, available in nomenclatures
sic_code_no	array of strings	false	Company Norway SIC Codes, available in nomenclatures
sic_code_se	array of strings	false	Company Sweden SIC Codes, available in nomenclatures
sic_code_sg	array of strings	false	Company Singapore SIC Code SIC Codes, available in nomenclatures
sic_code_us	array of strings	false	Company Singapore SIC Code SIC Codes, available in nomenclatures
sic_code_ca	array of strings	false	Company Canada SIC Codes, available in nomenclatures
sic_code_mx	array of strings	false	Company Mexico SIC Codes, available in nomenclatures
sic_code_anz	array of strings	false	Company ANZ SIC Codes, available in nomenclatures
location_regions	object	false	Company region, available in nomenclatures id (dive into nomenclature) parents (use in prospecting filter)
location_countries	object	false	Company country, available in nomenclatures id (dive into nomenclature) parents (use in prospecting filter)
location_zip	array of strings	false	Company ZIP Code
location_type	array of strings	false	Company City or State
financial_currency	array of strings	false	Company Currency, available in nomenclatures
financial_turnover	object	false	Company Turnover “gte” – “lte” range
financial_profit	object	false	Company Net Profit “gte” – “lte” range
financial_liabilities	object	false	Company Total Liabilities “gte” – “lte” range
financial_directors	array of int	false	Company Director remuneration “gte” – “lte” range
financial_employee_profit	object	false	Company Profit per Employee “gte” – “lte” range
financial_exports	object	false	Company financial exports “gte” – “lte” range
foreign_parents	string	false	Foreign Parent, available in nomenclatures
ownership_accounts	string	false	Consolidated Accounts, available in nomenclatures
insights_visits	array of strings	false	Company website visits, available in nomenclatures
insights_technologies	array of strings	false	Company website technologies, available in nomenclatures
insights_ranking	object	false	Company website Alexa ranking, available in nomenclatures
advance_companies	array of strings	false	Only Select Companies That, available in nomenclatures
yoy_exports	object	false	Exports “gte” – “lte” range
yoy_liabilities	object	false	Total Liabilities “gte” – “lte” range
yoy_staff	object	false	Staff numbers “gte” – “lte” range
yoy_turnover	object	false	Turnover Growth “gte” – “lte” range
yoy_ebitda	object	false	EBITDA “gte” – “lte” range
yoy_profit	object	false	Profit “gte” – “lte” range
linkedin	url	false	Company Linkedin Url

				
					Code samples


import requests

headers = {
  "Authorization": "Token 00000000-0000-0000-0000-000000000000"
}

r = requests.post("https://api.zephira.ai/v2/prospecting", json={
    "page": 1,
    "per_page": 50,
    "filters": {
        "company_status": [
            106
        ],
        "number_of_employees": {
            "gte": 1,
            "lte": 30000
        },
        "legal_form": [
            4024353
        ],
        "location_countries": [
            "1219916_1800795_1814321"
        ]
    }
}, headers = headers)

print(r.json())

Request example

{
    "page": 1,
    "per_page": 50,
    "filters": {
        "company_status": [
            106
        ],
        "number_of_employees": {
            "gte": 1,
            "lte": 30000
        },
        "legal_form": [
            4024353
        ],
        "location_countries": [
            "1219916_1800795_1814321"
        ]
    }
}

Success Response

{
    "total_companies": 2594573,
    "total_pages": 200,
    "data": [
        {
            "id": 17784513,
            "name": "FIAT CHRYSLER AUTOMOBILES UK LTD"
        },
        {
            "id": 19844844,
            "name": "BAKKAVOR LIMITED"
        },
        {
        "id": 22084035,
        "name": "ASTRAZENECA UK LIMITED"
        },
        //...
    ]
}

Companies API

The Companies API allows you to browse all companies based on specific parameters and will provide one or more results based on input that can then be further used to derive company details. You can search for companies in a specific location, of a specific size or turnover, or that are part of a particular industry.

Search Companies

POST https://api.zephira.ai/v2/overview

Find companies based on search criteria

Parameters

Parameter	In	Type	Required	Description
country_code	body	string	false	Country Code ISO 2
state	body	string	false	State (for US use iso 2)
name	body	string	false	Company Name
registration_number	body	string	false	Registration Number
lei_number	body	string	false	Lei Number
vat_number	body	string	false	VAT Number
website	body	string	false	Company Website
phone_number	body	string	false	Phone Number
person	body	string	false	Full Name Employee
company_status	body	list	false	Company status id, available in nomenclatures
page	body	int	false	Page (default 1)
per_page	body	int	false	Page (Maximum page value is 5)
linkedin	body	url	false	Company Linkedin Url

				
					Code samples

import requests

headers = {
  "Authorization": "Token 00000000-0000-0000-0000-000000000000"
}

r = requests.post("https://api.zephira.ai/v2/overview", json={
    "name": "Global Database",
    "country_code": "UK",
    "page": 1
}, headers = headers)

print(r.json())

Request example

{
    "name": "Global Database",
    "country_code": "UK",
    "page": 1
}

Success Response

{
    "total_results": 8,
    "total_pages": 2,
    "data": [
        {
            "id": "22401777", //(String) Company ID
            "name": "DATABASE SERVICE PROVIDER GLOBAL LTD", //(String) Company name
            "status": "Active", //(String) Company Status
            "country_code": "GB", //(String) Country code
            "registration_number": "03898451" //(String) Registration Number
        },
        {
            "id": "32019088",
            "name": "ALLIANCE GLOBAL DATABASE SOLUTIONS LTD",
            "status": "Active",
            "country_code": "GB",
            "registration_number": "11189294"
        },
        {
            "id": "28943006",
            "name": "GLOBAL REPERTOIRE DATABASE LIMITED",
            "status": "Active",
            "country_code": "GB",
            "registration_number": "08796841"
        },
        {
            "id": "32544410",
            "name": "GLOBAL CONSUMER DATABASE SERVICE LTD.",
            "status": "Active",
            "country_code": "GB",
            "registration_number": "11589671"
        },
        {
            "id": "22584291",
            "name": "GLOBAL DATABASE MANAGEMENT LIMITED",
            "status": "Active",
            "country_code": "GB",
            "registration_number": "04036430"
        }
    ]
}
Browse companies containing word "Global" in name from United Kingdom

{
  "name": "Global",
  "country_code": "UK",
  "page": 1
}
Browse companies with registration number "07949794" from United Kingdom

{
    "registration_number": "07949794",
    "country_code": "GB",
   "page": 1
}
Browse companies with website "www.novatech.co.uk" from United Kingdom

{
    "website": "www.novatech.co.uk",
    "country_code": "GB",
    "page": 1
}

Company Details

GET https://api.zephira.ai/v2/companies/{id}

View company details

Parameters

Parameter	In	Type	Required	Description
id	url	string	true	Company ID

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/companies/20581257',
                 headers = headers)

print(r.json())
Request example

{
  "id": 20581257
}

Success Response

{
    "id": 17937983,
    "name": "TESCO PLC",
    "registration_number": "00445790",
    "country_code": "GB",
    "company_phone": [
        "+441992632222"
    ],
    "company_email": [],
    "company_fax": [],
    "company_website": "http://www.tesco.com",
    "company_legal_form": "Public Limited Company",
    "status": "Active",
    "brands": "TESCO PLC, TESCO STORES (HOLDINGS) PUBLIC LIMITED COMPANY",
    "address_street": "TESCO HOUSE SHIRE PARK",
    "address_location": "KESTREL WAY",
    "address_city": "WELWYN GARDEN CITY",
    "country_region": null,
    "zip_code": "AL7 1GA",
    "country_name": "United Kingdom",
    "size": "10001",
    "vat_number": null,
    "founding_date": "1947-11-27",
    "industry": [
        {
            "id": 4592033,
            "type": "industry_focus",
            "value": "Retail"
        },
        {
            "id": 4563309,
            "type": "industry_focus",
            "value": "Fair trade products"
        },
        {
            "id": 4563294,
            "type": "industry_focus",
            "value": "Retail"
        }
    ],
    "sic": [
        {
            "id": 3969852,
            "type": "sic_code_gb",
            "value": "47110 - Retail sale in non-specialised stores with food, beverages or tobacco predominating"
        }
    ],
    "twitter": "twitter.com/tesco",
    "linkedin": "linkedin.com/company/-tesco",
    "facebook": "facebook.com/tesco"

Employees API

The Employee API looks up contacts and emails associated with employees in a company and returns information on their location, seniority, department, job title. For example, you can use this to find all Chief Information Security executives working in SMEs in the Automotive industry across the UK.

Search Employee

POST https://api.zephira.ai/v2/employees

View search employees

Parameters

Parameter	In	Type	Required	Description
page	body	int	false	Page number (Maximum page value is 10)
per_page	body	int	false	Number of results per page
filters	body	string	true	Filter criteria json encoded

Fields: filters

Parameter	Type	Required	Description
full_name	strings	false	Employee full name
advance	array of strings	false	Only Select Contacts That, available in nomenclatures – advance-contacts
seniority	array of int	false	Contact level, available in nomenclatures – seniority_level
department	array of int	false	Contact department, available in nomenclatures – departments
job_title	array of strings	false	Job Title
company_id	int	false	Company ID
linkedin	url	false	Contact Linkedin Url

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.post('https://api.zephira.ai/v2/employees', json={
                "page": 1,
                "per_page": 5,
                "filters": {
                    "company_id": 20581257
                }
    }, headers = headers)

print(r.json())
Request example

{
    "page": 1,
    "per_page": 5,
    "filters": {
        "company_id": 20581257
    }
}

Success Response

{
    "total_employees": 69,
    "total_pages": 14,
    "data": [
        {
            "id": "20773074",
            "name": "Alex Puttock",
            "company_id": "20581257",
            "company_name": "NOVATECH LIMITED"
        },
        {
            "id": "20773046",
            "name": "Alex Puttock",
            "company_id": "20581257",
            "company_name": "NOVATECH LIMITED"
        },
        {
            "id": "20773060",
            "name": "Jamie Peter Wilson",
            "company_id": "20581257",
            "company_name": "NOVATECH LIMITED"
        },
        {
            "id": "20773134",
            "name": "David Richard Morgan Furby",
            "company_id": "20581257",
            "company_name": "NOVATECH LIMITED"
        },
        {
            "id": "74271219",
            "name": "Darren Ian Smith",
            "company_id": "20581257",
            "company_name": "NOVATECH LIMITED"
        }
    ]
}

Employee Details

GET https://api.zephira.ai/v2/employees/{id}

View employee details

Parameters

Parameter	In	Type	Required	Description
id	url	int	true	Company ID

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/employees/199328763',
    headers = headers)

print(r.json())

Request example

{
  "id": 199328763
}

Success Response

{
    "id": "199328763",
    "full_name": "Kerry Louise Johnson",
    "first_name": "Kerry",
    "last_name": "Johnson",
    "patronime_name": "Louise",
    "gender": "F",
    "seniority_level": [
        "Manager"
    ],
    "function_original_name": "governance officer",
    "phone": "+447446108873",
    "email": "kerry.johnson@lewisham.gov.uk",
    "nationality": null,
    "company_name": "LONDON SOUTH BANK UNIVERSITY",
    "twitter": null,
    "linkedin": null,
    "facebook": null
}

Watch Companies API

The Watch API allows you to keep track of all relevant changes and updates made to a company as well as be informed automatically once chosen indicators change in the company’s profile be that change of name, directors, financial ratios, or legal status. For example, you can keep track of your buyer’s financial situation to gauge their credibility or monitor a provider’s growth to decide if you want to continue working with them.

Companies Webhook
The Webhook system allows you to be notified of changes made to indicators you have selected.

Start Watch Company

POST https://api.zephira.ai/v2/companies/{id}/watch/start

Start watch company

Parameters

Parameter	In	Type	Required	Description
id	url	int	true	Company ID
fields	body	list	false	Fields Watch [company_fax, name, vat_number, company_address_street, company_website, company_phone, company_email]

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.post('https://api.zephira.ai/v2/companies/20581257/watch/start', json={
                "fields": [
                    "company_fax",
                    "shareholder_name"
                ]}, headers = headers)

print(r.json())

Request example

{
    "fields": [
        "company_fax",
        "shareholder_name"
    ]
}
Success Response

201

Stop Watch Company

DELETE https://api.zephira.ai/v2/companies/{id}/watch/stop

Stop watch company

Parameters

Parameter	In	Type	Required	Description
id	url	int	true	Company ID

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.delete('https://api.zephira.ai/v2/companies/20581257/watch/stop',
                    headers = headers)

print(r.json())

Request example

{
    "id": 20581257
}
Success Response

200

Watched Companies

GET https://api.zephira.ai/v2/companies/watch

List watched companies

Parameters

Parameter	In	Type	Required	Description
date	params	date	false	Date
fields	params	list	false	Fields Watch
page	params	int	false	Page number
per_page	params	int	false	Number of results per page

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/companies/watch', params={
                "fields": ["company_fax"],
                "date": "2021-08-10",
                "page": 1,
                "per_page": 10
    }, headers = headers)

print(r.json())

Request example

{
  "fields": ["company_fax"],
  "date": "2021-08-10",
  "page": 1,
  "per_page": 10
}
Success Response

{
  "data": [
    {
      "id": "88663676",
      "name": "MMS A/S af 18.10.2017",
      "country_code": "DK",
      "registration_number": "25638700",
      "date": "2021-08-10",
      "fields": [
        "company_fax",
        "shareholder_name",
        "company_status"
      ]
    },
    //...
  ],
  "total_results": 10,
  "pages": 1
}

All Companies Events

GET https://api.zephira.ai/v2/companies/61862770/watch/events

List company events

Parameters

Parameter	In	Type	Required	Description
id	url	int	true	Company ID
from_date	params	date	false	From Date
to_date	params	date	false	To Date
fields	params	list	false	Fields Watch
page	params	int	false	Page number
per_page	params	int	false	Number of results per page

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/companies/61862770/watch/events', params={
                "fields": ["company_name"],
                "from_date": "2020-08-10",
                "to_date": "2021-08-10",
                "page": 1,
                "per_page": 10
    }, headers = headers)

print(r.json())

Request example

{
  "id": 61862770,
  "fields": ["company_name"],
  "from_date": "2020-08-10",
  "to_date": "2021-08-10",
  "page": 1,
  "per_page": 10
}

Success Response

{
    "data": [
        {
            "status": "UPDATED",
            "message": "Company change his name from <b>PATRICK SWEENEY FUNERAL DIRECTORS LIMITED</b> to <b>PATRICK</b>",
            "date_created": "2021-03-02T06:50:09Z",
            "event_type": "company_name"
        },
        //...
    ],
    "total_results": 5,
    "pages": 1
}

Watched Company Fields

GET https://api.zephira.ai/v2/companies/{id}/watch/stop

Get Watched Company Fields

Parameters

Parameter	In	Type	Required	Description
id	url	int	true	Company ID

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/companies/20581257/watch/fields',
                    headers = headers)

print(r.json())

Request example

{
    "id": 20581257
}
Success Response

[
    "vat_number"
]

Add Watched Fields

PUT https://api.zephira.ai/v2/companies/{id}/watch/start

Add fields for watch company

Parameters

Parameter	In	Type	Required	Description
id	url	int	true	Company ID
fields	body	list	false	Fields Watch

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.put('https://api.zephira.ai/v2/companies/20581257/watch/fields/add', json={
                "fields": [
                    "vat_number"
                ]}, headers = headers)

print(r.json())

Request example

{
    "fields": [
        "vat_number"
    ]
}

Success Response

[
    "company_fax",
    "vat_number"
]

Remove Watched Fields

PUT https://api.zephira.ai/v2/companies/{id}/watch/start

Remove fields for watch company

Parameters

Parameter	In	Type	Required	Description
id	url	int	true	Company ID
fields	body	list	false	Fields Watch

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.put('https://api.zephira.ai/v2/companies/20581257/watch/fields/remove', json={
                "fields": [
                    "vat_number"
                ]}, headers = headers)

print(r.json())

Request example

{
    "fields": [
        "company_phone"
    ]
}

Success Response

[
    "company_fax",
    "vat_number"
]

Set Callback URL

PUT https://api.zephira.ai/v2/companies/watch/callback

Set callback url for webhook notifications

Parameters

Parameter	In	Type	Required	Description
callback	body	url	true	Callback URL

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.put('https://api.zephira.ai/v2/companies/watch/callback', json={
                "callback": "https://globaldatabase.com"
    }, headers = headers)

print(r.json())

Request example

{
  "callback": "https://zephira.ai"
}
Success Response

200

Get Callback URL

GET https://api.zephira.ai/v2/companies/watch/callback

Get callback url for webhook companies notifications

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/companies/watch/callback',
                 headers = headers)

print(r.json())

Success Response

{
    "callback": "https://zephira.ai/"
}

Companies Webhook

POST https://your_callback_url

Webhook companies notifications

				
					Response

{
  "company_data": {
    "id": 9,
    "name": "TESCO PLC",
    "registration_number": "00445790",
    "country_code": "GB",
    "date": "2021-09-15T18:53:25Z"
  },
  "field": "company_email",
  "status": "UPDATE",
  "new_value": "email@example.com",
  "old_value": "email1@example.com"
}

Enrichment API

The Enrichment API is designed to find and receive detailed company and employee information based on domain or email. This can be utilized for only company, employee, or both combined. This solution allows you to look up a person’s position and contact details, receive a detailed profile of a company you’re verifying, or be utilized as an end-customer facing solution to provide them with information and insights. For example, you can provide your end-customers with white-labeled data from Global Database by integrating the Enrichment API into your own solution.

Enrichment Company By Website

POST https://api.zephira.ai/v2/enrichment/url

Parameters

Parameter	In	Type	Required	Description
url	body	string	true	Company Website

				
					Code samples

import requests

headers = {
  "Authorization": "Token 00000000-0000-0000-0000-000000000000"
}

r = requests.post("https://api.zephira.ai/v2/enrichment/url", json={
    "url": "http://www.tesco.com"
}, headers = headers)

print(r.json())

Request example

{
    "url": "http://www.tesco.com"
}

Success Response

{
    "id": 17937983,
    "name": "TESCO PLC",
    "registration_number": "00445790",
    "country_code": "GB",
    "company_phone": [
        "+441992632222"
    ],
    "company_email": [],
    "company_fax": [],
    "company_website": "http://www.tesco.com",
    "company_legal_form": "Public Limited Company",
    "brands": "TESCO PLC, TESCO STORES (HOLDINGS) PUBLIC LIMITED COMPANY",
    "address_street": "TESCO HOUSE SHIRE PARK",
    "address_location": "KESTREL WAY",
    "address_city": "WELWYN GARDEN CITY",
    "country_region": null,
    "zip_code": "AL7 1GA",
    "country_name": "United Kingdom",
    "size": "10001",
    "vat_number": null,
    "founding_date": "1947-11-27",
    "industry": [
        {
            "id": 4592033,
            "type": "industry_focus",
            "value": "Retail"
        },
        {
            "id": 4563309,
            "type": "industry_focus",
            "value": "Fair trade products"
        },
        {
            "id": 4563294,
            "type": "industry_focus",
            "value": "Retail"
        }
    ],
    "sic": [
        {
            "id": 3969852,
            "type": "sic_code_gb",
            "value": "47110 - Retail sale in non-specialised stores with food, beverages or tobacco predominating"
        }
    ],
    "twitter": "twitter.com/tesco",
    "linkedin": "linkedin.com/company/-tesco",
    "facebook": "facebook.com/tesco"
}

Enrichment Company By Linkedin URL

POST https://api.zephira.ai/v2/enrichment/company/linkedin

Parameters

Parameter	In	Type	Required	Description
linkedin	body	string	true	Company Linkedin Url

				
					Code samples

import requests

headers = {
  "Authorization": "Token 00000000-0000-0000-0000-000000000000"
}

r = requests.post("https://api.zephira.ai/v2/enrichment/company/linkedin", json={
    "linkedin": "https://www.linkedin.com/company/zephiraaaa-ai/"
}, headers = headers)

print(r.json())

Request example

{
    "linkedin": "https://www.linkedin.com/company/zephira-ai/"
}
Success Response

{
    "id": "29707645",
    "name": "ZEPHIRA INTELLIGENCE LIMITED",
    "registration_number": "09410808",
    "country_code": "GB",
    "company_phone": [
        "+442036406006"
    ],
    "company_email": [
        "info@zephira.ai"
    ],
    "company_fax": null,
    "company_website": "http://zephira.ai/",
    "company_legal_form": "Private limited company (Ltd.)",
    "status": "Active",
    "brands": "Zephira",
    "address_street": "Artisans' House",
    "address_location": "7 Queensbridge",
    "address_city": "Northampton",
    "country_region": "England",
    "zip_code": "NN4 7BF",
    "country_name": "United Kingdom",
    "size": "3",
    "vat_number": null,
    "founding_date": "2015-01-28",
    "industry": [
        {
            "id": 4563106,
            "type": "industry_focus",
            "value": "Information Technology"
        },
        {
            "id": 4563495,
            "type": "industry_focus",
            "value": "Textile"
        }
    ],
    "sic": [
        {
            "id": 3969895,
            "type": "sic_code_gb",
            "value": "47990 - Other retail sale not in stores, stalls or markets"
        }
    ],
    "twitter": null,
    "linkedin": "linkedin.com/company/zephira-ai",
    "facebook": null

Enrichment Company

POST https://api.zephira.ai/v2/enrichment/company

Parameters

Parameter	In	Type	Required	Description
registration_number	body	string	false	Company Registration Number
vat_number	body	string	false	Company VAT Number
country_code	body	string	true	Country Code
state	body	string	false	Is required for Country Code US

				
					Code samples

import requests

headers = {
  "Authorization": "Token 00000000-0000-0000-0000-000000000000"
}

r = requests.post("https://api.zephira.ai/v2/enrichment/company", json={
    "registration_number": "09410808",
    "country_code": "UK"
}, headers = headers)

print(r.json())

Request example

{
    "registration_number": "09410808",
    "country_code": "UK"
}

Success Response

{
    "id": "29707645",
    "name": "Zephira.ai",
    "registration_number": "09410808",
    "country_code": "GB",
    "company_phone": [
        "+442036406006"
    ],
    "company_email": [
        "info@zephira.ai"
    ],
    "company_fax": null,
    "company_website": "http://zephia.ai/",
    "company_legal_form": "Private limited company (Ltd.)",
    "status": "Active",
    "brands": "Zephira",
    "address_street": "Artisans' House",
    "address_location": "7 Queensbridge",
    "address_city": "Northampton",
    "country_region": "England",
    "zip_code": "NN4 7BF",
    "country_name": "United Kingdom",
    "size": "3",
    "vat_number": null,
    "founding_date": "2015-01-28",
    "industry": [
        {
            "id": 4563106,
            "type": "industry_focus",
            "value": "Information Technology"
        }
    ],
    "sic": [
        {
            "id": 3969895,
            "type": "sic_code_gb",
            "value": "47990 - Other retail sale not in stores, stalls or markets"
        }
    ],
    "twitter": null,
    "linkedin": "linkedin.com/company/zephira-ai",
    "facebook": null
}

Enrichment Contact By Email

POST https://api.zephira.ai.com/v2/enrichment/email

Parameters

Parameter	In	Type	Required	Description
email	body	string	true	Contact Email
reveal_phone	body	bool	false	Reveal Phone (Default value is True)

				
					Code samples

import requests

headers = {
  "Authorization": "Token 00000000-0000-0000-0000-000000000000"
}

r = requests.post("https://api.zephira.ai/v2/enrichment/email", json={
    "email": "thomas.vanmourik@culinalogistics.co.uk"
}, headers = headers)

print(r.json())

Request example

{
    "email": "thomas.vanmourik@culinalogistics.co.uk"
}

Success Response

{
    "id": "34871530",
    "full_name": "Thomas Van Mourik",
    "first_name": "Thomas",
    "last_name": "Van Mourik",
    "patronime_name": null,
    "gender": "M",
    "seniority_level": [
        "CXO"
    ],
    "function_original_name": "CXO",
    "phone": "+441650695000",
    "email": "thomas.vanmourik@culinalogistics.co.uk",
    "nationality": null,
    "company_id": "24131010",
    "company_name": "CULINA LOGISTICS LIMITED",
    "twitter": null,
    "linkedin": null,
    "facebook": null
}

Enrichment Contact By Linkedin URL

POST https://api.zephira.ai/v2/enrichment/employee/linkedin

Parameters

Parameter	In	Type	Required	Description
linkedin	body	string	true	Contact Linkedin Url
reveal_email	body	bool	false	Reveal Email (Default value is True)
reveal_phone	body	bool	false	Reveal Phone (Default value is True)

				
					Code samples

import requests

headers = {
  "Authorization": "Token 00000000-0000-0000-0000-000000000000"
}

r = requests.post("https://api.zephira.ai/v2/enrichment/employee/linkedin", json={
    "linkedin": "https://www.linkedin.com/in/alex-price-991845116/"
}, headers = headers)

print(r.json())

Request example

{
    "linkedin": "https://www.linkedin.com/in/alex-price-991845116/"
}

Success Response

{
    "id": "391778535",
    "full_name": "Alex Price",
    "first_name": "Alex",
    "last_name": "Price",
    "patronime_name": null,
    "gender": "M",
    "seniority_level": [
        "Manager"
    ],
    "department": [],
    "function_original_name": "Future Leaders Graduate",
    "phone": "+447984096205",
    "email": "alex.price@ba.com",
    "nationality": null,
    "company_id": "19531621",
    "company_name": "BRITISH AIRWAYS PLC",
    "twitter": null,
    "linkedin": "https://linkedin.com/in/alex-price-991845116",
    "facebook": null
}

Enrichment Contact

POST https://api.zephira.ai/v2/enrichment/employee/contacts

Parameters

Parameter	In	Type	Required	Description
first_name	body	string	false	Contact First Name
last_name	body	string	false	Contact First Name
company_name	body	string	false	Company Name
domain	body	string	false	Domain or Website
email	body	string	false	Contact Email
linkedin	body	string	false	Contact Linkedin Profile Url
reveal_email	body	bool	false	Reveal Email (Default value is True)
reveal_phone	body	bool	false	Reveal Phone (Default value is True)

				
					Code samples

import requests

headers = {
  "Authorization": "Token 00000000-0000-0000-0000-000000000000"
}

r = requests.post("https://api.zephira.ai/v2/enrichment/employee/contacts", json={
    "first_name": "Alex",
    "last_name": "Price",
    "company_name": "BRITISH AIRWAYS PLC",
    "email": "alex.price@ba.com"
}, headers = headers)

print(r.json())

Request example

{
    "first_name": "Alex",
    "last_name": "Price",
    "company_name": "BRITISH AIRWAYS PLC",
    "email": "alex.price@ba.com"
}

Success Response

{
    "id": "391778535",
    "full_name": "Alex Price",
    "first_name": "Alex",
    "last_name": "Price",
    "patronime_name": null,
    "gender": "M",
    "seniority_level": [
        "Manager"
    ],
    "department": [],
    "function_original_name": "Future Leaders Graduate",
    "phone": "+447984096205",
    "email": "alex.price@ba.com",
    "nationality": null,
    "company_id": "19531621",
    "company_name": "BRITISH AIRWAYS PLC",
    "twitter": null,
    "linkedin": "https://linkedin.com/in/alex-price-991845116",
    "facebook": null
}

Search employees

POST https://api.zephira.ai/v2/enrichment/employee/search

Parameters

Parameter	In	Type	Required	Description
domain_list	body	list	false	Domains Companies
company_locations	body	list	false	Companies Location
employee_locations	body	list	false	Employees Location
employee_seniorities	body	list	false	Employees Seniorities
page	body	int	false	Page
per_page	body	int	false	Number of results per page

Possible values for employee_seniorities:

owner
founder
c_suite
partner
vp
head
director
manager
senior
entry
intern

				
					Code samples

import requests

headers = {
  "Authorization": "Token 00000000-0000-0000-0000-000000000000"
}

r = requests.post("https://api.zephira.ai/v2/enrichment/employee/search", json={
    "domain_list": [
        "amazon.com"
    ],
    "company_locations": [
        "United States"
    ],
    "employee_locations": [
        "India"
    ],
    "employee_seniorities": [
        "director"
    ],
    "page": 1,
    "per_page": 100
}, headers = headers)

print(r.json())

Request example

{
    "domain_list": [
        "amazon.com"
    ],
    "company_locations": [
        "United States"
    ],
    "employee_locations": [
        "India"
    ],
    "employee_seniorities": [
        "director"
    ],
    "page": 1,
    "per_page": 100
}

Success Response

{
    "total_employees": 344,
    "total_pages": 4,
    "data": [
        {
            "id": "fa5ec73398a4a4ce2cd8a1a95c16b5fb",
            "last_name": "Gupta",
            "first_name": "Raghava",
            "name": "Raghava Gupta",
            "seniority_level": "director",
            "job_title": "Director - CrossBorder Tech, Product and Science",
            "twitter": null,
            "facebook": null,
            "linkedin": "http://www.linkedin.com/in/raghavagupta",
            "country": "India",
            "state": "Karnataka",
            "city": "Bengaluru",
            "company": {
                "name": "Amazon",
                "website": "http://www.amazon.com",
                "incorporation_date": 1994,
                "country": "United States",
                "state": "Washington",
                "city": "Seattle",
                "postal_code": "98109",
                "phone": "+12062661000",
                "twitter": "https://twitter.com/amazon",
                "facebook": "https://facebook.com/Amazon/",
                "linkedin": "http://www.linkedin.com/company/amazon",
                "street_address": "345 Boren Avenue North"
            }
        },
        ...
    ]
}

Autocomplete API

The Autocomplete API’s primary function is to automate the completion of forms and fields with an initial input. This is used to enhance end-customer services as well as populate CRM information with details on each introduced lead, be that company or employee. For example, you can use the Autocomplete API to allow your sales people keep your CRM tidy and organized by automatically filling in all relevant fields once they enter a new lead’s first email address.

Autocomplete Company Detail

POST https://api.zephira.ai/v2/autocomplete

View autocomplete company details

Parameters

Parameter	In	Type	Required	Description
country_code	body	string	false	Country Code ISO
name	body	string	false	Company Name
registration_number	body	string	false	Registration Number
vat_number	body	string	false	VAT Number
website	body	string	false	Company Website
email	body	string	false	Company Email
linkedin	body	url	false	Company Linkedin Url

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.post('https://api.zephira.ai/v2/autocomplete', json={
        "website": "http://www.tesco.com"
    }, headers = headers)

print(r.json())

Request example

{
    "website": "http://www.tesco.com"
}

Success Response

{
    "id": 17937983,
    "name": "TESCO PLC",
    "registration_number": "00445790",
    "country_code": "GB",
    "company_phone": [
        "+441992632222"
    ],
    "company_email": [],
    "company_fax": [],
    "company_website": "http://www.tesco.com",
    "company_legal_form": "Public Limited Company",
    "brands": "TESCO PLC, TESCO STORES (HOLDINGS) PUBLIC LIMITED COMPANY",
    "address_street": "TESCO HOUSE SHIRE PARK",
    "address_location": "KESTREL WAY",
    "address_city": "WELWYN GARDEN CITY",
    "country_region": null,
    "zip_code": "AL7 1GA",
    "country_name": "United Kingdom",
    "size": "10001",
    "vat_number": null,
    "founding_date": "1947-11-27",
    "industry": [
        {
            "id": 4592033,
            "type": "industry_focus",
            "value": "Retail"
        },
        {
            "id": 4563309,
            "type": "industry_focus",
            "value": "Fair trade products"
        },
        {
            "id": 4563294,
            "type": "industry_focus",
            "value": "Retail"
        }
    ],
    "sic": [
        {
            "id": 3969852,
            "type": "sic_code_gb",
            "value": "47110 - Retail sale in non-specialised stores with food, beverages or tobacco predominating"
        }
    ],
    "twitter": "twitter.com/tesco",
    "linkedin": "linkedin.com/company/-tesco",
    "facebook": "facebook.com/tesco"
}

				
					Request example

{
    "country_code": "GB"
}
Error Response

{
    "fields": [
        "Select at least one more field ['name', 'registration_number', 'vat_number', 'website', 'phone_number']."
    ]
}

Financials API

The Financial API is designed to provide detailed information on the latest financial figures for companies. The displayed fields can be adjust to reflect the most important financial indicators for you. For example you can create detailed reports and financial models by analyzing reports of similar companies in a given market.

Company Financials

GET https://api.zephira.ai/v2/financial/{id}

View company financials

Parameters

Parameter	In	Type	Required	Description
id	url	int	true	Company ID
year	body	int	false	Year

Response

Properties

year
- Type: object
- Properties
  - Reported-Date: date (yyyy-mm-dd)
  - Currency: string
  - Total-Other-Long-Term-Liabilities: double
  - Trade-And-Other-Payables: double
  - Trade-And-Other-Receivables: double
  - Trade-Creditors: double
  - Trade-Creditors-or-Trade-Payables: double
  - Trade-Debtors: double
  - Trading-Assets: double
  - Trading-Liabilities: double
  - Treasury-bills-and-other-eligible-bills: double
  - Turnover: double
  - Employee-Numbers-Yoy: double
  - EBITDA-Yoy: double
  - Accounting-From-Date: int
  - Accrued-interest-and-rent: double
  - All-Other-Income: double
  - Amortisation-of-Intangibles: double
  - Amounts-owed-to-credit-institutions: double
  - Amounts-owed-to-group-undertakings: double
  - Assets-Held-for-Resale: double
  - Audit-Fees: double
  - Auditor-Fees: double
  - Available-for-sale-financial-assets: double
  - Bank-Loan: double
  - Bank-Overdraft: double
  - Bank-Overdraft-And-LTL: double
  - Borrowings: double
  - Borrowings-due-after-one-year: double
  - Borrowings-due-within-one-year: double
  - CFO-To-Sales-Ratio: double
  - Capital-Employed: double
  - Cash: double
  - Cash-Conversion-Cycle: double
  - Cash-To-Current-Liabilities-Ratio: double
  - Cash-To-Total-Assets: double
  - Cash-To-Turnover: double
  - Cash-and-balances-at-central-banks: double
  - Cashflow-from-ROI: double
  - Cashflow-from-Returns-on-Investments: double
  - Company-Accounts-Status: string
  - Consolidated-Accounts: string
  - Contingent-Liability: double
  - Cost-of-Sales: double
  - Currency: string
  - Current-Financial-Liabilities: double
  - Current-Grants: double
  - Current-Hire-Purchase-Commitments: double
  - Current-Liabilities-held-for-resale: double
  - Current-Ratio: double
  - Current-Tax-Recoverable: double
  - Customer-Accounts-due-after-1-year: double
  - Customer-Accounts-due-within-1-year: double
  - Customer-accounts: double
  - Days-Inventory-Outstanding: double
  - Days-Payable-Outstanding: double
  - Days-Sales-Outstanding: double
  - Debt-Securities-Due-after-1-year: double
  - Debt-Securities-Due-within-1-year: double
  - Debt-Securities-in-Issue: double
  - Debt-Securities-in-issue-due-after-1-year: double
  - Debt-Securities-in-issue-due-within-1-year: double
  - Debt-To-Capital: double
  - Employee-Numbers: int
  - Employee-Remuneration: double
  - Equity-Paid-Up: double
  - Equity-Shares: double
  - Exports-Yoy: double
  - Fees-and-Commission-Expense: double
  - Finance: double
  - Finance-Costs: double
  - Financial-Assets-Current: double
  - Financial-Assets-Due-after-1-year: double
  - Financial-Assets-Due-within-1-year: double
  - Financial-Investments-after-12-months: double
  - Financial-Investments-within-12-months: double
  - Financial-Liabilities: double
  - Financial-Liabilities-due-after-1-year: double
  - Financial-Liabilities-due-within-1-year: double
  - Finished-Goods: double
  - Gearing-Gross-Debt-Basis: double
  - Gearing-Liability-Basis: double
  - Gearing-Net-Debt-Basis: double
  - Goodwill: double
  - Gross-Margin: double
  - Gross-Profit: double
  - Gross-Written-Premiums: double
  - Group-Accounts-Payable: double
  - Hire-Purchase-Commitments: double
  - Human-Capital-Value-Added: double
  - Increase-In-Cash: double
  - Insurance-Liabilities-to-be-settled-after-12-months: double
  - Insurance-Liabilities-to-be-settled-within-12-months: double
  - Insurance-debtors-And-assets-to-be-settled-after-12-months: double
  - Insurance-debtors-And-assets-to-be-settled-within-12-months: double
  - Insurance-debtors-and-assets: double
  - Intangible-Assets: double
  - Interest-Bearing-Loans: double
  - Interest-Coverage-Ratio: double
  - Interest-Payable: double
  - Interest-Receivable: double
  - Interest-and-Similar-Expense: double
  - Interest-and-Similar-Income: double
  - Inventory-Turnover-Ratio: double
  - Investment-And-Other: double
  - Investment-Expenses-and-Charges: double
  - Investment-Income: double
  - Investment-Liabilities: double
  - Investment-Liabilities-to-be-settled-after-12-months: double
  - Investment-Liabilities-to-be-settled-within-12-months: double
  - Investments: double
  - Investments-in-Group-Undertakings: double
  - Items-in-the-course-of-collection-from-other-banks: double
  - Items-in-the-course-of-transmission-to-other-banks: double
  - Land-And-Buildings: double
  - Lease-Commitments: double
  - Less-Income-Tax-Attributable-to-Policyholders-Returns: double
  - Liabilities-held-for-sale: double
  - Liquidity-Ratio: double
  - Loans-And-Deposits-with-Credit-Institutions: double
  - Loans-after-12-months: double
  - Loans-and-Advances-to-Banks-Due-after-1-year: double
  - Loans-and-Advances-to-Banks-Due-within-1-year: double
  - Loans-and-Advances-to-Customers-Due-after-1-year: double
  - Loans-and-Advances-to-Customers-Due-within-1-year: double
  - Loans-and-advances-to-banks: double
  - Loans-and-advances-to-customers: double
  - Loans-within-12-months: double
  - Long-Term-Hire-Purchase-Commitments: double
  - Long-Term-Lease-Commitments: double
  - Miscellaneous-Current-Assets: double
  - Miscellaneous-Current-Liabilities: double
  - Miscellaneous-Liabilities: double
  - Net-Assets: double
  - Net-Cash-Flow-before-Financing: double
  - Net-Cash-Flow-from-Financing: double
  - Net-Cash-Flow-from-Operations: double
  - Net-Cashflow-before-Financing: double
  - Net-Change-In-Cash: double
  - Net-Debt-To-EBITDA-Ratio: double
  - Net-Fees-and-Commission-Income: double
  - Net-Interest-Income: double
  - Net-Margin: double
  - Net-Operating-Expenses: double
  - Net-Premiums-Earned: double
  - Net-Tax-Paid: double
  - Net-Worth: double
  - Net-change-in-provision-for-unearned-premiums: double
  - Net-trading-Income: double
  - Non-Current-Directors-Loans: double
  - Non-Current-Financial-Liabilities: double
  - Non-Current-Grants: double
  - Non-Current-Group-Accounts-Payable: double
  - Non-Current-Group-Loans: double
  - Non-Current-Liabilities-held-for-resale: double
  - Non-Current-Other-Payables: double
  - Non-Current-Trade-Payables: double
  - Operating-Expenses: double
  - Operating-Profit: double
  - Operating-Profit-Margin: double
  - Other-Assets-due-after-1-year: double
  - Other-Assets-due-within-1-year: double
  - Other-Audit-Costs: double
  - Other-Current-Financial-Liabilities: double
  - Other-Investments: double
  - Other-Investments-after-12-months: double
  - Other-Investments-within-12-months: double
  - Other-Liabilities-due-after-1-year: double
  - Other-Liabilities-due-within-1-year: double
  - Other-Long-Term-Financing: double
  - Other-Non-Current-Assets: double
  - Other-Non-Current-Financial-Liabilities: double
  - Other-Non-Insurance-Liabilities: double
  - Other-Operating-Income: double
  - Other-Payables: double
  - Other-Short-Term-Financing: double
  - Other-Short-Term-Loans: double
  - Other-Technical-Income: double
  - Other-creditors: double
  - Other-debtors: double
  - Other-prepayments-and-accrued-income: double
  - Outward-reinsurance-premiums: double
  - P-And-L-Account-Reserve: double
  - Pension-Liabilities: double
  - Pensions: double
  - Plant-And-Equipment: double
  - Pre-Tax-Profit: double
  - Pretax-Profit-Margin: double
  - Profit-Before-Tax-attributable-to-shareholders: double
  - Profit-after-Tax: double
  - Profit-from-Continuing-Operations-After-Tax: double
  - Property: double
  - Provisions-And-Charges: double
  - Provisions-for-other-risks-and-charges: double
  - Raw-Materials: double
  - Reinsurance-Liabilities: double
  - Reinsurance-Liabilities-to-be-settled-after-12-months: double
  - Reinsurance-Liabilities-to-be-settled-within-12-months: double
  - Reinsurance-debtors-And-assets-to-be-settled-after-12-months: double
  - Reinsurance-debtors-And-assets-to-be-settled-within-12-months: double
  - Reinsurance-debtors-and-assets: double
  - Reinsurance-operations: double
  - Reinsurers-Share-of-Technical-Provisions: double
  - Reporting-period: double
  - Retained-Profit: double
  - Return-On-Assets: double
  - Return-On-Capital-Employed: double
  - Return-On-Equity: double
  - Revaluation-Reserve: double
  - Revenue-Per-Employee: double
  - Share-Capital: double
  - Share-Premium: double
  - Share-Premium-Account: double
  - Share-of-Profit-in-Associates-or-Joint-Ventures: string
  - Shareholder-Funds: double
  - Shares-and-other-Variable-Yield-Securities: double
  - Stocks-And-Work-in-Progress: double
  - Subordinated-Borrowings: double
  - Subordinated-Liabilities: double
  - Subordinated-Liabilities-due-after-1-year: double
  - Subordinated-Liabilities-due-within-1-year: double
  - Sundry-Reserves: double
  - Tangible-Assets: double
  - Tax-Attributable-to-Policyholders-Returns: double
  - Tax-Attributable-to-Shareholders-Profits: double
  - Tax-Expense: double
  - Taxation: double
  - Technical-Provisions: double
  - Total-Assets: double
  - Total-Capital-And-Reserves: double
  - Total-Current-Assets: double
  - Total-Current-Liabilities: double
  - Total-Equity-And-Reserves: double
  - Total-Fixed-Assets: double
  - Total-Liabilities: double
  - Total-Long-Term-HP-And-Lease-Commitments: double
  - Total-Long-Term-Liabilities: double
  - Total-Long-Term-Loans: double
  - Total-Non-Current-Assets: double
  - Total-Non-Current-HP-And-Lease-Commitments: double
  - Total-Non-Current-Liabilities: double
  - Total-Operating-Income: double
  - Total-Other-Creditors: double
  - Debtors-arising-out-of-group-undertakings: double
  - Debtors-arising-out-of-insurance-operations: double
  - Deferred-Acquisition-Costs: double
  - Deposits-by-banks: double
  - Deposits-by-banks-due-after-1-year: double
  - Deposits-by-banks-due-within-1-year: double
  - Deposits-received-from-reinsurers: double
  - Depreciation-of-Tangibles: double
  - Derivative-financial-instruments: double
  - Derivatives: double
  - Derivatives-Due-after-1-year: double
  - Derivatives-Due-within-1-year: double
  - Direct-insurance-operations: double
  - Directors-Remuneration: double
  - Dividends-Payable: double
  - EBITDA: double
  - EBITDA-Margin: double
  - Wages-And-Salaries: double
  - Work-in-Progress: double
  - Working-Capital: double
  - World-Turnover: double
  - Profit-after-Tax-Yoy: double
  - Turnover-Yoy: double
  - Total-Liabilities-Yoy: double

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/financial/20581257', params={
        "year": 2020
    }, headers = headers)

print(r.json())

Request example

{
  "year": 2020
}

Success Response

{
    "2020": {
        "Share-Capital": 535500,
        "Pretax-Profit-Margin": 0.55,
        "Bank-Overdraft-And-LTL": 1234603,
        "Cash-To-Total-Assets": 22.59,
        "Employee-Numbers-Yoy": -1,
        "EBITDA": 305579,
        "World-Turnover": 30705740,
        "Revenue-Per-Employee": 310158.9898989899,
        "Pre-Tax-Profit": 168377,
        "Capital-Employed": 4533491,
        "Human-Capital-Value-Added": 40796.79797979798,
        "Stocks-And-Work-in-Progress": 2321893,
        "Interest-Payable": 18160,
        "Intangible-Assets": 0,
        "P-And-L-Account-Reserve": 1739798,
        "Cost-of-Sales": 25720263,
        "Currency": "GBP",
        "Turnover": 30705740,
        "Total-Long-Term-Liabilities": 1184603,
        "Employee-Numbers": 99,
        "Other-Long-Term-Financing": 0,
        "Total-Liabilities-Yoy": 47.55891242551835,
        "Net-Assets": 3348888,
        "Other-Short-Term-Loans": 0,
        "Total-Current-Assets": 7329410,
        "EBITDA-Margin": 1.0,
        "Consolidated-Accounts": "N",
        "Net-Debt-To-EBITDA-Ratio": -3.5359628770301623,
        "Dividends-Payable": 250430,
        "Other-Short-Term-Financing": 0,
        "Return-On-Assets": 1.99,
        "Total-Non-Current-HP-And-Lease-Commitments": 0,
        "Liquidity-Ratio": 0.8434609219101853,
        "Reporting-period": 13,
        "Taxation": -50772,
        "Miscellaneous-Current-Assets": 0,
        "Shareholder-Funds": 3348888,
        "Auditor-Fees": 43350,
        "Days-Payable-Outstanding": 25.678956218293727,
        "Gearing-Net-Debt-Basis": -32.26,
        "Net-Cash-Flow-before-Financing": 0,
        "Audit-Fees": 25000,
        "Other-Audit-Costs": 18350,
        "Turnover-Yoy": 14.205527131629847,
        "Days-Inventory-Outstanding": 26.96832823987842,
        "Miscellaneous-Current-Liabilities": 2041890,
        "Gearing-Gross-Debt-Basis": 38.36,
        "Interest-Receivable": 0,
        "Wages-And-Salaries": 3852346,
        "Days-Sales-Outstanding": 21.509643066736057,
        "Current-Hire-Purchase-Commitments": 0,
        "Cash": 2365119,
        "Net-Margin": 0.38,
        "Return-On-Equity": 3.51,
        "Depreciation-of-Tangibles": 119042,
        "Total-Fixed-Assets": 3140950,
        "Profit-after-Tax": 117605,
        "Profit-after-Tax-Yoy": -52.05490621343628,
        "Debt-To-Capital": 68.02,
        "Employee-Remuneration": 3416507,
        "Exports-Yoy": 43.78552368091236,
        "Contingent-Liability": 0,
        "Gross-Margin": 16.24,
        "Operating-Profit-Margin": 0.61,
        "Net-Cashflow-before-Financing": 0,
        "Net-Worth": 3348888,
        "Bank-Overdraft": 50000,
        "Sundry-Reserves": 170463,
        "Directors-Remuneration": 590808,
        "Cash-To-Turnover": 5.449435512708698,
        "Revaluation-Reserve": 903127,
        "EBITDA-Yoy": -6.058938540616316,
        "Current-Ratio": 1.234558148411225,
        "Amortisation-of-Intangibles": 0,
        "Reported-Date": "2020-05-31",
        "Return-On-Capital-Employed": 4.56,
        "Tangible-Assets": 3140950,
        "Interest-Coverage-Ratio": 10.271861233480177,
        "Equity-Paid-Up": 535500,
        "Inventory-Turnover-Ratio": 13.22444229772862,
        "Cash-Conversion-Cycle": 22.79901508832075,
        "Total-Liabilities": 7121472,
        "Gearing-Liability-Basis": 212.65,
        "Cash-To-Current-Liabilities-Ratio": 0.3983781686946436,
        "Retained-Profit": -132825,
        "Operating-Profit": 186537,
        "Total-Long-Term-Loans": 950000,
        "Trade-Debtors": 1594061,
        "Bank-Loan": 50000,
        "Total-Assets": 10470360,
        "Trade-Creditors": 3844979,
        "Total-Current-Liabilities": 5936869,
        "Investment-And-Other": 0,
        "Gross-Profit": 4985477,
        "Working-Capital": 1392541
    }
}

Digital Insights API

The Digital Insights API showcases a company’s used technologies such as used Analytical tools, technologies used to build their website, Payment systems utilized, and much more from a selection of over 880 tracked technologies. For example, your sales team will appreciate the additional personalization their email will now contain when they reach out to potential customers o propose your product or solution.

Search Company for Digital Insights

POST https://api.zephira.ai/v2/digital-insights

View search company for digital insights

Parameters

Parameter	In	Type	Required	Description
name	body	string	false	Company Name
registration_number	body	string	false	Registration Number

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.post('https://api.zephira.ai/v2/digital-insights', json={
            "name": "NOVATECH LIMITED"
    }, headers = headers)

print(r.json())

Request example

{
    "name": "NOVATECH LIMITED"
}

Success Response

[
    {
        "id": "20581257",
        "name": "NOVATECH LIMITED",
        "country_code": "GB",
        "registration_number": "02605046"
    },
    //...
]

Error Response

{
    "fields": [
        "Choose one or more of these fields ['name', 'registration_number']."
    ]
}

Company Digital Insights

GET https://api.zephira.ai/v2/digital-insights/{id}

View company digital insights

Parameters

Parameter	In	Type	Required	Description
id	url	int	true	Company ID

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/digital-insights/20581257',
    headers = headers)

print(r.json())

Request example

{
  "id": 20581257
}

Success Response

{
    "domain": "novatech.co.uk",
    "id": 308874,
    "nameservers": "hank.ns.cloudflare.com",
    "mx_list": [
        "novatech.co.uk.p10.mxguardian.net."
    ],
    "contact_city": null,
    "contact_country": null,
    "contact_email": null,
    "contact_name": null,
    "contact_phone": null,
    "contact_postalcode": null,
    "contact_state": null,
    "contact_street": null,
    "contact_organization": null,
    "raw": "TEXT",
    "expiration_date": "2025-09-10T00:00:00",
    "created_at": "2020-09-14T13:01:15.482566",
    "ip": "104.20.46.31",
    "isp_name": "CLOUDFLARENET",
    "isp_country": "United States",
    "domain_creation_date": "1996-08-28",
    "domain_name": "novatech.co.uk",
    "engagement_bounce_rate": "0.5325903646130219",
    "engagement_page_views": 1140537.0,
    "engagement_time_on_site": "00:02:55",
    "engagement_total_visits": 303228,
    "engagement_total_relative_change": null,
    "global_rank": 119775,
    "global_rank_change": null,
    "category_rank": 4691,
    "category_rank_change": null,
    "country_rank": 6453,
    "country_rank_change": null,
    "similar_date": "2020-08-01T00:00:00",
    "redirect_url": null,
    "icon_url": "https://site-images.similarcdn.com/image?url=novatech.co.uk&t=1&h=f7a9874c2d9d3d85da032c743400e1f36a6fd02adc1ff24472192000f2c188c3",
    "top_country_shares": [
        {
            "id": 33832425,
            "similar_country_id": 826,
            "share_percent": 0.803093404605964,
            "share_change": null,
            "name": "United Kingdom",
            "similar_web_data_id": 16075338
        },
        //...
    ],
    "referrals": [],
    "keywords": [],
    "referrals_destination": [],
    "visits": [
        {
            "id": 1679,
            "similar_web_data_id": 378,
            "date_value": "2016-07-01",
            "value": 1141493
        },
        //...
    ],
    "stat_organic_search": 162916,
    "stat_organic_search_percent": 53.7,
    "stat_direct": 107862,
    "stat_direct_percent": 35.6,
    "stat_referral": 7253,
    "stat_referral_percent": 2.4,
    "technologies": [
        {
            "id": 2,
            "list": [
                {
                    "id": 2,
                    "name": "Google Analytics",
                    "image_path": "tech/1.png",
                    "description": "Google Analytics is a service offered by ...",
                    "category": 2
                },
                //...
            ],
            "name": "Analytics",
            "parent_id": null,
            "important": false
        },
        //...
    ],
    "graph": {
        "visits": {
            "categories": [],
            "data": [
                [
                    "2016-07-01",
                    1141493
                ],
                //..
            ]
        },
        "sources": {
            "organic": [
                [
                    "2016-07-01",
                    613294.0
                ],
                //..
            ],
            "direct": [
                [
                    "2016-07-01",
                    406046.0
                ],
               //..
            ],
            "referral": [
                [
                    "2016-07-01",
                    27305.0
                ],
                //...
            ]
        }
    },
    "total_traffic": 30806206,
    "up_visits": false,
    "alexa_rank": 140443

Ownership API

The Ownership API indicated the complete group structure and beneficial owners of a particular business.

Search Company for Ownership

POST https://api.zephira.ai/v2/ownership

View search company for ownership

Parameters

Parameter	In	Type	Required	Description
name	body	string	false	Company Name
registration_number	body	string	false	Registration Number

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.post('https://api.zephira.ai/v2/ownership', json={
            "name": "BANDENIA GATEWAY LTD"
    }, headers = headers)

print(r.json())

Request example

{
    "name": "BANDENIA GATEWAY LTD"
}

Success Response

[
    {
        "id": "28672740",
        "name": "BANDENIA GATEWAY LTD",
        "country_code": "GB",
        "registration_number": "08588209"
    },
    {
        "id": "30303326",
        "name": "BANDENIA GROUP GATEWAY TAK LTD",
        "country_code": "GB",
        "registration_number": "09877665"
    },
    //...
]

Error Response

{
    "fields": [
        "Choose one or more of these fields ['name', 'registration_number']."
    ]
}

Company Ownership

GET https://api.zephira.ai/v2/ownership/{id}

View company ownership

Parameters

Parameter	In	Type	Required	Description
id	url	int	true	Company ID

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/ownership/28672740',
    headers = headers)

print(r.json())

Request example

{
  "id": 28672740
}

Success Response

{
    "shareholders": [
        {
            "id": 45048908,
            "name": "BANDENIA BANQUEROS PRIVADOS INC",
            "quantity": 530000,
            "currency": "GBP",
            "share_value": "530,000 ORDINARY  GBP 1.00",
            "created_at": "2022-02-03T17:29:01.696+0000",
            "share_type": "ORDINARY",
            "share_price": 1.0
        },
        {
            "id": 45048909,
            "name": "BANDENIA FINANCIAL GROUP INC",
            "quantity": 1700000,
            "currency": "GBP",
            "share_value": "1,700,000 ORDINARY  GBP 1.00",
            "created_at": "2022-02-03T17:29:01.698+0000",
            "share_type": "ORDINARY",
            "share_price": 1.0
        },
        //...
    ],
    "data": [],
    "group_structure": [
        {
            "id": 28672740,
            "registration_number": "IE673949",
            "selected": false,
            "name": "BANDENIA GLOBAL LIMITED",
            "children": [
                {
                    "id": 25330406,
                    "registration_number": "06016301",
                    "selected": false,
                    "name": "BANDENIA FIDUCIARY MANAGEMENT LTD",
                    "children": []
                },
                {
                    "id": 28672740,
                    "registration_number": "08588209",
                    "selected": true,
                    "name": "BANDENIA GATEWAY LTD",
                    "children": []
                },
                {
                    "id": 29380240,
                    "registration_number": "09150992",
                    "selected": false,
                    "name": "BANDENIA OIL AND GAS LTD",
                    "children": []
                },
                //...
            ]
        }
    ],
    "registration_number": "08588209"
}

Credit Report API

The Credit Report API provide full detailed Business Credit Reports for selected companies.

Search Credit Report

GET https://api.zephira.ai/v2/credit-report

Search for companies by Legal Name or Registration ID number and their country ID to learn if Global Database can provide you with a detailed Credit Report for that given company.

Parameters

Parameter	In	Type	Required	Description
company	body	string	false	Company Name
registration_number	body	string	false	Registration Number
vat_number	body	string	false	VAT Number
country	body	string	true	Country Code ISO
province	body	string	false	Province, available in nomenclatures
registered_city	body	string	false	City
post_code	body	string	false	Post Code

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/credit-report', params={
        "company": "00445790",
        "country": "GB"
    }, headers = headers)

print(r.json())

Request example

{
    "company": "00445790",
    "country": "GB"
}

Success Response

[
    {
        "id": "GB-0-00445790",
        "name": "TESCO PLC",
        "address": {
            "post_code": "AL7 1GA",
            "city": "WELWYN GARDEN CITY",
            "province": null,
            "text": "WELWYN GARDEN CITY",
            "street": "TESCO HOUSE SHIRE PARK, KESTREL WAY, WELWYN GARDEN CITY, AL7 1GA"
        },
        "registration_number": "00445790",
        "vat_number": [
            "GB220430231"
        ],
        "status": "Active"
    }
]
Request example

{
    "company": "00445790"
}

Error Response

{
    "country": [
        "This field is required."
    ]
}

Generate Credit Report

POST https://api.zephira.ai/v2/credit-report/report/{format}

Generate the Credit Report itself based on the requested company name. Depending on the given company and country the generation process can be instant or take up to 3 minutes to complete. You will receive the Credit Report ID as the results of Generation procedure. Multiple Generate requests can be completed at the same time if you are looking to look up multiple companies and would like to wait for each one to finalize before requesting the next one.

Parameters

Parameter	In	Type	Required	Description
format	url	string	true	Format response (json or html)
source_id	body	string	true	Source Id
country	body	string	true	Country Code ISO

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.post('https://api.zephira.ai/v2/credit-report/report/json', json={
        "source_id": "GB-0-00445790",
        "country": "GB"
    }, headers = headers)

print(r.json())

Request example

{
    "source_id": "GB-0-00445790",
    "country": "GB"
}

Success Response

{
    "id": 52,
    "name": "TESCO PLC",
    "source_id": "GB-0-00445790",
    "url": null,
    "expired": false,
    "date_created": "2021-09-30T07:09:57.081437Z",
    "address": {
        "province": null,
        "post_code": "AL7 1GA",
        "city": "WELWYN GARDEN CITY",
        "text": "TESCO HOUSE SHIRE PARK, KESTREL WAY, WELWYN GARDEN CITY, AL7 1GA, WELWYN GARDEN CITY, None, AL7 1GA, GB",
        "street": "TESCO HOUSE SHIRE PARK, KESTREL WAY, WELWYN GARDEN CITY, AL7 1GA"
    },
    "status": "finish",
    "registration_number": "00445790"
}

Check Credit Report

GET https://api.zephira.ai/v2/credit-report/{id}/check

Check credit report availability

Parameters

Parameter	In	Type	Required	Description
id	url	int	true	Credit Report ID

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/credit-report/568/check', headers = headers)

print(r.json())

Request example

{
    "id": 568
}

Success Response

{
  true
}

Content Credit Report by ID

GET https://api.zephira.ai/v2/credit-report/report/{format}/{report_id}/file

Introduce the Credit Report ID to get access to the requested Credit Report.

Parameters

Parameter	In	Type	Required	Description
format	url	string	true	Format response (json or html)
report_id	url	int	true	Report Id

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/credit-report/report/json/52/file',
                 headers = headers)

print(r.json())

Request example

{
    "report_id": 52
}

Success Response

{
    "ccj": [],
    "liens": [],
    "bankers": [],
    "summary": {
        "ebitda": 4516000000.0,
        "charges": 2,
        "country": "GB",
        "comments": null,
        "extended": [
            {
                "Charges": 2,
                "Mortgages": 9,
                "Court Judgments": 8
            },
            {
                "EBITDA": 4516000000.0,
                "Turnover": 57887000000.0,
                "Age of Business": 73,
                "Number of Employees": "367321"
            }
        ],
        "language": "EN",
        "turnover": 57887000000.0,
        "mortgages": 9,
        "last_update": null,
        "nsso_number": null,
        "cash_at_bank": 2510000000.0,
        "nsso_summons": null,
        "liable_for_vat": null,
        "age_of_business": 73,
        "fin_information": null,
        "charges_dynamics": null,
        "court_judgements": 8,
        "derogatory_legal": null,
        "mortgages_dynamics": "04-11-2009",
        "rating_information": null,
        "shareholder_equity": 12343000000.0,
        "things_to_consider": [
            "This company has been treated as a PLC company in terms of the score/limit that has been generated",
            "This company's Asset Ratio shows a moderate amount of cover on outstanding obligations."
        ],
        "company_description": "",
        "number_of_employees": "367321",
        "overall_credit_risk": {
            "pod": 0.0597,
            "commonValue": "A",
            "creditLimit": {
                "value": "100000000",
                "currency": "GBP"
            },
            "providerValue": {
                "value": "86",
                "maxValue": "100",
                "minValue": "1"
            },
            "commonDescription": "Very Low Risk",
            "providerDescription": "Very Low Risk"
        },
        "payment_information": null,
        "protested_bills_flag": null,
        "additional_foreign_oenb": null,
        "credit_score_description": null,
        "pd_according_to_basel_ii": null,
        "court_judgements_dynamics": null,
        "overall_credit_risk_class": "Very Low Risk",
        "credit_limit_recommendation": {
            "value": "100000000",
            "currency": "GBP"
        },
        "what_you_should_be_aware_of": "",
        "company_credibility_assessment": null,
        "what_we_like_about_this_company": [
            "This is a very large company with Total Assets in excess of £5 billion and Equity greater than £50 million.",
            "This company's auditors have reported no adverse information."
        ]
    },
    "ccj_exact": [
        {
            "date": "25 Mar 2020",
            "type": null,
            "court": "COUNTY COURT BUSINESS CENTRE",
            "amount": 9139.0,
            "status": "Judgment",
            "date_paid": null,
            "case_number": "G3AT671V"
        },
        //...
    ],
    "ccj_grouped": [],
    "ccj_possible": [
        {
            "date": "23 Sep 2015",
            "type": null,
            "court": "COUNTY COURT BUSINESS CENTRE",
            "amount": 43926.0,
            "status": "Judgment",
            "date_paid": null,
            "case_number": "B2QZ4N96"
        }
    ],
    "judicial_ccj": [],
    "order_logger": {
        "order": null,
        "api_key": null,
        "company": null,
        "country": null,
        "end_time": null,
        "provider": null,
        "start_time": null,
        "parsing_time": null,
        "pdf_traceback": null,
        "parsing_status": null,
        "provider_error": null,
        "sentry_event_id": null,
        "get_report_error": null,
        "get_status_error": null,
        "our_response_time": null,
        "parsing_exception": null,
        "place_order_error": null,
        "provider_duration": null,
        "provider_response": null,
        "get_status_counter": null,
        "get_report_duration": null,
        "get_report_response": null,
        "get_status_duration": null,
        "get_status_response": null,
        "pdf_generation_time": null,
        "pdf_report_document": null,
        "get_report_timestamp": null,
        "place_order_duration": null,
        "place_order_response": null,
        "provider_status_code": null,
        "pdf_generation_status": null,
        "place_order_timestamp": null,
        "provider_order_reason": null,
        "get_report_status_code": null,
        "get_status_status_code": null,
        "place_order_status_code": null,
        "check_order_availability_error": null,
        "check_order_availability_duration": null,
        "check_order_availability_response": null,
        "check_order_availability_timestamp": null,
        "check_order_availability_status_code": null
    },
    "shareholders": [
        {
            "name": "UNDISCLOSED",
            "address": null,
            "currency": "GBP",
            "quantity": 8174160481,
            "percentage": 100.0,
            "share_type": "ORDINARY",
            "start_date": null,
            "share_price": null,
            "total_value": 408708024.05,
            "share_classes": [
                {
                    "currency": "GBP",
                    "shareType": "ORDINARY",
                    "valuePerShare": 0.05,
                    "additionalData": {
                        "percentSharesHeld": 100.0
                    },
                    "valueOfSharesOwned": 408708024.05,
                    "numberOfSharesOwned": 8174160481
                }
            ],
            "shareholder_type": "Other"
        }
    ],
    "land_registry": [],
    "score_history": [
        {
            "date": "06-12-2019",
            "event": null,
            "score": 86,
            "description": "Very Low Risk"
        },
        //...
    ],
    "search_logger": {
        "query": null,
        "api_key": null,
        "country": null,
        "provider": null,
        "sentry_event_id": null,
        "our_response_time": null,
        "our_response_nr_companies": null,
        "provider_name_search_time": null,
        "provider_errors_name_search": null,
        "provider_reg_nr_search_time": null,
        "provider_errors_reg_nr_search": null,
        "provider_nr_companies_name_search": null,
        "provider_response_code_name_search": null,
        "provider_response_text_name_search": null,
        "provider_nr_companies_reg_nr_search": null,
        "provider_response_code_reg_nr_search": null,
        "provider_response_text_reg_nr_search": null
    },
    "branch_details": [
        {
            "fax": null,
            "tel": null,
            "name": null,
            "type": null,
            "address": null,
            "country": null
        },
        //...
    ],
    "employees_info": [
        {
            "year": 2021,
            "number_of_employees": "367321"
        },
        {
            "year": 2020,
            "number_of_employees": "354448"
        },
        {
            "year": 2019,
            "number_of_employees": "464505"
        },
        {
            "year": 2017,
            "number_of_employees": "464520"
        }
    ],
    "additional_misc": [],
    "company_profile": {
        "fax": "",
        "name": "TESCO PLC",
        "email": null,
        "status": "Active",
        "auditor": "DELOITTE LLP",
        "website": "https://www.tescoplc.com/",
        "province": null,
        "sic_code": "SIC03, 5211, Retail in non-specialised stores holding an alcohol licence, with food, beverages or tobacco predominating, not elsewhere classified; SIC07, 47110, Retail sale in non-specialised stores with food, beverages or tobacco predominating",
        "ofac_bool": null,
        "ofac_date": null,
        "post_code": "AL7 1GA",
        "source_id": null,
        "legal_form": "Public limited with Share Capital",
        "vat_number": "GB220430231",
        "export_bool": null,
        "import_bool": null,
        "main_products": null,
        "parent_company": null,
        "registered_city": null,
        "trading_address": "Tesco House Shire Park, Kestrel Way, Welwyn Garden City, AL7 1GA",
        "telephone_number": "+01992632222",
        "type_of_accounts": "Consolidated",
        "principal_activity": "SIC07, 47110, Retail sale in non-specialised stores with food, beverages or tobacco predominating",
        "registered_address": "TESCO HOUSE SHIRE PARK, KESTREL WAY, WELWYN GARDEN CITY, AL7 1GA",
        "registration_number": "00445790",
        "date_of_incorporation": "27-11-1947",
        "latest_filed_accounts": "16-07-2021",
        "stock_exchange_status": null,
        "cross_border_agent_bool": null,
        "ultimate_holding_company": null
    },
    "enquiries_trend": {
        "breakdown": {
            "month1": 12,
            "month2": 53,
            "month3": 79,
            "month4": 69,
            "month5": 89,
            "month6": 48,
            "month7": 95,
            "month8": 111,
            "month9": 72,
            "month10": 88,
            "month11": 105,
            "month12": 127,
            "months1to3": 144,
            "months4to6": 206,
            "months7to9": 278,
            "months10to12": 320,
            "monthlyAverage": 79.0,
            "latestEnquiryDate": "2021-09-11T14:58:30Z"
        },
        "total_3_months": 144,
        "total_6_months": 350,
        "total_9_months": 628,
        "total_12_months": 948,
        "the_last_enquiry_date": "11-09-2021",
        "average_reports_taken_each_month": "79",
        "number_of_enquiries_in_the_past_12_months": 948
    },
    "historic_health": [
        {
            "date": "26-06-2020",
            "event": "Profit Warning",
            "description": "Following revised macro-economic assumptions regarding GDP and unemployment levels, we have increased our provision for potential bad debts at Tesco Bank and we now expect to report a loss for the Bank of between £(175)m and £(200)m for the 2020/21 financial year.  We will continue to review any changes made to macro-economic forecasts and this could result in releases from or additions to this provision. Whilst headline profitability is impacted in the short term, the Bank's capital ratios and liquidity remain strong"
        }
    ],
    "trading_address": [
        {
            "phone": "+0345 6778993",
            "address": "1 Laurel Drive, Bridge Of Don, Aberdeen, Aberdeenshire, AB22 8HB"
        },
        //...
    ],
    "document_filings": [
        {
            "date": "16-07-2021",
            "description": "New Accounts Filed",
            "number_of_deeds": null
        },
        //...
    ],
    "coface_financials": [],
    "current_directors": [
        {
            "job": "Director",
            "name": "Ms Karen Tracy Whitworth",
            "title": "Ms",
            "gender": "Female",
            "address": "Tesco House Shire Park, Kestrel Way, Welwyn Garden City, AL7 1GA",
            "nationality": "British",
            "date_of_birth": "01-08-1969",
            "appointment_date": "18-06-2021",
            "current_appointments": 4
        },
        //...
    ],
    "administrative_ccj": [],
    "custom_data_tables": [],
    "financials_summary": {
        "ebitda": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    2647000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "turnover": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    55917000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "net_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    6438000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "total_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    45877000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "working_capital": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    -4332000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "employee_numbers": [
            {
                "date": "25-02-2017",
                "value": "464,520.00"
            },
            //...
        ],
        "profit_after_tax": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    58000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "reporting_period": [
            {
                "date": "25-02-2017",
                "value": "27-02-2016 - 25-02-2017"
            },
            //...
        ],
        "consolidated_a_cs": [
            {
                "date": "25-02-2017",
                "value": true
            },
            //...
        ],
        "total_liabilities": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    39439000000.0
                ],
                "consolidated": true
            },
            //...
        ]
    },
    "import_export_info": {
        "export_info": null,
        "import_info": null,
        "export_countries": "",
        "import_countries": ""
    },
    "previous_directors": [
        {
            "job": null,
            "name": "Olivia Garfield",
            "title": null,
            "period": "",
            "address": null,
            "nationality": null,
            "date_of_birth": null,
            "total_appointments": null,
            "present_appointments": 0,
            "previous_appointments": 1,
            "dissolved_appointments": 0
        },
        //...
    ],
    "fresh_investigation": {
        "order": null,
        "status": null,
        "company": null,
        "due_date": null,
        "parameters": null,
        "date_checked": null,
        "date_created": null,
        "provider_country": null,
        "provider_order_id": null,
        "provider_response": null,
        "provider_investigation_status": null
    },
    "payment_information": [],
    "credit_limit_history": [
        {
            "date": "06-12-2019",
            "limit": {
                "value": 100000000.0,
                "currency": "GBP"
            },
            "description": null
        },
        //...
    ],
    "financials_cash_flow": {
        "increase_in_cash": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    881000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "net_change_in_cash": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    881000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "net_cash_flow_from_financing": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    -1387000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "net_cash_flow_from_operations": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    1989000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "net_cash_flow_before_financing": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    2268000000.0
                ],
                "consolidated": true
            },
            //...
        ]
    },
    "current_directorships": [],
    "mortgages_and_charges": [
        {
            "type": "ACCOUNT SECURITY AGREEMENT",
            "satisfied": null,
            "created_date": "04-11-2009",
            "registered_date": "06-11-2009",
            "persons_entitled": "TESCO TRUSTEE COMPANY OF IRELAND LIMITED AS TRUSTEE OF THE TESCO IRELAND LIMITED SENIOR EXECUTI",
            "further_information": "RIGHT TITLE BENEFIT AND INTEREST IN ANDTO THE ACCOUNT BEING THE EURO DESIGNATED ACCOUNT IN THE NAME OF THE COMPANY WITH SORT CODE 40-05-15 ACCOUNT NUMBER 67851117, AND THE DEPOSIT. SEE IMAGE FOR FULL DETAILS"
        },
        //...
    ],
    "previous_company_names": [
        {
            "name": "TESCO STORES (HOLDINGS) PUBLIC LIMITED COMPANY",
            "period": "25-08-1983"
        }
    ],
    "previous_directorships": [],
    "share_capital_structure": {
        "issued_capital": 408708024.05,
        "nominal_capital": null,
        "issued_capital_currency": "GBP",
        "number_of_shares_issued": 8174160481,
        "nominal_capital_currency": null
    },
    "ccj_summarised_defendant": [],
    "ccj_summarised_plaintiff": [],
    "financials_balance_sheet": {
        "cash": [
            {
                "dynamics": 6.2,
                "indicator": [
                    "24-02-2018",
                    4059000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "stock": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    2301000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "net_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    6438000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "fixed_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    30804000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "total_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    45877000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "trade_debtors": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    697000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "bank_overdraft": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    912000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "current_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    15073000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "tangible_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    18108000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "trade_creditors": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    4914000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "intangible_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    2717000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "total_liabilities": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    39439000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "total_fixed_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    30804000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "current_liabilities": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    19405000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "investment_and_other": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    9979000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "other_long_term_financing": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    2986000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "other_short_term_financing": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    8584000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "total_long_term_liabilities": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    20034000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "miscellaneous_current_liabilities": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    4995000000.0
                ],
                "consolidated": true
            },
            //...
        ]
    },
    "group_structure_extended": [
        {
            "level": 0,
            "status": "Active",
            "address": null,
            "turnover": null,
            "net_worth": null,
            "company_name": "TESCO PLC",
            "registered_number": "00445790",
            "registered_country": "GB",
            "percent_of_ownership": null,
            "latest_annual_accounts": "27-02-2021"
        },
        //...
    ],
    "financials_kpis_and_ratios": {
        "net_margin": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.001037251640824794
                ],
                "consolidated": true
            },
            //...
        ],
        "gross_margin": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.05189834933919917
                ],
                "consolidated": true
            },
            //...
        ],
        "current_ratio": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.78
                ],
                "consolidated": true
            },
            //...
        ],
        "ebitda_margin": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.047338018849366024
                ],
                "consolidated": true
            },
            //...
        ],
        "debt_to_capital": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.8596682433463392
                ],
                "consolidated": true
            },
            //...
        ],
        "liquidity_ratio": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.66
                ],
                "consolidated": true
            },
            //...
        ],
        "gearing_net_debt": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    3.9933209071140108
                ],
                "consolidated": true
            },
            //...
        ],
        "return_on_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.02216797087865379
                ],
                "consolidated": true
            },
            //...
        ],
        "return_on_equity": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.009009009009009009
                ],
                "consolidated": true
            },
            //...
        ],
        "consolidated_a_cs": [
            {
                "date": "25-02-2017",
                "value": true
            },
            //...
        ],
        "gearing_liability": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    6.125970798384592
                ],
                "consolidated": true
            },
            //...
        ],
        "gearing_gross_debt": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    4.586828207517863
                ],
                "consolidated": true
            },
            //...
        ],
        "cash_turnover_ratio": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.06833342275157823
                ],
                "consolidated": true
            },
            //...
        ],
        "cash_to_total_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.08328792205244458
                ],
                "consolidated": true
            },
            //...
        ],
        "pre_tax_profit_margin": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.26
                ],
                "consolidated": true
            },
            //...
        ],
        "operating_profit_margin": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.01818767101239337
                ],
                "consolidated": true
            },
            //...
        ],
        "inventory_turnover_ratio": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    4.12
                ],
                "consolidated": true
            },
            //...
        ],
        "return_on_capital_employed": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.55
                ],
                "consolidated": true
            },
            //...
        ],
        "cash_to_current_liabilities_ratio": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.1969080133986086
                ],
                "consolidated": true
            },
            //...
        ]
    },
    "financials_misc_indicators": {
        "goodwill": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    null
                ],
                "consolidated": true
            },
            //...
        ],
        "pensions": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.0
                ],
                "consolidated": true
            },
            //...
        ],
        "audit_fees": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    6000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "derivatives": "",
        "auditor_fees": "",
        "equity_shares": "",
        "all_other_income": "",
        "customer_accounts": "",
        "deposits_by_banks": "",
        "dividends_payable": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.0
                ],
                "consolidated": true
            },
            //...
        ],
        "contingent_liability": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    "YES"
                ],
                "consolidated": true
            },
            //...
        ],
        "employee_remuneration": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    6051000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "financial_liabilities": "",
        "interest_bearing_loans": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    9330000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "amortisation_of_intangibles": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    299000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "fees_and_commission_expense": "",
        "interest_and_similar_income": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    null
                ],
                "consolidated": true
            },
            //...
        ],
        "loans_and_advances_to_banks": "",
        "interest_and_similar_expense": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    1015000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "loans_and_advances_to_customers": "",
        "derivative_financial_instruments": "",
        "cash_and_balances_at_central_banks": "",
        "available_for_sale_financial_assets": "",
        "treasury_bill_and_other_eligible_bills": "",
        "items_in_the_course_of_collection_from_other_banks": "",
        "items_in_the_course_of_transmission_from_other_banks": ""
    },
    "financials_profit_and_loss": {
        "weeks": [
            {
                "date": "25-02-2017",
                "value": 52
            },
            //...
        ],
        "export": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    null
                ],
                "consolidated": true
            },
            //...
        ],
        "currency": [
            {
                "date": "25-02-2017",
                "value": "GBP"
            },
            //...
        ],
        "taxation": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    -87000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "audit_fees": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    6000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "depreciation": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    1331000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "gross_profit": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    2902000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "pre_tax_profit": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    145000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "retained_profit": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    -40000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "operating_profit": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    1017000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "profit_after_tax": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    58000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "consolidated_a_cs": [
            {
                "date": "25-02-2017",
                "value": true
            },
            //...
        ],
        "dividends_payable": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.0
                ],
                "consolidated": true
            },
            //...
        ],
        "interest_payments": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    1015000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "wages_and_salaries": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    6051000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "directors_emoluments": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    7800000.0
                ],
                "consolidated": true
            },
            //...
        ]
    },
    "group_structure_affiliated": [],
    "current_company_secretaries": [
        {
            "job": "Company Secretary",
            "name": "Mr Robert John Welch",
            "title": "Mr",
            "period": null,
            "address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, AL7 1GA",
            "nationality": null,
            "date_of_birth": null,
            "appointment_date": "10-08-2016",
            "current_appointments": 1
        }
    ],
    "group_structure_subsidiaries": [
        {
            "level": null,
            "status": "Active",
            "address": null,
            "turnover": null,
            "net_worth": null,
            "company_name": "TESCO TRUSTEE COMPANY OF IRELAND DESIGNATED ACTIVITY COMPANY",
            "registered_number": "IE096453",
            "registered_country": "IE",
            "latest_annual_accounts": null
        },
        //...
    ],
    "previous_company_secretaries": [],
    "financials_capital_and_reserves": {
        "equity_paid_up": "",
        "sundry_reserves": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    5697000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "capital_employed": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    26472000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "interest_payments": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    1015000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "shareholder_funds": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    6438000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "revaluation_reserve": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.0
                ],
                "consolidated": true
            },
            //...
        ],
        "called_up_share_capital": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    409000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "p_and_l_account_reserve": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    332000000.0
                ],
                "consolidated": true
            },
            //...
        ]
    },
    "financials_growth_and_industry_comparison": {
        "net_assets": [
            {
                "date": "2017 vs 2016",
                "value": null
            },
            //...
        ],
        "total_assets": [
            {
                "date": "2017 vs 2016",
                "value": null
            },
            //...
        ],
        "current_ratio": [
            {
                "date": "2017 vs 2016",
                "value": null
            },
            //...
        ],
        "debt_to_capital": [
            {
                "date": "2017 vs 2016",
                "value": null
            },
            //...
        ],
        "working_capital": [
            {
                "date": "2017 vs 2016",
                "value": null
            },
            //...
        ],
        "consolidated_a_cs": [
            {
                "date": "25-02-2017",
                "value": true
            },
            //...
        ],
        "total_liabilities": [
            {
                "date": "2017 vs 2016",
                "value": null
            },
            //...
        ]
    },
    "name": "TESCO PLC",
    "nr": 634
}

Generate CR and Get Content

POST https://api.zephira.ai/v2/credit-report/report/{format}/file

A unified model of the Generate Credit Report and Get/View Credit Report by ID, can be used to avoid the 2-step process. This option is better for single requests where the delay in the Generate Credit Report phase will not cause a problem for you or your end-customer.

Parameters

Parameter	In	Type	Required	Description
format	url	string	true	Format response (json or html)
source_id	body	string	true	Source Id
country	body	string	true	Country Code ISO

Response

Properties

additional_misc
- Type: array
  - Items: object
  - Properties
    - header: string
    - description: string
administrative_ccj
- Type: array
  - Items: object
  - Properties
    - date: string
    - type: string
    - amount: number
    - complainant: string
bankers
- Type: array
  - Items: object
  - Properties
    - name: string
    - address: string
    - bank_code: string
branch_details
- Type: array
  - Items: object
  - Properties
    - fax: string
    - tel: string
    - name: string
    - type: string
    - address: string
    - country: string
business_failure_risk_score: object
- Properties
  - risk_class: number
  - current_BFRS: string
  - reason_codes: string
  - quarterly_trends
    - Type: array
      - Items: object
      - Properties
        bfrs: string
        year: string
        quarter: string
        industryAverage: string
business_licenses
- Type: array
  - Items: object
  - Properties
    - type: string
    - status: string
    - end_date: string
    - body_name: string
    - start_date: string
    - jurisdiction: string
business_references: object
- Properties
  - last_purchase_date: string
  - last_purchase_value: number
  - largest_invoice_date: string
  - largest_invoice_value: number
  - last_purchase_average: number
  - largest_invoice_average: number
  - largest_credit_used_date: string
  - largest_credit_used_value: number
  - largest_credit_used_average: number
business_sales_breakdowns
- Type: array
  - Items: object
  - Properties
    - date: string
    - sales: number
    - business: string
    - currency: string
cautionary_ucc_filings
- Type: array
  - Items: object
  - Properties
    - status: string
    - collateral: string
    - filed_date: string
    - debtor_name: string
    - filing_type: string
    - jurisdiction: string
    - filing_number: string
    - filing_office: string
    - debtor_address: string
    - secured_party_name: string
    - secured_party_address: string
    - related_document_number: string
ccj
- Type: array
  - Items: object
  - Properties
    - date: string
    - type: string
    - court: string
ccj_exact
- Type: array
  - Items: object
  - Properties
    - date: string
    - type: string
    - court: string
    - amount: number
    - status: string
    - date_paid: string
    - case_number: string
ccj_grouped
- Type: array
  - Items: object
  - Properties
    - court_city: string
    - court_state: string
    - latest_date: string
    - type_action: string
    - court_number: string
    - number_actions: number
ccj_legal_canada
- Type: array
  - Items: object
  - Properties
    - amount: number
    - reason: string
    - defendant: string
    - plaintiff: string
    - claim_date: string
    - court_type: string
    - claim_number: string
    - reported_date: string
    - court_location: string
    - court_province: string
    - legal_item_type: string
    - legal_item_details: string
ccj_possible
- Type: array
  - Items: object
  - Properties
    - date: string
    - type: string
    - court: string
    - amount: number
    - status: string
    - date_paid: string
    - case_number: string
ccj_summarised_defendant
- Type: array
  - Items: object
  - Properties
    - period: string
    - total_value: string
    - claims_value: string
    - total_number: number
    - legal_proceedings_value: string
    - legal_proceedings_number: number
    - bankruptcy_proceedings_value: string
ccj_summarised_plaintiff
- Type: array
  - Items: string
civil_ccj
- Type: array
  - Items: string
coface_financials
- Type: array
  - Items: string
collection_details
- Type: array
  - Items: object
  - Properties
    - debtor: string
    - status: string
    - creditor: string
    - currency: string
    - paid_date: string
    - claim_date: string
    - amount_paid: string
    - closed_date: string
    - claim_amount: number
    - reported_date: string
    - account_balance: number
    - collection_agency: string
    - status_update_date: string
commercial_delinquency_score: object
- Properties
  - risk_class: number
  - current_CDS: string
  - reason_codes: string
  - quarterly_trends: array
    - Type: array
      - Items
      - Type: object
      - Properties
        cds: string
        year: string
        quarter: string
company_credit_file
- Type: array
  - Items: object
  - Properties
    - account_type: string
    - inquiry_date: string
    - inquiry_amount: number
    - company_credit_inquirer: string
company_profile: object
- Properties
  - name: string
  - status: string
  - auditor: string
  - website: string
  - sic_code: string
  - source_id: string
  - audit_fees: number
  - vat_number: string
  - parent_company: string
  - trading_address: string
  - telephone_number: string
  - type_of_accounts: string
  - principal_activity: string
  - registered_address: string
  - registration_number: string
  - date_of_incorporation: string
  - latest_filed_accounts: string
  - ultimate_holding_company: string
  - registered_city: string
  - fax: string
  - email: string
  - province: string
  - ofac_bool: string
  - ofac_date: string
  - post_code: string
  - legal_form: string
  - export_bool: number
  - import_bool: number
  - main_products: string
  - stock_exchange_status: string
  - cross_border_agent_bool: string
  - export_countries: string
  - import_countries: string
competitors
- Type: array
  - Items: object
  - Properties
    - date: string
    - name: string
    - currency: string
    - gross_sales: number
corporate_records
- Type: array
  - Items: object
  - Properties
    - status: string
    - address: string
    - agent_name: string
    - filing_date: string
    - agent_address: string
    - business_name: string
    - principal_state: string
    - foreign_domestic: string
    - profit_non_profit: string
    - incorporation_date: string
    - sos_charter_number: string
    - business_legal_name: string
    - incorporation_state: string
credit_information_score: object
- Properties
  - ciScore90Day: string
  - trade_lines_value: string
  - trade_lines_factor: string
  - years_on_file_value: string
  - years_on_file_factor: string
  - year_difference_PI_value: string
  - year_difference_PI_factor: string
  - ciScore_payment_index_value: string
  - ciScore_payment_index_factor: string
  - last_negative_occurrence_value: string
  - last_negative_occurrence_factor: string
  - negative_occurrence_percentage_value: string
  - number_of_negative_occurrences_value: string
  - negative_occurrence_percentage_factor: string
  - number_of_negative_occurrences_factor: string
credit_information_score_quarter
- Type: array
  - Items: object
  - Properties
    - year: string
    - quarter: string
    - composite_index: string
credit_limit_history
- Type: array
  - Items: object
  - Properties
    - date: string
    - limit: object
      - Properties
        value: string
        currency: string
    - description: string
credit_reference_summaries
- Type: array
  - Items: object
  - Properties
    - current: number
    - period1: string
    - period2: string
    - period3: string
    - currency: string
    - description: string
    - high_credit: number
    - total_owing: number
    - payment_index: string
    - number_of_credit_references: number
current_company_secretaries
- Type: array
  - Items: string
current_directors
- Type: array
  - Items: object
  - Properties
    - job: string
    - name: string
    - title: string
    - gender: string
    - address: string
    - nationality: string
    - date_of_birth: string
    - appointment_date: string
    - current_appointments: string
current_directorships
- Type: array
  - Items: object
  - Properties
    - job: string
    - name: string
    - title: string
    - status: string
    - address: string
    - nationality: string
    - company_name: string
    - date_of_birth: string
    - appointment_date: string
    - resignation_date: string
    - registration_number: string
    - current_appointments: string
current_mandates
- Type: array
  - Items: object
  - Properties
    - name: string
    - position: string
    - start_date: string
    - business_number: string
custom_data_tables
- Type: array
  - Items: object
  - Properties
    - rows
      - Type: array
        Items: array
        Items: object
        Properties
        value: string
    - headers: array
      - Type: array
        Items: string
    - section: string
    - header_count: number
dbt_trends
- Type: array
  - Items: object
  - Properties
    - dbt: string
    - year: number
    - quarter: number
    - currency: string
derogatory_summaries
- Type: array
  - Items: object
  - Properties
    - currency: string
    - number_on_file: string
    - derogatory_type: string
    - comments_on_file: string
    - date_of_last_item: string
    - total_amount_on_file: string
document_filings
- Type: array
  - Items: object
  - Properties
    - date: string
    - description: string
documents_registered
- Type: array
  - Items: object
  - Properties
    - date_registered: string
    - document_description: string
employees_info
- Type: array
  - Items: object
  - Properties
    - year: number
    - number_of_employees: string
enquiries_trend: object
- Properties
  - breakdown: object
    - Properties
      - month1: string
      - month2: string
      - month3: string
      - month4: string
      - month5: string
      - month6: string
      - month7: string
      - month8: string
      - month9: string
      - month10: number
      - month11: string
      - month12: string
      - months1to3: string
      - months4to6: string
      - months7to9: string
      - months10to12: number
      - monthlyAverage: string
      - latestEnquiryDate: string
  - total_3_months: string
  - total_6_months: string
  - total_9_months: string
  - total_12_months: number
  - the_last_enquiry_date: string
  - average_reports_taken_each_month: string
  - number_of_enquiries_in_the_past_12_months: number
enquiries_trend_exists: string
financials_balance_sheet: object
- Properties
  - cash
    - Type: array
      - Items: object
      - Properties
        dynamics: number
        indicator
        Type: array
        Items: string
        consolidated: string
  - stock
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - net_assets
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - fixed_assets
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - total_assets
    - Type: array
      - Items: object
      - Properties
        dynamics: number
        indicator
        Type: array
        Items: string
        consolidated: string
  - trade_debtors
    - Type: array
      - Items: object
      - Properties
        dynamics: number
        indicator
        Type: array
        Items: string
        consolidated: string
  - bank_overdraft
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - current_assets
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - tangible_assets
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - trade_creditors
    - Type: array
      - Items: object
      - Properties
        dynamics: number
        indicator
        Type: array
        Items: string
        consolidated: string
  - intangible_assets
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - total_liabilities
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - total_fixed_assets
    - Type: array
      - Items: object
      - Properties
        dynamics: number
        indicator
        Type: array
        Items: string
        consolidated: string
  - current_liabilities
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - investment_and_other
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - other_long_term_financing
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - other_short_term_financing
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - total_long_term_liabilities
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - miscellaneous_current_liabilities
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
financials_balance_sheet_exists: boolean
financials_capital_and_reserves: object
- Properties
  - equity_paid_up: string
  - sundry_reserves
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - capital_employed
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - interest_payments
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - shareholder_funds
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - revaluation_reserve
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - called_up_share_capital
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator – Type: array – Items: string
        consolidated: string
  - p_and_l_account_reserve
    - Type: array
      - Items: object
      - Properties
        dynamics: number
        indicator
        Type: array
        Items: string
        consolidated: string
financials_capital_and_reserves_exists: boolean
financials_cash_flow: object
- Properties
  - increase_in_cash
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - net_change_in_cash
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator – Type: array – Items: string
        consolidated: string
  - net_cash_flow_from_financing
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - net_cash_flow_from_operations
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - net_cash_flow_before_financing
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator:
        Type: array
        Items: string
        consolidated: string
financials_cash_flow_exists: string
financials_growth_and_industry_comparison: object
- Properties
  - net_assets
    - Type: array
      - Items: object
      - Properties
        date: string
        value: string
  - total_assets
    - Type: array
      - Items: object
      - Properties
        date: string
        value: string
  - current_ratio
    - Type: array
      - Items: object
      - Properties
        date: string
        value: string
  - debt_to_capital
    - Type: array
      - Items: object
      - Properties
        date: string
        value: string
  - working_capital
    - Type: array
      - Items: object
      - Properties
        date: string
        value: string
  - consolidated_a_cs
    - Type: array
      - Items: object
      - Properties
        date: string
        value: string
  - total_liabilities
    - Type: array
      - Items: object
      - Properties
        date: string
        value: string
financials_growth_and_industry_comparison_exists: boolean
financials_kpis_and_ratios: object
- Properties
  - net_margin
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - gross_margin
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
- current_ratio
  - Type: array
    - Items: object
    - Properties
      - dynamics: string
      - indicator
        Type: array
        Items: string
      - consolidated: string
  - ebitda_margin
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - debt_to_capital
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - liquidity_ratio:
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator – Type: array – Items: string
        consolidated: string
  - gearing_net_debt
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - return_on_assets
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - return_on_equity
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - consolidated_a_cs
    - Type: array
      - Items: object
      - Properties
        date: string
        value: string
  - gearing_liability
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - gearing_gross_debt
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - cash_turnover_ratio
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - cash_to_total_assets
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator – Type: array – Items: string
        consolidated: string
  - pre_tax_profit_margin
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - operating_profit_margin
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - inventory_turnover_ratio
    - Type: array
      - Items: object
        Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
- return_on_capital_employed
  - Type: array
    - Items: object
    - Properties
      - dynamics: string
      - indicator
        Type: array
        Items: string
      - consolidated: string
- cash_to_current_liabilities_ratio
  - Type: array
    - Items: object
    - Properties
      - dynamics: string
      - indicator
        Type: array
        Items: string
      - consolidated: string
financials_kpis_and_ratios_exists: boolean
financials_misc_indicators: object
- Properties
  - goodwill
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - pensions
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - audit_fees
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - derivatives: string
  - auditor_fees: string
  - equity_shares: string
  - all_other_income: string
  - customer_accounts: string
  - deposits_by_banks: string
  - dividends_payable
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - contingent_liability
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - employee_remuneration
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - financial_liabilities: string
  - interest_bearing_loans
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - amortisation_of_intangibles
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - fees_and_commission_expense: string
  - interest_and_similar_income
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - loans_and_advances_to_banks: string
  - interest_and_similar_expense
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - loans_and_advances_to_customers: string
  - derivative_financial_instruments: string
  - cash_and_balances_at_central_banks: string
  - available_for_sale_financial_assets: string
  - treasury_bill_and_other_eligible_bills: string
  - items_in_the_course_of_collection_from_other_banks: string
  - items_in_the_course_of_transmission_from_other_banks: string
financials_misc_indicators_exists: boolean
financials_profit_and_loss: object
- Properties
  - weeks
    - Type: array
      - Items: object
      - Properties
        date: string
        value: number
  - export
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - currency
    - Type: array
      - Items: object
      - Properties
        date: string
        value: string
  - taxation
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - audit_fees
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator – Type: array – Items: string
        consolidated: string
  - depreciation
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - gross_profit
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - pre_tax_profit
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - retained_profit
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - operating_profit
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - profit_after_tax
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator: array
        Type: array
        Items: string
        consolidated: string
  - consolidated_a_cs
    - Type: array
      - Items: object
      - Properties
        date: string
        value: string
  - dividends_payable
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - interest_payments
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - wages_and_salaries
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - directors_emoluments
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
financials_profit_and_loss_exists: boolean
financials_summary: object
- Properties
  - ebitda
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - turnover: array
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator: array
        Type: array
        Items: string
        consolidated: string
  - net_assets
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - total_assets
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - working_capital
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator: array
        Type: array
        Items: string
        consolidated: string
  - employee_numbers
    - Type: array
      - Items: object
      - Properties
        date: string
        value: string
  - profit_after_tax
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
  - reporting_period
    - Type: array
      - Items: object
      - Properties
        date: string
        value: string
  - consolidated_a_cs: array
    - Type: array
      - Items: object
      - Properties
        date: string
        value: string
  - total_liabilities
    - Type: array
      - Items: object
      - Properties
        dynamics: string
        indicator
        Type: array
        Items: string
        consolidated: string
financials_summary_exists: boolean
font_size_value: number
former_mandates
- Type: array
  - Items: object
  - Properties
    - name: string
    - end_date: string
    - position: string
    - start_date: string
    - business_number: string
fresh_investigation: object
- Properties
  - order: string
  - status: string
  - company: string
  - due_date: string
  - parameters: string
  - date_checked: string
  - date_created: string
  - provider_country: string
  - provider_order_id: string
  - provider_response: string
  - provider_investigation_status: string
geographical_sales_breakdowns
- Type: array
  - Items: object
  - Properties
    - date: string
    - sales: number
    - currency: string
    - geographical_area: string
group_analysis_industries
- Type: array
  - Items: object
  - Properties
    - description: string
    - occurrences: string
group_analysis_officers
- Type: array
  - Items: object
  - Properties
    - description: string
    - occurrences: string
group_structure_affiliated
- Type: array
  - Items: object
  - Properties
    - level: string
    - turnover: string
    - net_worth: string
    - company_name: string
    - registered_number: string
    - registered_country: string
group_structure_analysis: object
- Properties
  - avg_dbt: number
  - max_dbt: number
  - min_dbt: string
  - currency: string
  - avg_limit: number
  - max_limit: number
  - min_limit: number
  - avg_rating: number
  - max_rating: number
  - min_rating: number
  - current_dbt: number
  - current_limit: number
  - current_rating: number
  - avg_number_of_legal_filings: string
  - max_number_of_legal_filings: number
  - min_number_of_legal_filings: string
  - avg_legal_filings_and_amount: number
  - max_legal_filings_and_amount: number
  - min_legal_filings_and_amount: string
  - current_number_of_legal_filings: number
  - current_legal_filings_and_amount: number
group_structure_extended
- Type: array
  - Items: object
  - Properties
    - level: string
    - turnover: string
    - net_worth: string
    - company_name: string
    - registered_number: string
    - registered_country: string
group_structure_subsidiaries
- Type: array
  - Items: object
  - Properties
    - level: string
    - turnover: string
    - net_worth: string
    - company_name: string
    - registered_number: string
    - registered_country: string
group_trade_payment_info: object
- Properties
  - currency: string
  - trade_lines: string
  - balance_1_30: number
  - balance_31_60: number
  - balance_61_90: number
  - balance_total: number
  - balance_91_plus: number
  - balance_current: number
high_credit_balances: object
- Properties
  - currency: string
  - average_91: string
  - average_1_30: string
  - average_31_60: string
  - average_61_90: string
  - trade_lines_91: string
  - average_current: string
  - single_trade_91: string
  - trade_lines_1_30: string
  - single_trade_1_30: string
  - trade_lines_31_60: string
  - trade_lines_61_90: string
  - single_trade_31_60: string
  - single_trade_61_90: string
  - trade_lines_current: string
  - single_trade_current: string
high_dbt: object
- Properties
  - average: string
  - trade_lines: string
  - single_trade: string
historic_health
- Type: array
  - Items: object
  - Properties
    - date: string
    - event: string
    - description: string
historic_trade_info
- Type: array
  - Items: object
  - Properties
    - month: string
    - total: number
    - current: number
    - period1: number
    - period2: number
    - period3: number
    - currency: string
    - past_due: number
    - severely_past_due: number
import_export_info: object
- Properties
  - export_info
    - Type: array
      - Items: object
      - Properties
        exportValue: number
        yearEndDate: string
        exportCurrency: string
  - import_info
    - Type: array
      - Items: object
      - Properties
        importValue: number
        yearEndDate: string
        importCurrency: string
  - export_countries: string
  - import_countries: string
industry_comparison_and_analysis: object
- Properties
  - industry_comparison: object
    - Properties
      - activityCode: string
      - activityDescription: string
      - industryAverageCreditLimit: string
      - industryAverageCreditRating: string
      - industryAverageCreditLimitCurrency: string
      - industryAverageDaySalesOutstanding: string
      - industryAveragePaymentExpectationDays: string
  - day_sales_outstanding: object
    - Properties
      - daySalesOutstandingLower: string
      - daySalesOutstandingUpper: string
      - daySalesOutstandingMedian: string
  - payment_expectation_days: object
    - Properties
      - paymentExpectationsLower: string
      - paymentExpectationsUpper: string
      - paymentExpectationsMedian: string
inquiries
- Type: array
  - Items: object
  - Properties
    - sic_code: string
    - inquiry_date: string
    - sic_description: string
judgements
- Type: array
  - Items: object
  - Properties
    - amount: number
    - status: string
    - currency: string
    - plaintiff: string
    - court_name: string
    - filed_date: string
    - action_type: string
    - filing_type: string
    - court_address: string
    - filing_number: string
    - court_telephone: string
judicial_ccj
- Type: array
  - Items: object
  - Properties
    - date: string
    - amount: string
    - status: string
    - complainant: string
land_registry
- Type: array
  - Items: string
latest_enquiries
- Type: array
  - Items: object
  - Properties
    - date: string
    - number: string
    - company: string
legal_filing_branch_summary: object
- Properties
  - sum: object
    - Properties
      - value: string
      - currency: string
  - suits: string
  - bankruptcy: string
  - ucc_filings: string
  - judgment_filings: string
  - tax_lien_filings: string
  - cautionary_ucc_filings: string
  - amount: object
    - Properties
      - value: string
      - currency: string
legal_filing_group_summary: object
- Properties
  - sum: object
    - Properties
      - value: number
      - currency: string
  - suits: string
  - bankruptcy: string
  - ucc_filings: string
  - judgment_filings: string
  - tax_lien_filings: string
  - cautionary_ucc_filings: string
  - amount: object
    - Properties
      - value: string
      - currency: string
legal_filing_summary: object
- Properties
  - sum: object
    - Properties
      - value: number
      - currency: string
  - suits: string
  - bankruptcy: string
  - ucc_filings: string
  - possible_ofac: string
  - judgment_filings: string
  - tax_lien_filings: string
  - cautionary_ucc_filings: string
  - amount: object
    - Properties
      - value: string
      - currency: string
liens
- Type: array
  - Items: object
  - Properties
    - collateral: string
    - lien_number: string
    - lien_period: string
    - reported_date: string
    - renewal_period: string
    - date_registered: string
    - principal_amount: string
    - secured_party_name: string
    - secured_party_address: string
    - secured_party_assignor: string
lifetime_dbt: object
- Properties
  - dbt_3_month: string
  - dbt_6_month: string
  - dbt_9_month: string
  - dbt_12_month: string
  - dbt_lifetime: string
lifetime_hb: object
- Properties
  - average_lft: string
  - single_3_month: string
  - single_6_month: string
  - single_9_month: string
  - trade_line_lft: string
  - average_3_month: string
  - average_6_month: string
  - average_9_month: string
  - single_12_month: string
  - single_high_lft: string
  - average_12_month: string
  - trade_line_3_month: string
  - trade_line_6_month: string
  - trade_line_9_month: string
  - trade_line_12_month: string
  - currency: string
line_height: number
litigation
- Type: array
  - Items: object
  - Properties
    - status: string
    - amount1: string
    - amount2: string
    - amount3: string
    - amount4: string
    - amount5: string
    - currency1: string
    - currency2: string
    - currency3: string
    - currency4: string
    - currency5: string
    - date_writ: string
    - case_number: string
    - status_date: string
    - subject_name: string
    - document_remark: string
    - nature_of_claim: string
    - defence_law_firm: string
    - defence_solicitor: string
    - plaintiff_law_firm: string
    - plaintiff_solicitor: string
    - defence_solicitor_id: string
    - defence_file_reference: string
    - plaintiff_solicitor_id: string
    - plaintiff_file_reference: string
litigation_events
- Type: array
  - Items: object
  - Properties
    - court: string
    - file_number: string
    - court_verdict: string
    - judgement_date: string
    - plaintiff_or_defendant: string
main_suppliers
- Type: array
  - Items: object
  - Properties
    - name: string
    - activity_code: string
    - registration_number: string
    - activity_description: string
mini_dashboard: object
- Properties
  - dbt: string
  - credit_ratio: string
  - last_updated: string
  - total_balance: string
  - past_due_total: string
  - highest_past_due: string
  - past_due_percent: string
  - total_trade_lines: string
  - active_trade_lines: string
  - recent_high_credit: string
  - active_credit_amount: string
  - industry_performance: string
  - past_due_severe_total: string
  - highest_severely_past_due: string
minority_interests
- Type: array
  - Items: object
  - Properties
    - country: string
    - company_name: string
    - credit_limit: string
    - provider_value: string
    - business_number: string
    - percentage_owned: number
    - credit_limit_currency: string
    - latest_annual_accounts: string
minority_shareholders
- Type: array
  - Items: object
  - Properties
    - country: string
    - company_name: string
    - credit_limit: number
    - provider_value: number
    - business_number: string
    - percentage_owned: string
    - credit_limit_currency: string
    - latest_annual_accounts: string
miscellaneous_information: object
- Properties
  - fax_number: string
  - tax_number: string
  - tax_office: string
  - credit_assessment: string
  - commercial_registry: string
  - gazette_date_established: string
mortgages_and_charges
- Type: array
  - Items: object
  - Properties
    - type: string
    - satisfied: string
    - created_date: string
    - registered_date: string
    - persons_entitled: string
    - further_information: string
most_recent_legal_filings
- Type: array
  - Items: object
  - Properties
    - status: string
    - filed_date: string
    - case_number: string
    - filing_type: string
    - released_date: string
    - legal_filing_type: string
name: string
nr: number
order_logger: object
- Properties
  - order: string
  - api_key: string
  - company: string
  - country: string
  - end_time: string
  - provider: string
  - start_time: string
  - parsing_time: string
  - pdf_traceback: string
  - parsing_status: string
  - get_report_errors: string
  - our_response_time: string
  - get_status_counter: string
  - get_report_duration: string
  - get_status_duration: string
  - get_status_response: string
  - pdf_generation_time: string
  - pdf_report_document: string
  - get_report_timestamp: string
  - place_order_duration: string
  - place_order_response: string
  - pdf_generation_status: string
  - place_order_timestamp: string
  - provider_order_reason: string
  - get_report_status_code: string
  - get_status_status_code: string
  - provider_error_content: string
  - provider_response_code: string
  - provider_response_size: string
  - provider_response_time: string
  - place_order_status_code: string
  - provider_error: string
  - sentry_event_id: string
  - get_report_error: string
  - get_status_error: string
  - parsing_exception: string
  - place_order_error: string
  - provider_duration: string
  - provider_response: string
  - get_report_response: string
  - provider_status_code: string
  - check_order_availability_error: string
  - check_order_availability_duration: string
  - check_order_availability_response: string
  - check_order_availability_timestamp: string
  - check_order_availability_status_code: string
osha
- Type: array
  - Items: object
  - Properties
    - activity: string
    - open_date: string
    - abate_date: string
    - citation_id: string
    - site_address: string
    - current_penalty: string
    - initial_penalty: string
    - number_of_instances: string
    - inspection_classification: string
    - violation_type_description: string
    - inspection_type_description: string
outstanding_by_high_credit_utilization
- Type: array
  - Items: object
  - Properties
    - balance: number
    - currency: string
    - high_credit: number
    - credit_utilization_band: string
past_due_balances: object
- Properties
  - hb_lft: number
  - sh_lft: number
  - tb_lft: number
  - hb_12_months: number
  - sh_12_months: number
  - tb_12_months: number
  - hb_60_days_lft: string
  - sh_60_days_lft: string
  - tb_60_days_lft: string
  - hb_60_days_12_months: string
  - sh_60_days_12_months: string
  - tb_60_days_12_months: string
  - currency: string
past_due_trade_lines: object
- Properties
  - high_tl_lft: string
  - total_tl_lft: string
  - high_tl_12_months: string
  - total_tl_12_months: string
  - high_tl_60_days_lft: string
  - total_tl_60_days_lft: string
  - high_tl_60_days_12_months: string
  - total_tl_60_days_12_months: string
payment_dbt_history
- Type: array
  - Items: object
  - Properties
    - dbt: number
    - date: string
    - industry_dbt: number
payment_history_status
- Type: array
  - Items: object
  - Properties
    - year: string
    - cycle: string
    - status: string
    - quarter: string
payment_index: object
- Properties
  - pi_score_0: string
  - pi_score_na: string
  - pi_score_1to10: string
  - pi_score_11to20: string
  - pi_score_21to30: string
  - pi_score_31to40: string
  - pi_score_41to90: string
  - pi_score_91to100: string
  - current_payment_index: string
payment_index_quarter
- Type: array
  - Items: object
  - Properties
    - year: string
    - quarter: string
    - payment_index: string
    - industry_average: string
payment_information
- Type: array
  - Items: string
payment_information_exists: string
previous_company_names
- Type: array
  - Items: object
  - Properties
    - name: string
    - period: string
previous_company_secretaries
- Type: array
  - Items: object
  - Properties
    - job: string
    - name: string
    - title: string
    - period: string
    - address: string
    - nationality: string
    - date_of_birth: string
    - appointment_date: string
    - total_appointments: string
    - current_appointments: string
    - present_appointments: number
    - previous_appointments: number
    - dissolved_appointments: string
previous_directors
- Type: array
  - Items: object
  - Properties
    - job: string
    - name: string
    - title: string
    - gender: string
    - period: string
    - address: string
    - nationality: string
    - date_of_birth: string
    - appointment_date: string
    - resignation_date: string
    - total_appointments: string
    - present_appointments: string
    - previous_appointments: string
    - dissolved_appointments: string
previous_directorships
- Type: array
  - Items: object
  - Properties
    - job: string
    - name: string
    - title: string
    - status: string
    - address: string
    - nationality: string
    - company_name: string
    - date_of_birth: string
    - appointment_date: string
    - resignation_date: string
    - registration_number: string
    - current_appointments: string
publications
- Type: array
  - Items: object
  - Properties
    - title: string
    - information: string
    - notice_type: string
    - publication: string
    - canton_of_origin: string
    - date_of_publication: string
    - gazette_issue_number: string
quarterly_industry_payment_trends
- Type: array
  - Items: object
  - Properties
    - currency: string
    - total_amount
      - Type: array
        Items: object
        Properties
        year: string
        amount: string
        quarter: string
    - payment_index
      - Type: array
        Items: object
        Properties
        year: string
        quarter: string
        paymentIndex: string
    - current_amount
      - Type: array
        Items: object
        Properties
        year: string
        amount: string
        quarter: string
    - number_of_references
      - Type: array
        Items: object
        Properties
        year: string
        quarter: string
        numberofReferences: string
    - composite_index_score
      - Type: array
        Items: object
        Properties
        year: string
        quarter: string
        compositeIndex: string
    - period_1_trend_amount
      - Type: array
        Items: object
        Properties
        year: string
        amount: string
        quarter: string
    - period_2_trend_amount
      - Type: array
        Items: object
        Properties
        year: string
        amount: string
        quarter: string
    - period_3_trend_amount
      - Type: array
        Items: object
        Properties
        year: string
        amount: string
        quarter: string
receivables
- Type: array
  - Items: string
related_names_and_address
- Type: array
  - Items: object
  - Properties
    - address: string
    - file_number: string
    - company_name: string
    - subject_number: string
report_highlights_and_alerts: object
- Properties
  - currency: string
  - total_past_due: number
  - total_outstanding: number
  - liens_total_amount: string
  - bank_report_on_file: string
  - credit_limit_90_day: string
  - number_of_inquiries: string
  - credit_limit_13_month: string
  - liens_number_of_liens: string
  - total_current_balance: number
  - credit_limit_all_lines: string
  - liens_most_recent_date: string
  - most_severe_status_date: string
  - number_of_delinquencies: string
  - collections_total_amount: string
  - corporate_search_on_file: string
  - legal_items_total_amount: string
  - collections_most_recent_date: string
  - legal_items_most_recent_date: string
  - number_of_accounts_reporting: string
  - single_highest_credit_90_day: string
  - other_legal_info_total_amount: string
  - total_current_credit_exposure: number
  - single_highest_credit_13_month: string
  - single_highest_credit_all_lines: string
  - collections_number_of_collections: string
  - legal_items_number_of_legal_items: string
  - other_legal_info_most_recent_date: string
  - charge_offs_total_amount_charged_off: string
  - charge_offs_largest_charge_off_amount: string
  - charge_offs_number_of_accounts_charged_off: string
  - other_legal_info_number_of_other_legal_info: string
representative_checks
- Type: array
  - Items: object
  - Properties
    - name: string
    - address: string
    - description: string
    - year_of_birth: string
    - number_of_directorships: string
    - representative_credit_score: string
    - number_of_related_company_insolvencies: string
score_history
- Type: array
  - Items: object
  - Properties
    - date: string
    - event: string
    - score: string
    - description: string
search_logger: object
- Properties
  - query: string
  - api_key: string
  - country: string
  - provider: string
  - our_response_time: string
  - our_response_nr_companies: string
  - provider_name_search_time: string
  - provider_errors_name_search: string
  - provider_reg_nr_search_time: string
  - provider_errors_reg_nr_search: string
  - provider_nr_companies_name_search: string
  - provider_response_code_name_search: string
  - provider_nr_companies_reg_nr_search: string
  - provider_response_code_reg_nr_search: string
  - sentry_event_id: string
  - provider_response_text_name_search: string
  - provider_response_text_reg_nr_search: string
  - user_input: string
share_capital_fresh_investigation: object
- Properties
  - issued_capital: string
  - nominal_capital: string
  - issued_capital_currency: string
  - nominal_capital_currency: string
share_capital_structure: object
- Properties
  - issued_capital: number
  - nominal_capital: number
  - issued_capital_currency: string
  - number_of_shares_issued: number
  - nominal_capital_currency: string
shareholders
- Type: array
  - Items: object
  - Properties
    - name: string
    - value: string
    - quantity: string
    - share_type: string
    - share_price: string
    - total_value: string
    - issued_capital: string
size_title: number
social_balance_sheet: object
- Properties
  - social_balance_sheet: object
    - Properties
      - currency: string
      - leaversFT: number
      - leaversPT: number
      - managementFT: number
      - managementPT: number
      - newStartersFT: number
      - newStartersPT: number
      - leaversTotalFte: number
      - menUniversityFT: number
      - menUniversityPT: number
      - hoursWorkedTotal: number
      - reportingYearEnd: string
      - fullTimeEmployees: number
      - partTimeEmployees: number
      - totalFteEmployees: number
      - womenUniversityFT: number
      - womenUniversityPT: number
      - blueCollarWorkerFT: number
      - blueCollarWorkerPT: number
      - managementTotalFte: number
      - newStartersTotalFte: number
      - whiteCollarWorkerFT: number
      - whiteCollarWorkerPT: number
      - costOfTemporaryStaff: number
      - menHigherEducationFT: number
      - menHigherEducationPT: number
      - menPrimaryEducationFT: number
      - menPrimaryEducationPT: number
      - menUniversityTotalFte: number
      - personnelChargesTotal: number
      - hoursWorkedFTEmployees: number
      - hoursWorkedPTEmployees: number
      - womenHigherEducationFT: number
      - womenHigherEducationPT: number
      - menSecondaryEducationFT: number
      - menSecondaryEducationPT: number
      - womenPrimaryEducationFT: number
      - womenPrimaryEducationPT: number
      - womenUniversityTotalFte: number
      - blueCollarWorkerTotalFte: number
      - prevYearPersonnelCharges: number
      - whiteCollarWorkerTotalFte: number
      - womenSecondaryEducationFT: number
      - womenSecondaryEducationPT: number
      - limitedDurationContractsFT: number
      - menHigherEducationTotalFte: number
      - prevYearActualWorkingHours: number
      - menPrimaryEducationTotalFte: number
      - personnelChargesFTEmployees: number
      - personnelChargesPTEmployees: number
      - tempStaffActualWorkingHours: number
      - unlimitedDurationContractsFT: number
      - unlimitedDurationContractsPT: number
      - womenHigherEducationTotalFte: number
      - averageNumberOfTemporaryStaff: number
      - menSecondaryEducationTotalFte: number
      - womenPrimaryEducationTotalFte: number
      - womenSecondaryEducationTotalFte: number
      - limitedDurationContractsTotalFte: number
      - prevYearAverageNumberOfEmployees: number
      - unlimitedDurationContractsTotalFte: number
      - formalTrainingNumberOfEmployeesMale: number
      - formalTrainingNumberOfEmployeesFemale: number
      - informalTrainingNumberOfEmployeesMale: number
      - formalTrainingNetCostsForEnterpriseMale: number
      - formalTrainingNumberOfTrainingHoursMale: number
      - informalTrainingNumberOfEmployeesFemale: number
      - formalTrainingNetCostsForEnterpriseFemale: number
      - formalTrainingNumberOfTrainingHoursFemale: number
      - informalTrainingNetCostsForEnterpriseMale: number
      - informalTrainingNumberOfTrainingHoursMale: number
      - informalTrainingNetCostsForEnterpriseFemale: number
      - informalTrainingNumberOfTrainingHoursFemale: number
      - limitedDurationContractsPT: number
social_ccj
- Type: array
  - Items: string
stock_information: object
- Properties
  - dividends: array
    - Type: array
      - Items: object
      - Properties
        dividendDate: string
        dividendValue: string
        dividendCurrency: string
        dividendShareType: string
  - isin_codes: string
  - company_type: string
  - market_segments: string
  - outstanding_shares
    - Type: array
      - Items: object
      - Properties
        outstandingShareDate: string
        outstandingShareValue: string
        outstandingShareSeriesName: string
  - stock_exchange_names: string
  - stock_ticker_symbols: string
  - latest_market_capitalisation: string
  - latest_capitalisation_currency: string
suits
- Type: array
  - Items: object
  - Properties
    - amount: string
    - status: string
    - currency: string
    - plaintiff: string
    - court_name: string
    - filed_date: string
    - action_type: string
    - filing_type: string
    - court_address: string
    - filing_number: string
    - court_telephone: string
summary
- Type: object
- Properties
  - ebitda: number
  - charges: string
  - mortgages: string
  - cash_at_bank: string
  - age_of_business: number
  - charges_dynamics: string
  - court_judgements: string
  - mortgages_dynamics: string
  - things_to_consider: array
    - Type: array
      - Items: string
  - number_of_employees: string
  - overall_credit_risk: object
    - Properties
      - commonValue: string
      - creditLimit: object
        Properties
        value: string
        currency: string
      - providerValue: object
        Properties
        value: string
        maxValue: string
        minValue: string
      - commonDescription: string
      - providerDescription: string
      - pod: number
  - court_judgements_dynamics: string
  - overall_credit_risk_class: string
  - credit_limit_recommendation: object
    - Properties
      - value: string
      - currency: string
  - what_you_should_be_aware_of: string
  - what_we_like_about_this_company
    - Type: array
      - Items: string
  - country: string
  - comments: string
  - extended
    - Type: array
      - Items: object
      - Properties
        Country: string
        Language: string
        Mortgages: number
  - language: string
  - turnover: number
  - last_update: string
  - nsso_number: string
  - nsso_summons: string
  - liable_for_vat: string
  - fin_information: string
  - derogatory_legal: string
  - rating_information: string
  - shareholder_equity: number
  - company_description: string
  - payment_information: string
  - protested_bills_flag: string
  - additional_foreign_oenb: string
  - credit_score_description: string
  - pd_according_to_basel_ii: string
  - company_credibility_assessment: string
  - sic_code: string
tax_liens
- Type: array
  - Items: object
  - Properties
    - amount: number
    - status: string
    - currency: string
    - filed_date: string
    - action_type: string
    - filing_type: string
    - jurisdiction: string
    - filing_number: string
    - released_date: string
text_config
- Type: object
- Properties
  - font: number
  - line_height: number
tpd_balance_histories
- Type: array
  - Items: object
  - Properties
    - date: string
    - currency: string
    - range_1_to_30: string
    - range_91_plus: string
    - total_balance: string
    - range_31_to_60: string
    - range_61_to_90: string
    - balance_current: string
tpd_group_industry_breakdown
- Type: array
  - Items: object
  - Properties
    - total: string
    - currency: string
    - trade_lines: number
    - current_value: string
    - range_1_to_30: number
    - range_91_plus: number
    - range_31_to_60: number
    - range_61_to_90: number
    - industry_description: string
tpd_industry_breakdown
- Type: array
  - Items: object
  - Properties
    - total: string
    - currency: string
    - trade_lines: number
    - current_value: string
    - range_1_to_30: number
    - range_91_plus: string
    - range_31_to_60: number
    - range_61_to_90: number
    - industry_description: string
tpd_industry_breakdown_period
- Type: array
  - Items: object
  - Properties
    - total: string
    - period1: string
    - period2: string
    - period3: string
    - currency: string
    - trade_lines: number
    - current_value: string
    - industry_description: string
trade_lines_info
- Type: object
- Properties
  - total: object
    - Properties
      - number: number
      - balance: number
      - current: number
      - currency: string
      - range1to30: string
      - range31to60: string
      - range61to90: string
      - range91plus: string
  - combined: object
    - Properties
      - number: number
      - balance: number
      - current: number
      - currency: string
      - range1to30: string
      - range31to60: string
      - range61to90: string
      - range91plus: string
  - continuous: object
    - Properties
      - number: number
      - balance: number
      - current: number
      - currency: string
      - range1to30: string
      - range31to60: string
      - range61to90: string
      - range91plus: string
trade_payment_info
- Type: object
- Properties
  - total: number
  - current: number
  - period1: number
  - period2: number
  - period3: number
  - currency: string
  - total_tradeLines: number
  - current_percentage: number
  - period1_percentage: number
  - period2_percentage: number
  - period3_percentage: number
trade_payments_credit_extended
- Type: object
- Properties
  - credit_over_1m: object
    - Properties
      - pastDue: string
      - currency: string
      - tradeLines: string
      - totalAmount: string
      - percentPastDue: string
      - percentWithinTerms: string
      - withinTerms: number
      - creditExtendedRange: string
  - credit_1k_to_5k: object
    - Properties
      - pastDue: string
      - currency: string
      - tradeLines: string
      - totalAmount: string
      - percentPastDue: string
      - percentWithinTerms: string
      - withinTerms: number
      - creditExtendedRange: string
  - credit_under_1k: object
    - Properties
      - pastDue: string
      - currency: string
      - tradeLines: string
      - totalAmount: string
      - percentPastDue: string
      - percentWithinTerms: string
      - withinTerms: number
      - creditExtendedRange: string
  - credit_5k_to_25k: object
    - Properties
      - pastDue: string
      - currency: string
      - tradeLines: string
      - totalAmount: string
      - percentPastDue: string
      - percentWithinTerms: string
      - withinTerms: number
      - creditExtendedRange: string
  - credit_100k_to_1m: object
    - Properties
      - pastDue: string
      - currency: string
      - tradeLines: string
      - totalAmount: string
      - percentPastDue: string
      - percentWithinTerms: string
      - withinTerms: number
      - creditExtendedRange: string
  - credit_25k_to_50k: object
    - Properties
      - pastDue: string
      - currency: string
      - tradeLines: string
      - totalAmount: string
      - withinTerms: number
      - creditExtendedRange: string
      - percentPastDue: string
      - percentWithinTerms: string
  - credit_50k_to_100k: object
    - Properties
      - pastDue: string
      - currency: string
      - tradeLines: string
      - totalAmount: string
      - percentPastDue: string
      - percentWithinTerms: string
      - withinTerms: number
      - creditExtendedRange: string
trading_address
- Type: array
  - Items: object
  - Properties
    - phone: string
    - address: string
trucking_carrier_info
- Type: array
  - Items: object
  - Properties
    - name_dba: string
    - mc_number: string
    - fleet_size: string
    - revoked_flag: string
    - safety_rating: string
    - us_dot_number: string
    - hazmat_indicator: string
    - motor_safety_cargo_types: string
    - motor_safety_entity_types: string
    - motor_safety_classifications: string
ucc_filings
- Type: array
  - Items: object
  - Properties
    - status: string
    - filed_date: string
    - debtor_name: string
    - filing_type: string
    - jurisdiction: string
    - filing_number: string
    - filing_office: string
    - debtor_address: string
    - secured_party_name: string
    - secured_party_address: string
    - related_document_number: string

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.post('https://platform.zephira.ai/v2/credit-report/report/json/file',  json={
        "source_id": "GB-0-00445790",
        "country": "GB"
    }, headers = headers)

print(r.json())

Request example

{
    "source_id": "GB-0-00445790",
    "country": "GB"
}

Success Response

{
    "ccj": [],
    "liens": [],
    "bankers": [],
    "summary": {
        "ebitda": 4516000000.0,
        "charges": 2,
        "country": "GB",
        "comments": null,
        "extended": [
            {
                "Charges": 2,
                "Mortgages": 9,
                "Court Judgments": 8
            },
            {
                "EBITDA": 4516000000.0,
                "Turnover": 57887000000.0,
                "Age of Business": 73,
                "Number of Employees": "367321"
            }
        ],
        "language": "EN",
        "turnover": 57887000000.0,
        "mortgages": 9,
        "last_update": null,
        "nsso_number": null,
        "cash_at_bank": 2510000000.0,
        "nsso_summons": null,
        "liable_for_vat": null,
        "age_of_business": 73,
        "fin_information": null,
        "charges_dynamics": null,
        "court_judgements": 8,
        "derogatory_legal": null,
        "mortgages_dynamics": "04-11-2009",
        "rating_information": null,
        "shareholder_equity": 12343000000.0,
        "things_to_consider": [
            "This company has been treated as a PLC company in terms of the score/limit that has been generated",
            "This company's Asset Ratio shows a moderate amount of cover on outstanding obligations."
        ],
        "company_description": "",
        "number_of_employees": "367321",
        "overall_credit_risk": {
            "pod": 0.0597,
            "commonValue": "A",
            "creditLimit": {
                "value": "100000000",
                "currency": "GBP"
            },
            "providerValue": {
                "value": "86",
                "maxValue": "100",
                "minValue": "1"
            },
            "commonDescription": "Very Low Risk",
            "providerDescription": "Very Low Risk"
        },
        "payment_information": null,
        "protested_bills_flag": null,
        "additional_foreign_oenb": null,
        "credit_score_description": null,
        "pd_according_to_basel_ii": null,
        "court_judgements_dynamics": null,
        "overall_credit_risk_class": "Very Low Risk",
        "credit_limit_recommendation": {
            "value": "100000000",
            "currency": "GBP"
        },
        "what_you_should_be_aware_of": "",
        "company_credibility_assessment": null,
        "what_we_like_about_this_company": [
            "This is a very large company with Total Assets in excess of £5 billion and Equity greater than £50 million.",
            "This company's auditors have reported no adverse information."
        ]
    },
    "ccj_exact": [
        {
            "date": "25 Mar 2020",
            "type": null,
            "court": "COUNTY COURT BUSINESS CENTRE",
            "amount": 9139.0,
            "status": "Judgment",
            "date_paid": null,
            "case_number": "G3AT671V"
        },
        //...
    ],
    "ccj_grouped": [],
    "ccj_possible": [
        {
            "date": "23 Sep 2015",
            "type": null,
            "court": "COUNTY COURT BUSINESS CENTRE",
            "amount": 43926.0,
            "status": "Judgment",
            "date_paid": null,
            "case_number": "B2QZ4N96"
        }
    ],
    "judicial_ccj": [],
    "order_logger": {
        "order": null,
        "api_key": null,
        "company": null,
        "country": null,
        "end_time": null,
        "provider": null,
        "start_time": null,
        "parsing_time": null,
        "pdf_traceback": null,
        "parsing_status": null,
        "provider_error": null,
        "sentry_event_id": null,
        "get_report_error": null,
        "get_status_error": null,
        "our_response_time": null,
        "parsing_exception": null,
        "place_order_error": null,
        "provider_duration": null,
        "provider_response": null,
        "get_status_counter": null,
        "get_report_duration": null,
        "get_report_response": null,
        "get_status_duration": null,
        "get_status_response": null,
        "pdf_generation_time": null,
        "pdf_report_document": null,
        "get_report_timestamp": null,
        "place_order_duration": null,
        "place_order_response": null,
        "provider_status_code": null,
        "pdf_generation_status": null,
        "place_order_timestamp": null,
        "provider_order_reason": null,
        "get_report_status_code": null,
        "get_status_status_code": null,
        "place_order_status_code": null,
        "check_order_availability_error": null,
        "check_order_availability_duration": null,
        "check_order_availability_response": null,
        "check_order_availability_timestamp": null,
        "check_order_availability_status_code": null
    },
    "shareholders": [
        {
            "name": "UNDISCLOSED",
            "address": null,
            "currency": "GBP",
            "quantity": 8174160481,
            "percentage": 100.0,
            "share_type": "ORDINARY",
            "start_date": null,
            "share_price": null,
            "total_value": 408708024.05,
            "share_classes": [
                {
                    "currency": "GBP",
                    "shareType": "ORDINARY",
                    "valuePerShare": 0.05,
                    "additionalData": {
                        "percentSharesHeld": 100.0
                    },
                    "valueOfSharesOwned": 408708024.05,
                    "numberOfSharesOwned": 8174160481
                }
            ],
            "shareholder_type": "Other"
        }
    ],
    "land_registry": [],
    "score_history": [
        {
            "date": "06-12-2019",
            "event": null,
            "score": 86,
            "description": "Very Low Risk"
        },
        //...
    ],
    "search_logger": {
        "query": null,
        "api_key": null,
        "country": null,
        "provider": null,
        "sentry_event_id": null,
        "our_response_time": null,
        "our_response_nr_companies": null,
        "provider_name_search_time": null,
        "provider_errors_name_search": null,
        "provider_reg_nr_search_time": null,
        "provider_errors_reg_nr_search": null,
        "provider_nr_companies_name_search": null,
        "provider_response_code_name_search": null,
        "provider_response_text_name_search": null,
        "provider_nr_companies_reg_nr_search": null,
        "provider_response_code_reg_nr_search": null,
        "provider_response_text_reg_nr_search": null
    },
    "branch_details": [
        {
            "fax": null,
            "tel": null,
            "name": null,
            "type": null,
            "address": null,
            "country": null
        },
        //...
    ],
    "employees_info": [
        {
            "year": 2021,
            "number_of_employees": "367321"
        },
        {
            "year": 2020,
            "number_of_employees": "354448"
        },
        {
            "year": 2019,
            "number_of_employees": "464505"
        },
        {
            "year": 2017,
            "number_of_employees": "464520"
        }
    ],
    "additional_misc": [],
    "company_profile": {
        "fax": "",
        "name": "TESCO PLC",
        "email": null,
        "status": "Active",
        "auditor": "DELOITTE LLP",
        "website": "https://www.tescoplc.com/",
        "province": null,
        "sic_code": "SIC03, 5211, Retail in non-specialised stores holding an alcohol licence, with food, beverages or tobacco predominating, not elsewhere classified; SIC07, 47110, Retail sale in non-specialised stores with food, beverages or tobacco predominating",
        "ofac_bool": null,
        "ofac_date": null,
        "post_code": "AL7 1GA",
        "source_id": null,
        "legal_form": "Public limited with Share Capital",
        "vat_number": "GB220430231",
        "export_bool": null,
        "import_bool": null,
        "main_products": null,
        "parent_company": null,
        "registered_city": null,
        "trading_address": "Tesco House Shire Park, Kestrel Way, Welwyn Garden City, AL7 1GA",
        "telephone_number": "+01992632222",
        "type_of_accounts": "Consolidated",
        "principal_activity": "SIC07, 47110, Retail sale in non-specialised stores with food, beverages or tobacco predominating",
        "registered_address": "TESCO HOUSE SHIRE PARK, KESTREL WAY, WELWYN GARDEN CITY, AL7 1GA",
        "registration_number": "00445790",
        "date_of_incorporation": "27-11-1947",
        "latest_filed_accounts": "16-07-2021",
        "stock_exchange_status": null,
        "cross_border_agent_bool": null,
        "ultimate_holding_company": null
    },
    "enquiries_trend": {
        "breakdown": {
            "month1": 12,
            "month2": 53,
            "month3": 79,
            "month4": 69,
            "month5": 89,
            "month6": 48,
            "month7": 95,
            "month8": 111,
            "month9": 72,
            "month10": 88,
            "month11": 105,
            "month12": 127,
            "months1to3": 144,
            "months4to6": 206,
            "months7to9": 278,
            "months10to12": 320,
            "monthlyAverage": 79.0,
            "latestEnquiryDate": "2021-09-11T14:58:30Z"
        },
        "total_3_months": 144,
        "total_6_months": 350,
        "total_9_months": 628,
        "total_12_months": 948,
        "the_last_enquiry_date": "11-09-2021",
        "average_reports_taken_each_month": "79",
        "number_of_enquiries_in_the_past_12_months": 948
    },
    "historic_health": [
        {
            "date": "26-06-2020",
            "event": "Profit Warning",
            "description": "Following revised macro-economic assumptions regarding GDP and unemployment levels, we have increased our provision for potential bad debts at Tesco Bank and we now expect to report a loss for the Bank of between £(175)m and £(200)m for the 2020/21 financial year.  We will continue to review any changes made to macro-economic forecasts and this could result in releases from or additions to this provision. Whilst headline profitability is impacted in the short term, the Bank's capital ratios and liquidity remain strong"
        }
    ],
    "trading_address": [
        {
            "phone": "+0345 6778993",
            "address": "1 Laurel Drive, Bridge Of Don, Aberdeen, Aberdeenshire, AB22 8HB"
        },
        //...
    ],
    "document_filings": [
        {
            "date": "16-07-2021",
            "description": "New Accounts Filed",
            "number_of_deeds": null
        },
        //...
    ],
    "coface_financials": [],
    "current_directors": [
        {
            "job": "Director",
            "name": "Ms Karen Tracy Whitworth",
            "title": "Ms",
            "gender": "Female",
            "address": "Tesco House Shire Park, Kestrel Way, Welwyn Garden City, AL7 1GA",
            "nationality": "British",
            "date_of_birth": "01-08-1969",
            "appointment_date": "18-06-2021",
            "current_appointments": 4
        },
        //...
    ],
    "administrative_ccj": [],
    "custom_data_tables": [],
    "financials_summary": {
        "ebitda": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    2647000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "turnover": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    55917000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "net_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    6438000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "total_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    45877000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "working_capital": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    -4332000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "employee_numbers": [
            {
                "date": "25-02-2017",
                "value": "464,520.00"
            },
            //...
        ],
        "profit_after_tax": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    58000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "reporting_period": [
            {
                "date": "25-02-2017",
                "value": "27-02-2016 - 25-02-2017"
            },
            //...
        ],
        "consolidated_a_cs": [
            {
                "date": "25-02-2017",
                "value": true
            },
            //...
        ],
        "total_liabilities": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    39439000000.0
                ],
                "consolidated": true
            },
            //...
        ]
    },
    "import_export_info": {
        "export_info": null,
        "import_info": null,
        "export_countries": "",
        "import_countries": ""
    },
    "previous_directors": [
        {
            "job": null,
            "name": "Olivia Garfield",
            "title": null,
            "period": "",
            "address": null,
            "nationality": null,
            "date_of_birth": null,
            "total_appointments": null,
            "present_appointments": 0,
            "previous_appointments": 1,
            "dissolved_appointments": 0
        },
        //...
    ],
    "fresh_investigation": {
        "order": null,
        "status": null,
        "company": null,
        "due_date": null,
        "parameters": null,
        "date_checked": null,
        "date_created": null,
        "provider_country": null,
        "provider_order_id": null,
        "provider_response": null,
        "provider_investigation_status": null
    },
    "payment_information": [],
    "credit_limit_history": [
        {
            "date": "06-12-2019",
            "limit": {
                "value": 100000000.0,
                "currency": "GBP"
            },
            "description": null
        },
        //...
    ],
    "financials_cash_flow": {
        "increase_in_cash": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    881000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "net_change_in_cash": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    881000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "net_cash_flow_from_financing": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    -1387000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "net_cash_flow_from_operations": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    1989000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "net_cash_flow_before_financing": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    2268000000.0
                ],
                "consolidated": true
            },
            //...
        ]
    },
    "current_directorships": [],
    "mortgages_and_charges": [
        {
            "type": "ACCOUNT SECURITY AGREEMENT",
            "satisfied": null,
            "created_date": "04-11-2009",
            "registered_date": "06-11-2009",
            "persons_entitled": "TESCO TRUSTEE COMPANY OF IRELAND LIMITED AS TRUSTEE OF THE TESCO IRELAND LIMITED SENIOR EXECUTI",
            "further_information": "RIGHT TITLE BENEFIT AND INTEREST IN ANDTO THE ACCOUNT BEING THE EURO DESIGNATED ACCOUNT IN THE NAME OF THE COMPANY WITH SORT CODE 40-05-15 ACCOUNT NUMBER 67851117, AND THE DEPOSIT. SEE IMAGE FOR FULL DETAILS"
        },
        //...
    ],
    "previous_company_names": [
        {
            "name": "TESCO STORES (HOLDINGS) PUBLIC LIMITED COMPANY",
            "period": "25-08-1983"
        }
    ],
    "previous_directorships": [],
    "share_capital_structure": {
        "issued_capital": 408708024.05,
        "nominal_capital": null,
        "issued_capital_currency": "GBP",
        "number_of_shares_issued": 8174160481,
        "nominal_capital_currency": null
    },
    "ccj_summarised_defendant": [],
    "ccj_summarised_plaintiff": [],
    "financials_balance_sheet": {
        "cash": [
            {
                "dynamics": 6.2,
                "indicator": [
                    "24-02-2018",
                    4059000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "stock": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    2301000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "net_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    6438000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "fixed_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    30804000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "total_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    45877000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "trade_debtors": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    697000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "bank_overdraft": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    912000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "current_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    15073000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "tangible_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    18108000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "trade_creditors": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    4914000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "intangible_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    2717000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "total_liabilities": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    39439000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "total_fixed_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    30804000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "current_liabilities": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    19405000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "investment_and_other": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    9979000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "other_long_term_financing": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    2986000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "other_short_term_financing": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    8584000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "total_long_term_liabilities": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    20034000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "miscellaneous_current_liabilities": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    4995000000.0
                ],
                "consolidated": true
            },
            //...
        ]
    },
    "group_structure_extended": [
        {
            "level": 0,
            "status": "Active",
            "address": null,
            "turnover": null,
            "net_worth": null,
            "company_name": "TESCO PLC",
            "registered_number": "00445790",
            "registered_country": "GB",
            "percent_of_ownership": null,
            "latest_annual_accounts": "27-02-2021"
        },
        //...
    ],
    "financials_kpis_and_ratios": {
        "net_margin": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.001037251640824794
                ],
                "consolidated": true
            },
            //...
        ],
        "gross_margin": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.05189834933919917
                ],
                "consolidated": true
            },
            //...
        ],
        "current_ratio": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.78
                ],
                "consolidated": true
            },
            //...
        ],
        "ebitda_margin": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.047338018849366024
                ],
                "consolidated": true
            },
            //...
        ],
        "debt_to_capital": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.8596682433463392
                ],
                "consolidated": true
            },
            //...
        ],
        "liquidity_ratio": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.66
                ],
                "consolidated": true
            },
            //...
        ],
        "gearing_net_debt": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    3.9933209071140108
                ],
                "consolidated": true
            },
            //...
        ],
        "return_on_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.02216797087865379
                ],
                "consolidated": true
            },
            //...
        ],
        "return_on_equity": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.009009009009009009
                ],
                "consolidated": true
            },
            //...
        ],
        "consolidated_a_cs": [
            {
                "date": "25-02-2017",
                "value": true
            },
            //...
        ],
        "gearing_liability": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    6.125970798384592
                ],
                "consolidated": true
            },
            //...
        ],
        "gearing_gross_debt": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    4.586828207517863
                ],
                "consolidated": true
            },
            //...
        ],
        "cash_turnover_ratio": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.06833342275157823
                ],
                "consolidated": true
            },
            //...
        ],
        "cash_to_total_assets": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.08328792205244458
                ],
                "consolidated": true
            },
            //...
        ],
        "pre_tax_profit_margin": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.26
                ],
                "consolidated": true
            },
            //...
        ],
        "operating_profit_margin": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.01818767101239337
                ],
                "consolidated": true
            },
            //...
        ],
        "inventory_turnover_ratio": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    4.12
                ],
                "consolidated": true
            },
            //...
        ],
        "return_on_capital_employed": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.55
                ],
                "consolidated": true
            },
            //...
        ],
        "cash_to_current_liabilities_ratio": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.1969080133986086
                ],
                "consolidated": true
            },
            //...
        ]
    },
    "financials_misc_indicators": {
        "goodwill": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    null
                ],
                "consolidated": true
            },
            //...
        ],
        "pensions": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.0
                ],
                "consolidated": true
            },
            //...
        ],
        "audit_fees": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    6000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "derivatives": "",
        "auditor_fees": "",
        "equity_shares": "",
        "all_other_income": "",
        "customer_accounts": "",
        "deposits_by_banks": "",
        "dividends_payable": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.0
                ],
                "consolidated": true
            },
            //...
        ],
        "contingent_liability": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    "YES"
                ],
                "consolidated": true
            },
            //...
        ],
        "employee_remuneration": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    6051000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "financial_liabilities": "",
        "interest_bearing_loans": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    9330000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "amortisation_of_intangibles": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    299000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "fees_and_commission_expense": "",
        "interest_and_similar_income": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    null
                ],
                "consolidated": true
            },
            //...
        ],
        "loans_and_advances_to_banks": "",
        "interest_and_similar_expense": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    1015000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "loans_and_advances_to_customers": "",
        "derivative_financial_instruments": "",
        "cash_and_balances_at_central_banks": "",
        "available_for_sale_financial_assets": "",
        "treasury_bill_and_other_eligible_bills": "",
        "items_in_the_course_of_collection_from_other_banks": "",
        "items_in_the_course_of_transmission_from_other_banks": ""
    },
    "financials_profit_and_loss": {
        "weeks": [
            {
                "date": "25-02-2017",
                "value": 52
            },
            //...
        ],
        "export": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    null
                ],
                "consolidated": true
            },
            //...
        ],
        "currency": [
            {
                "date": "25-02-2017",
                "value": "GBP"
            },
            //...
        ],
        "taxation": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    -87000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "audit_fees": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    6000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "depreciation": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    1331000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "gross_profit": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    2902000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "pre_tax_profit": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    145000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "retained_profit": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    -40000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "operating_profit": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    1017000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "profit_after_tax": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    58000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "consolidated_a_cs": [
            {
                "date": "25-02-2017",
                "value": true
            },
            //...
        ],
        "dividends_payable": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.0
                ],
                "consolidated": true
            },
            //...
        ],
        "interest_payments": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    1015000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "wages_and_salaries": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    6051000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "directors_emoluments": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    7800000.0
                ],
                "consolidated": true
            },
            //...
        ]
    },
    "group_structure_affiliated": [],
    "current_company_secretaries": [
        {
            "job": "Company Secretary",
            "name": "Mr Robert John Welch",
            "title": "Mr",
            "period": null,
            "address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, AL7 1GA",
            "nationality": null,
            "date_of_birth": null,
            "appointment_date": "10-08-2016",
            "current_appointments": 1
        }
    ],
    "group_structure_subsidiaries": [
        {
            "level": null,
            "status": "Active",
            "address": null,
            "turnover": null,
            "net_worth": null,
            "company_name": "TESCO TRUSTEE COMPANY OF IRELAND DESIGNATED ACTIVITY COMPANY",
            "registered_number": "IE096453",
            "registered_country": "IE",
            "latest_annual_accounts": null
        },
        //...
    ],
    "previous_company_secretaries": [],
    "financials_capital_and_reserves": {
        "equity_paid_up": "",
        "sundry_reserves": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    5697000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "capital_employed": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    26472000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "interest_payments": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    1015000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "shareholder_funds": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    6438000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "revaluation_reserve": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    0.0
                ],
                "consolidated": true
            },
            //...
        ],
        "called_up_share_capital": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    409000000.0
                ],
                "consolidated": true
            },
            //...
        ],
        "p_and_l_account_reserve": [
            {
                "dynamics": null,
                "indicator": [
                    "25-02-2017",
                    332000000.0
                ],
                "consolidated": true
            },
            //...
        ]
    },
    "financials_growth_and_industry_comparison": {
        "net_assets": [
            {
                "date": "2017 vs 2016",
                "value": null
            },
            //...
        ],
        "total_assets": [
            {
                "date": "2017 vs 2016",
                "value": null
            },
            //...
        ],
        "current_ratio": [
            {
                "date": "2017 vs 2016",
                "value": null
            },
            //...
        ],
        "debt_to_capital": [
            {
                "date": "2017 vs 2016",
                "value": null
            },
            //...
        ],
        "working_capital": [
            {
                "date": "2017 vs 2016",
                "value": null
            },
            //...
        ],
        "consolidated_a_cs": [
            {
                "date": "25-02-2017",
                "value": true
            },
            //...
        ],
        "total_liabilities": [
            {
                "date": "2017 vs 2016",
                "value": null
            },
            //...
        ]
    },
    "name": "TESCO PLC",
    "nr": 634
}

Get Credit Report by ID

GET https://api.zephira.ai/v2/credit-report/report/{format}/{report_id}

Get Credit Report by ID

Parameters

Parameter	In	Type	Required	Description
format	url	string	true	Format response (json or html)
report_id	url	int	true	Report Id

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/credit-report/report/json/52',
                 headers = headers)

print(r.json())

Request example

{
    "report_id": 52
}

Success Response

{
    "id": 52,
    "name": "TESCO PLC",
    "source_id": "GB-0-00445790",
    "url": null,
    "expired": false,
    "date_created": "2021-09-30T07:09:57.081437Z",
    "address": {
        "province": null,
        "post_code": "AL7 1GA",
        "city": "WELWYN GARDEN CITY",
        "text": "TESCO HOUSE SHIRE PARK, KESTREL WAY, WELWYN GARDEN CITY, AL7 1GA, WELWYN GARDEN CITY, None, AL7 1GA, GB",
        "street": "TESCO HOUSE SHIRE PARK, KESTREL WAY, WELWYN GARDEN CITY, AL7 1GA"
    },
    "status": "finish",
    "registration_number": "00445790"
}

Purchased Credit Report

GET https://api.zephira.ai/v2/credit-report/purchased

Purchased Credit Reports. Here you can review the previously Generated Credit Reports as well as access them without using your allotted credits.

Parameters

Parameter	In	Type	Required	Description
search	body	string	false	Company Name
page	body	int	false	Page
per_page	body	int	false	Per Page

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/credit-report/purchased', params={
        "page": 1,
        "per_page": 10,
        "search": "tesco"
    }, headers = headers)

print(r.json())

Request example

{
    "page": 1,
    "per_page": 10,
    "search": "tesco"
}

Success Response

{
    "data": [
        {
            "id": 31,
            "name": "TESCO PLC",
            "source_id": "GB-0-00445790",
            "url": "/api/exports/file/token",
            "expired": false,
            "date_created": "2021-09-16T08:08:13.951869Z",
            "address": {
                "city": "WELWYN GARDEN CITY",
                "text": "TESCO HOUSE SHIRE PARK, KESTREL WAY, WELWYN GARDEN CITY, AL7 1GA, WELWYN GARDEN CITY, None, AL7 1GA, None",
                "street": "TESCO HOUSE SHIRE PARK, KESTREL WAY, WELWYN GARDEN CITY, AL7 1GA",
                "province": null,
                "post_code": "AL7 1GA"
            },
            "status": "finish",
            "registration_number": "00445790"
        }
    ],
    "total_results": 1,
    "pages": 1
}

Nomenclatures API

Everything about nomenclatures

Seniority

GET https://api.zephira.ai/v2/nomenclatures/seniority

Get GlobalDatabase Seniority

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/nomenclatures/seniority',
                 headers = headers)

print(r.json())

Success Response

[
    {
        "id": 1377,
        "name": "CXO",
        "has_children": false,
        "active": true
    },
    {
        "id": 1379,
        "name": "Director",
        "has_children": false,
        "active": true
    },
    //...
]

Department

GET https://api.zephira.ai/v2/nomenclatures/department

Get GlobalDatabase Department

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/nomenclatures/seniority',
                 headers = headers)

print(r.json())

Success Response

[
    {
        "id": 1377,
        "name": "CXO",
        "has_children": false,
        "active": true
    },
    {
        "id": 1379,
        "name": "Director",
        "has_children": false,
        "active": true
    },
    //...
]

Activity Type

GET https://api.zephira.ai/v2/nomenclatures/activity-type

Get GlobalDatabase Activity Type

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/nomenclatures/activity-type',
                 headers = headers)

print(r.json())

Success Response

[
    {
        "id": 4591902,
        "parents": "4591902",
        "name": "Distributor",
        "has_children": false,
        "active": true
    },
    {
        "id": 4591903,
        "parents": "4591903",
        "name": "Producer",
        "has_children": false,
        "active": true
    },
    {
        "id": 4591904,
        "parents": "4591904",
        "name": "Service Provider",
        "has_children": false,
        "active": true
    }
]

Company Type

GET https://api.zephira.ai/v2/nomenclatures/company-type

Get GlobalDatabase Company Type

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/nomenclatures/company-type',
                 headers = headers)

print(r.json())

Success Response

[
    {
        "id": 1501926,
        "parents": "1501926",
        "name": "Branch",
        "has_children": false,
        "active": true
    },
    {
        "id": 1501925,
        "parents": "1501925",
        "name": "Head Office",
        "has_children": false,
        "active": true
    }
]

Company Status

GET GET https://api.zephira.ai/v2/nomenclatures/company-status

Get GlobalDatabase Company Status

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/nomenclatures/company-status',
                 headers = headers)

print(r.json())

Success Response

[
    {
        "id": 106,
        "parents": "106",
        "name": "Active",
        "has_children": false,
        "active": true
    },
    {
        "id": 108,
        "parents": "108",
        "name": "Inactive",
        "has_children": false,
        "active": true
    },
    {
        "id": 1615,
        "parents": "1615",
        "name": "Intermediate",
        "has_children": false,
        "active": true
    }
]

Legal Form

GET https://api.zephira.ai/v2/nomenclatures/legal-form

Get GlobalDatabase Legal Form

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/nomenclatures/legal-form',
                 headers = headers)

print(r.json())

Success Response

[
    {
        "id": 4024357,
        "parents": "4024357",
        "name": "Charitable Incorporated Organisation",
        "has_children": false,
        "active": true
    },
    {
        "id": 4024362,
        "parents": "4024362",
        "name": "Co-operative Society",
        "has_children": false,
        "active": true
    },
    {
        "id": 4024359,
        "parents": "4024359",
        "name": "Community Benefit Society",
        "has_children": false,
        "active": true
    },
    //...
]

Industry Focus

GET https://api.zephira.ai/v2/nomenclatures/industry-focus

Get GlobalDatabase Industry Focus

Parameters

Parameter	In	Type	Required	Description
parent	params	int	false	Parent Id

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/nomenclatures/industry-focus',
                 headers = headers)

print(r.json())

Success Response

[
    {
        "id": 4564019,
        "parents": "4564019",
        "name": "Agriculture",
        "has_children": true,
        "active": true
    },
    {
        "id": 4564002,
        "parents": "4564002",
        "name": "Automotive",
        "has_children": true,
        "active": true
    },
    {
        "id": 4563183,
        "parents": "4563183",
        "name": "Beverages",
        "has_children": true,
        "active": true
    },
    //...
]

International SIC Code

GET https://api.zephira.ai/v2/nomenclatures/isic

Get GlobalDatabase International SIC Code

Parameters

Parameter	In	Type	Required	Description
parent	params	int	false	Parent Id

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/nomenclatures/isic',
                 headers = headers)

print(r.json())

Success Response

[
    {
        "id": 4591135,
        "parents": "4591135",
        "name": "A - Agriculture",
        "has_children": true,
        "active": true
    },
    {
        "id": 4591190,
        "parents": "4591190",
        "name": "B - Mining and quarrying",
        "has_children": true,
        "active": true
    },
    {
        "id": 4591220,
        "parents": "4591220",
        "name": "C - Manufacturing",
        "has_children": true,
        "active": true
    },
    //...
]

NACE Rev. 2

GET https://api.zephira.ai/v2/nomenclatures/nace

Get GlobalDatabase NACE Rev. 2

Parameters

Parameter	In	Type	Required	Description
parent	params	int	false	Parent Id

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/nomenclatures/nace',
                 headers = headers)

print(r.json())

Success Response

[
    {
        "id": 4583537,
        "parents": "4583537",
        "name": "A - AGRICULTURE, FORESTRY AND FISHING",
        "has_children": true,
        "active": true
    },
    {
        "id": 4583593,
        "parents": "4583593",
        "name": "B - MINING AND QUARRYING",
        "has_children": true,
        "active": true
    },
    {
        "id": 4583624,
        "parents": "4583624",
        "name": "C - MANUFACTURING",
        "has_children": true,
        "active": true
    },
    //...
]

Country SIC Codes

GET https://api.zephira.ai/v2/nomenclatures/sic/{country_code}

Get GlobalDatabase Country SIC Codes

Parameters

Parameter	In	Type	Required	Description
country_code	url	string	true	Country Code
parent	params	int	false	Parent Id

Countries SIC Codes

Country Code	Name
no	Norway SIC Code
de	Germany SIC Code
fr	France SIC Code
se	Sweden SIC Code
lu	Luxembourg SIC Code
it	Italy SIC Code
dk	Denmark SIC Code
gb	United Kingdom SIC Code
be	Belgium SIC Code
ie	Ireland SIC Code
nl	Netherlands SIC Code
sg	Singapore SIC Code
us	United States of America SIC Code
ca	Canada SIC Code
mx	Mexico SIC Code
anz	ANZ SIC Code

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/nomenclatures/sic/gb',
                 headers = headers)

print(r.json())

Success Response

[
    {
        "id": 3968625,
        "parents": "3968625",
        "name": "A - Agriculture, forestry and fishing",
        "has_children": true,
        "active": true
    },
    {
        "id": 3968690,
        "parents": "3968690",
        "name": "B - Mining and quarrying",
        "has_children": true,
        "active": true
    },
    {
        "id": 3968721,
        "parents": "3968721",
        "name": "C - Manufacturing",
        "has_children": true,
        "active": true
    },
    //...
]

Countries

GET https://api.zephira.ai/v2/nomenclatures/country

Get GlobalDatabase Countries

Parameters

Parameter	In	Type	Required	Description
parent	params	int	false	Parent Id

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/nomenclatures/country',
                 headers = headers)

print(r.json())

Success Response

[
    {
        "id": 4004115,
        "parents": "1463712_4004115",
        "name": "Afghanistan",
        "has_children": true,
        "active": true
    },
    {
        "id": 1547645,
        "parents": "1219916_1547645",
        "name": "Albania",
        "has_children": true,
        "active": true
    },
    {
        "id": 4367081,
        "parents": "4292987_4367081",
        "name": "Algeria",
        "has_children": true,
        "active": true
    },
    //...
]

Regions

GET https://api.zephira.ai/v2/nomenclatures/region

Get GlobalDatabase Regions

Parameters

Parameter	In	Type	Required	Description
parent	params	int	false	Parent Id

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/nomenclatures/region',
                 headers = headers)

print(r.json())

Success Response

[
    {
        "id": 4292987,
        "parents": "4292987",
        "name": "Africa",
        "has_children": true,
        "active": true
    },
    {
        "id": 1463712,
        "parents": "1463712",
        "name": "Asia",
        "has_children": true,
        "active": true
    },
    {
        "id": 4249245,
        "parents": "4249245",
        "name": "Central America",
        "has_children": true,
        "active": true
    },
    //...
]

States US & CA

GET https://api.zehira.ai/v2/nomenclatures/states

Get GlobalDatabase States

Parameters

Parameter	In	Type	Required	Description
country	params	string	True	Country Code US or CA

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/nomenclatures/states', params={
        "country": "US"
    }, headers = headers)

print(r.json())

Success Response

{
    "AL": "Alabama",
    "AK": "Alaska",
    "AS": "American Samoa",
    "AZ": "Arizona",
    "AR": "Arkansas",
    "CA": "California",
    "CO": "Colorado",
    "CT": "Connecticut",
    "DE": "Delaware",
    "DC": "District Of Columbia",
    "FL": "Florida",
    "GA": "Georgia",
    "GU": "Guam",
    "HI": "Hawaii",
    "ID": "Idaho",
    "IL": "Illinois",
    "IN": "Indiana",
    "IA": "Iowa",
    "KS": "Kansas",
    "KY": "Kentucky",
    "LA": "Louisiana",
    "ME": "Maine",
    "MD": "Maryland",
    //...
}

Technologies

GET https://api.zephira.ai/v2/nomenclatures/technology

Get GlobalDatabase Technologies

Parameters

Parameter	In	Type	Required	Description
parent	params	int	false	Parent Id

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/nomenclatures/technology',
                 headers = headers)

print(r.json())

Success Response

[
    {
        "id": "c-36",
        "name": "Advertisement",
        "has_children": false
    },
    {
        "id": "c-134",
        "name": "Advertising",
        "has_children": true
    },
    {
        "id": "c-94",
        "name": "Advertising Solutions",
        "has_children": true
    },
    //...
]vvv

Currency

GET https://api.zephira.ai/v2/nomenclatures/currency

Get GlobalDatabase Currency

				
					Code samples

import requests

headers = {
  'Authorization': 'Token 00000000-0000-0000-0000-000000000000'
}

r = requests.get('https://api.zephira.ai/v2/nomenclatures/currency',
                 headers = headers)

print(r.json())

Success Response

[
    {
        "id": "GBP",
        "name": "GBP"
    },
    {
        "id": "EUR",
        "name": "EUR"
    },
    {
        "id": "USD",
        "name": "USD"
    },
    //...
]

– Advance contacts

Name
“have_email_address”
“have_telephone”

– Trading Activity

Name
“import”
“export”

– Ownership Parents

Name
“has_parents”
“has_no_parents”

– Website monthly visits

Name
“0-10000”
“1000-100000”
“100000-500000”
“500000-1000000”
“5000000”
“1000000-5000000”

– Alexa ranking

Name
“0-10000”
“1000-100000”
“100000-500000”
“500000-1000000”
“5000000”
“1000000-5000000”

– Only Select Companies That

Name
“have_email_address”
“have_telephone”
“have_fax”
“have_website”
“have_vat_number”
“have_registration_number”
“have_business_address”
“have_lat_and_long”

– Foreign Parent

Name
“has_a_foreign_parent”
“has_no_foreign_parent”

– Consolidated Accounts

Name
“consolidated”
“not_consolidated”