Sanctions Search API: v1

<back to all web services

AddIndividualSearch

Sanctions

Create a new sanctions search for a person. SanctionsListId: valid values: HMTSL and OFACL

The following routes are available for this service:
POST/sanctions/individual/createCreate a new sanctions search for an individual
import Foundation
import ServiceStack

/**
* Create a new sanctions search for a person. SanctionsListId: valid values: HMTSL and OFACL
*/
// @Api(Description="Create a new sanctions search for a person. SanctionsListId: valid values: HMTSL and OFACL")
// @ApiResponse(Description="Your request is successful if the \"<em>Data.ResponseStatus.Message</em>\" field is \"<b>Success</b>\".", StatusCode=200)
// @DataContract
public class AddIndividualSearch : IBaseRequest, Codable
{
    // @DataMember
    public var authentication:Authentication

    // @DataMember
    public var request:SearchIndividualRequest

    required public init(){}
}

// @DataContract
public class Authentication : IAuthentication, Codable
{
    /**
    * 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)
    public var apiUserId:String

    /**
    * 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)
    public var apiUserKey:String

    required public init(){}
}

public class SearchIndividualRequest : Codable
{
    public var name1:String
    public var name2:String
    public var name3:String
    public var name4:String
    public var name5:String
    public var name6:String
    public var dateOfBirth:String
    public var countryOfBirth:String
    public var nationality:String
    public var address:String
    public var selectedSanctionsLists:ArrayOfSanctionsLists

    required public init(){}
}

public class ArrayOfSanctionsLists : List<String>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract
public class AddIndividualSearchResponse : Codable
{
    // @DataMember
    public var data:AddIndividualSearchData

    required public init(){}
}

// @DataContract
public class AddIndividualSearchData : IBaseDataResponse, IHasResponseStatus, Codable
{
    // @DataMember
    public var responseStatus:ResponseStatus

    // @DataMember
    public var searchRecord:SearchRecord

    required public init(){}
}

public class ArrayOfResponseError : List<ResponseError>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class SearchRecord : Codable
{
    public var id:Int
    public var searchType:String
    public var dateSearched:Date
    public var dateUpdated:Date
    public var numOfResults:Int
    public var clientInResults:Bool
    public var clientNotInResults:Bool
    public var affectedByUpdate:Bool
    public var searchCriteria:SearchCriteria
    public var searchResults:SearchResults

    required public init(){}
}

public class SearchCriteria : Codable
{
    public var name:String
    public var dateOfBirth:String
    public var countryOfBirth:String
    public var nationality:String
    public var address:String

    required public init(){}
}

public class SearchResults : Codable
{
    public var hmtResults:[SearchResultHmTreasury] = []
    public var ofacResults:[SearchResultOfac] = []

    required public init(){}
}

public class SearchResultHmTreasury : Codable
{
    public var resultStrength:Int
    public var resultSimilarity:Double
    public var resultResolved:Bool
    public var resultType:String
    public var dateListed:Date
    public var dateUpdated:Date
    public var name1:String
    public var name2:String
    public var name3:String
    public var name4:String
    public var name5:String
    public var name6:String
    public var dateOfBirth:String
    public var countryOfBirth:String
    public var nationality:String
    public var address1:String
    public var address2:String
    public var address3:String
    public var address4:String
    public var address5:String
    public var address6:String
    public var postCode:String
    public var country:String

    required public init(){}
}

public class SearchResultOfac : Codable
{
    public var resultStrength:Int
    public var resultSimilarity:Double
    public var resultResolved:Bool
    public var resultType:String
    public var dateUpdated:Date
    public var firstName:String
    public var lastName:String
    public var addresses:[SearchResultOfacAddress] = []
    public var akas:[SearchResultOfacAka] = []
    public var dateOfBirths:[SearchResultOfacDateOfBirth] = []
    public var nationalities:[SearchResultOfacNationality] = []
    public var placeOfBirths:[SearchResultOfacPlaceOfBirth] = []

    required public init(){}
}

public class SearchResultOfacAddress : Codable
{
    public var address1:String
    public var address2:String
    public var address3:String
    public var city:String
    public var state:String
    public var postCode:String
    public var country:String

    required public init(){}
}

public class SearchResultOfacAka : Codable
{
    public var firstName:String
    public var lastName:String
    public var type:String
    public var strength:String

    required public init(){}
}

public class SearchResultOfacDateOfBirth : Codable
{
    public var dateOfBirth:String

    required public init(){}
}

public class SearchResultOfacNationality : Codable
{
    public var country:String

    required public init(){}
}

public class SearchResultOfacPlaceOfBirth : Codable
{
    public var placeOfBirth:String

    required public init(){}
}

Swift AddIndividualSearch 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/individual/create HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Authentication":{"ApiUserId":"String","ApiUserKey":"String"},"Request":{"Name1":"String","Name2":"String","Name3":"String","Name4":"String","Name5":"String","Name6":"String","DateOfBirth":"String","CountryOfBirth":"String","Nationality":"String","Address":"String","SelectedSanctionsLists":["String"]}}

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"}]}]}}}}