Sanctions Search API: v2

<back to all web services

SearchCompanyLookup

CompanyLookup
The following routes are available for this service:
POST/companylookups/searchSearch for company details
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

// @DataContract
class Authentication implements IConvertible
{
    /**
    * 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")
    String? apiUserId;

    /**
    * 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")
    String? apiUserKey;

    Authentication({this.apiUserId,this.apiUserKey});
    Authentication.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        apiUserId = json['apiUserId'];
        apiUserKey = json['apiUserKey'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'apiUserId': apiUserId,
        'apiUserKey': apiUserKey
    };

    getTypeName() => "Authentication";
    TypeContext? context = _ctx;
}

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

    BaseRequest({this.authentication});
    BaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        authentication = JsonConverters.fromJson(json['authentication'],'Authentication',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'authentication': JsonConverters.toJson(authentication,'Authentication',context!)
    };

    getTypeName() => "BaseRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class ResponseError implements IConvertible
{
    // @DataMember(Order=1)
    String? errorCode;

    // @DataMember(Order=2)
    String? fieldName;

    // @DataMember(Order=3)
    String? message;

    // @DataMember(Order=4)
    Map<String,String?>? meta;

    ResponseError({this.errorCode,this.fieldName,this.message,this.meta});
    ResponseError.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        errorCode = json['errorCode'];
        fieldName = json['fieldName'];
        message = json['message'];
        meta = JsonConverters.toStringMap(json['meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'errorCode': errorCode,
        'fieldName': fieldName,
        'message': message,
        'meta': meta
    };

    getTypeName() => "ResponseError";
    TypeContext? context = _ctx;
}

class ArrayOfResponseError extends ListBase<ResponseError> implements IConvertible
{
    final List<ResponseError> l = [];
    set length(int newLength) { l.length = newLength; }
    int get length => l.length;
    ResponseError operator [](int index) => l[index];
    void operator []=(int index, ResponseError value) { l[index] = value; }
    ArrayOfResponseError();
    ArrayOfResponseError.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "ArrayOfResponseError";
    TypeContext? context = _ctx;
}

// @DataContract
class ResponseStatus implements IConvertible
{
    // @DataMember(Order=1)
    String? errorCode;

    // @DataMember(Order=2)
    String? message;

    // @DataMember(Order=3)
    String? stackTrace;

    // @DataMember(Order=4)
    ArrayOfResponseError? errors;

    // @DataMember(Order=5)
    Map<String,String?>? meta;

    ResponseStatus({this.errorCode,this.message,this.stackTrace,this.errors,this.meta});
    ResponseStatus.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        errorCode = json['errorCode'];
        message = json['message'];
        stackTrace = json['stackTrace'];
        errors = JsonConverters.fromJson(json['errors'],'ArrayOfResponseError',context!);
        meta = JsonConverters.toStringMap(json['meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'errorCode': errorCode,
        'message': message,
        'stackTrace': stackTrace,
        'errors': JsonConverters.toJson(errors,'ArrayOfResponseError',context!),
        'meta': meta
    };

    getTypeName() => "ResponseStatus";
    TypeContext? context = _ctx;
}

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

    BaseResponse({this.responseStatus});
    BaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "BaseResponse";
    TypeContext? context = _ctx;
}

class CompanySearchResultItem implements IConvertible
{
    String? id;
    String? number;
    String? name;
    String? address;
    String? country;
    String? status;

    CompanySearchResultItem({this.id,this.number,this.name,this.address,this.country,this.status});
    CompanySearchResultItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        number = json['number'];
        name = json['name'];
        address = json['address'];
        country = json['country'];
        status = json['status'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'number': number,
        'name': name,
        'address': address,
        'country': country,
        'status': status
    };

    getTypeName() => "CompanySearchResultItem";
    TypeContext? context = _ctx;
}

class ArrayOfCompanySearchResult extends ListBase<CompanySearchResultItem> implements IConvertible
{
    final List<CompanySearchResultItem> l = [];
    set length(int newLength) { l.length = newLength; }
    int get length => l.length;
    CompanySearchResultItem operator [](int index) => l[index];
    void operator []=(int index, CompanySearchResultItem value) { l[index] = value; }
    ArrayOfCompanySearchResult();
    ArrayOfCompanySearchResult.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "ArrayOfCompanySearchResult";
    TypeContext? context = _ctx;
}

class SearchCompanyLookupData extends BaseResponse implements IConvertible
{
    ArrayOfCompanySearchResult? searchResults;

    SearchCompanyLookupData({this.searchResults});
    SearchCompanyLookupData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        searchResults = JsonConverters.fromJson(json['searchResults'],'ArrayOfCompanySearchResult',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'searchResults': JsonConverters.toJson(searchResults,'ArrayOfCompanySearchResult',context!)
    });

    getTypeName() => "SearchCompanyLookupData";
    TypeContext? context = _ctx;
}

// @DataContract
class SearchCompanyLookupResponse implements IConvertible
{
    // @DataMember
    SearchCompanyLookupData? data;

    SearchCompanyLookupResponse({this.data});
    SearchCompanyLookupResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        data = JsonConverters.fromJson(json['data'],'SearchCompanyLookupData',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'data': JsonConverters.toJson(data,'SearchCompanyLookupData',context!)
    };

    getTypeName() => "SearchCompanyLookupResponse";
    TypeContext? context = _ctx;
}

class SearchCompanyLookupRequest implements IConvertible
{
    String? companyName;
    String? companyCountry;
    bool? autocompleteMode;

    SearchCompanyLookupRequest({this.companyName,this.companyCountry,this.autocompleteMode});
    SearchCompanyLookupRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        companyName = json['companyName'];
        companyCountry = json['companyCountry'];
        autocompleteMode = json['autocompleteMode'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'companyName': companyName,
        'companyCountry': companyCountry,
        'autocompleteMode': autocompleteMode
    };

    getTypeName() => "SearchCompanyLookupRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class SearchCompanyLookup extends BaseRequest implements IConvertible
{
    // @DataMember
    SearchCompanyLookupRequest? request;

    SearchCompanyLookup({this.request});
    SearchCompanyLookup.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        request = JsonConverters.fromJson(json['request'],'SearchCompanyLookupRequest',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'request': JsonConverters.toJson(request,'SearchCompanyLookupRequest',context!)
    });

    getTypeName() => "SearchCompanyLookup";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.sanctionssearch.com', types: <String, TypeInfo> {
    'Authentication': TypeInfo(TypeOf.Class, create:() => Authentication()),
    'BaseRequest': TypeInfo(TypeOf.Class, create:() => BaseRequest()),
    'ArrayOfResponseError': TypeInfo(TypeOf.Class, create:() => ArrayOfResponseError()),
    'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
    'CompanySearchResultItem': TypeInfo(TypeOf.Class, create:() => CompanySearchResultItem()),
    'ArrayOfCompanySearchResult': TypeInfo(TypeOf.Class, create:() => ArrayOfCompanySearchResult()),
    'SearchCompanyLookupData': TypeInfo(TypeOf.Class, create:() => SearchCompanyLookupData()),
    'SearchCompanyLookupResponse': TypeInfo(TypeOf.Class, create:() => SearchCompanyLookupResponse()),
    'SearchCompanyLookupRequest': TypeInfo(TypeOf.Class, create:() => SearchCompanyLookupRequest()),
    'SearchCompanyLookup': TypeInfo(TypeOf.Class, create:() => SearchCompanyLookup()),
});

Dart SearchCompanyLookup 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 /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"}}}}