Sanctions Search API: v2

<back to all web services

GetSearch

Sanctions
The following routes are available for this service:
POST/sanctions/getGet a sanctions search
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using SanctionsSearch.Api2.ServiceModel.Operations.Searches;
using SanctionsSearch.Api2.ServiceModel.Operations.Base;
using SanctionsSearch.Api2.ServiceModel.Types;

namespace SanctionsSearch.Api2.ServiceModel.Operations.Base
{
    public partial class ArrayOfResponseError
        : List<ResponseError>
    {
    }

    [DataContract]
    public partial class BaseRequest
        : IBaseRequest
    {
        ///<summary>
        ///The authentication credentials
        ///</summary>
        [DataMember]
        [ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")]
        public virtual Authentication Authentication { get; set; }
    }

    public partial class BaseResponse
        : IBaseDataResponse, IHasResponseStatus
    {
        ///<summary>
        ///The status of the response
        ///</summary>
        [ApiMember(Description="The status of the response")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public partial class ResponseError
    {
        public ResponseError()
        {
            Meta = new Dictionary<string, string>{};
        }

        [DataMember(Order=1)]
        public virtual string ErrorCode { get; set; }

        [DataMember(Order=2)]
        public virtual string FieldName { get; set; }

        [DataMember(Order=3)]
        public virtual string Message { get; set; }

        [DataMember(Order=4)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public partial class ResponseStatus
    {
        public ResponseStatus()
        {
            Meta = new Dictionary<string, string>{};
        }

        [DataMember(Order=1)]
        public virtual string ErrorCode { get; set; }

        [DataMember(Order=2)]
        public virtual string Message { get; set; }

        [DataMember(Order=3)]
        public virtual string StackTrace { get; set; }

        [DataMember(Order=4)]
        public virtual ArrayOfResponseError Errors { get; set; }

        [DataMember(Order=5)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

}

namespace SanctionsSearch.Api2.ServiceModel.Operations.Searches
{
    [DataContract]
    public partial class GetSearch
        : BaseRequest
    {
        [DataMember]
        public virtual GetSearchRequest Request { get; set; }
    }

    public partial class GetSearchData
        : BaseResponse, IBaseSearchResponse
    {
        public virtual ArrayOfLinkedTo LinkedTo { get; set; }
        public virtual SearchRecord SearchRecord { get; set; }
    }

    public partial class GetSearchRequest
    {
        ///<summary>
        ///If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it
        ///</summary>
        [ApiMember(Description="If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it")]
        public virtual string SubUserName { get; set; }

        ///<summary>
        ///If set to true, the response will exclude resolved search results, it will only include unresolved results
        ///</summary>
        [ApiMember(Description="If set to true, the response will exclude resolved search results, it will only include unresolved results")]
        public virtual bool OnlyShowUnresolvedResults { get; set; }

        public virtual long Id { get; set; }
    }

    [DataContract]
    public partial class GetSearchResponse
    {
        [DataMember]
        public virtual GetSearchData Data { get; set; }
    }

}

namespace SanctionsSearch.Api2.ServiceModel.Types
{
    public partial class ArrayOfLinkedTo
        : List<LinkedTo>
    {
    }

    public partial class ArrayOfSearchResultEntries
        : List<SearchResultEntry>
    {
    }

    [DataContract]
    public partial class Authentication
    {
        ///<summary>
        ///The API User ID provided by us when you signed up to use our API
        ///</summary>
        [DataMember]
        [ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")]
        public virtual string ApiUserId { get; set; }

        ///<summary>
        ///The API User Key provided by us when you signed up to use our API
        ///</summary>
        [DataMember]
        [ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")]
        public virtual string ApiUserKey { get; set; }
    }

    public partial class LinkedTo
    {
        public virtual int? ClientId { get; set; }
        public virtual long? Id { get; set; }
        public virtual string Type { get; set; }
        public virtual string Subtype { get; set; }
        public virtual string Status { get; set; }
        public virtual string Description { get; set; }
        public virtual bool? IsArchived { get; set; }
        public virtual string Name { get; set; }
        public virtual DateTime? Date { get; set; }
    }

    public partial class SearchCriteria
    {
        public virtual string Name { get; set; }
        public virtual string Address { get; set; }
        public virtual string Country { get; set; }
        public virtual string DateOfBirth { get; set; }
        public virtual string Nationality { get; set; }
        public virtual string Reference { get; set; }
    }

    public partial class SearchRecord
    {
        public SearchRecord()
        {
            SearchSources = new List<SearchSource>{};
        }

        public virtual long Id { get; set; }
        public virtual string SearchType { get; set; }
        public virtual DateTime DateSearched { get; set; }
        public virtual DateTime DateUpdated { get; set; }
        public virtual DateTime? DateArchived { get; set; }
        public virtual bool IsArchived { get; set; }
        public virtual int NumOfResults { get; set; }
        public virtual bool ClientInResults { get; set; }
        public virtual bool ClientNotInResults { get; set; }
        public virtual bool AffectedByUpdate { get; set; }
        public virtual SearchCriteria SearchCriteria { get; set; }
        public virtual SearchResults SearchResults { get; set; }
        public virtual List<SearchSource> SearchSources { get; set; }
        public virtual ArrayOfSearchResultEntries ListSearchResults { get; set; }
    }

    public partial class SearchResultAddress
    {
        public virtual long SearchResultAddressId { get; set; }
        public virtual string Type { get; set; }
        public virtual string Address1 { get; set; }
        public virtual string Address2 { get; set; }
        public virtual string Address3 { get; set; }
        public virtual string City { get; set; }
        public virtual string County { get; set; }
        public virtual string PostCode { get; set; }
        public virtual string Country { get; set; }
    }

    public partial class SearchResultCanadianJustice
    {
        public virtual int ResultStrength { get; set; }
        public virtual decimal ResultSimilarity { get; set; }
        public virtual bool ResultResolved { get; set; }
        public virtual string ResultType { get; set; }
        public virtual DateTime DateUpdated { get; set; }
        public virtual string Name { get; set; }
        public virtual string DateOfBirth { get; set; }
        public virtual string Country { get; set; }
        public virtual int RefId { get; set; }
    }

    public partial class SearchResultCanadianSema
    {
        public virtual int ResultStrength { get; set; }
        public virtual decimal ResultSimilarity { get; set; }
        public virtual bool ResultResolved { get; set; }
        public virtual string ResultType { get; set; }
        public virtual DateTime DateUpdated { get; set; }
        public virtual string Name { get; set; }
        public virtual string DateOfBirth { get; set; }
        public virtual string Country { get; set; }
        public virtual string Schedule { get; set; }
        public virtual string Item { get; set; }
    }

    public partial class SearchResultDateOfBirth
    {
        public virtual long SearchResultDateOfBirthId { get; set; }
        public virtual string DateOfBirth { get; set; }
        public virtual short? Year { get; set; }
        public virtual byte? Month { get; set; }
        public virtual byte? Day { get; set; }
        public virtual string Type { get; set; }
    }

    public partial class SearchResultDfat
    {
        public virtual int ResultStrength { get; set; }
        public virtual decimal ResultSimilarity { get; set; }
        public virtual bool ResultResolved { get; set; }
        public virtual string ResultType { get; set; }
        public virtual DateTime DateUpdated { get; set; }
        public virtual string FullName { get; set; }
        public virtual string Address { get; set; }
        public virtual string DateOfBirth { get; set; }
        public virtual string PlaceOfBirth { get; set; }
        public virtual string Nationality { get; set; }
    }

    public partial class SearchResultEntry
    {
        public SearchResultEntry()
        {
            Addresses = new List<SearchResultAddress>{};
            DatesOfBirth = new List<SearchResultDateOfBirth>{};
            Names = new List<SearchResultName>{};
            Nationalities = new List<SearchResultNationality>{};
            PlacesOfBirth = new List<SearchResultPlaceOfBirth>{};
            Remarks = new List<SearchResultRemark>{};
        }

        public virtual long SearchResultId { get; set; }
        public virtual int ResultStrength { get; set; }
        public virtual decimal ResultSimilarity { get; set; }
        public virtual bool ResultResolved { get; set; }
        public virtual string ResultType { get; set; }
        public virtual DateTime? DateUpdated { get; set; }
        public virtual string SanctionsListId { get; set; }
        public virtual string SanctionsListName { get; set; }
        public virtual List<SearchResultAddress> Addresses { get; set; }
        public virtual List<SearchResultDateOfBirth> DatesOfBirth { get; set; }
        public virtual List<SearchResultName> Names { get; set; }
        public virtual List<SearchResultNationality> Nationalities { get; set; }
        public virtual List<SearchResultPlaceOfBirth> PlacesOfBirth { get; set; }
        public virtual List<SearchResultRemark> Remarks { get; set; }
    }

    public partial class SearchResultEu
    {
        public SearchResultEu()
        {
            Addresses = new List<SearchResultEuAddress>{};
            Births = new List<SearchResultEuBirth>{};
            Citizenships = new List<SearchResultOfacEuCitizenship>{};
            Names = new List<SearchResultEuName>{};
            Passports = new List<SearchResultEuPassport>{};
        }

        public virtual int ResultStrength { get; set; }
        public virtual decimal ResultSimilarity { get; set; }
        public virtual bool ResultResolved { get; set; }
        public virtual string ResultType { get; set; }
        public virtual DateTime DateUpdated { get; set; }
        public virtual List<SearchResultEuAddress> Addresses { get; set; }
        public virtual List<SearchResultEuBirth> Births { get; set; }
        public virtual List<SearchResultOfacEuCitizenship> Citizenships { get; set; }
        public virtual List<SearchResultEuName> Names { get; set; }
        public virtual List<SearchResultEuPassport> Passports { get; set; }
    }

    public partial class SearchResultEuAddress
    {
        public virtual string Street { get; set; }
        public virtual string City { get; set; }
        public virtual string Country { get; set; }
        public virtual string PostCode { get; set; }
        public virtual string Other { get; set; }
    }

    public partial class SearchResultEuBirth
    {
        public virtual string Date { get; set; }
        public virtual string Place { get; set; }
        public virtual string Country { get; set; }
    }

    public partial class SearchResultEuName
    {
        public virtual string FullName { get; set; }
        public virtual string Gender { get; set; }
    }

    public partial class SearchResultEuPassport
    {
        public virtual string Number { get; set; }
        public virtual string Country { get; set; }
    }

    public partial class SearchResultHmTreasury
    {
        public virtual int ResultStrength { get; set; }
        public virtual decimal ResultSimilarity { get; set; }
        public virtual bool ResultResolved { get; set; }
        public virtual string ResultType { get; set; }
        public virtual DateTime DateListed { get; set; }
        public virtual DateTime DateUpdated { get; set; }
        public virtual string Name1 { get; set; }
        public virtual string Name2 { get; set; }
        public virtual string Name3 { get; set; }
        public virtual string Name4 { get; set; }
        public virtual string Name5 { get; set; }
        public virtual string Name6 { get; set; }
        public virtual string DateOfBirth { get; set; }
        public virtual string CountryOfBirth { get; set; }
        public virtual string Nationality { get; set; }
        public virtual string Address1 { get; set; }
        public virtual string Address2 { get; set; }
        public virtual string Address3 { get; set; }
        public virtual string Address4 { get; set; }
        public virtual string Address5 { get; set; }
        public virtual string Address6 { get; set; }
        public virtual string PostCode { get; set; }
        public virtual string Country { get; set; }
    }

    public partial class SearchResultName
    {
        public virtual long SearchResultNameId { get; set; }
        public virtual string Type { get; set; }
        public virtual string Title { get; set; }
        public virtual string FullName { get; set; }
        public virtual decimal ResultSimilarity { get; set; }
    }

    public partial class SearchResultNationality
    {
        public virtual long SearchResultNationalityId { get; set; }
        public virtual string Nationality { get; set; }
    }

    public partial class SearchResultOfac
    {
        public SearchResultOfac()
        {
            Addresses = new List<SearchResultOfacAddress>{};
            Akas = new List<SearchResultOfacAka>{};
            DateOfBirths = new List<SearchResultOfacDateOfBirth>{};
            Nationalities = new List<SearchResultOfacNationality>{};
            PlaceOfBirths = new List<SearchResultOfacPlaceOfBirth>{};
        }

        public virtual int ResultStrength { get; set; }
        public virtual decimal ResultSimilarity { get; set; }
        public virtual bool ResultResolved { get; set; }
        public virtual string ResultType { get; set; }
        public virtual DateTime DateUpdated { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual List<SearchResultOfacAddress> Addresses { get; set; }
        public virtual List<SearchResultOfacAka> Akas { get; set; }
        public virtual List<SearchResultOfacDateOfBirth> DateOfBirths { get; set; }
        public virtual List<SearchResultOfacNationality> Nationalities { get; set; }
        public virtual List<SearchResultOfacPlaceOfBirth> PlaceOfBirths { get; set; }
    }

    public partial class SearchResultOfacAddress
    {
        public virtual string Address1 { get; set; }
        public virtual string Address2 { get; set; }
        public virtual string Address3 { get; set; }
        public virtual string City { get; set; }
        public virtual string State { get; set; }
        public virtual string PostCode { get; set; }
        public virtual string Country { get; set; }
    }

    public partial class SearchResultOfacAka
    {
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual string Type { get; set; }
        public virtual string Strength { get; set; }
    }

    public partial class SearchResultOfacDateOfBirth
    {
        public virtual string DateOfBirth { get; set; }
    }

    public partial class SearchResultOfacEuCitizenship
    {
        public virtual string Country { get; set; }
    }

    public partial class SearchResultOfacNationality
    {
        public virtual string Country { get; set; }
    }

    public partial class SearchResultOfacPlaceOfBirth
    {
        public virtual string PlaceOfBirth { get; set; }
    }

    public partial class SearchResultOsfi
    {
        public virtual int ResultStrength { get; set; }
        public virtual decimal ResultSimilarity { get; set; }
        public virtual bool ResultResolved { get; set; }
        public virtual string ResultType { get; set; }
        public virtual DateTime DateUpdated { get; set; }
        public virtual string FullName { get; set; }
        public virtual string Address { get; set; }
        public virtual string DateOfBirth { get; set; }
        public virtual string PlaceOfBirth { get; set; }
        public virtual string Nationality { get; set; }
    }

    public partial class SearchResultPlaceOfBirth
    {
        public virtual long SearchResultPlaceOfBirthId { get; set; }
        public virtual string PlaceOfBirth { get; set; }
        public virtual string CountryOfBirth { get; set; }
    }

    public partial class SearchResultRemark
    {
        public virtual long SearchResultRemarkId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
    }

    public partial class SearchResults
    {
        public SearchResults()
        {
            EuResults = new List<SearchResultEu>{};
            HMTResults = new List<SearchResultHmTreasury>{};
            HMTUkraineResults = new List<SearchResultHmTreasury>{};
            OfacResults = new List<SearchResultOfac>{};
            OfacConsolidatedResults = new List<SearchResultOfac>{};
            DfatResults = new List<SearchResultDfat>{};
            OsfiResults = new List<SearchResultOsfi>{};
            CanadianJusticeResults = new List<SearchResultCanadianJustice>{};
            CanadianSemaResults = new List<SearchResultCanadianSema>{};
            SwissSecoResults = new List<SearchResultEntry>{};
        }

        public virtual List<SearchResultEu> EuResults { get; set; }
        public virtual List<SearchResultHmTreasury> HMTResults { get; set; }
        public virtual List<SearchResultHmTreasury> HMTUkraineResults { get; set; }
        public virtual List<SearchResultOfac> OfacResults { get; set; }
        public virtual List<SearchResultOfac> OfacConsolidatedResults { get; set; }
        public virtual List<SearchResultDfat> DfatResults { get; set; }
        public virtual List<SearchResultOsfi> OsfiResults { get; set; }
        public virtual List<SearchResultCanadianJustice> CanadianJusticeResults { get; set; }
        public virtual List<SearchResultCanadianSema> CanadianSemaResults { get; set; }
        public virtual List<SearchResultEntry> SwissSecoResults { get; set; }
    }

    public partial class SearchSource
    {
        public virtual string ListId { get; set; }
        public virtual string ListName { get; set; }
        public virtual string ListShortName { get; set; }
        public virtual bool? IsAffectedByListUpdate { get; set; }
    }

}

C# GetSearch 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/get HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"subUserName":"String","onlyShowUnresolvedResults":false,"id":0},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}],"searchRecord":{"id":0,"searchType":"String","dateSearched":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","dateArchived":"\/Date(-62135596800000-0000)\/","isArchived":false,"numOfResults":0,"clientInResults":false,"clientNotInResults":false,"affectedByUpdate":false,"searchCriteria":{"name":"String","address":"String","country":"String","dateOfBirth":"String","nationality":"String","reference":"String"},"searchResults":{"euResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","addresses":[{"street":"String","city":"String","country":"String","postCode":"String","other":"String"}],"births":[{"date":"String","place":"String","country":"String"}],"citizenships":[{"country":"String"}],"names":[{"fullName":"String","gender":"String"}],"passports":[{"number":"String","country":"String"}]}],"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"}],"hmtUkraineResults":[{"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"}]}],"ofacConsolidatedResults":[{"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"}]}],"dfatResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","fullName":"String","address":"String","dateOfBirth":"String","placeOfBirth":"String","nationality":"String"}],"osfiResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","fullName":"String","address":"String","dateOfBirth":"String","placeOfBirth":"String","nationality":"String"}],"canadianJusticeResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","name":"String","dateOfBirth":"String","country":"String","refId":0}],"canadianSemaResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","name":"String","dateOfBirth":"String","country":"String","schedule":"String","item":"String"}],"swissSecoResults":[{"searchResultId":0,"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","sanctionsListId":"String","sanctionsListName":"String","addresses":[{"searchResultAddressId":0,"type":"String","address1":"String","address2":"String","address3":"String","city":"String","county":"String","postCode":"String","country":"String"}],"datesOfBirth":[{"searchResultDateOfBirthId":0,"dateOfBirth":"String","year":0,"month":0,"day":0,"type":"String"}],"names":[{"searchResultNameId":0,"type":"String","title":"String","fullName":"String","resultSimilarity":0}],"nationalities":[{"searchResultNationalityId":0,"nationality":"String"}],"placesOfBirth":[{"searchResultPlaceOfBirthId":0,"placeOfBirth":"String","countryOfBirth":"String"}],"remarks":[{"searchResultRemarkId":0,"name":"String","description":"String"}]}]},"searchSources":[{"listId":"String","listName":"String","listShortName":"String","isAffectedByListUpdate":false}],"listSearchResults":[{"searchResultId":0,"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","sanctionsListId":"String","sanctionsListName":"String","addresses":[{"searchResultAddressId":0,"type":"String","address1":"String","address2":"String","address3":"String","city":"String","county":"String","postCode":"String","country":"String"}],"datesOfBirth":[{"searchResultDateOfBirthId":0,"dateOfBirth":"String","year":0,"month":0,"day":0,"type":"String"}],"names":[{"searchResultNameId":0,"type":"String","title":"String","fullName":"String","resultSimilarity":0}],"nationalities":[{"searchResultNationalityId":0,"nationality":"String"}],"placesOfBirth":[{"searchResultPlaceOfBirthId":0,"placeOfBirth":"String","countryOfBirth":"String"}],"remarks":[{"searchResultRemarkId":0,"name":"String","description":"String"}]}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}