Sanctions Search API: v2

<back to all web services

SearchCompanyLookup

// @DataContract
export class Authentication
{
    /** @description The API User ID provided by us when you signed up to use our API */
    // @DataMember
    // @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public apiUserId: string;

    /** @description The API User Key provided by us when you signed up to use our API */
    // @DataMember
    // @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public apiUserKey: string;

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

// @DataContract
export class BaseRequest implements IBaseRequest
{
    /** @description The authentication credentials */
    // @DataMember
    // @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    public authentication: Authentication;

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

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

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

    // @DataMember(Order=3)
    public message: string;

    // @DataMember(Order=4)
    public meta: { [index: string]: 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;

    // @DataMember(Order=5)
    public meta: { [index: string]: string; };

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

export class BaseResponse implements IBaseDataResponse, IHasResponseStatus
{
    /** @description The status of the response */
    // @ApiMember(Description="The status of the response")
    public responseStatus: ResponseStatus;

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

export class CompanySearchResultItem
{
    public id: string;
    public number: string;
    public name: string;
    public address: string;
    public country: string;
    public status: string;

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

export class ArrayOfCompanySearchResult extends Array<CompanySearchResultItem>
{

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

export class SearchCompanyLookupData extends BaseResponse
{
    public searchResults: ArrayOfCompanySearchResult;

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

// @DataContract
export class SearchCompanyLookupResponse
{
    // @DataMember
    public data: SearchCompanyLookupData;

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

export class SearchCompanyLookupRequest
{
    public companyName: string;
    public companyCountry: string;
    public autocompleteMode: boolean;

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

// @DataContract
export class SearchCompanyLookup extends BaseRequest
{
    // @DataMember
    public request: SearchCompanyLookupRequest;

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

TypeScript SearchCompanyLookup DTOs

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

{"request":{"companyName":"String","companyCountry":"String","autocompleteMode":false},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"searchResults":[{"id":"String","number":"String","name":"String","address":"String","country":"String","status":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}