Sanctions Search API: v2

<back to all web services

SearchCompanyLookup

"use strict";
export class Authentication {
    /** @param {{apiUserId?:string,apiUserKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API User ID provided by us when you signed up to use our API */
    apiUserId;
    /**
     * @type {string}
     * @description The API User Key provided by us when you signed up to use our API */
    apiUserKey;
}
export class BaseRequest {
    /** @param {{authentication?:Authentication}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Authentication}
     * @description The authentication credentials */
    authentication;
}
export class ResponseError {
    /** @param {{errorCode?:string,fieldName?:string,message?:string,meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    errorCode;
    /** @type {string} */
    fieldName;
    /** @type {string} */
    message;
    /** @type {{ [index: string]: string; }} */
    meta;
}
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,meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    errorCode;
    /** @type {string} */
    message;
    /** @type {string} */
    stackTrace;
    /** @type {ArrayOfResponseError} */
    errors;
    /** @type {{ [index: string]: string; }} */
    meta;
}
export class BaseResponse {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {ResponseStatus}
     * @description The status of the response */
    responseStatus;
}
export class CompanySearchResultItem {
    /** @param {{id?:string,number?:string,name?:string,address?:string,country?:string,status?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    number;
    /** @type {string} */
    name;
    /** @type {string} */
    address;
    /** @type {string} */
    country;
    /** @type {string} */
    status;
}
export class ArrayOfCompanySearchResult extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class SearchCompanyLookupData extends BaseResponse {
    /** @param {{searchResults?:ArrayOfCompanySearchResult,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {ArrayOfCompanySearchResult} */
    searchResults;
}
export class SearchCompanyLookupResponse {
    /** @param {{data?:SearchCompanyLookupData}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {SearchCompanyLookupData} */
    data;
}
export class SearchCompanyLookupRequest {
    /** @param {{companyName?:string,companyCountry?:string,autocompleteMode?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    companyName;
    /** @type {string} */
    companyCountry;
    /** @type {boolean} */
    autocompleteMode;
}
export class SearchCompanyLookup extends BaseRequest {
    /** @param {{request?:SearchCompanyLookupRequest,authentication?:Authentication}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {SearchCompanyLookupRequest} */
    request;
}

JavaScript SearchCompanyLookup DTOs

POST /companylookups/search HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SearchCompanyLookup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <AutocompleteMode>false</AutocompleteMode>
    <CompanyCountry>String</CompanyCountry>
    <CompanyName>String</CompanyName>
  </Request>
</SearchCompanyLookup>

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

<SearchCompanyLookupResponse 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>
          <Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </Meta>
        </ResponseError>
      </Errors>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseStatus>
    <SearchResults>
      <Company>
        <Address>String</Address>
        <Country>String</Country>
        <Id>String</Id>
        <Name>String</Name>
        <Number>String</Number>
        <Status>String</Status>
      </Company>
    </SearchResults>
  </Data>
</SearchCompanyLookupResponse>