Sanctions Search API: v2

<back to all web services

AddPepSearch

PEP
The following routes are available for this service:
POST/peps/addAdd a PEP search
namespace SanctionsSearch.Api2.ServiceModel.Operations.Base

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type ResponseError() = 
        [<DataMember(Order=1)>]
        member val ErrorCode:String = null with get,set

        [<DataMember(Order=2)>]
        member val FieldName:String = null with get,set

        [<DataMember(Order=3)>]
        member val Message:String = null with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type ArrayOfResponseError() = 
        inherit ResizeArray<ResponseError>()

    [<DataContract>]
    [<AllowNullLiteral>]
    type ResponseStatus() = 
        [<DataMember(Order=1)>]
        member val ErrorCode:String = null with get,set

        [<DataMember(Order=2)>]
        member val Message:String = null with get,set

        [<DataMember(Order=3)>]
        member val StackTrace:String = null with get,set

        [<DataMember(Order=4)>]
        member val Errors:ArrayOfResponseError = null with get,set

        [<DataMember(Order=5)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///The status of the response
        ///</summary>
        [<ApiMember(Description="The status of the response")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type LinkedTo() = 
        member val ClientId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val Type:String = null with get,set
        member val Subtype:String = null with get,set
        member val Status:String = null with get,set
        member val Description:String = null with get,set
        member val IsArchived:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val Name:String = null with get,set
        member val Date:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type ArrayOfLinkedTo() = 
        inherit ResizeArray<LinkedTo>()

    [<AllowNullLiteral>]
    type SearchCriteria() = 
        member val Name:String = null with get,set
        member val Address:String = null with get,set
        member val Country:String = null with get,set
        member val DateOfBirth:String = null with get,set
        member val Nationality:String = null with get,set
        member val Reference:String = null with get,set

    [<AllowNullLiteral>]
    type PepSearchResultAddress() = 
        member val AddressLine1:String = null with get,set
        member val AddressLine2:String = null with get,set
        member val AddressLine3:String = null with get,set
        member val AddressLine4:String = null with get,set
        member val Town:String = null with get,set
        member val County:String = null with get,set
        member val PostCode:String = null with get,set
        member val Country:String = null with get,set
        member val ISOCountry:String = null with get,set
        member val SoftDelete:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val DateLastUpdated:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type PepSearchResultAlias() = 
        member val Forename:String = null with get,set
        member val MiddleName:String = null with get,set
        member val Surname:String = null with get,set
        member val SoftDelete:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val DateOfSoftDelete:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DateLastUpdated:DateTime = new DateTime() with get,set
        member val Title:String = null with get,set
        member val AlternateTitle:String = null with get,set
        member val BusinessName:String = null with get,set

    [<AllowNullLiteral>]
    type PepSearchResultArticleSnippet() = 
        member val Title:String = null with get,set
        member val Text:String = null with get,set
        member val AdverseTerms:String = null with get,set

    [<AllowNullLiteral>]
    type PepSearchResultArticle() = 
        member val Url:String = null with get,set
        member val OriginalUrl:String = null with get,set
        member val Source:String = null with get,set
        member val DateOfCapture:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DateLastUpdated:DateTime = new DateTime() with get,set
        member val Snippets:ResizeArray<PepSearchResultArticleSnippet> = new ResizeArray<PepSearchResultArticleSnippet>() with get,set

    [<AllowNullLiteral>]
    type PepSearchResultIndividualAssociation() = 
        member val LinkDescription:String = null with get,set
        member val SoftDelete:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val DateLastUpdated:DateTime = new DateTime() with get,set
        member val FullName:String = null with get,set

    [<AllowNullLiteral>]
    type PepSearchResultBusinessAssociation() = 
        member val LinkDescription:String = null with get,set
        member val SoftDelete:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val DateLastUpdated:DateTime = new DateTime() with get,set
        member val BusinessName:String = null with get,set

    [<AllowNullLiteral>]
    type PepSearchResultNote() = 
        member val Source:String = null with get,set
        member val Notes:String = null with get,set
        member val SoftDelete:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val DateLastUpdated:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type PepSearchResultPoliticalPosition() = 
        member val Description:String = null with get,set
        member val From:String = null with get,set
        member val To:String = null with get,set
        member val Country:String = null with get,set
        member val SoftDelete:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val DateLastUpdated:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type PepSearchResult() = 
        member val ResultSimilarity:Decimal = new Decimal() with get,set
        member val ResultResolved:Boolean = new Boolean() with get,set
        member val DateLastUpdated:DateTime = new DateTime() with get,set
        member val ResultIsClient:Boolean = new Boolean() with get,set
        member val Id:Int64 = new Int64() with get,set
        member val Type:String = null with get,set
        member val Title:String = null with get,set
        member val Forename:String = null with get,set
        member val Middlename:String = null with get,set
        member val Surname:String = null with get,set
        member val SoftDelete:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val DateOfSoftDelete:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DateOfCapture:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DateOfBirth:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DateOfDeath:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val YearOfBirth:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val YearOfDeath:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Gender:String = null with get,set
        member val HomeTelephone:String = null with get,set
        member val BusinessTelephone:String = null with get,set
        member val MobileTelephone:String = null with get,set
        member val Fax:String = null with get,set
        member val Email:String = null with get,set
        member val Nationality:String = null with get,set
        member val Source:String = null with get,set
        member val Category:String = null with get,set
        member val Picture:String = null with get,set
        member val AlternateTitle:String = null with get,set
        member val BusinessName:String = null with get,set
        member val Description:String = null with get,set
        member val Telephone:String = null with get,set
        member val Website:String = null with get,set
        member val PepTier:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Addresses:ResizeArray<PepSearchResultAddress> = new ResizeArray<PepSearchResultAddress>() with get,set
        member val Aliases:ResizeArray<PepSearchResultAlias> = new ResizeArray<PepSearchResultAlias>() with get,set
        member val Articles:ResizeArray<PepSearchResultArticle> = new ResizeArray<PepSearchResultArticle>() with get,set
        member val Associations:ResizeArray<PepSearchResultIndividualAssociation> = new ResizeArray<PepSearchResultIndividualAssociation>() with get,set
        member val BusinessAssociations:ResizeArray<PepSearchResultBusinessAssociation> = new ResizeArray<PepSearchResultBusinessAssociation>() with get,set
        member val Notes:ResizeArray<PepSearchResultNote> = new ResizeArray<PepSearchResultNote>() with get,set
        member val PoliticalPositions:ResizeArray<PepSearchResultPoliticalPosition> = new ResizeArray<PepSearchResultPoliticalPosition>() with get,set

    [<AllowNullLiteral>]
    type PepSearchResults() = 
        member val Results:ResizeArray<PepSearchResult> = new ResizeArray<PepSearchResult>() with get,set

    [<AllowNullLiteral>]
    type PepSearchRecord() = 
        member val Id:Int64 = new Int64() with get,set
        member val SearchType:String = null with get,set
        member val DateSearched:DateTime = new DateTime() with get,set
        member val DateUpdated:DateTime = new DateTime() with get,set
        member val DateRenewal:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DateArchived:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val IsArchived:Boolean = new Boolean() with get,set
        member val NumOfResults:Int32 = new Int32() with get,set
        member val ClientInResults:Boolean = new Boolean() with get,set
        member val ClientNotInResults:Boolean = new Boolean() with get,set
        member val AffectedByUpdate:Boolean = new Boolean() with get,set
        member val IsDayOneSearch:Boolean = new Boolean() with get,set
        member val SearchCriteria:SearchCriteria = null with get,set
        member val SearchResults:PepSearchResults = null with get,set

    [<AllowNullLiteral>]
    type SearchResultEuAddress() = 
        member val Street:String = null with get,set
        member val City:String = null with get,set
        member val Country:String = null with get,set
        member val PostCode:String = null with get,set
        member val Other:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultEuBirth() = 
        member val Date:String = null with get,set
        member val Place:String = null with get,set
        member val Country:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultOfacEuCitizenship() = 
        member val Country:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultEuName() = 
        member val FullName:String = null with get,set
        member val Gender:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultEuPassport() = 
        member val Number:String = null with get,set
        member val Country:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultEu() = 
        member val ResultStrength:Int32 = new Int32() with get,set
        member val ResultSimilarity:Decimal = new Decimal() with get,set
        member val ResultResolved:Boolean = new Boolean() with get,set
        member val ResultType:String = null with get,set
        member val DateUpdated:DateTime = new DateTime() with get,set
        member val Addresses:ResizeArray<SearchResultEuAddress> = new ResizeArray<SearchResultEuAddress>() with get,set
        member val Births:ResizeArray<SearchResultEuBirth> = new ResizeArray<SearchResultEuBirth>() with get,set
        member val Citizenships:ResizeArray<SearchResultOfacEuCitizenship> = new ResizeArray<SearchResultOfacEuCitizenship>() with get,set
        member val Names:ResizeArray<SearchResultEuName> = new ResizeArray<SearchResultEuName>() with get,set
        member val Passports:ResizeArray<SearchResultEuPassport> = new ResizeArray<SearchResultEuPassport>() with get,set

    [<AllowNullLiteral>]
    type SearchResultHmTreasury() = 
        member val ResultStrength:Int32 = new Int32() with get,set
        member val ResultSimilarity:Decimal = new Decimal() with get,set
        member val ResultResolved:Boolean = new Boolean() with get,set
        member val ResultType:String = null with get,set
        member val DateListed:DateTime = new DateTime() with get,set
        member val DateUpdated:DateTime = new DateTime() with get,set
        member val Name1:String = null with get,set
        member val Name2:String = null with get,set
        member val Name3:String = null with get,set
        member val Name4:String = null with get,set
        member val Name5:String = null with get,set
        member val Name6:String = null with get,set
        member val DateOfBirth:String = null with get,set
        member val CountryOfBirth:String = null with get,set
        member val Nationality:String = null with get,set
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val Address3:String = null with get,set
        member val Address4:String = null with get,set
        member val Address5:String = null with get,set
        member val Address6:String = null with get,set
        member val PostCode:String = null with get,set
        member val Country:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultOfacAddress() = 
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val Address3:String = null with get,set
        member val City:String = null with get,set
        member val State:String = null with get,set
        member val PostCode:String = null with get,set
        member val Country:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultOfacAka() = 
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val Type:String = null with get,set
        member val Strength:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultOfacDateOfBirth() = 
        member val DateOfBirth:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultOfacNationality() = 
        member val Country:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultOfacPlaceOfBirth() = 
        member val PlaceOfBirth:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultOfac() = 
        member val ResultStrength:Int32 = new Int32() with get,set
        member val ResultSimilarity:Decimal = new Decimal() with get,set
        member val ResultResolved:Boolean = new Boolean() with get,set
        member val ResultType:String = null with get,set
        member val DateUpdated:DateTime = new DateTime() with get,set
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val Addresses:ResizeArray<SearchResultOfacAddress> = new ResizeArray<SearchResultOfacAddress>() with get,set
        member val Akas:ResizeArray<SearchResultOfacAka> = new ResizeArray<SearchResultOfacAka>() with get,set
        member val DateOfBirths:ResizeArray<SearchResultOfacDateOfBirth> = new ResizeArray<SearchResultOfacDateOfBirth>() with get,set
        member val Nationalities:ResizeArray<SearchResultOfacNationality> = new ResizeArray<SearchResultOfacNationality>() with get,set
        member val PlaceOfBirths:ResizeArray<SearchResultOfacPlaceOfBirth> = new ResizeArray<SearchResultOfacPlaceOfBirth>() with get,set

    [<AllowNullLiteral>]
    type SearchResultDfat() = 
        member val ResultStrength:Int32 = new Int32() with get,set
        member val ResultSimilarity:Decimal = new Decimal() with get,set
        member val ResultResolved:Boolean = new Boolean() with get,set
        member val ResultType:String = null with get,set
        member val DateUpdated:DateTime = new DateTime() with get,set
        member val FullName:String = null with get,set
        member val Address:String = null with get,set
        member val DateOfBirth:String = null with get,set
        member val PlaceOfBirth:String = null with get,set
        member val Nationality:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultOsfi() = 
        member val ResultStrength:Int32 = new Int32() with get,set
        member val ResultSimilarity:Decimal = new Decimal() with get,set
        member val ResultResolved:Boolean = new Boolean() with get,set
        member val ResultType:String = null with get,set
        member val DateUpdated:DateTime = new DateTime() with get,set
        member val FullName:String = null with get,set
        member val Address:String = null with get,set
        member val DateOfBirth:String = null with get,set
        member val PlaceOfBirth:String = null with get,set
        member val Nationality:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultCanadianJustice() = 
        member val ResultStrength:Int32 = new Int32() with get,set
        member val ResultSimilarity:Decimal = new Decimal() with get,set
        member val ResultResolved:Boolean = new Boolean() with get,set
        member val ResultType:String = null with get,set
        member val DateUpdated:DateTime = new DateTime() with get,set
        member val Name:String = null with get,set
        member val DateOfBirth:String = null with get,set
        member val Country:String = null with get,set
        member val RefId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type SearchResultCanadianSema() = 
        member val ResultStrength:Int32 = new Int32() with get,set
        member val ResultSimilarity:Decimal = new Decimal() with get,set
        member val ResultResolved:Boolean = new Boolean() with get,set
        member val ResultType:String = null with get,set
        member val DateUpdated:DateTime = new DateTime() with get,set
        member val Name:String = null with get,set
        member val DateOfBirth:String = null with get,set
        member val Country:String = null with get,set
        member val Schedule:String = null with get,set
        member val Item:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultAddress() = 
        member val SearchResultAddressId:Int64 = new Int64() with get,set
        member val Type:String = null with get,set
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val Address3:String = null with get,set
        member val City:String = null with get,set
        member val County:String = null with get,set
        member val PostCode:String = null with get,set
        member val Country:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultDateOfBirth() = 
        member val SearchResultDateOfBirthId:Int64 = new Int64() with get,set
        member val DateOfBirth:String = null with get,set
        member val Year:Nullable<Int16> = new Nullable<Int16>() with get,set
        member val Month:Nullable<Byte> = new Nullable<Byte>() with get,set
        member val Day:Nullable<Byte> = new Nullable<Byte>() with get,set
        member val Type:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultName() = 
        member val SearchResultNameId:Int64 = new Int64() with get,set
        member val Type:String = null with get,set
        member val Title:String = null with get,set
        member val FullName:String = null with get,set
        member val ResultSimilarity:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type SearchResultNationality() = 
        member val SearchResultNationalityId:Int64 = new Int64() with get,set
        member val Nationality:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultPlaceOfBirth() = 
        member val SearchResultPlaceOfBirthId:Int64 = new Int64() with get,set
        member val PlaceOfBirth:String = null with get,set
        member val CountryOfBirth:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultRemark() = 
        member val SearchResultRemarkId:Int64 = new Int64() with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResultEntry() = 
        member val SearchResultId:Int64 = new Int64() with get,set
        member val ResultStrength:Int32 = new Int32() with get,set
        member val ResultSimilarity:Decimal = new Decimal() with get,set
        member val ResultResolved:Boolean = new Boolean() with get,set
        member val ResultType:String = null with get,set
        member val DateUpdated:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val SanctionsListId:String = null with get,set
        member val SanctionsListName:String = null with get,set
        member val Addresses:ResizeArray<SearchResultAddress> = new ResizeArray<SearchResultAddress>() with get,set
        member val DatesOfBirth:ResizeArray<SearchResultDateOfBirth> = new ResizeArray<SearchResultDateOfBirth>() with get,set
        member val Names:ResizeArray<SearchResultName> = new ResizeArray<SearchResultName>() with get,set
        member val Nationalities:ResizeArray<SearchResultNationality> = new ResizeArray<SearchResultNationality>() with get,set
        member val PlacesOfBirth:ResizeArray<SearchResultPlaceOfBirth> = new ResizeArray<SearchResultPlaceOfBirth>() with get,set
        member val Remarks:ResizeArray<SearchResultRemark> = new ResizeArray<SearchResultRemark>() with get,set

    [<AllowNullLiteral>]
    type SearchResults() = 
        member val EuResults:ResizeArray<SearchResultEu> = new ResizeArray<SearchResultEu>() with get,set
        member val HMTResults:ResizeArray<SearchResultHmTreasury> = new ResizeArray<SearchResultHmTreasury>() with get,set
        member val HMTUkraineResults:ResizeArray<SearchResultHmTreasury> = new ResizeArray<SearchResultHmTreasury>() with get,set
        member val OfacResults:ResizeArray<SearchResultOfac> = new ResizeArray<SearchResultOfac>() with get,set
        member val OfacConsolidatedResults:ResizeArray<SearchResultOfac> = new ResizeArray<SearchResultOfac>() with get,set
        member val DfatResults:ResizeArray<SearchResultDfat> = new ResizeArray<SearchResultDfat>() with get,set
        member val OsfiResults:ResizeArray<SearchResultOsfi> = new ResizeArray<SearchResultOsfi>() with get,set
        member val CanadianJusticeResults:ResizeArray<SearchResultCanadianJustice> = new ResizeArray<SearchResultCanadianJustice>() with get,set
        member val CanadianSemaResults:ResizeArray<SearchResultCanadianSema> = new ResizeArray<SearchResultCanadianSema>() with get,set
        member val SwissSecoResults:ResizeArray<SearchResultEntry> = new ResizeArray<SearchResultEntry>() with get,set

    [<AllowNullLiteral>]
    type SearchSource() = 
        member val ListId:String = null with get,set
        member val ListName:String = null with get,set
        member val ListShortName:String = null with get,set
        member val IsAffectedByListUpdate:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<AllowNullLiteral>]
    type ArrayOfSearchResultEntries() = 
        inherit ResizeArray<SearchResultEntry>()

    [<AllowNullLiteral>]
    type SearchRecord() = 
        member val Id:Int64 = new Int64() with get,set
        member val SearchType:String = null with get,set
        member val DateSearched:DateTime = new DateTime() with get,set
        member val DateUpdated:DateTime = new DateTime() with get,set
        member val DateArchived:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val IsArchived:Boolean = new Boolean() with get,set
        member val NumOfResults:Int32 = new Int32() with get,set
        member val ClientInResults:Boolean = new Boolean() with get,set
        member val ClientNotInResults:Boolean = new Boolean() with get,set
        member val AffectedByUpdate:Boolean = new Boolean() with get,set
        member val SearchCriteria:SearchCriteria = null with get,set
        member val SearchResults:SearchResults = null with get,set
        member val SearchSources:ResizeArray<SearchSource> = new ResizeArray<SearchSource>() with get,set
        member val ListSearchResults:ArrayOfSearchResultEntries = null with get,set

    [<AllowNullLiteral>]
    type AddPepSearchData() = 
        inherit BaseResponse()
        member val LinkedTo:ArrayOfLinkedTo = null with get,set
        member val SearchRecord:PepSearchRecord = null with get,set
        member val IncludesSanctionsSearchRecord:Boolean = new Boolean() with get,set
        member val SanctionsSearchRecord:SearchRecord = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AddPepSearchResponse() = 
        [<DataMember>]
        member val Data:AddPepSearchData = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApiUserId:String = null with 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")>]
        member val ApiUserKey:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseRequest() = 
        ///<summary>
        ///The authentication credentials
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")>]
        member val Authentication:Authentication = null with get,set

    [<AllowNullLiteral>]
    type ArrayOfLists() = 
        inherit ResizeArray<String>()

    [<AllowNullLiteral>]
    type AddPepSearchRequest() = 
        ///<summary>
        ///If the search should be saved against a single Sub User account, specify their username here
        ///</summary>
        [<ApiMember(Description="If the search should be saved against a single Sub User account, specify their username here")>]
        member val SubUserName:String = null with get,set

        member val Type:String = null with get,set
        member val Name:String = null with get,set
        member val Country:String = null with get,set
        member val Address:String = null with get,set
        member val DateOfBirth:String = null with get,set
        member val Nationality:String = null with get,set
        member val Reference:String = null with get,set
        member val ExcludeResults:Boolean = new Boolean() with get,set
        member val PerformSanctionsSearch:Boolean = new Boolean() with get,set
        member val DayOneSearch:Boolean = new Boolean() with get,set
        member val SelectedLists:ArrayOfLists = null with get,set
        ///<summary>
        ///If the search should be linked to other searches, specify the them here
        ///</summary>
        [<ApiMember(Description="If the search should be linked to other searches, specify the them here")>]
        member val LinkedTo:ArrayOfLinkedTo = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AddPepSearch() = 
        inherit BaseRequest()
        [<DataMember>]
        member val Request:AddPepSearchRequest = null with get,set

F# AddPepSearch 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 /peps/add HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"subUserName":"String","type":"String","name":"String","country":"String","address":"String","dateOfBirth":"String","nationality":"String","reference":"String","excludeResults":false,"performSanctionsSearch":false,"dayOneSearch":false,"selectedLists":["String"],"linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}]},"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)\/","dateRenewal":"\/Date(-62135596800000-0000)\/","dateArchived":"\/Date(-62135596800000-0000)\/","isArchived":false,"numOfResults":0,"clientInResults":false,"clientNotInResults":false,"affectedByUpdate":false,"isDayOneSearch":false,"searchCriteria":{"name":"String","address":"String","country":"String","dateOfBirth":"String","nationality":"String","reference":"String"},"searchResults":{"results":[{"resultSimilarity":0,"resultResolved":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/","resultIsClient":false,"id":0,"type":"String","title":"String","forename":"String","middlename":"String","surname":"String","softDelete":false,"dateOfSoftDelete":"\/Date(-62135596800000-0000)\/","dateOfCapture":"\/Date(-62135596800000-0000)\/","dateOfBirth":"\/Date(-62135596800000-0000)\/","dateOfDeath":"\/Date(-62135596800000-0000)\/","yearOfBirth":0,"yearOfDeath":0,"gender":"String","homeTelephone":"String","businessTelephone":"String","mobileTelephone":"String","fax":"String","email":"String","nationality":"String","source":"String","category":"String","picture":"String","alternateTitle":"String","businessName":"String","description":"String","telephone":"String","website":"String","pepTier":0,"addresses":[{"addressLine1":"String","addressLine2":"String","addressLine3":"String","addressLine4":"String","town":"String","county":"String","postCode":"String","country":"String","isoCountry":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/"}],"aliases":[{"forename":"String","middleName":"String","surname":"String","softDelete":false,"dateOfSoftDelete":"\/Date(-62135596800000-0000)\/","dateLastUpdated":"\/Date(-62135596800000-0000)\/","title":"String","alternateTitle":"String","businessName":"String"}],"articles":[{"url":"String","originalUrl":"String","source":"String","dateOfCapture":"\/Date(-62135596800000-0000)\/","dateLastUpdated":"\/Date(-62135596800000-0000)\/","snippets":[{"title":"String","text":"String","adverseTerms":"String"}]}],"associations":[{"linkDescription":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/","fullName":"String"}],"businessAssociations":[{"linkDescription":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/","businessName":"String"}],"notes":[{"source":"String","notes":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/"}],"politicalPositions":[{"description":"String","from":"String","to":"String","country":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/"}]}]}},"includesSanctionsSearchRecord":false,"sanctionsSearchRecord":{"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"}}}}