Sanctions Search API: v1

<back to all web services

AddCompanySearch

Create a new sanctions search for an entity

Create a new sanctions search for an entityThis will create 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 AddCompanySearchData implements IBaseDataResponse, IHasResponseStatus
{
    // @DataMember
    public ResponseStatus: ResponseStatus;

    // @DataMember
    public SearchRecord: SearchRecord;

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

// @DataContract
export class AddCompanySearchResponse
{
    // @DataMember
    // @ApiMember(IsRequired=true)
    public Data: AddCompanySearchData;

    public constructor(init?: Partial<AddCompanySearchResponse>) { (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); }
}

export class ArrayOfSanctionsLists extends Array<string>
{

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

export class SearchCompanyRequest
{
    /** @description The name of the entity that is being searched. */
    // @ApiMember(DataType="string", Description="The name of the entity that is being searched.", IsRequired=true)
    public CompanyName: string;

    /** @description The country where the entity is registered. */
    // @ApiMember(DataType="string", Description="The country where the entity is registered.", Format="int64")
    public Country: string;

    /** @description The address where the entity is registered. */
    // @ApiMember(DataType="string", Description="The address where the entity is registered.")
    public Address: string;

    /** @description Array of sanctions lists to be included in the search. At least one is required. */
    // @ApiMember(DataType="ArrayOfSanctionsLists", Description="Array of sanctions lists to be included in the search. At least one is required.", IsRequired=true)
    public SelectedSanctionsLists: ArrayOfSanctionsLists;

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

/** @description Create a new sanctions search for an entity */
// @Api(Description="Create a new sanctions search for an entity")
// @ApiResponse(Description="Your request is successful if the \"<em>Data.ResponseStatus.Message</em>\" field is \"<b>Success</b>\".", StatusCode=200)
// @DataContract
export class AddCompanySearch implements IBaseRequest
{
    /** @description Authentication object */
    // @DataMember
    // @ApiMember(DataType="Authentication", Description="Authentication object", IsRequired=true)
    public Authentication: Authentication;

    /** @description Request object */
    // @DataMember
    // @ApiMember(DataType="SearchCompanyRequest", Description="Request object", IsRequired=true)
    public Request: SearchCompanyRequest;

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

TypeScript AddCompanySearch DTOs

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

HTTP + SOAP11

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

POST /soap11 HTTP/1.1 
Host: api.sanctionssearch.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: AddCompanySearch

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>

<AddCompanySearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <Address>String</Address>
    <CompanyName>String</CompanyName>
    <Country>String</Country>
    <SelectedSanctionsLists>
      <SanctionsListId>String</SanctionsListId>
    </SelectedSanctionsLists>
  </Request>
</AddCompanySearch>

</soap:Body>
</soap:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>

<AddCompanySearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Data>
    <ResponseStatus>
      <ErrorCode>String</ErrorCode>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
      <Errors>
        <ResponseError>
          <ErrorCode>String</ErrorCode>
          <FieldName>String</FieldName>
          <Message>String</Message>
        </ResponseError>
      </Errors>
    </ResponseStatus>
    <SearchRecord>
      <AffectedByUpdate>false</AffectedByUpdate>
      <ClientInResults>false</ClientInResults>
      <ClientNotInResults>false</ClientNotInResults>
      <DateSearched>0001-01-01T00:00:00</DateSearched>
      <DateUpdated>0001-01-01T00:00:00</DateUpdated>
      <Id>0</Id>
      <NumOfResults>0</NumOfResults>
      <SearchCriteria>
        <Address>String</Address>
        <CountryOfBirth>String</CountryOfBirth>
        <DateOfBirth>String</DateOfBirth>
        <Name>String</Name>
        <Nationality>String</Nationality>
      </SearchCriteria>
      <SearchResults>
        <HMTResults>
          <SearchResultHmTreasury>
            <Address1>String</Address1>
            <Address2>String</Address2>
            <Address3>String</Address3>
            <Address4>String</Address4>
            <Address5>String</Address5>
            <Address6>String</Address6>
            <Country>String</Country>
            <CountryOfBirth>String</CountryOfBirth>
            <DateListed>0001-01-01T00:00:00</DateListed>
            <DateOfBirth>String</DateOfBirth>
            <DateUpdated>0001-01-01T00:00:00</DateUpdated>
            <Name1>String</Name1>
            <Name2>String</Name2>
            <Name3>String</Name3>
            <Name4>String</Name4>
            <Name5>String</Name5>
            <Name6>String</Name6>
            <Nationality>String</Nationality>
            <PostCode>String</PostCode>
            <ResultResolved>false</ResultResolved>
            <ResultSimilarity>0</ResultSimilarity>
            <ResultStrength>0</ResultStrength>
            <ResultType>String</ResultType>
          </SearchResultHmTreasury>
        </HMTResults>
        <OfacResults>
          <SearchResultOfac>
            <Addresses>
              <SearchResultOfacAddress>
                <Address1>String</Address1>
                <Address2>String</Address2>
                <Address3>String</Address3>
                <City>String</City>
                <Country>String</Country>
                <PostCode>String</PostCode>
                <State>String</State>
              </SearchResultOfacAddress>
            </Addresses>
            <Akas>
              <SearchResultOfacAka>
                <FirstName>String</FirstName>
                <LastName>String</LastName>
                <Strength>String</Strength>
                <Type>String</Type>
              </SearchResultOfacAka>
            </Akas>
            <DateOfBirths>
              <SearchResultOfacDateOfBirth>
                <DateOfBirth>String</DateOfBirth>
              </SearchResultOfacDateOfBirth>
            </DateOfBirths>
            <DateUpdated>0001-01-01T00:00:00</DateUpdated>
            <FirstName>String</FirstName>
            <LastName>String</LastName>
            <Nationalities>
              <SearchResultOfacNationality>
                <Country>String</Country>
              </SearchResultOfacNationality>
            </Nationalities>
            <PlaceOfBirths>
              <SearchResultOfacPlaceOfBirth>
                <PlaceOfBirth>String</PlaceOfBirth>
              </SearchResultOfacPlaceOfBirth>
            </PlaceOfBirths>
            <ResultResolved>false</ResultResolved>
            <ResultSimilarity>0</ResultSimilarity>
            <ResultStrength>0</ResultStrength>
            <ResultType>String</ResultType>
          </SearchResultOfac>
        </OfacResults>
      </SearchResults>
      <SearchType>String</SearchType>
    </SearchRecord>
  </Data>
</AddCompanySearchResponse>

</soap:Body>
</soap:Envelope>