Sanctions Search API: v1

GetCompanySearch

Sanctions

The following routes are available for this service:
POST	/sanctions/entity/get	Create a get a sanctions search for an entity	This will get a new sanctions search for an entity, such as a company, vessel, organisation, or group.

import java.math.*
import java.util.*
import net.servicestack.client.*


@ApiResponse(Description="Your request is successful if the \"<em>Data.ResponseStatus.Message</em>\" field is \"<b>Success</b>\".", StatusCode=200)
@DataContract
open class GetCompanySearch : IBaseRequest
{
    @DataMember
    var Authentication:Authentication? = null

    @DataMember
    var Id:Long? = null
}

@DataContract
open class Authentication : IAuthentication
{
    /**
    * The API User ID that will authenticate your request
    */
    @DataMember
    @ApiMember(DataType="string", Description="The API User ID that will authenticate your request", IsRequired=true)
    var ApiUserId:String? = null

    /**
    * The API User Key that will authenticate your request
    */
    @DataMember
    @ApiMember(DataType="string", Description="The API User Key that will authenticate your request", IsRequired=true)
    var ApiUserKey:String? = null
}

@DataContract
open class GetCompanySearchResponse
{
    @DataMember
    var Data:GetCompanySearchData? = null
}

@DataContract
open class GetCompanySearchData : IBaseDataResponse, IHasResponseStatus
{
    @DataMember
    var ResponseStatus:ResponseStatus? = null

    @DataMember
    var SearchRecord:SearchRecord? = null
}

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

open class SearchRecord
{
    var Id:Long? = null
    var SearchType:String? = null
    var DateSearched:Date? = null
    var DateUpdated:Date? = null
    var NumOfResults:Int? = null
    var ClientInResults:Boolean? = null
    var ClientNotInResults:Boolean? = null
    var AffectedByUpdate:Boolean? = null
    var SearchCriteria:SearchCriteria? = null
    var SearchResults:SearchResults? = null
}

open class SearchCriteria
{
    var Name:String? = null
    var DateOfBirth:String? = null
    var CountryOfBirth:String? = null
    var Nationality:String? = null
    var Address:String? = null
}

open class SearchResults
{
    var HMTResults:ArrayList<SearchResultHmTreasury> = ArrayList<SearchResultHmTreasury>()
    var OfacResults:ArrayList<SearchResultOfac> = ArrayList<SearchResultOfac>()
}

open class SearchResultHmTreasury
{
    var ResultStrength:Int? = null
    var ResultSimilarity:BigDecimal? = null
    var ResultResolved:Boolean? = null
    var ResultType:String? = null
    var DateListed:Date? = null
    var DateUpdated:Date? = null
    var Name1:String? = null
    var Name2:String? = null
    var Name3:String? = null
    var Name4:String? = null
    var Name5:String? = null
    var Name6:String? = null
    var DateOfBirth:String? = null
    var CountryOfBirth:String? = null
    var Nationality:String? = null
    var Address1:String? = null
    var Address2:String? = null
    var Address3:String? = null
    var Address4:String? = null
    var Address5:String? = null
    var Address6:String? = null
    var PostCode:String? = null
    var Country:String? = null
}

open class SearchResultOfac
{
    var ResultStrength:Int? = null
    var ResultSimilarity:BigDecimal? = null
    var ResultResolved:Boolean? = null
    var ResultType:String? = null
    var DateUpdated:Date? = null
    var FirstName:String? = null
    var LastName:String? = null
    var Addresses:ArrayList<SearchResultOfacAddress> = ArrayList<SearchResultOfacAddress>()
    var Akas:ArrayList<SearchResultOfacAka> = ArrayList<SearchResultOfacAka>()
    var DateOfBirths:ArrayList<SearchResultOfacDateOfBirth> = ArrayList<SearchResultOfacDateOfBirth>()
    var Nationalities:ArrayList<SearchResultOfacNationality> = ArrayList<SearchResultOfacNationality>()
    var PlaceOfBirths:ArrayList<SearchResultOfacPlaceOfBirth> = ArrayList<SearchResultOfacPlaceOfBirth>()
}

open class SearchResultOfacAddress
{
    var Address1:String? = null
    var Address2:String? = null
    var Address3:String? = null
    var City:String? = null
    var State:String? = null
    var PostCode:String? = null
    var Country:String? = null
}

open class SearchResultOfacAka
{
    var FirstName:String? = null
    var LastName:String? = null
    var Type:String? = null
    var Strength:String? = null
}

open class SearchResultOfacDateOfBirth
{
    var DateOfBirth:String? = null
}

open class SearchResultOfacNationality
{
    var Country:String? = null
}

open class SearchResultOfacPlaceOfBirth
{
    var PlaceOfBirth:String? = null
}

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

{"Authentication":{"ApiUserId":"String","ApiUserKey":"String"},"Id":0}

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

{"Data":{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]},"SearchRecord":{"Id":0,"SearchType":"String","DateSearched":"\/Date(-62135596800000-0000)\/","DateUpdated":"\/Date(-62135596800000-0000)\/","NumOfResults":0,"ClientInResults":false,"ClientNotInResults":false,"AffectedByUpdate":false,"SearchCriteria":{"Name":"String","DateOfBirth":"String","CountryOfBirth":"String","Nationality":"String","Address":"String"},"SearchResults":{"HMTResults":[{"ResultStrength":0,"ResultSimilarity":0,"ResultResolved":false,"ResultType":"String","DateListed":"\/Date(-62135596800000-0000)\/","DateUpdated":"\/Date(-62135596800000-0000)\/","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"}],"OfacResults":[{"ResultStrength":0,"ResultSimilarity":0,"ResultResolved":false,"ResultType":"String","DateUpdated":"\/Date(-62135596800000-0000)\/","FirstName":"String","LastName":"String","Addresses":[{"Address1":"String","Address2":"String","Address3":"String","City":"String","State":"String","PostCode":"String","Country":"String"}],"Akas":[{"FirstName":"String","LastName":"String","Type":"String","Strength":"String"}],"DateOfBirths":[{"DateOfBirth":"String"}],"Nationalities":[{"Country":"String"}],"PlaceOfBirths":[{"PlaceOfBirth":"String"}]}]}}}}