Sanctions Search API: v1

<back to all web services

GetCompanySearch

Sanctions
The following routes are available for this service:
POST/sanctions/entity/getCreate a get a sanctions search for an entityThis will get a new sanctions search for an entity, such as a company, vessel, organisation, or group.
"use strict";
export class ResponseError {
    /** @param {{ErrorCode?:string,FieldName?:string,Message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    FieldName;
    /** @type {string} */
    Message;
}
export class ArrayOfResponseError extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class ResponseStatus {
    /** @param {{ErrorCode?:string,Message?:string,StackTrace?:string,Errors?:ArrayOfResponseError}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    Message;
    /** @type {string} */
    StackTrace;
    /** @type {ArrayOfResponseError} */
    Errors;
}
export class SearchCriteria {
    /** @param {{Name?:string,DateOfBirth?:string,CountryOfBirth?:string,Nationality?:string,Address?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    DateOfBirth;
    /** @type {string} */
    CountryOfBirth;
    /** @type {string} */
    Nationality;
    /** @type {string} */
    Address;
}
export class SearchResultHmTreasury {
    /** @param {{ResultStrength?:number,ResultSimilarity?:number,ResultResolved?:boolean,ResultType?:string,DateListed?:string,DateUpdated?:string,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}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ResultStrength;
    /** @type {number} */
    ResultSimilarity;
    /** @type {boolean} */
    ResultResolved;
    /** @type {string} */
    ResultType;
    /** @type {string} */
    DateListed;
    /** @type {string} */
    DateUpdated;
    /** @type {string} */
    Name1;
    /** @type {string} */
    Name2;
    /** @type {string} */
    Name3;
    /** @type {string} */
    Name4;
    /** @type {string} */
    Name5;
    /** @type {string} */
    Name6;
    /** @type {string} */
    DateOfBirth;
    /** @type {string} */
    CountryOfBirth;
    /** @type {string} */
    Nationality;
    /** @type {string} */
    Address1;
    /** @type {string} */
    Address2;
    /** @type {string} */
    Address3;
    /** @type {string} */
    Address4;
    /** @type {string} */
    Address5;
    /** @type {string} */
    Address6;
    /** @type {string} */
    PostCode;
    /** @type {string} */
    Country;
}
export class SearchResultOfacAddress {
    /** @param {{Address1?:string,Address2?:string,Address3?:string,City?:string,State?:string,PostCode?:string,Country?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Address1;
    /** @type {string} */
    Address2;
    /** @type {string} */
    Address3;
    /** @type {string} */
    City;
    /** @type {string} */
    State;
    /** @type {string} */
    PostCode;
    /** @type {string} */
    Country;
}
export class SearchResultOfacAka {
    /** @param {{FirstName?:string,LastName?:string,Type?:string,Strength?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    Type;
    /** @type {string} */
    Strength;
}
export class SearchResultOfacDateOfBirth {
    /** @param {{DateOfBirth?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DateOfBirth;
}
export class SearchResultOfacNationality {
    /** @param {{Country?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Country;
}
export class SearchResultOfacPlaceOfBirth {
    /** @param {{PlaceOfBirth?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PlaceOfBirth;
}
export class SearchResultOfac {
    /** @param {{ResultStrength?:number,ResultSimilarity?:number,ResultResolved?:boolean,ResultType?:string,DateUpdated?:string,FirstName?:string,LastName?:string,Addresses?:SearchResultOfacAddress[],Akas?:SearchResultOfacAka[],DateOfBirths?:SearchResultOfacDateOfBirth[],Nationalities?:SearchResultOfacNationality[],PlaceOfBirths?:SearchResultOfacPlaceOfBirth[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ResultStrength;
    /** @type {number} */
    ResultSimilarity;
    /** @type {boolean} */
    ResultResolved;
    /** @type {string} */
    ResultType;
    /** @type {string} */
    DateUpdated;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {SearchResultOfacAddress[]} */
    Addresses;
    /** @type {SearchResultOfacAka[]} */
    Akas;
    /** @type {SearchResultOfacDateOfBirth[]} */
    DateOfBirths;
    /** @type {SearchResultOfacNationality[]} */
    Nationalities;
    /** @type {SearchResultOfacPlaceOfBirth[]} */
    PlaceOfBirths;
}
export class SearchResults {
    /** @param {{HMTResults?:SearchResultHmTreasury[],OfacResults?:SearchResultOfac[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {SearchResultHmTreasury[]} */
    HMTResults;
    /** @type {SearchResultOfac[]} */
    OfacResults;
}
export class SearchRecord {
    /** @param {{Id?:number,SearchType?:string,DateSearched?:string,DateUpdated?:string,NumOfResults?:number,ClientInResults?:boolean,ClientNotInResults?:boolean,AffectedByUpdate?:boolean,SearchCriteria?:SearchCriteria,SearchResults?:SearchResults}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    SearchType;
    /** @type {string} */
    DateSearched;
    /** @type {string} */
    DateUpdated;
    /** @type {number} */
    NumOfResults;
    /** @type {boolean} */
    ClientInResults;
    /** @type {boolean} */
    ClientNotInResults;
    /** @type {boolean} */
    AffectedByUpdate;
    /** @type {SearchCriteria} */
    SearchCriteria;
    /** @type {SearchResults} */
    SearchResults;
}
export class GetCompanySearchData {
    /** @param {{ResponseStatus?:ResponseStatus,SearchRecord?:SearchRecord}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {SearchRecord} */
    SearchRecord;
}
export class GetCompanySearchResponse {
    /** @param {{Data?:GetCompanySearchData}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {GetCompanySearchData} */
    Data;
}
export class Authentication {
    /** @param {{ApiUserId?:string,ApiUserKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API User ID that will authenticate your request */
    ApiUserId;
    /**
     * @type {string}
     * @description The API User Key that will authenticate your request */
    ApiUserKey;
}
export class GetCompanySearch {
    /** @param {{Authentication?:Authentication,Id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Authentication} */
    Authentication;
    /** @type {number} */
    Id;
}

JavaScript GetCompanySearch 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/entity/get HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Authentication":{"ApiUserId":"String","ApiUserKey":"String"},"Id":0}

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

{"Data":{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]},"SearchRecord":{"Id":0,"SearchType":"String","DateSearched":"\/Date(-62135596800000-0000)\/","DateUpdated":"\/Date(-62135596800000-0000)\/","NumOfResults":0,"ClientInResults":false,"ClientNotInResults":false,"AffectedByUpdate":false,"SearchCriteria":{"Name":"String","DateOfBirth":"String","CountryOfBirth":"String","Nationality":"String","Address":"String"},"SearchResults":{"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"}],"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"}]}]}}}}