Sanctions Search API: v2

GetCompanyLookups

CompanyLookup

The following routes are available for this service:
POST	/companylookups/list	Get all company lookups

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class GetCompanyLookups : BaseRequest()
{
    @DataMember
    var request:GetCompanyLookupsRequest? = null
}

@DataContract
open class BaseRequest : IBaseRequest
{
    /**
    * The authentication credentials
    */
    @DataMember
    @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    var authentication:Authentication? = null
}

@DataContract
open class Authentication
{
    /**
    * 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")
    var apiUserId:String? = null

    /**
    * 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")
    var apiUserKey:String? = null
}

open class GetCompanyLookupsRequest
{
    /**
    * If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view
    */
    @ApiMember(Description="If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view")
    var subUserName:String? = null

    var listIncompleteSearches:Boolean? = null
    var page:Int? = null
    var sortOrder:String? = null
    var nameSearch:String? = null
    var filterReference:String? = null
    var filterDateFrom:Date? = null
    var filterDateTo:Date? = null
    /**
    * If set, will only return searches created by the user
    */
    @ApiMember(Description="If set, will only return searches created by the user")
    var filterUserName:String? = null
}

@DataContract
open class GetCompanyLookupsResponse
{
    @DataMember
    @SerializedName("data") var Data:GetCompanyLookupsData? = null
}

open class GetCompanyLookupsData : BaseResponse()
{
    var totalRecords:Int? = null
    var currentPageNum:Int? = null
    var maxPageNum:Int? = null
    var companyLookupRecords:ArrayOfCompanyLookupListItem? = null
}

open class BaseResponse : IBaseDataResponse, IHasResponseStatus
{
    /**
    * The status of the response
    */
    @ApiMember(Description="The status of the response")
    var responseStatus:ResponseStatus? = null
}

open class ArrayOfResponseError : ArrayList<ResponseError>()
{
}

open class ArrayOfCompanyLookupListItem : ArrayList<CompanyLookupListItem>()
{
}

open class CompanyLookupListItem
{
    var id:Int? = null
    var searchCriteria:SearchCriteria? = null
    var selectedLists:ArrayOfLists? = null
    var date:Date? = null
    var hasCompanyId:Boolean? = null
    var hasCompanyDetails:Boolean? = null
    var hasStartedSearches:Boolean? = null
    var hasCompletedSearches:Boolean? = null
}

open class SearchCriteria
{
    var name:String? = null
    var address:String? = null
    var country:String? = null
    var dateOfBirth:String? = null
    var nationality:String? = null
    var reference:String? = null
}

open class ArrayOfLists : ArrayList<String>()
{
}

Kotlin GetCompanyLookups 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/list HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"subUserName":"String","listIncompleteSearches":false,"page":0,"sortOrder":"String","nameSearch":"String","filterReference":"String","filterDateFrom":"\/Date(-62135596800000-0000)\/","filterDateTo":"\/Date(-62135596800000-0000)\/","filterUserName":"String"},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"totalRecords":0,"currentPageNum":0,"maxPageNum":0,"companyLookupRecords":[{"id":0,"searchCriteria":{"name":"String","address":"String","country":"String","dateOfBirth":"String","nationality":"String","reference":"String"},"selectedLists":["String"],"date":"\/Date(-62135596800000-0000)\/","hasCompanyId":false,"hasCompanyDetails":false,"hasStartedSearches":false,"hasCompletedSearches":false}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}