| Create a new sanctions search for an entity | This will create 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 AddCompanySearchData {
/** @param {{ResponseStatus?:ResponseStatus,SearchRecord?:SearchRecord}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {SearchRecord} */
SearchRecord;
}
export class AddCompanySearchResponse {
/** @param {{Data?:AddCompanySearchData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {AddCompanySearchData} */
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 ArrayOfSanctionsLists extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class SearchCompanyRequest {
/** @param {{CompanyName?:string,Country?:string,Address?:string,SelectedSanctionsLists?:ArrayOfSanctionsLists}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The name of the entity that is being searched. */
CompanyName;
/**
* @type {string}
* @description The country where the entity is registered. */
Country;
/**
* @type {string}
* @description The address where the entity is registered. */
Address;
/**
* @type {ArrayOfSanctionsLists}
* @description Array of sanctions lists to be included in the search. At least one is required. */
SelectedSanctionsLists;
}
export class AddCompanySearch {
/** @param {{Authentication?:Authentication,Request?:SearchCompanyRequest}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {Authentication}
* @description Authentication object */
Authentication;
/**
* @type {SearchCompanyRequest}
* @description Request object */
Request;
}
JavaScript AddCompanySearch DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=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>