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.

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

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

    // @DataMember(Order=3)
    public Message: 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;

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

export class SearchCriteria
{
    public Name: string;
    public DateOfBirth: string;
    public CountryOfBirth: string;
    public Nationality: string;
    public Address: string;

    public constructor(init?: Partial<SearchCriteria>) { (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 SearchResults
{
    public HMTResults: SearchResultHmTreasury[];
    public OfacResults: SearchResultOfac[];

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

export class SearchRecord
{
    public Id: number;
    public SearchType: string;
    public DateSearched: string;
    public DateUpdated: string;
    public NumOfResults: number;
    public ClientInResults: boolean;
    public ClientNotInResults: boolean;
    public AffectedByUpdate: boolean;
    public SearchCriteria: SearchCriteria;
    public SearchResults: SearchResults;

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

// @DataContract
export class GetCompanySearchData implements IBaseDataResponse, IHasResponseStatus
{
    // @DataMember
    public ResponseStatus: ResponseStatus;

    // @DataMember
    public SearchRecord: SearchRecord;

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

// @DataContract
export class GetCompanySearchResponse
{
    // @DataMember
    public Data: GetCompanySearchData;

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

// @DataContract
export class Authentication implements IAuthentication
{
    /** @description The API User ID that will authenticate your request */
    // @DataMember
    // @ApiMember(DataType="string", Description="The API User ID that will authenticate your request", IsRequired=true)
    public ApiUserId: string;

    /** @description The API User Key that will authenticate your request */
    // @DataMember
    // @ApiMember(DataType="string", Description="The API User Key that will authenticate your request", IsRequired=true)
    public ApiUserKey: string;

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

// @ApiResponse(Description="Your request is successful if the \"<em>Data.ResponseStatus.Message</em>\" field is \"<b>Success</b>\".", StatusCode=200)
// @DataContract
export class GetCompanySearch implements IBaseRequest
{
    // @DataMember
    public Authentication: Authentication;

    // @DataMember
    public Id: number;

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

TypeScript 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"}]}]}}}}