As of May 2021, new API users, and those who choose to upgrade will receive search results in a new format.
This new format will include all Sanctions search results in one Array/List of "SearchResultEntry" type objects, rather than multiple arrays of different typed objects.
If you have created an API account prior to May 2021 or you have not upgraded to the new format, you will continue to receive the legacy format.
You can view the documentation for both formats below.
Parameter | Type | Format | Description |
---|---|---|---|
SanctionsListId | String | Max length 5 characters | The Id of the List where this result came from |
SanctionsListName | String | Max length 150 characters | The Name of the List where this result came from |
ResultResolved | Boolean | True if this specific search result has been resolved. A search result is resolved when the search record is updated with "ClientInResults" or "ClientNotInResults". | |
ResultStrength Deprecated | Int | Indicates the strength of the match, starts at 3 a value greater than 3 indicates a strong match. | |
ResultSimilarity | Decimal | Indicates the highest relative similarity of the search result's names when compared to the name in the search criteria. | |
ResultType | String | Max length 50 characters | The type of result. Either: "individual" or "entity". |
DateUpdated | DateTime | ISO 8601 | Date of the last modification. |
Names | Array | Array of SearchResultName | |
Names > … > Type | String | Max length 50 characters | The type of name (valid values: primary, alias, alias-strong, alias-weak, alias-former, alias-former-strong, alias-former-weak, alias-now-strong, unknown, or unknown-strong). |
Names > … > Title | String | Max length 250 characters | Title, e.g. Mr, Mrs, Miss, etc. |
Names > … > FullName | String | Max length 250 characters | |
Names > … > ResultSimilarity | String | Max length 50 characters | Indicates the relative similarity of the this name compared to the name in the search criteria. |
Addresses | Array | Array of SearchResultAddress | |
Addresses > … > Type | String | Max length 10 characters | The type of address if known (valid values: blank, "Current", or "Previous") |
Addresses > … > Address1 | String | Max length 500 characters | |
Addresses > … > Address2 | String | Max length 250 characters | |
Addresses > … > Address3 | String | Max length 250 characters | |
Addresses > … > City | String | Max length 250 characters | |
Addresses > … > County | String | Max length 250 characters | |
Addresses > … > PostCode | String | Max length 250 characters | |
Addresses > … > Country | String | Max length 250 characters | |
DatesOfBirth | Array | Array of SearchResultDateOfBirth | |
DatesOfBirth > … > Type | String | Max length 10 characters | Not currently in use. |
DatesOfBirth > … > DateOfBirth | String | Max length 100 characters | |
DatesOfBirth > … > Year | Int16/Short | Nullable | If known, the year of birth |
DatesOfBirth > … > Month | Int8/Byte | Nullable | If known, the month of birth |
DatesOfBirth > … > Day | Int8/Byte | Nullable | If known, the day of the month of birth |
PlacesOfBirth | Array | Array of SearchResultPlaceOfBirth | |
PlacesOfBirth > … > PlaceOfBirth | String | Max length 500 characters | |
PlacesOfBirth > … > CountryOfBirth | String | Max length 250 characters | |
Nationalities | Array | Array of SearchResultNationality | |
Nationalities > … > Nationality | String | Max length 500 characters | |
Remarks | Array | Array of SearchResultRemark | |
Remarks > … > Name | String | Max length 250 characters | The name describing the type of remark, e.g. "Passport". |
Remarks > … > Description | String | Max length unknown, use NVARCHAR(MAX) or similar | The contents of this remark, e.g. as passport number. |
HM Treasury Search Results
Parameter | Type | Format | Description |
---|---|---|---|
Name1 | String | Max length 250 characters | |
Name2 | String | Max length 250 characters | |
Name3 | String | Max length 250 characters | |
Name4 | String | Max length 250 characters | |
Name5 | String | Max length 250 characters | |
Name6 | String | Max length 250 characters | The last name of an individual or the full name of a entity |
Address1 | String | Max length 250 characters | |
Address2 | String | Max length 250 characters | |
Address3 | String | Max length 250 characters | |
Address4 | String | Max length 250 characters | |
Address5 | String | Max length 250 characters | |
Address6 | String | Max length 250 characters | |
PostCode | String | Max length 50 characters | |
Country | String | Max length 250 characters | |
DateOfBirth | String | Max length 50 characters | |
CountryOfBirth | String | Max length 250 characters | Country of incorporation for companies |
Nationality | String | Max length 250 characters | |
ResultResolved | Boolean | True if this specific search result has been resolved. A search result is resolved when the search record is updated with "ClientInResults" or "ClientNotInResults". | |
ResultStrength | Int | Indicates the strength of the match, a value greater than 3 indicates a strong match. | |
ResultSimilarity | Decimal | Indicates the relative similarity of the search result compared to the name in the search criteria. | |
ResultType | String | Max length 50 characters | The type of result. Either: "individual" or "entity". |
DateListed | DateTime | ISO 8601 | Date the result was added to the sanctions list. |
DateUpdated | DateTime | ISO 8601 | Date of the last modification. |
OFAC Search Results
Parameter | Type | Format | Description |
---|---|---|---|
FirstName | String | Max length 250 characters | |
LastName | String | Max length 250 characters | |
Akas | Array | Array of SearchResultOfacAka | |
Akas > SearchResultOfacAka > FirstName | String | Max length 250 characters | FirstName of alias |
Akas > SearchResultOfacAka > LastName | String | Max length 250 characters | LastName of alias |
Akas > SearchResultOfacAka > Strength | String | Max length 50 characters | Strength of the alias, "weak" or "strong" |
Akas > SearchResultOfacAka > Type | String | Max length 50 characters | Type of the alias, "a.k.a." or "f.k.a." or "n.k.a." |
Addresses | Array | Array of SearchResultOfacAddress | |
Addresses > SearchResultOfacAddress > Address1 | String | Max length 250 characters | |
Addresses > SearchResultOfacAddress > Address2 | String | Max length 250 characters | |
Addresses > SearchResultOfacAddress > Address3 | String | Max length 250 characters | |
Addresses > SearchResultOfacAddress > City | String | Max length 250 characters | |
Addresses > SearchResultOfacAddress > State | String | Max length 250 characters | |
Addresses > SearchResultOfacAddress > PostCode | String | Max length 250 characters | |
Addresses > SearchResultOfacAddress > Country | String | Max length 250 characters | |
DateOfBirths | Array | Array of SearchResultOfacDateOfBirth | |
DateOfBirths > SearchResultOfacDateOfBirth > DateOfBirth | String | Max length 250 characters | |
PlaceOfBirths | Array | Array of SearchResultOfacPlaceOfBirth | |
PlaceOfBirths > SearchResultOfacPlaceOfBirth > PlaceOfBirth | Max length 250 characters | ||
Nationalities | Array | Array of SearchResultOfacNationality | |
Nationalities > SearchResultOfacNationality > Country | Max length 250 characters | ||
ResultResolved | Boolean | True if this specific search result has been resolved. A search result is resolved when the search record is updated with "ClientInResults" or "ClientNotInResults". | |
ResultStrength | Int | Indicates the strength of the match, a value greater than 3 indicates a strong match. | |
ResultSimilarity | Decimal | Indicates the relative similarity of the search result compared to the name in the search criteria. | |
ResultType | String | Max length 50 characters | The type of result. Either: "individual" or "entity". |
DateUpdated | DateTime | ISO 8601 | Date of the last modification. |
DFAT Search Results
Parameter | Type | Format | Description |
---|---|---|---|
FullName | String | Max length 500 characters | |
Address | String | Max length 8000 characters | |
DateOfBirth | String | Max length 50 characters | |
PlaceOfBirth | String | Max length 500 characters | |
Nationality | String | Max length 250 characters | |
ResultResolved | Boolean | True if this specific search result has been resolved. A search result is resolved when the search record is updated with "ClientInResults" or "ClientNotInResults". | |
ResultStrength | Int | Indicates the strength of the match, a value greater than 3 indicates a strong match. | |
ResultSimilarity | Decimal | Indicates the relative similarity of the search result compared to the name in the search criteria. | |
ResultType | String | Max length 50 characters | The type of result. Either: "individual" or "entity". |
DateUpdated | DateTime | ISO 8601 | Date of the last modification. |
OSFI Search Results
Parameter | Type | Format | Description |
---|---|---|---|
FullName | String | Max length 500 characters | |
Address | String | Max length 8000 characters | |
DateOfBirth | String | Max length 50 characters | |
PlaceOfBirth | String | Max length 500 characters | |
Nationality | String | Max length 250 characters | |
ResultResolved | Boolean | True if this specific search result has been resolved. A search result is resolved when the search record is updated with "ClientInResults" or "ClientNotInResults". | |
ResultStrength | Int | Indicates the strength of the match, a value greater than 3 indicates a strong match. | |
ResultSimilarity | Decimal | Indicates the relative similarity of the search result compared to the name in the search criteria. | |
ResultType | String | Max length 50 characters | The type of result. Either: "individual" or "entity". |
DateUpdated | DateTime | ISO 8601 | Date of the last modification. |
Canadian Justice Search Results
Parameter | Type | Format | Description |
---|---|---|---|
Name | String | Max length 500 characters | |
DateOfBirth | String | Max length 50 characters | |
Country | String | Max length 500 characters | |
RefId | Int32 | ||
ResultResolved | Boolean | True if this specific search result has been resolved. A search result is resolved when the search record is updated with "ClientInResults" or "ClientNotInResults". | |
ResultStrength | Int | Indicates the strength of the match, a value greater than 3 indicates a strong match. | |
ResultSimilarity | Decimal | Indicates the relative similarity of the search result compared to the name in the search criteria. | |
ResultType | String | Max length 50 characters | The type of result. Either: "individual" or "entity". |
DateUpdated | DateTime | ISO 8601 | Date of the last modification. |
Canadian Justice Search Results
Parameter | Type | Format | Description |
---|---|---|---|
Name | String | Max length 500 characters | |
DateOfBirth | String | Max length 250 characters | |
Country | String | Max length 250 characters | |
RefId | Int32 | ||
ResultResolved | Boolean | True if this specific search result has been resolved. A search result is resolved when the search record is updated with "ClientInResults" or "ClientNotInResults". | |
ResultStrength | Int | Indicates the strength of the match, a value greater than 3 indicates a strong match. | |
ResultSimilarity | Decimal | Indicates the relative similarity of the search result compared to the name in the search criteria. | |
ResultType | String | Max length 50 characters | The type of result. Either: "individual" or "entity". |
DateUpdated | DateTime | ISO 8601 | Date of the last modification. |
Canadian SEMA Search Results
Parameter | Type | Format | Description |
---|---|---|---|
Name | String | Max length 500 characters | |
DateOfBirth | String | Max length 250 characters | |
Country | String | Max length 250 characters | |
Schedule | String | Max length 50 characters | |
Item | String | Max length 50 characters | |
ResultResolved | Boolean | True if this specific search result has been resolved. A search result is resolved when the search record is updated with "ClientInResults" or "ClientNotInResults". | |
ResultStrength | Int | Indicates the strength of the match, a value greater than 3 indicates a strong match. | |
ResultSimilarity | Decimal | Indicates the relative similarity of the search result compared to the name in the search criteria. | |
ResultType | String | Max length 50 characters | The type of result. Either: "individual" or "entity". |
DateUpdated | DateTime | ISO 8601 | Date of the last modification. |
Swiss SSECO Search Results
The Swiss search results use the new format as show on the "Search Results (new format)" tab above.