FirstLink API Products Documentation
Entity Reports
Entity Verification
Validates key details including company information, directors, and shareholders to ensure accurate identification and ownership mapping. Online Instant.
{
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [],
"properties": {
"entity_data": {
"order": 1,
"required": [
"entity_id",
"identity"
],
"properties": {
"entity": {
"$id": "https://firstlink.world/schemas/sections/identity.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Core identity information for an entity",
"order": 1,
"properties": {
"address_line_1": {
"description": "Primary address line",
"maxLength": 255,
"order": 4,
"type": "string"
},
"address_line_2": {
"description": "Secondary address line",
"maxLength": 255,
"order": 5,
"type": "string"
},
"address_line_3": {
"description": "Third address line",
"maxLength": 255,
"order": 6,
"type": "string"
},
"address_line_4": {
"description": "Fourth address line",
"maxLength": 255,
"order": 7,
"type": "string"
},
"city": {
"description": "City name",
"maxLength": 100,
"order": 9,
"type": "string"
},
"country": {
"description": "Country name",
"enum": [
"Malta",
"Italy",
"United Kingdom",
"Germany",
"France",
"Spain",
"Netherlands",
"Belgium"
],
"order": 11,
"type": "string"
},
"country_code": {
"description": "Country code",
"order": 12,
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"country_dial_code": {
"description": "country dial code",
"order": 15,
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"country_iso_a3": {
"description": "ISO 3-letter country code",
"order": 13,
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"country_iso_number": {
"description": "ISO number",
"order": 14,
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"county": {
"description": "County or region",
"maxLength": 100,
"order": 10,
"type": "string"
},
"entity_id": {
"description": "Unique entity identifier",
"maxLength": 50,
"order": 1,
"pattern": "^[A-Z]{2}[0-9]{10}$",
"type": "string"
},
"entity_name": {
"description": "Official entity name",
"maxLength": 255,
"minLength": 1,
"order": 2,
"type": "string"
},
"last_annual_return": {
"description": "Last Annual Return",
"order": 17,
"type": "string"
},
"last_approval_date": {
"description": "Last Approval Date",
"order": 19,
"type": "string"
},
"last_general_meeting": {
"description": "Last General Meeting date",
"order": 18,
"type": "string"
},
"postcode": {
"description": "Postal code",
"maxLength": 20,
"order": 8,
"type": "string"
},
"termination_reason": {
"description": "Reason for termination",
"order": 16,
"type": "string"
},
"trading_name": {
"description": "Trading or commercial name",
"maxLength": 255,
"order": 3,
"type": "string"
},
"number_of_employees": {
"order": 255,
"type": "string",
"description": "Number of employees"
}
},
"required": [
"entity_name",
"city",
"country"
],
"title": "Entity Identity Information",
"type": "object"
},
"registered_names": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 2,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"end_date": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"order": 4,
"type": [
"string",
"null"
],
"description": "Date of cancellation / struck off (YYYY-MM-DD)"
},
"status": {
"order": 2,
"type": "integer",
"enum": [
0,
1
],
"description": "Registered Name Status: 0 = inactive, 1 = active"
},
"name_type": {
"order": 5,
"type": "string",
"description": "Registered Name Type"
},
"name": {
"maxLength": 255,
"order": 7,
"type": "string",
"minLength": 1,
"description": "Registered Name"
},
"record_number": {
"order": 1,
"type": "integer",
"minimum": 1,
"description": "Sequential record identifier"
},
"start_date": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"order": 3,
"type": [
"string",
"null"
],
"description": "Date of registration / incorporation (YYYY-MM-DD)"
},
"name_code": {
"order": 6,
"type": "string",
"description": "Registered Name Code"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/registered_name.json",
"title": "Registered Name",
"description": "A registered name entry"
},
"type": "array",
"$id": "https://firstlink.world/schemas/sections/registered_names.json",
"title": "Registered Names",
"description": "Historical and current registered names for the entity",
"array_ordering": {
"order_fields": [
"record_number",
"name",
"status",
"name_type",
"name_code",
"start_date",
"end_date"
]
}
},
"registered_offices": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 3,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"registration_office": {
"order": 5,
"type": "string",
"description": "Name of the registration office"
},
"end_date": {
"order": 4,
"type": [
"string",
"null"
],
"description": "Date of cancellation / struck off (YYYY-MM-DD)"
},
"status": {
"order": 2,
"type": "integer",
"enum": [
0,
1
],
"description": "Registered office status: 0=inactive, 1=active"
},
"record_number": {
"order": 1,
"type": "integer",
"description": "Sequential record identifier"
},
"start_date": {
"order": 3,
"type": [
"string",
"null"
],
"description": "Date of registration / incorporation (YYYY-MM-DD)"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/registered_office.json",
"title": "Registered Offices",
"description": "Registration authority information"
},
"type": "array",
"$id": "https://firstlink.world/schemas/sections/registrations.json",
"title": "Registrations",
"description": "Registration authorities and offices",
"array_ordering": {
"order_fields": [
"record_number",
"registration_office",
"status",
"start_date",
"end_date"
]
}
},
"identifiers": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 4,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"id_key": {
"order": 7,
"type": "string",
"description": "Identification number",
"minLength": 1
},
"end_date": {
"order": 4,
"type": [
"string",
"null"
],
"description": "Date of cancellation / struck off (YYYY-MM-DD)"
},
"status": {
"order": 2,
"type": "integer",
"enum": [
0,
1
],
"description": "Identification number status: 0=inactive, 1=active"
},
"id_name": {
"order": 6,
"type": [
"string",
"null"
],
"description": "Identification number name"
},
"record_number": {
"order": 1,
"type": "integer",
"description": "Sequential record identifier"
},
"start_date": {
"order": 3,
"type": [
"string",
"null"
],
"description": "Date of registration / incorporation (YYYY-MM-DD)"
},
"id_type": {
"order": 5,
"type": "string",
"enum": [
"VAT",
"COM",
"REG",
"TAX"
],
"description": "Identification number type"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/identifier.json",
"title": "Identification Key",
"description": "Official identification number"
},
"type": "array",
"$id": "https://firstlink.world/schemas/sections/id_keys.json",
"title": "Identification numbers",
"description": "Official identification numbers and keys for the entity",
"array_ordering": {
"order_fields": [
"record_number",
"id_key",
"status",
"id_type",
"id_name",
"start_date",
"end_date"
]
}
},
"attributes": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 5,
"properties": {
"legal_forms": {
"order": 1,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"legal_form_type": {
"order": 4,
"type": "string",
"description": "Type of legal entity structure (e.g., Corporation, LLC, Partnership)"
},
"legal_form_code": {
"order": 3,
"type": "string",
"description": "Standardized code identifying the legal form type"
},
"end_date": {
"order": 6,
"type": [
"string",
"null"
],
"description": "Date when the legal form classification ended or became inactive"
},
"status": {
"order": 2,
"type": "string",
"description": "1 = Active, 0 = Inactive - indicates if the legal form is currently valid, other values also possible"
},
"record_number": {
"order": 1,
"type": "integer",
"description": "Sequential record identifier"
},
"start_date": {
"order": 5,
"type": [
"string",
"null"
],
"description": "Date when the legal form classification became effective"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/legal_form.json",
"title": "Legal Form",
"description": "Legal form classification"
},
"type": "array",
"description": "Legal Forms"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/sections/attributes.json",
"title": "Attributes",
"description": "Legal forms, company statuses, and other legal classifications"
},
"addresses": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 9,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"record_number",
"status",
"country_code",
"country"
],
"properties": {
"county": {
"order": 15,
"type": [
"string",
"null"
],
"description": "County or state"
},
"country": {
"order": 17,
"type": "string",
"description": "Country name"
},
"address_line_1": {
"maxLength": 255,
"order": 7,
"type": [
"string",
"null"
],
"description": "Primary address line"
},
"address_code": {
"order": 5,
"type": "string",
"description": "Address type code"
},
"country_code": {
"pattern": "^[A-Z]{2}$",
"order": 16,
"type": "string",
"description": "ISO 2-letter country code"
},
"street_name": {
"order": 11,
"type": [
"string",
"null"
],
"description": "Street name"
},
"end_date": {
"order": 4,
"type": [
"string",
"null"
],
"description": "Address validity end date"
},
"status": {
"order": 2,
"type": "integer",
"enum": [
0,
1
],
"description": "1 = Active, 0 = Inactive"
},
"address_line_2": {
"maxLength": 255,
"order": 8,
"type": [
"string",
"null"
],
"description": "Secondary address line"
},
"address_type": {
"order": 6,
"type": [
"string",
"null"
],
"description": "Address type description"
},
"city": {
"order": 14,
"type": [
"string",
"null"
],
"description": "City name"
},
"address_line_4": {
"maxLength": 255,
"order": 10,
"type": [
"string",
"null"
],
"description": "Fourth address line"
},
"address_line_3": {
"maxLength": 255,
"order": 9,
"type": [
"string",
"null"
],
"description": "Third address line"
},
"postcode": {
"order": 13,
"type": [
"string",
"integer",
"null"
],
"description": "Postal code"
},
"street_number": {
"order": 12,
"type": [
"string",
"null"
],
"description": "Street number"
},
"record_number": {
"order": 1,
"type": "integer",
"description": "Sequential record identifier",
"minimum": 1
},
"start_date": {
"order": 3,
"type": [
"string",
"null"
],
"description": "Address validity start date"
},
"full_address": {
"order": 18,
"type": [
"string",
"null"
],
"description": "Full address"
}
},
"type": "array",
"$id": "https://firstlink.world/schemas/types/address.json",
"title": "Address",
"description": "Physical or mailing address"
},
"type": "array",
"$id": "https://firstlink.world/schemas/sections/addresses.json",
"title": "Entity Addresses",
"description": "Physical and registered addresses for the entity",
"array_ordering": {
"order_fields": [
"record_number",
"status",
"start_date",
"end_date",
"address_code",
"address_type",
"full_address",
"address_line_1",
"address_line_2",
"address_line_3",
"address_line_4",
"street_name",
"street_number",
"postcode",
"city",
"county",
"country_code",
"country"
]
}
},
"financials": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 19,
"properties": {
"capital": {
"order": 88,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"capital_code": {
"order": 6,
"type": "string",
"description": "Capital code"
},
"capital_type": {
"order": 7,
"type": "string",
"description": "Capital type"
},
"paid_up": {
"order": 9,
"type": "number",
"description": "Paid up value",
"minimum": 0
},
"end_date": {
"order": 4,
"type": [
"string",
"null"
],
"description": "End date of the capital"
},
"status": {
"order": 2,
"type": "integer",
"enum": [
0,
1
],
"description": "Record status: 0=inactive, 1=active"
},
"capital_value": {
"order": 8,
"type": "number",
"description": "Capital value",
"minimum": 0
},
"currency": {
"order": 5,
"pattern": "^[A-Z]{3}$",
"type": "string",
"description": "Currency of the capital"
},
"record_number": {
"order": 1,
"type": "integer",
"description": "Sequential record identifier",
"minimum": 1
},
"start_date": {
"order": 3,
"type": [
"string",
"null"
],
"description": "Start date of the capital"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/capital.json",
"title": "Capital",
"description": "Capital structure information"
},
"type": "array",
"array_ordering": {
"order_fields": [
"capital_code",
"capital_type",
"paid_up",
"end_date",
"status",
"capital_value",
"currency",
"record_number",
"start_date"
]
}
},
"capital_shares": {
"order": 90,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"share_code": {
"order": 6,
"type": "string",
"description": "Share code"
},
"end_date": {
"order": 4,
"type": [
"string",
"null"
],
"description": "End date of the share"
},
"status": {
"order": 2,
"type": "integer",
"enum": [
0,
1
],
"description": "Record status: 0=inactive, 1=active"
},
"share_type": {
"order": 7,
"type": "string",
"description": "Share type"
},
"quantity": {
"order": 8,
"type": "number",
"description": "Quantity of the share",
"minimum": 0
},
"value": {
"order": 9,
"type": "number",
"description": "Value of the share",
"minimum": 0
},
"class": {
"order": 10,
"type": "number",
"description": "Class of the share",
"minimum": 0
},
"currency": {
"order": 5,
"pattern": "^[A-Z]{3}$",
"type": "string",
"description": "Currency of the share"
},
"record_number": {
"order": 1,
"type": "integer",
"description": "Sequential record identifier",
"minimum": 1
},
"start_date": {
"order": 3,
"type": [
"string",
"null"
],
"description": "Start date of the share"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/capital_share_item.json",
"title": "Capital Share Item",
"description": "Capital structure information"
},
"type": "array",
"array_ordering": {
"order_fields": [
"share_code",
"end_date",
"status",
"share_type",
"quantity",
"value",
"class",
"currency",
"record_number",
"start_date"
]
}
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/sections/financials.json",
"title": "Entity Financial Information",
"description": "Financial figures, capital information, and financial performance data for the entity"
},
"contact": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 8,
"properties": {
"phone_numbers": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 2,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"status": {
"order": 2,
"type": "integer",
"enum": [
0,
1
],
"description": "1 = Active 0 = Inactive"
},
"phone_number": {
"pattern": "^\\+?[0-9\\s\\-\\(\\)]+$",
"order": 4,
"type": "string",
"description": "Phone number including country prefix"
},
"label": {
"order": 3,
"type": "string",
"description": "Phone number type"
},
"record_number": {
"order": 1,
"type": "integer",
"description": "Sequential record identifier"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/phone_number.json",
"title": "Phone Number",
"description": "Phone contact information"
},
"type": "array",
"description": "Phones",
"array_ordering": {
"order_fields": [
"record_number",
"status",
"label",
"phone_number"
]
}
},
"email_addresses": {
"order": 1,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"status": {
"order": 2,
"type": "integer",
"enum": [
0,
1
],
"description": "1 = Active 0 = Inactive"
},
"email_address": {
"order": 4,
"type": "string",
"description": "Email Address",
"format": "email"
},
"label": {
"order": 3,
"type": "string",
"description": "Email type"
},
"record_number": {
"order": 1,
"type": "integer",
"description": "Sequential record identifier"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/email_address.json",
"title": "Email Address",
"description": "Email contact information"
},
"type": "array",
"description": "Emails",
"array_ordering": {
"order_fields": [
"record_number",
"status",
"label",
"email_address"
]
}
},
"website_addresses": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 4,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"status": {
"order": 1,
"type": "integer",
"enum": [
0,
1
],
"description": "1 = Active 0 = Inactive"
},
"url": {
"order": 2,
"type": "string",
"description": "Website URL"
},
"label": {
"order": 3,
"type": "string",
"description": "Website address lable"
},
"record_number": {
"order": 4,
"type": "integer",
"description": "Sequential record identifier"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/website_address.json",
"title": "Website Address",
"description": "Website address information"
},
"type": "array",
"description": "Website addresses",
"array_ordering": {
"order_fields": [
"record_number",
"status",
"label",
"url"
]
}
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/sections/contact.json",
"title": "Contact Information",
"description": "Entity contact details including phones, emails, etc."
},
"classification": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 10,
"properties": {
"industry_codes": {
"order": 6,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [],
"properties": {
"industry_code": {
"order": 2,
"maximum": 999999,
"type": "integer",
"description": "Industry classification code number",
"minimum": 1
},
"industry_text": {
"order": 3,
"type": "string",
"description": "Industry classification description",
"minLength": 1
},
"record_number": {
"order": 1,
"type": "integer",
"description": "Sequential record identifier"
}
},
"type": "array",
"$id": "https://firstlink.world/schemas/types/industry_code.json",
"title": "Industry Classification",
"description": "Industry classification"
},
"type": "array",
"description": "Array of industry classification codes",
"array_ordering": {
"order_fields": [
"record_number",
"industry_code",
"industry_text"
]
}
},
"business_lines": {
"order": 6,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"line_of_business_code": {
"order": 1,
"type": "integer",
"description": "Line of business classification code"
},
"line_of_business_text": {
"order": 2,
"type": "string",
"description": "Line of business description"
},
"record_number": {
"order": 3,
"type": "integer",
"description": ""
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/business_line.json",
"title": "Business Line",
"description": "Line of business classification"
},
"type": "array",
"description": "Business line classifications",
"array_ordering": {
"order_fields": [
"line_of_business_code",
"line_of_business_text",
"record_number"
]
}
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/sections/business_classification.json",
"title": "Business Classification",
"description": "Business activity classifications and industry codes"
},
"shareholders": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 13,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"full_name"
],
"properties": {
"origin": {
"order": 31,
"type": [
"string",
"null"
],
"description": "Origin"
},
"end_year": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"order": 6,
"type": [
"string",
"null"
],
"description": "End year of involvement"
},
"range_type": {
"order": 2,
"pattern": "^(\\d+(-\\d+)?%|100%)$",
"type": "string",
"description": "Shareholder percentage range"
},
"entity_type": {
"order": 3,
"type": "string",
"enum": [
"i",
"c",
"m"
],
"description": "Type (i=individual, c=corporate, m=mixed)"
},
"full_name": {
"maxLength": 255,
"order": 10,
"type": "string",
"description": "Full name of person/entity",
"minLength": 1
},
"entity_id": {
"order": 7,
"type": "string",
"description": "WorldBox Identification Number"
},
"in_capital": {
"order": 3,
"maximum": 100,
"type": "number",
"description": "Capital ownership percentage",
"minimum": 0
},
"nickname": {
"order": 14,
"type": [
"string",
"null"
],
"description": "Nickname"
},
"first_name": {
"order": 12,
"type": [
"string",
"null"
],
"description": "First name"
},
"end_date": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"order": 6,
"type": [
"string",
"null"
],
"description": "Start date of involvement"
},
"status": {
"order": 2,
"type": "integer",
"enum": [
0,
1
],
"description": "Record status: 0=inactive, 1=active"
},
"address_line_2": {
"order": 19,
"type": [
"string",
"null"
],
"description": "Address line 2"
},
"currency_code": {
"pattern": "^[A-Z]{3}$",
"order": 17,
"type": "string",
"description": "Currency code (ISO 4217, alpha 3-code)"
},
"in_voting_right": {
"order": 17,
"maximum": 100,
"type": "number",
"description": "Voting rights percentage",
"minimum": 0
},
"birth_date": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"order": 25,
"type": [
"string",
"null"
],
"description": "Birth date"
},
"last_name": {
"order": 13,
"type": [
"string",
"null"
],
"description": "Last name"
},
"died_date": {
"order": 28,
"type": [
"string",
"null"
]
},
"birth_year": {
"order": 26,
"maximum": 2100,
"type": [
"integer",
"null"
],
"description": "Birth year",
"minimum": 1900
},
"city": {
"order": 17,
"type": "string",
"description": "City of residence/incorporation"
},
"address_line_3": {
"order": 20,
"type": [
"string",
"null"
],
"description": "Address line 3"
},
"range_code": {
"order": 18,
"type": "string",
"description": "Ownership range code"
},
"record_number": {
"order": 1,
"type": "integer",
"description": "Sequential record identifier"
},
"amount": {
"multipleOf": 0.01,
"order": 16,
"type": "number",
"description": "Total amount of shares/warranty held",
"minimum": 0
},
"email": {
"order": 24,
"type": [
"string",
"null"
],
"description": "Email address",
"format": "email"
},
"county": {
"order": 22,
"type": [
"string",
"null"
],
"description": "County"
},
"died_year": {
"order": 28,
"type": [
"integer",
"null"
],
"description": "Died year"
},
"country": {
"order": 16,
"type": "string",
"description": "Country of residence/incorporation"
},
"died": {
"order": 27,
"type": "integer",
"enum": [
0,
1
],
"description": "Deceased flag (0=alive, 1=deceased)"
},
"start_year": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"order": 5,
"type": [
"string",
"null"
],
"description": "End year of involvement"
},
"level": {
"order": 4,
"type": "integer",
"description": "Ownership level",
"minimum": 0
},
"origin_countries": {
"order": 31,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"country_code"
],
"properties": {
"country_code": {
"type": "string",
"description": "Country code",
"order": 2
},
"country": {
"type": "string",
"description": "Country name",
"order": 3
},
"record_number": {
"type": "integer",
"description": "Sequential record identifier",
"minimum": 1,
"order": 1
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/origin_country.json",
"title": "Origin country",
"description": "Origin country"
},
"type": "array",
"description": "Origin countries",
"array_ordering": {
"order_fields": [
"record_number",
"country_code",
"country"
]
}
},
"address_line_1": {
"order": 18,
"type": [
"string",
"null"
],
"description": "Address line 1"
},
"direct": {
"order": 19,
"type": "integer",
"enum": [
0,
1
],
"description": "Relation type"
},
"country_code": {
"pattern": "^[A-Z]{2}$",
"order": 23,
"type": "string",
"description": "ISO 2-letter country code"
},
"gender": {
"order": 9,
"type": "string",
"enum": [
"M",
"F",
"C"
],
"description": "Gender (M=Male, F=Female, C=Corporate)"
},
"profession": {
"order": 28,
"type": [
"string",
"null"
],
"description": "Profession or business type"
},
"address_resident": {
"order": 18,
"type": [
"string",
"null"
],
"description": "Address Resident"
},
"quantity": {
"order": 15,
"type": "integer",
"description": "Quantity of shares held",
"minimum": 0
},
"local_name": {
"order": 15,
"type": [
"string",
"null"
],
"description": "Local name variant"
},
"currency": {
"order": 18,
"type": "string",
"description": "Currency name (ISO 4217, text)"
},
"reference_id": {
"order": 8,
"type": "string",
"description": "Reference ID"
},
"title": {
"order": 11,
"type": [
"string",
"null"
],
"description": "Title or position"
},
"postcode": {
"order": 21,
"type": [
"string",
"null"
],
"description": "ZIP/Postal code"
},
"start_date": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"order": 5,
"type": [
"string",
"null"
],
"description": "Start date of involvement"
},
"origin_city": {
"order": 31,
"type": [
"string",
"null"
],
"description": "Origin"
},
"full_address": {
"order": 21,
"type": [
"string",
"null"
],
"description": "Full Address"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/shareholder.json",
"title": "Shareholder",
"description": "Shareholder"
},
"type": "array",
"$id": "https://firstlink.world/schemas/sections/shareholders.json",
"title": "Shareholders Information",
"description": "Array of shareholders/persons with ownership",
"array_ordering": {
"order_fields": [
"record_number",
"range_type",
"status",
"entity_type",
"in_capital",
"level",
"start_year",
"start_date",
"end_year",
"end_date",
"entity_id",
"reference_id",
"gender",
"full_name",
"title",
"first_name",
"last_name",
"nickname",
"quantity",
"local_name",
"amount",
"country",
"currency_code",
"in_voting_right",
"city",
"full_address",
"range_code",
"address_line_1",
"address_resident",
"currency",
"address_line_2",
"direct",
"address_line_3",
"postcode",
"county",
"country_code",
"email",
"birth_date",
"birth_year",
"died",
"died_date",
"died_year",
"profession",
"origin",
"origin_countries",
"origin_city"
]
}
},
"management": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 15,
"properties": {
"directors": {
"order": 149,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"full_name"
],
"properties": {
"origin": {
"order": 31,
"type": [
"string",
"null"
],
"description": "Origin"
},
"end_year": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"order": 6,
"type": [
"string",
"null"
],
"description": "End year of involvement"
},
"range_type": {
"order": 154,
"pattern": "^(\\d+(-\\d+)?%|100%)$",
"type": "string",
"description": "Shareholder percentage range"
},
"entity_type": {
"order": 3,
"type": "string",
"enum": [
"i",
"c",
"m"
],
"description": "Type (i=individual, c=corporate, m=mixed)"
},
"full_name": {
"maxLength": 255,
"order": 10,
"type": "string",
"description": "Full name of person/entity",
"minLength": 1
},
"entity_id": {
"order": 7,
"type": "string",
"description": "WorldBox Identification Number"
},
"in_capital": {
"order": 4,
"maximum": 100,
"type": "number",
"description": "Capital ownership percentage",
"minimum": 0
},
"nickname": {
"order": 14,
"type": [
"string",
"null"
],
"description": "Nickname"
},
"signature_type": {
"order": 32,
"type": [
"string",
"null"
],
"description": "Type of signature authority"
},
"first_name": {
"order": 12,
"type": [
"string",
"null"
],
"description": "First name"
},
"end_date": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"order": 6,
"type": [
"string",
"null"
],
"description": "End date of involvement"
},
"status": {
"order": 2,
"type": "integer",
"enum": [
0,
1
],
"description": "Record status: 0=inactive, 1=active"
},
"signature_restriction": {
"order": 33,
"type": [
"string",
"null"
],
"description": "Restrictions on signature authority"
},
"address_line_2": {
"order": 19,
"type": [
"string",
"null"
],
"description": "Address line 2"
},
"in_voting_right": {
"order": 155,
"maximum": 100,
"type": "number",
"description": "Voting rights percentage",
"minimum": 0
},
"birth_date": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"order": 25,
"type": [
"string",
"null"
],
"description": "Birth date"
},
"last_name": {
"order": 13,
"type": [
"string",
"null"
],
"description": "Last name"
},
"died_date": {
"order": 28,
"type": [
"string",
"null"
]
},
"birth_year": {
"order": 26,
"maximum": 2100,
"type": [
"integer",
"null"
],
"description": "Birth year",
"minimum": 1900
},
"city": {
"order": 17,
"type": "string",
"description": "City of residence/incorporation"
},
"address_line_3": {
"order": 20,
"type": [
"string",
"null"
],
"description": "Address line 3"
},
"range_code": {
"order": 156,
"type": "string",
"description": "Ownership range code"
},
"record_number": {
"order": 1,
"type": "integer",
"description": "Sequential record identifier"
},
"email": {
"order": 24,
"type": [
"string",
"null"
],
"description": "Email address",
"format": "email"
},
"county": {
"order": 22,
"type": [
"string",
"null"
],
"description": "County"
},
"died_year": {
"order": 28,
"type": [
"integer",
"null"
],
"description": "Died year"
},
"warranty_currency": {
"pattern": "^[A-Z]{3}$",
"order": 34,
"type": [
"string",
"null"
],
"description": "Currency code for warranty amount (ISO 4217)"
},
"country": {
"order": 16,
"type": "string",
"description": "Country of residence/incorporation"
},
"died": {
"order": 27,
"type": "integer",
"enum": [
0,
1
],
"description": "Deceased flag (0=alive, 1=deceased)"
},
"start_year": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"order": 6,
"type": [
"string",
"null"
],
"description": "End year of involvement"
},
"signature_code": {
"order": 31,
"type": [
"string",
"null"
],
"description": "Code representing signature authority"
},
"level": {
"order": 4,
"type": "integer",
"description": "Ownership level",
"minimum": 0
},
"origin_countries": {
"order": 31,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"country_code"
],
"properties": {
"country_code": {
"type": "string",
"description": "Country code",
"order": 2
},
"country": {
"type": "string",
"description": "Country name",
"order": 3
},
"record_number": {
"type": "integer",
"description": "Sequential record identifier",
"minimum": 1,
"order": 1
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/origin_country.json",
"title": "Origin country",
"description": "Origin country"
},
"type": "array",
"description": "Origin countries",
"array_ordering": {
"order_fields": [
"record_number",
"country_code",
"country"
]
}
},
"address_line_1": {
"order": 18,
"type": [
"string",
"null"
],
"description": "Address line 1"
},
"direct": {
"order": 157,
"type": "integer",
"enum": [
0,
1
],
"description": "Relation type"
},
"country_code": {
"pattern": "^[A-Z]{2}$",
"order": 23,
"type": "string",
"description": "ISO 2-letter country code"
},
"gender": {
"order": 9,
"type": "string",
"enum": [
"M",
"F",
"C"
],
"description": "Gender (M=Male, F=Female, C=Corporate)"
},
"last_change_date": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"order": 30,
"type": [
"string",
"null"
],
"description": "Date of last change to director information (YYYY-MM-DD)"
},
"profession": {
"order": 28,
"type": [
"string",
"null"
],
"description": "Profession or business type"
},
"address_resident": {
"order": 18,
"type": [
"string",
"null"
],
"description": "Address Resident"
},
"local_name": {
"order": 15,
"type": [
"string",
"null"
],
"description": "Local name variant"
},
"reference_id": {
"order": 8,
"type": "string",
"description": "Reference ID"
},
"warranty_amount": {
"order": 35,
"type": [
"string",
"null"
],
"description": "Warranty or guarantee amount"
},
"title": {
"order": 11,
"type": [
"string",
"null"
],
"description": "Title or position"
},
"postcode": {
"order": 21,
"type": [
"string",
"null"
],
"description": "ZIP/Postal code"
},
"start_date": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"order": 5,
"type": [
"string",
"null"
],
"description": "Start date of involvement"
},
"functions": {
"order": 29,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"function_type"
],
"properties": {
"function_type": {
"type": "string",
"description": "Type of function or role",
"order": 3
},
"function_code": {
"type": "integer",
"description": "Numeric code representing the function type",
"order": 2
},
"record_number": {
"type": "integer",
"description": "Sequential record identifier",
"minimum": 1,
"order": 1
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/function.json",
"title": "Function",
"description": "Director or officer function/role within the company"
},
"type": "array",
"description": "Director functions - can be a single function or array of functions",
"array_ordering": {
"order_fields": [
"record_number",
"function_code",
"function_type"
]
}
},
"origin_city": {
"order": 31,
"type": [
"string",
"null"
],
"description": "Origin"
},
"full_address": {
"order": 21,
"type": [
"string",
"null"
],
"description": "Full Address"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/director.json",
"title": "Director",
"description": "Company director or officer"
},
"type": "array",
"description": "Array of Directors",
"array_ordering": {
"order_fields": [
"record_number",
"status",
"entity_type",
"in_capital",
"level",
"start_date",
"end_year",
"end_date",
"start_year",
"entity_id",
"reference_id",
"gender",
"full_name",
"title",
"first_name",
"last_name",
"nickname",
"local_name",
"country",
"city",
"full_address",
"address_line_1",
"address_resident",
"address_line_2",
"address_line_3",
"postcode",
"county",
"country_code",
"email",
"birth_date",
"birth_year",
"died",
"died_date",
"died_year",
"profession",
"functions",
"last_change_date",
"origin",
"signature_code",
"origin_countries",
"origin_city",
"signature_type",
"signature_restriction",
"warranty_currency",
"warranty_amount",
"range_type",
"in_voting_right",
"range_code",
"direct"
]
}
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/sections/management.json",
"title": "Management",
"description": "Entity Management details, Directors, Managers etc"
},
"security": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 25,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"record_number": {
"type": "integer",
"minimum": 1,
"order": 1,
"description": "Sequential record identifier"
},
"status": {
"type": "integer",
"enum": [
0,
1
],
"order": 2,
"description": "Record status: 0=inactive, 1=active"
},
"is_listed": {
"type": "integer",
"enum": [
0,
1
],
"order": 2,
"description": "Is listed on an exchange"
},
"start_date": {
"type": "string",
"order": 3,
"format": "date",
"description": "Date of registration/start of ownership (YYYY-MM-DD)"
},
"end_date": {
"type": "string",
"order": 4,
"format": "date",
"description": "Date of deregistration/end of ownership (YYYY-MM-DD)"
},
"ticker": {
"type": "string",
"order": 5,
"description": "ticker"
},
"isin": {
"type": "string",
"order": 6,
"description": "International Security Identifier Number"
},
"nsin": {
"type": "string",
"order": 7,
"description": "National Security Identifier Number (Switzerland=Valore, Germany=WKN, US=CUISIP etc.)"
},
"mic": {
"type": "string",
"order": 8,
"description": "ISO 10383 - Market Identifier Codes"
},
"main": {
"type": "string",
"order": 9,
"description": "1 = main market where the security is traded, 0= not the main market where the security is traded"
},
"market": {
"type": "string",
"order": 10,
"description": "Name of the Market / Stock Exchange"
},
"market_acronym": {
"type": "string",
"order": 11,
"description": "Acronym of the Market / Stock Exchange"
},
"operating_mic": {
"type": "string",
"order": 12,
"description": "Operating Market Identifier Code (ISO 10383)"
},
"operating_market": {
"type": "string",
"order": 13,
"description": "Name of the Operating Market / Stock Exchange"
},
"market_level": {
"type": "string",
"order": 14,
"description": "Market level of the MIC"
},
"country": {
"type": "string",
"order": 15,
"description": "Market Country description"
},
"country_code": {
"type": "string",
"order": 16,
"description": "Market Country code"
},
"city": {
"type": "string",
"order": 17,
"description": "Market City"
},
"website": {
"type": "string",
"order": 18,
"description": "website"
}
}
},
"type": "array",
"$id": "https://firstlink.world/schemas/sections/security.json",
"title": "Entity Security Information",
"description": "Securities, financial instruments, and investment-related information",
"array_ordering": {
"order_fields": [
"record_number",
"status",
"is_listed",
"start_date",
"end_date",
"ticker",
"isin",
"nsin",
"mic",
"main",
"market",
"market_acronym",
"operating_mic",
"operating_market",
"market_level",
"country",
"country_code",
"city",
"website"
]
}
}
},
"type": "object"
},
"metadata": {
"order": 2,
"properties": {
"language": {
"order": 3,
"type": "string",
"enum": [
"EN",
"MT",
"IT",
"DE",
"FR"
],
"description": "Data language code",
"default": "EN"
},
"extracted_date": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"order": 1,
"type": "string",
"description": "Date when data was extracted"
}
},
"type": "object",
"description": "Metadata information"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/entity_schema.json",
"description": "Standard Entity Data Schema - Main Entry Point"
}