Sanctions Search API: v2

GetSearch

Sanctions

The following routes are available for this service:
POST	/sanctions/get	Get a sanctions search


// @DataContract
export class Authentication
{
    /** @description The API User ID provided by us when you signed up to use our API */
    // @DataMember
    // @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public apiUserId: string;

    /** @description The API User Key provided by us when you signed up to use our API */
    // @DataMember
    // @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public apiUserKey: string;

    public constructor(init?: Partial<Authentication>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseRequest implements IBaseRequest
{
    /** @description The authentication credentials */
    // @DataMember
    // @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    public authentication: Authentication;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseError
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public fieldName: string;

    // @DataMember(Order=3)
    public message: string;

    // @DataMember(Order=4)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseError>) { (Object as any).assign(this, init); }
}

export class ArrayOfResponseError extends Array<ResponseError>
{

    public constructor(init?: Partial<ArrayOfResponseError>) { super(); (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseStatus
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public message: string;

    // @DataMember(Order=3)
    public stackTrace: string;

    // @DataMember(Order=4)
    public errors: ArrayOfResponseError;

    // @DataMember(Order=5)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}

export class BaseResponse implements IBaseDataResponse, IHasResponseStatus
{
    /** @description The status of the response */
    // @ApiMember(Description="The status of the response")
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

export class LinkedTo
{
    public clientId?: number;
    public id?: number;
    public type?: string;
    public subtype?: string;
    public status?: string;
    public description?: string;
    public isArchived?: boolean;
    public name?: string;
    public date?: string;

    public constructor(init?: Partial<LinkedTo>) { (Object as any).assign(this, init); }
}

export class ArrayOfLinkedTo extends Array<LinkedTo>
{

    public constructor(init?: Partial<ArrayOfLinkedTo>) { super(); (Object as any).assign(this, init); }
}

export class SearchCriteria
{
    public name: string;
    public address: string;
    public country: string;
    public dateOfBirth: string;
    public nationality: string;
    public reference: string;

    public constructor(init?: Partial<SearchCriteria>) { (Object as any).assign(this, init); }
}

export class SearchResultEuAddress
{
    public street: string;
    public city: string;
    public country: string;
    public postCode: string;
    public other: string;

    public constructor(init?: Partial<SearchResultEuAddress>) { (Object as any).assign(this, init); }
}

export class SearchResultEuBirth
{
    public date: string;
    public place: string;
    public country: string;

    public constructor(init?: Partial<SearchResultEuBirth>) { (Object as any).assign(this, init); }
}

export class SearchResultOfacEuCitizenship
{
    public country: string;

    public constructor(init?: Partial<SearchResultOfacEuCitizenship>) { (Object as any).assign(this, init); }
}

export class SearchResultEuName
{
    public fullName: string;
    public gender: string;

    public constructor(init?: Partial<SearchResultEuName>) { (Object as any).assign(this, init); }
}

export class SearchResultEuPassport
{
    public number: string;
    public country: string;

    public constructor(init?: Partial<SearchResultEuPassport>) { (Object as any).assign(this, init); }
}

export class SearchResultEu
{
    public resultStrength: number;
    public resultSimilarity: number;
    public resultResolved: boolean;
    public resultType: string;
    public dateUpdated: string;
    public addresses: SearchResultEuAddress[];
    public births: SearchResultEuBirth[];
    public citizenships: SearchResultOfacEuCitizenship[];
    public names: SearchResultEuName[];
    public passports: SearchResultEuPassport[];

    public constructor(init?: Partial<SearchResultEu>) { (Object as any).assign(this, init); }
}

export class SearchResultHmTreasury
{
    public resultStrength: number;
    public resultSimilarity: number;
    public resultResolved: boolean;
    public resultType: string;
    public dateListed: string;
    public dateUpdated: string;
    public name1: string;
    public name2: string;
    public name3: string;
    public name4: string;
    public name5: string;
    public name6: string;
    public dateOfBirth: string;
    public countryOfBirth: string;
    public nationality: string;
    public address1: string;
    public address2: string;
    public address3: string;
    public address4: string;
    public address5: string;
    public address6: string;
    public postCode: string;
    public country: string;

    public constructor(init?: Partial<SearchResultHmTreasury>) { (Object as any).assign(this, init); }
}

export class SearchResultOfacAddress
{
    public address1: string;
    public address2: string;
    public address3: string;
    public city: string;
    public state: string;
    public postCode: string;
    public country: string;

    public constructor(init?: Partial<SearchResultOfacAddress>) { (Object as any).assign(this, init); }
}

export class SearchResultOfacAka
{
    public firstName: string;
    public lastName: string;
    public type: string;
    public strength: string;

    public constructor(init?: Partial<SearchResultOfacAka>) { (Object as any).assign(this, init); }
}

export class SearchResultOfacDateOfBirth
{
    public dateOfBirth: string;

    public constructor(init?: Partial<SearchResultOfacDateOfBirth>) { (Object as any).assign(this, init); }
}

export class SearchResultOfacNationality
{
    public country: string;

    public constructor(init?: Partial<SearchResultOfacNationality>) { (Object as any).assign(this, init); }
}

export class SearchResultOfacPlaceOfBirth
{
    public placeOfBirth: string;

    public constructor(init?: Partial<SearchResultOfacPlaceOfBirth>) { (Object as any).assign(this, init); }
}

export class SearchResultOfac
{
    public resultStrength: number;
    public resultSimilarity: number;
    public resultResolved: boolean;
    public resultType: string;
    public dateUpdated: string;
    public firstName: string;
    public lastName: string;
    public addresses: SearchResultOfacAddress[];
    public akas: SearchResultOfacAka[];
    public dateOfBirths: SearchResultOfacDateOfBirth[];
    public nationalities: SearchResultOfacNationality[];
    public placeOfBirths: SearchResultOfacPlaceOfBirth[];

    public constructor(init?: Partial<SearchResultOfac>) { (Object as any).assign(this, init); }
}

export class SearchResultDfat
{
    public resultStrength: number;
    public resultSimilarity: number;
    public resultResolved: boolean;
    public resultType: string;
    public dateUpdated: string;
    public fullName: string;
    public address: string;
    public dateOfBirth: string;
    public placeOfBirth: string;
    public nationality: string;

    public constructor(init?: Partial<SearchResultDfat>) { (Object as any).assign(this, init); }
}

export class SearchResultOsfi
{
    public resultStrength: number;
    public resultSimilarity: number;
    public resultResolved: boolean;
    public resultType: string;
    public dateUpdated: string;
    public fullName: string;
    public address: string;
    public dateOfBirth: string;
    public placeOfBirth: string;
    public nationality: string;

    public constructor(init?: Partial<SearchResultOsfi>) { (Object as any).assign(this, init); }
}

export class SearchResultCanadianJustice
{
    public resultStrength: number;
    public resultSimilarity: number;
    public resultResolved: boolean;
    public resultType: string;
    public dateUpdated: string;
    public name: string;
    public dateOfBirth: string;
    public country: string;
    public refId: number;

    public constructor(init?: Partial<SearchResultCanadianJustice>) { (Object as any).assign(this, init); }
}

export class SearchResultCanadianSema
{
    public resultStrength: number;
    public resultSimilarity: number;
    public resultResolved: boolean;
    public resultType: string;
    public dateUpdated: string;
    public name: string;
    public dateOfBirth: string;
    public country: string;
    public schedule: string;
    public item: string;

    public constructor(init?: Partial<SearchResultCanadianSema>) { (Object as any).assign(this, init); }
}

export class SearchResultAddress
{
    public searchResultAddressId: number;
    public type: string;
    public address1: string;
    public address2: string;
    public address3: string;
    public city: string;
    public county: string;
    public postCode: string;
    public country: string;

    public constructor(init?: Partial<SearchResultAddress>) { (Object as any).assign(this, init); }
}

export class SearchResultDateOfBirth
{
    public searchResultDateOfBirthId: number;
    public dateOfBirth: string;
    public year?: number;
    public month?: number;
    public day?: number;
    public type: string;

    public constructor(init?: Partial<SearchResultDateOfBirth>) { (Object as any).assign(this, init); }
}

export class SearchResultName
{
    public searchResultNameId: number;
    public type: string;
    public title: string;
    public fullName: string;
    public resultSimilarity: number;

    public constructor(init?: Partial<SearchResultName>) { (Object as any).assign(this, init); }
}

export class SearchResultNationality
{
    public searchResultNationalityId: number;
    public nationality: string;

    public constructor(init?: Partial<SearchResultNationality>) { (Object as any).assign(this, init); }
}

export class SearchResultPlaceOfBirth
{
    public searchResultPlaceOfBirthId: number;
    public placeOfBirth: string;
    public countryOfBirth: string;

    public constructor(init?: Partial<SearchResultPlaceOfBirth>) { (Object as any).assign(this, init); }
}

export class SearchResultRemark
{
    public searchResultRemarkId: number;
    public name: string;
    public description: string;

    public constructor(init?: Partial<SearchResultRemark>) { (Object as any).assign(this, init); }
}

export class SearchResultEntry
{
    public searchResultId: number;
    public resultStrength: number;
    public resultSimilarity: number;
    public resultResolved: boolean;
    public resultType: string;
    public dateUpdated?: string;
    public sanctionsListId: string;
    public sanctionsListName: string;
    public addresses: SearchResultAddress[];
    public datesOfBirth: SearchResultDateOfBirth[];
    public names: SearchResultName[];
    public nationalities: SearchResultNationality[];
    public placesOfBirth: SearchResultPlaceOfBirth[];
    public remarks: SearchResultRemark[];

    public constructor(init?: Partial<SearchResultEntry>) { (Object as any).assign(this, init); }
}

export class SearchResults
{
    public euResults: SearchResultEu[];
    public hmtResults: SearchResultHmTreasury[];
    public hmtUkraineResults: SearchResultHmTreasury[];
    public ofacResults: SearchResultOfac[];
    public ofacConsolidatedResults: SearchResultOfac[];
    public dfatResults: SearchResultDfat[];
    public osfiResults: SearchResultOsfi[];
    public canadianJusticeResults: SearchResultCanadianJustice[];
    public canadianSemaResults: SearchResultCanadianSema[];
    public swissSecoResults: SearchResultEntry[];

    public constructor(init?: Partial<SearchResults>) { (Object as any).assign(this, init); }
}

export class SearchSource
{
    public listId: string;
    public listName: string;
    public listShortName: string;
    public isAffectedByListUpdate?: boolean;

    public constructor(init?: Partial<SearchSource>) { (Object as any).assign(this, init); }
}

export class ArrayOfSearchResultEntries extends Array<SearchResultEntry>
{

    public constructor(init?: Partial<ArrayOfSearchResultEntries>) { super(); (Object as any).assign(this, init); }
}

export class SearchRecord
{
    public id: number;
    public searchType: string;
    public dateSearched: string;
    public dateUpdated: string;
    public dateArchived?: string;
    public isArchived: boolean;
    public numOfResults: number;
    public clientInResults: boolean;
    public clientNotInResults: boolean;
    public affectedByUpdate: boolean;
    public searchCriteria: SearchCriteria;
    public searchResults: SearchResults;
    public searchSources: SearchSource[];
    public listSearchResults: ArrayOfSearchResultEntries;

    public constructor(init?: Partial<SearchRecord>) { (Object as any).assign(this, init); }
}

export class GetSearchData extends BaseResponse implements IBaseSearchResponse
{
    public linkedTo: ArrayOfLinkedTo;
    public searchRecord: SearchRecord;

    public constructor(init?: Partial<GetSearchData>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class GetSearchResponse
{
    // @DataMember
    public data: GetSearchData;

    public constructor(init?: Partial<GetSearchResponse>) { (Object as any).assign(this, init); }
}

export class GetSearchRequest
{
    /** @description If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it */
    // @ApiMember(Description="If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it")
    public subUserName: string;

    /** @description If set to true, the response will exclude resolved search results, it will only include unresolved results */
    // @ApiMember(Description="If set to true, the response will exclude resolved search results, it will only include unresolved results")
    public onlyShowUnresolvedResults: boolean;

    public id: number;

    public constructor(init?: Partial<GetSearchRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetSearch extends BaseRequest
{
    // @DataMember
    public request: GetSearchRequest;

    public constructor(init?: Partial<GetSearch>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetSearch DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /sanctions/get HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"subUserName":"String","onlyShowUnresolvedResults":false,"id":0},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"data":{"linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}],"searchRecord":{"id":0,"searchType":"String","dateSearched":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","dateArchived":"\/Date(-62135596800000-0000)\/","isArchived":false,"numOfResults":0,"clientInResults":false,"clientNotInResults":false,"affectedByUpdate":false,"searchCriteria":{"name":"String","address":"String","country":"String","dateOfBirth":"String","nationality":"String","reference":"String"},"searchResults":{"euResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","addresses":[{"street":"String","city":"String","country":"String","postCode":"String","other":"String"}],"births":[{"date":"String","place":"String","country":"String"}],"citizenships":[{"country":"String"}],"names":[{"fullName":"String","gender":"String"}],"passports":[{"number":"String","country":"String"}]}],"hmtResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateListed":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","name1":"String","name2":"String","name3":"String","name4":"String","name5":"String","name6":"String","dateOfBirth":"String","countryOfBirth":"String","nationality":"String","address1":"String","address2":"String","address3":"String","address4":"String","address5":"String","address6":"String","postCode":"String","country":"String"}],"hmtUkraineResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateListed":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","name1":"String","name2":"String","name3":"String","name4":"String","name5":"String","name6":"String","dateOfBirth":"String","countryOfBirth":"String","nationality":"String","address1":"String","address2":"String","address3":"String","address4":"String","address5":"String","address6":"String","postCode":"String","country":"String"}],"ofacResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","firstName":"String","lastName":"String","addresses":[{"address1":"String","address2":"String","address3":"String","city":"String","state":"String","postCode":"String","country":"String"}],"akas":[{"firstName":"String","lastName":"String","type":"String","strength":"String"}],"dateOfBirths":[{"dateOfBirth":"String"}],"nationalities":[{"country":"String"}],"placeOfBirths":[{"placeOfBirth":"String"}]}],"ofacConsolidatedResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","firstName":"String","lastName":"String","addresses":[{"address1":"String","address2":"String","address3":"String","city":"String","state":"String","postCode":"String","country":"String"}],"akas":[{"firstName":"String","lastName":"String","type":"String","strength":"String"}],"dateOfBirths":[{"dateOfBirth":"String"}],"nationalities":[{"country":"String"}],"placeOfBirths":[{"placeOfBirth":"String"}]}],"dfatResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","fullName":"String","address":"String","dateOfBirth":"String","placeOfBirth":"String","nationality":"String"}],"osfiResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","fullName":"String","address":"String","dateOfBirth":"String","placeOfBirth":"String","nationality":"String"}],"canadianJusticeResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","name":"String","dateOfBirth":"String","country":"String","refId":0}],"canadianSemaResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","name":"String","dateOfBirth":"String","country":"String","schedule":"String","item":"String"}],"swissSecoResults":[{"searchResultId":0,"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","sanctionsListId":"String","sanctionsListName":"String","addresses":[{"searchResultAddressId":0,"type":"String","address1":"String","address2":"String","address3":"String","city":"String","county":"String","postCode":"String","country":"String"}],"datesOfBirth":[{"searchResultDateOfBirthId":0,"dateOfBirth":"String","year":0,"month":0,"day":0,"type":"String"}],"names":[{"searchResultNameId":0,"type":"String","title":"String","fullName":"String","resultSimilarity":0}],"nationalities":[{"searchResultNationalityId":0,"nationality":"String"}],"placesOfBirth":[{"searchResultPlaceOfBirthId":0,"placeOfBirth":"String","countryOfBirth":"String"}],"remarks":[{"searchResultRemarkId":0,"name":"String","description":"String"}]}]},"searchSources":[{"listId":"String","listName":"String","listShortName":"String","isAffectedByListUpdate":false}],"listSearchResults":[{"searchResultId":0,"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","sanctionsListId":"String","sanctionsListName":"String","addresses":[{"searchResultAddressId":0,"type":"String","address1":"String","address2":"String","address3":"String","city":"String","county":"String","postCode":"String","country":"String"}],"datesOfBirth":[{"searchResultDateOfBirthId":0,"dateOfBirth":"String","year":0,"month":0,"day":0,"type":"String"}],"names":[{"searchResultNameId":0,"type":"String","title":"String","fullName":"String","resultSimilarity":0}],"nationalities":[{"searchResultNationalityId":0,"nationality":"String"}],"placesOfBirth":[{"searchResultPlaceOfBirthId":0,"placeOfBirth":"String","countryOfBirth":"String"}],"remarks":[{"searchResultRemarkId":0,"name":"String","description":"String"}]}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}