FirstLink API Products Documentation
AML Check
PEPs/Sanctions
Check Businesses, individuals behind the business, Vessels and Aircraft for Politically Exposed Persons (PEPs), Sanctions and Adverse Media globally.
{
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [],
"properties": {
"request": {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://firstlink.world/schemas/sections/request.json",
"title": "Request",
"description": "Search request parameters and configuration",
"type": "object",
"order": 3,
"properties": {
"categories": {
"type": "array",
"order": 1,
"description": "Risk categories to search within",
"items": {
"type": "string",
"enum": [
"Sanctions",
"PEPs",
"Law Enforcement",
"Export Control",
"Delisted",
"Contract Debarment",
"Elevated Risk",
"Regulatory Enforcement",
"Adverse Media"
]
}
},
"name": {
"type": "string",
"order": 2,
"description": "Entity or individual name to search for"
},
"search_type": {
"type": "string",
"order": 3,
"description": "Type of search being performed",
"enum": [
"general_search",
"exact_match",
"fuzzy_search"
]
},
"entity_types": {
"type": "array",
"order": 4,
"description": "Types of entities to include in search",
"items": {
"type": "string",
"enum": [
"Individual",
"Entity",
"Vessel",
"Aircraft",
"Location",
"Media",
"Security"
]
}
},
"countries": {
"type": "array",
"order": 5,
"description": "Country filters for the search. If null all countries are searched",
"items": {
"type": "string",
"pattern": "^[A-Z]{2}$"
}
},
"citizenships": {
"type": "array",
"order": 6,
"description": "Citizenship filters for the search, If null all citizenships are searched",
"items": {
"type": "string",
"pattern": "^[A-Z]{2}$"
}
},
"customer_reference": {
"type": [
"string",
"null"
],
"order": 7,
"description": "Customer-provided reference identifier for this search"
},
"list_source_categories": {
"type": "array",
"order": 8,
"description": "Specific list source categories to search",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"search_type"
]
},
"response": {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://firstlink.world/schemas/sections/response.json",
"title": "Response",
"description": "Search response data containing results and metadata",
"type": "object",
"order": 4,
"properties": {
"total_results": {
"type": "integer",
"order": 1,
"description": "Total number of results found",
"minimum": 0
},
"results": {
"order": 2,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 1,
"properties": {
"entity_type": {
"order": 4,
"type": "string",
"enum": [
"Individual",
"Entity",
"Vessel",
"Aircraft",
"Location",
"Media",
"Security"
],
"description": "Type of entity"
},
"middle_name": {
"order": 12,
"type": [
"string",
"null"
],
"description": "Middle name (for individuals)"
},
"snippet": {
"order": 21,
"type": [
"string",
"null"
],
"description": "Brief text snippet"
},
"addresses": {
"order": 17,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"record_number",
"status",
"country_code",
"country"
],
"properties": {
"full_address": {
"order": 5,
"type": "string",
"description": "Full Address"
},
"county": {
"order": 16,
"type": [
"string",
"null"
],
"description": "County or state"
},
"country": {
"order": 18,
"type": "string",
"description": "Country name"
},
"address_line_1": {
"maxLength": 255,
"order": 8,
"type": [
"string",
"null"
],
"description": "Primary address line"
},
"address_code": {
"order": 6,
"type": "string",
"description": "Address type code"
},
"country_code": {
"pattern": "^[A-Z]{3}$",
"order": 17,
"type": "string",
"description": "ISO 2-letter country code"
},
"status": {
"order": 2,
"type": "integer",
"enum": [
0,
1
],
"description": "1 = Active, 0 = Inactive"
},
"end_date": {
"order": 4,
"type": [
"string",
"null"
],
"description": "Address validity end date"
},
"street_name": {
"order": 12,
"type": [
"string",
"null"
],
"description": "Street name"
},
"address_line_2": {
"maxLength": 255,
"order": 9,
"type": [
"string",
"null"
],
"description": "Secondary address line"
},
"address_type": {
"order": 7,
"type": [
"string",
"null"
],
"description": "Address type description"
},
"city": {
"order": 15,
"type": [
"string",
"null"
],
"description": "City name"
},
"address_line_4": {
"maxLength": 255,
"order": 11,
"type": [
"string",
"null"
],
"description": "Fourth address line"
},
"address_line_3": {
"maxLength": 255,
"order": 10,
"type": [
"string",
"null"
],
"description": "Third address line"
},
"record_number": {
"order": 1,
"type": "integer",
"description": "Sequential record identifier",
"minimum": 1
},
"street_number": {
"order": 13,
"type": [
"string",
"null"
],
"description": "Street number"
},
"postcode": {
"order": 14,
"type": [
"string",
"integer",
"null"
],
"description": "Postal code"
},
"start_date": {
"order": 3,
"type": [
"string",
"null"
],
"description": "Address validity start date"
}
},
"type": "array",
"$id": "https://firstlink.world/schemas/types/address.json",
"title": "Address",
"description": "Physical or mailing address"
},
"type": [
"array",
"null"
],
"description": "Associated addresses"
},
"source": {
"order": 5,
"type": "string",
"description": "Data source name"
},
"dobs": {
"order": 8,
"items": {
"type": "string",
"format": "date"
},
"type": "array",
"description": "Dates of birth"
},
"last_updated": {
"order": 24,
"type": "string",
"description": "Last update timestamp (ISO 8601 format)",
"format": "date-time"
},
"pobs": {
"order": 16,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 1,
"properties": {
"city": {
"order": 1,
"type": "string",
"description": "City"
},
"address": {
"order": 2,
"type": "string",
"description": "Address"
},
"country": {
"order": 3,
"type": "string",
"description": "Country"
},
"country_code": {
"pattern": "^[A-Z]{3}$",
"order": 4,
"type": "string",
"description": "Country code"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/pob.json",
"title": "Pob",
"description": "Place of birth"
},
"type": [
"array",
"null"
],
"description": "Places of birth"
},
"maiden_name": {
"order": 13,
"type": [
"string",
"null"
],
"description": "Maiden name (for individuals)"
},
"lists": {
"order": 6,
"items": {
"type": "string"
},
"type": "array",
"description": "List classifications for this record"
},
"first_name": {
"order": 10,
"type": [
"string",
"null"
],
"description": "First name (for individuals)"
},
"record_uuid": {
"order": 1,
"type": "string",
"description": "Unique identifier for the record",
"format": "uuid"
},
"article": {
"order": 22,
"type": [
"string",
"null"
],
"description": "Full article text"
},
"url": {
"order": 19,
"type": [
"string",
"null"
],
"description": "URL reference",
"format": "uri"
},
"low_quality_name": {
"order": 9,
"type": "boolean",
"description": "Indicates if the name quality is considered low"
},
"citizenships": {
"order": 7,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 1,
"properties": {
"country": {
"order": 1,
"type": "string",
"description": "Country"
},
"country_code": {
"pattern": "^[A-Z]{3}$",
"order": 2,
"type": "string",
"description": "Country code"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/citizenship.json",
"title": "Citizenship",
"description": "Citizenship country"
},
"type": [
"array",
"null"
],
"description": "Citizenship countries"
},
"nick_name": {
"order": 14,
"type": [
"string",
"null"
],
"description": "Nickname or alias"
},
"last_name": {
"order": 11,
"type": [
"string",
"null"
],
"description": "Last name (for individuals)"
},
"relationships": {
"order": 18,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 1,
"properties": {
"relation": {
"type": "string",
"description": "Type of relationship"
},
"name": {
"type": "string",
"description": "Name of related entity"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/relationship.json",
"title": "Related Entity",
"description": "Related entity information"
},
"type": "array",
"description": "Related entities and their relationship types"
},
"name": {
"order": 3,
"type": "string",
"description": "Primary name of the entity or individual"
},
"name_aliases": {
"order": 15,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 1,
"properties": {
"middle_name": {
"type": [
"string",
"null"
],
"description": "Middle name component"
},
"full_name": {
"type": "string",
"description": "Full alternative name"
},
"maiden_name": {
"type": [
"string",
"null"
],
"description": "Maiden name component"
},
"first_name": {
"type": [
"string",
"null"
],
"description": "First name component"
},
"low_quality_name": {
"type": "boolean",
"description": "Quality indicator for this name"
},
"last_name": {
"type": [
"string",
"null"
],
"description": "Last name component"
},
"nick_name": {
"type": [
"string",
"null"
],
"description": "Nickname component"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/name_alias.json",
"title": "Result Record",
"description": "Alternative name entry"
},
"type": "array",
"description": "Alternative names and aliases"
},
"title": {
"order": 20,
"type": [
"string",
"null"
],
"description": "Title or position"
},
"record_number": {
"order": 2,
"type": "string",
"description": "Record identification number"
},
"additional_info": {
"order": 23,
"items": {
"$schema": "http://json-schema.org/draft-07/schema#",
"order": 1,
"properties": {
"values": {
"items": {
"type": "string"
},
"type": "array",
"description": "Array of values for this label"
},
"label": {
"type": "string",
"description": "Information label/category"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/additional_info_item.json",
"title": "Additional Information Item",
"description": "Additional information key-value group"
},
"type": "array",
"description": "Additional structured information"
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/types/result_record.json",
"title": "Result Record",
"description": "Individual search result record"
},
"type": "array",
"description": "Array of search result records"
},
"extracted_at": {
"type": "string",
"order": 3,
"description": "Timestamp when the data was extracted (ISO 8601 format)",
"format": "date-time"
}
},
"required": []
}
},
"type": "object",
"$id": "https://firstlink.world/schemas/entity_schema.json",
"description": "Standard Entity Data Schema - Main Entry Point"
}