stable
Search Profile
Search and retrieve unified entity profiles from the AML database.
GET
{AML_CORE_URL}/amlcore/api/v1/search-profileDescription
This endpoint searches the AML database for entity profiles matching the provided criteria. It uses fuzzy matching to find similar names and can search across all entity types.
Required Criterion
At least one of
fullName or documentNumber must be provided — calling with no search criteria returns a 400 Bad Request.Query Parameters
All parameters are passed as query string parameters (not request body). Values must be URL-encoded.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| fullName | string | Optional | Name to search for | — |
| nationalityCodes | string[] | Optional | ISO 3166-1 alpha-2 country codes | — |
| dob | string | Optional | Date of birth filter (YYYY-MM-DD) | — |
| documentNumber | string | Optional | Government-issued ID number | — |
| entityTypes | string[] | Optional | Accepted values: INDIVIDUAL, ORGANIZATION (case-insensitive) | — |
| watchlistCategories | string[] | Optional | Filter by watchlist category: SANCTION, PEP, ADVERSE_MEDIA, INTERNAL | — |
| riskLevels | string[] | Optional | Filter by risk level: LOW, MEDIUM, HIGH, CRITICAL | — |
| cursor | string | Optional | Pagination cursor from previous response | — |
| limit | integer | Optional | Results per page (default: 20, max: 100) | — |
URL Encoding
Query parameter values with spaces or special characters must be URL-encoded (e.g.,
fullName=John+Smith or fullName=John%20Smith). The cURL example below uses + for spaces.Example Request
cURL
curl "AML_CORE/amlcore/api/v1/search-profile?fullName=John+Smith&limit=10" \
-H "Authorization: Bearer fl_live_abc123"Example Response
JSON
{
"timestamp": "2026-06-02T08:23:48.197956273Z",
"status": 200,
"message": "Profiles searched",
"correlationId": "fl-srch-abc123",
"data": {
"items": [
{
"profileId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"gender": "NOT_APPLICABLE",
"watchlistStatus": "ACTIVE",
"riskLevel": "HIGH",
"recencyScore": 0.98,
"schemaRef": null,
"names": [
{
"nameId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"fullNameRaw": "Acme Corporation Global Holdings Ltd.",
"fullNameNormalized": "ACME CORPORATION GLOBAL HOLDINGS LTD",
"nameType": "PRIMARY",
"scriptCode": "latn"
},
{
"nameId": "ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj",
"fullNameRaw": "Acme Corp Global Holdings",
"fullNameNormalized": "ACME CORP GLOBAL HOLDINGS",
"nameType": "ALIAS",
"scriptCode": "latn"
}
],
"addresses": [
{
"addressId": "kkkkkkkk-llll-mmmm-nnnn-oooooooooooo",
"addressRaw": "123 Business Park Drive, Suite 400, Metro City, 90210, US",
"addressType": "REGISTERED",
"stateProvince": "California",
"city": "Metro City",
"street": "123 Business Park Drive, Suite 400, 90210",
"premises": null,
"postalCode": "90210",
"country": "US"
}
],
"sources": [
{
"profileSourceLinkId": "pppppppp-qqqq-rrrr-ssss-tttttttttttt",
"watchlistId": "uuuuuuuu-vvvv-wwww-xxxx-yyyyyyyyyyyy",
"externalReferenceId": "EXT-REF-001-ABC",
"listingDate": "2023-06-15",
"removalDate": null,
"contexts": [
{
"contextId": "zzzzzzzz-aaaa-bbbb-cccc-dddddddddddd",
"schemaName": "Sanction",
"startDate": "2023-06-15",
"endDate": null,
"country": "us",
"authority": "National Financial Sanctions Authority",
"isActive": true,
"properties": {
"program": ["sanctions_program_a", "sanctions_program_b"],
"sourceUrls": ["https://example.gov/sanctions/list"],
"uniqueSanctionId": "sanctions-id-00123456"
}
}
]
}
],
"dates": [
{
"dateId": "eeeeeeee-ffff-gggg-hhhh-iiiiiiiiiiii",
"type": "INCORPORATION",
"value": "2005-03-14",
"yearOnly": false
},
{
"dateId": "jjjjjjjj-kkkk-llll-mmmm-nnnnnnnnnnnn",
"type": "UNKNOWN",
"value": "1998-11-01",
"yearOnly": true
}
],
"documents": [
{
"docId": "oooooooo-pppp-qqqq-rrrr-ssssssssssss",
"type": "REGISTRATION_NUMBER",
"value": "REG-987654321",
"issuingCountry": "US",
"issueDate": "2005-03-14",
"expiryDate": null
},
{
"docId": "tttttttt-uuuu-vvvv-wwww-xxxxxxxxxxxx",
"type": "TAX_ID",
"value": "TAX-987-65-4321",
"issuingCountry": "US"
}
],
"nationalities": [
{
"profileNationalityId": "yyyyyyyy-zzzz-aaaa-bbbb-cccccccccccc",
"sourceRaw": "us",
"countryCode": "US",
"status": "DOMICILED"
}
],
"features": [
{
"featureId": "dddddddd-eeee-ffff-gggg-hhhhhhhhhhhh",
"name": "NOTE",
"value": "Registration number: REG-987654321 (Date of registration: 14.03.2005)"
}
],
"contacts": [
{
"contactId": "iiiiiiii-jjjj-kkkk-llll-mmmmmmmmmmmm",
"type": "website",
"value": "https://acme-corp.example.com"
},
{
"contactId": "nnnnnnnn-oooo-pppp-qqqq-rrrrrrrrrrrr",
"type": "email",
"value": "compliance@acme-corp.example.com"
},
{
"contactId": "ssssssss-tttt-uuuu-vvvv-wwwwwwwwwwww",
"type": "phone",
"value": "+15551234567"
}
],
"cryptoWallets": null,
"outgoingEdges": null,
"metadata": {
"target": "true",
"topics": ["sanction"],
"datasets": ["sanctions_list_a", "sanctions_list_b", "sanctions_list_c"],
"lastSeen": "2026-06-01T10:00:00Z",
"firstSeen": "2023-06-20T14:30:00Z",
"websites": ["https://acme-corp.example.com"],
"legalForm": "Public Limited Company",
"referents": ["ref-sanc-001", "ref-sanc-002"]
},
"createdAt": "2026-05-26T15:11:37.877856+03:00",
"updatedAt": "2026-06-01T10:15:45.107935+03:00",
"createdBy": "SYSTEM",
"updatedBy": "SYSTEM",
"version": 1,
"entityType": "ORGANIZATION"
}
],
"nextCursor": null,
"hasMore": false,
"limit": 20
}
}Response Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| items[].profileId | string | Optional | Unique profile identifier | a1b2c3d4-e5f6-7890-abcd-ef1234567890 |
| items[].gender | string | Optional | Gender — MALE, FEMALE, NOT_APPLICABLE, or null for organizations | NOT_APPLICABLE |
| items[].watchlistStatus | string | Optional | Watchlist status | ACTIVE |
| items[].riskLevel | string | Optional | Risk level | HIGH |
| items[].recencyScore | number | Optional | Match recency (0.0–1.0) | 0.98 |
| items[].schemaRef | string | Optional | Schema reference (reserved) | null |
| items[].names[] | array | Optional | Known name variants. Types: PRIMARY, ALIAS | [{"fullNameRaw":"Acme Corporation...","fullNameNormalized":"ACME CORPORATION...","nameType":"PRIMARY"}] |
| items[].addresses[] | array | Optional | Known addresses | [{"addressRaw":"123 Business Park Drive...","country":"US","addressType":"REGISTERED"}] |
| items[].sources[] | array | Optional | Watchlist sources with nested contexts | [{"externalReferenceId":"EXT-REF-001","contexts":[{"schemaName":"Sanction","authority":"National Financial Sanctions Authority","country":"us","isActive":true,"properties":{"program":["sanctions_program_a"]}}]}] |
| items[].dates[] | array | Optional | Relevant dates | [{"type":"INCORPORATION","value":"2005-03-14","yearOnly":false}] |
| items[].documents[] | array | Optional | Identity documents. Types: REGISTRATION_NUMBER, TAX_ID, NATIONAL_ID | [{"type":"REGISTRATION_NUMBER","value":"REG-987654321","issuingCountry":"US"}] |
| items[].nationalities[] | array | Optional | Nationalities / domiciles | [{"sourceRaw":"us","countryCode":"US","status":"DOMICILED"}] |
| items[].features[] | array | Optional | Key-value notes | [{"name":"NOTE","value":"Registration number: REG-987654321"}] |
| items[].contacts[] | array | Optional | Contact methods | [{"type":"website","value":"https://acme-corp.example.com"}] |
| items[].cryptoWallets | array | Optional | Crypto wallet addresses (not yet populated) | null |
| items[].outgoingEdges | array | Optional | Relationships to other profiles (not yet populated) | null |
| items[].metadata | object | Optional | Enriched metadata. May include websites, legalForm, referents. | {"target":"true","topics":["sanction"],"datasets":["sanctions_list_a"],"firstSeen":"2023-06-20T14:30:00Z","lastSeen":"2026-06-01T10:00:00Z"} |
| items[].createdAt | string | Optional | Creation timestamp | 2026-05-26T15:11:37.877856+03:00 |
| items[].updatedAt | string | Optional | Last update timestamp | 2026-06-01T10:15:45.107935+03:00 |
| items[].createdBy | string | Optional | Creator — SYSTEM or user identifier | SYSTEM |
| items[].updatedBy | string | Optional | Last updater — SYSTEM or user identifier | SYSTEM |
| items[].version | integer | Optional | Optimistic lock version | 1 |
| items[].entityType | string | Optional | Entity type | ORGANIZATION |
| nextCursor | string | Optional | Pagination cursor (base64 string when more pages exist) | null |
| hasMore | boolean | Optional | Whether more pages exist | false |
| limit | integer | Optional | Max results per page | 20 |
Error Codes
| Code | Message |
|---|---|
| 400 | At least one search criterion (fullName or documentNumber) must be provided |
| 401 | Invalid or expired API key |
| 429 | Rate limit exceeded |