Sanctions Search API: v2

<back to all web services

AddPepSearch

Add a PEP search
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports SanctionsSearch.Api2.ServiceModel.Operations.PepSearches
Imports SanctionsSearch.Api2.ServiceModel.Operations.Base
Imports SanctionsSearch.Api2.ServiceModel.Types

Namespace Global

    Namespace SanctionsSearch.Api2.ServiceModel.Operations.Base

        Public Partial Class ArrayOfResponseError
            Inherits List(Of ResponseError)
        End Class

        <DataContract>
        Public Partial Class BaseRequest
            Implements IBaseRequest
            '''<Summary>
            '''The authentication credentials
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="The authentication credentials", IsRequired:=true, ParameterType:="header, body")>
            Public Overridable Property Authentication As Authentication
        End Class

        Public Partial Class BaseResponse
            Implements IBaseDataResponse
            Implements IHasResponseStatus
            '''<Summary>
            '''The status of the response
            '''</Summary>
            <ApiMember(Description:="The status of the response")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        <DataContract>
        Public Partial Class ResponseError
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property ErrorCode As String

            <DataMember(Order:=2)>
            Public Overridable Property FieldName As String

            <DataMember(Order:=3)>
            Public Overridable Property Message As String

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        <DataContract>
        Public Partial Class ResponseStatus
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property ErrorCode As String

            <DataMember(Order:=2)>
            Public Overridable Property Message As String

            <DataMember(Order:=3)>
            Public Overridable Property StackTrace As String

            <DataMember(Order:=4)>
            Public Overridable Property Errors As ArrayOfResponseError

            <DataMember(Order:=5)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class
    End Namespace

    Namespace SanctionsSearch.Api2.ServiceModel.Operations.PepSearches

        <DataContract>
        Public Partial Class AddPepSearch
            Inherits BaseRequest
            <DataMember>
            Public Overridable Property Request As AddPepSearchRequest
        End Class

        Public Partial Class AddPepSearchData
            Inherits BaseResponse
            Implements IBaseSearchResponse
            Public Overridable Property LinkedTo As ArrayOfLinkedTo
            Public Overridable Property SearchRecord As PepSearchRecord
            Public Overridable Property IncludesSanctionsSearchRecord As Boolean
            Public Overridable Property SanctionsSearchRecord As SearchRecord
        End Class

        Public Partial Class AddPepSearchRequest
            Implements IAddSearchRequest
            '''<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")>
            Public Overridable Property SubUserName As String

            Public Overridable Property Type As String
            Public Overridable Property Name As String
            Public Overridable Property Country As String
            Public Overridable Property Address As String
            Public Overridable Property DateOfBirth As String
            Public Overridable Property Nationality As String
            Public Overridable Property Reference As String
            Public Overridable Property ExcludeResults As Boolean
            Public Overridable Property PerformSanctionsSearch As Boolean
            Public Overridable Property DayOneSearch As Boolean
            Public Overridable Property SelectedLists As ArrayOfLists
            '''<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")>
            Public Overridable Property LinkedTo As ArrayOfLinkedTo
        End Class

        <DataContract>
        Public Partial Class AddPepSearchResponse
            <DataMember>
            Public Overridable Property Data As AddPepSearchData
        End Class
    End Namespace

    Namespace SanctionsSearch.Api2.ServiceModel.Types

        Public Partial Class ArrayOfLinkedTo
            Inherits List(Of LinkedTo)
        End Class

        Public Partial Class ArrayOfLists
            Inherits List(Of String)
        End Class

        Public Partial Class ArrayOfSearchResultEntries
            Inherits List(Of SearchResultEntry)
        End Class

        <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 Overridable Property ApiUserId As String

            '''<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 Overridable Property ApiUserKey As String
        End Class

        Public Partial Class LinkedTo
            Public Overridable Property ClientId As Nullable(Of Integer)
            Public Overridable Property Id As Nullable(Of Long)
            Public Overridable Property Type As String
            Public Overridable Property Subtype As String
            Public Overridable Property Status As String
            Public Overridable Property Description As String
            Public Overridable Property IsArchived As Nullable(Of Boolean)
            Public Overridable Property Name As String
            Public Overridable Property [Date] As Nullable(Of Date)
        End Class

        Public Partial Class PepSearchRecord
            Public Overridable Property Id As Long
            Public Overridable Property SearchType As String
            Public Overridable Property DateSearched As Date
            Public Overridable Property DateUpdated As Date
            Public Overridable Property DateRenewal As Nullable(Of Date)
            Public Overridable Property DateArchived As Nullable(Of Date)
            Public Overridable Property IsArchived As Boolean
            Public Overridable Property NumOfResults As Integer
            Public Overridable Property ClientInResults As Boolean
            Public Overridable Property ClientNotInResults As Boolean
            Public Overridable Property AffectedByUpdate As Boolean
            Public Overridable Property IsDayOneSearch As Boolean
            Public Overridable Property SearchCriteria As SearchCriteria
            Public Overridable Property SearchResults As PepSearchResults
        End Class

        Public Partial Class PepSearchResult
            Public Sub New()
                Addresses = New List(Of PepSearchResultAddress)
                Aliases = New List(Of PepSearchResultAlias)
                Articles = New List(Of PepSearchResultArticle)
                Associations = New List(Of PepSearchResultIndividualAssociation)
                BusinessAssociations = New List(Of PepSearchResultBusinessAssociation)
                Notes = New List(Of PepSearchResultNote)
                PoliticalPositions = New List(Of PepSearchResultPoliticalPosition)
            End Sub

            Public Overridable Property ResultSimilarity As Decimal
            Public Overridable Property ResultResolved As Boolean
            Public Overridable Property DateLastUpdated As Date
            Public Overridable Property ResultIsClient As Boolean
            Public Overridable Property Id As Long
            Public Overridable Property Type As String
            Public Overridable Property Title As String
            Public Overridable Property Forename As String
            Public Overridable Property Middlename As String
            Public Overridable Property Surname As String
            Public Overridable Property SoftDelete As Nullable(Of Boolean)
            Public Overridable Property DateOfSoftDelete As Nullable(Of Date)
            Public Overridable Property DateOfCapture As Nullable(Of Date)
            Public Overridable Property DateOfBirth As Nullable(Of Date)
            Public Overridable Property DateOfDeath As Nullable(Of Date)
            Public Overridable Property YearOfBirth As Nullable(Of Integer)
            Public Overridable Property YearOfDeath As Nullable(Of Integer)
            Public Overridable Property Gender As String
            Public Overridable Property HomeTelephone As String
            Public Overridable Property BusinessTelephone As String
            Public Overridable Property MobileTelephone As String
            Public Overridable Property Fax As String
            Public Overridable Property Email As String
            Public Overridable Property Nationality As String
            Public Overridable Property Source As String
            Public Overridable Property Category As String
            Public Overridable Property Picture As String
            Public Overridable Property AlternateTitle As String
            Public Overridable Property BusinessName As String
            Public Overridable Property Description As String
            Public Overridable Property Telephone As String
            Public Overridable Property Website As String
            Public Overridable Property PepTier As Nullable(Of Integer)
            Public Overridable Property Addresses As List(Of PepSearchResultAddress)
            Public Overridable Property Aliases As List(Of PepSearchResultAlias)
            Public Overridable Property Articles As List(Of PepSearchResultArticle)
            Public Overridable Property Associations As List(Of PepSearchResultIndividualAssociation)
            Public Overridable Property BusinessAssociations As List(Of PepSearchResultBusinessAssociation)
            Public Overridable Property Notes As List(Of PepSearchResultNote)
            Public Overridable Property PoliticalPositions As List(Of PepSearchResultPoliticalPosition)
        End Class

        Public Partial Class PepSearchResultAddress
            Public Overridable Property AddressLine1 As String
            Public Overridable Property AddressLine2 As String
            Public Overridable Property AddressLine3 As String
            Public Overridable Property AddressLine4 As String
            Public Overridable Property Town As String
            Public Overridable Property County As String
            Public Overridable Property PostCode As String
            Public Overridable Property Country As String
            Public Overridable Property ISOCountry As String
            Public Overridable Property SoftDelete As Nullable(Of Boolean)
            Public Overridable Property DateLastUpdated As Date
        End Class

        Public Partial Class PepSearchResultAlias
            Public Overridable Property Forename As String
            Public Overridable Property MiddleName As String
            Public Overridable Property Surname As String
            Public Overridable Property SoftDelete As Nullable(Of Boolean)
            Public Overridable Property DateOfSoftDelete As Nullable(Of Date)
            Public Overridable Property DateLastUpdated As Date
            Public Overridable Property Title As String
            Public Overridable Property AlternateTitle As String
            Public Overridable Property BusinessName As String
        End Class

        Public Partial Class PepSearchResultArticle
            Public Sub New()
                Snippets = New List(Of PepSearchResultArticleSnippet)
            End Sub

            Public Overridable Property Url As String
            Public Overridable Property OriginalUrl As String
            Public Overridable Property Source As String
            Public Overridable Property DateOfCapture As Nullable(Of Date)
            Public Overridable Property DateLastUpdated As Date
            Public Overridable Property Snippets As List(Of PepSearchResultArticleSnippet)
        End Class

        Public Partial Class PepSearchResultArticleSnippet
            Public Overridable Property Title As String
            Public Overridable Property Text As String
            Public Overridable Property AdverseTerms As String
        End Class

        Public Partial Class PepSearchResultBusinessAssociation
            Public Overridable Property LinkDescription As String
            Public Overridable Property SoftDelete As Nullable(Of Boolean)
            Public Overridable Property DateLastUpdated As Date
            Public Overridable Property BusinessName As String
        End Class

        Public Partial Class PepSearchResultIndividualAssociation
            Public Overridable Property LinkDescription As String
            Public Overridable Property SoftDelete As Nullable(Of Boolean)
            Public Overridable Property DateLastUpdated As Date
            Public Overridable Property FullName As String
        End Class

        Public Partial Class PepSearchResultNote
            Public Overridable Property Source As String
            Public Overridable Property Notes As String
            Public Overridable Property SoftDelete As Nullable(Of Boolean)
            Public Overridable Property DateLastUpdated As Date
        End Class

        Public Partial Class PepSearchResultPoliticalPosition
            Public Overridable Property Description As String
            Public Overridable Property From As String
            Public Overridable Property To As String
            Public Overridable Property Country As String
            Public Overridable Property SoftDelete As Nullable(Of Boolean)
            Public Overridable Property DateLastUpdated As Date
        End Class

        Public Partial Class PepSearchResults
            Public Sub New()
                Results = New List(Of PepSearchResult)
            End Sub

            Public Overridable Property Results As List(Of PepSearchResult)
        End Class

        Public Partial Class SearchCriteria
            Public Overridable Property Name As String
            Public Overridable Property Address As String
            Public Overridable Property Country As String
            Public Overridable Property DateOfBirth As String
            Public Overridable Property Nationality As String
            Public Overridable Property Reference As String
        End Class

        Public Partial Class SearchRecord
            Public Sub New()
                SearchSources = New List(Of SearchSource)
            End Sub

            Public Overridable Property Id As Long
            Public Overridable Property SearchType As String
            Public Overridable Property DateSearched As Date
            Public Overridable Property DateUpdated As Date
            Public Overridable Property DateArchived As Nullable(Of Date)
            Public Overridable Property IsArchived As Boolean
            Public Overridable Property NumOfResults As Integer
            Public Overridable Property ClientInResults As Boolean
            Public Overridable Property ClientNotInResults As Boolean
            Public Overridable Property AffectedByUpdate As Boolean
            Public Overridable Property SearchCriteria As SearchCriteria
            Public Overridable Property SearchResults As SearchResults
            Public Overridable Property SearchSources As List(Of SearchSource)
            Public Overridable Property ListSearchResults As ArrayOfSearchResultEntries
        End Class

        Public Partial Class SearchResultAddress
            Public Overridable Property SearchResultAddressId As Long
            Public Overridable Property Type As String
            Public Overridable Property Address1 As String
            Public Overridable Property Address2 As String
            Public Overridable Property Address3 As String
            Public Overridable Property City As String
            Public Overridable Property County As String
            Public Overridable Property PostCode As String
            Public Overridable Property Country As String
        End Class

        Public Partial Class SearchResultCanadianJustice
            Public Overridable Property ResultStrength As Integer
            Public Overridable Property ResultSimilarity As Decimal
            Public Overridable Property ResultResolved As Boolean
            Public Overridable Property ResultType As String
            Public Overridable Property DateUpdated As Date
            Public Overridable Property Name As String
            Public Overridable Property DateOfBirth As String
            Public Overridable Property Country As String
            Public Overridable Property RefId As Integer
        End Class

        Public Partial Class SearchResultCanadianSema
            Public Overridable Property ResultStrength As Integer
            Public Overridable Property ResultSimilarity As Decimal
            Public Overridable Property ResultResolved As Boolean
            Public Overridable Property ResultType As String
            Public Overridable Property DateUpdated As Date
            Public Overridable Property Name As String
            Public Overridable Property DateOfBirth As String
            Public Overridable Property Country As String
            Public Overridable Property Schedule As String
            Public Overridable Property Item As String
        End Class

        Public Partial Class SearchResultDateOfBirth
            Public Overridable Property SearchResultDateOfBirthId As Long
            Public Overridable Property DateOfBirth As String
            Public Overridable Property Year As Nullable(Of Short)
            Public Overridable Property Month As Nullable(Of Byte)
            Public Overridable Property Day As Nullable(Of Byte)
            Public Overridable Property Type As String
        End Class

        Public Partial Class SearchResultDfat
            Public Overridable Property ResultStrength As Integer
            Public Overridable Property ResultSimilarity As Decimal
            Public Overridable Property ResultResolved As Boolean
            Public Overridable Property ResultType As String
            Public Overridable Property DateUpdated As Date
            Public Overridable Property FullName As String
            Public Overridable Property Address As String
            Public Overridable Property DateOfBirth As String
            Public Overridable Property PlaceOfBirth As String
            Public Overridable Property Nationality As String
        End Class

        Public Partial Class SearchResultEntry
            Public Sub New()
                Addresses = New List(Of SearchResultAddress)
                DatesOfBirth = New List(Of SearchResultDateOfBirth)
                Names = New List(Of SearchResultName)
                Nationalities = New List(Of SearchResultNationality)
                PlacesOfBirth = New List(Of SearchResultPlaceOfBirth)
                Remarks = New List(Of SearchResultRemark)
            End Sub

            Public Overridable Property SearchResultId As Long
            Public Overridable Property ResultStrength As Integer
            Public Overridable Property ResultSimilarity As Decimal
            Public Overridable Property ResultResolved As Boolean
            Public Overridable Property ResultType As String
            Public Overridable Property DateUpdated As Nullable(Of Date)
            Public Overridable Property SanctionsListId As String
            Public Overridable Property SanctionsListName As String
            Public Overridable Property Addresses As List(Of SearchResultAddress)
            Public Overridable Property DatesOfBirth As List(Of SearchResultDateOfBirth)
            Public Overridable Property Names As List(Of SearchResultName)
            Public Overridable Property Nationalities As List(Of SearchResultNationality)
            Public Overridable Property PlacesOfBirth As List(Of SearchResultPlaceOfBirth)
            Public Overridable Property Remarks As List(Of SearchResultRemark)
        End Class

        Public Partial Class SearchResultEu
            Public Sub New()
                Addresses = New List(Of SearchResultEuAddress)
                Births = New List(Of SearchResultEuBirth)
                Citizenships = New List(Of SearchResultOfacEuCitizenship)
                Names = New List(Of SearchResultEuName)
                Passports = New List(Of SearchResultEuPassport)
            End Sub

            Public Overridable Property ResultStrength As Integer
            Public Overridable Property ResultSimilarity As Decimal
            Public Overridable Property ResultResolved As Boolean
            Public Overridable Property ResultType As String
            Public Overridable Property DateUpdated As Date
            Public Overridable Property Addresses As List(Of SearchResultEuAddress)
            Public Overridable Property Births As List(Of SearchResultEuBirth)
            Public Overridable Property Citizenships As List(Of SearchResultOfacEuCitizenship)
            Public Overridable Property Names As List(Of SearchResultEuName)
            Public Overridable Property Passports As List(Of SearchResultEuPassport)
        End Class

        Public Partial Class SearchResultEuAddress
            Public Overridable Property Street As String
            Public Overridable Property City As String
            Public Overridable Property Country As String
            Public Overridable Property PostCode As String
            Public Overridable Property Other As String
        End Class

        Public Partial Class SearchResultEuBirth
            Public Overridable Property [Date] As String
            Public Overridable Property Place As String
            Public Overridable Property Country As String
        End Class

        Public Partial Class SearchResultEuName
            Public Overridable Property FullName As String
            Public Overridable Property Gender As String
        End Class

        Public Partial Class SearchResultEuPassport
            Public Overridable Property Number As String
            Public Overridable Property Country As String
        End Class

        Public Partial Class SearchResultHmTreasury
            Public Overridable Property ResultStrength As Integer
            Public Overridable Property ResultSimilarity As Decimal
            Public Overridable Property ResultResolved As Boolean
            Public Overridable Property ResultType As String
            Public Overridable Property DateListed As Date
            Public Overridable Property DateUpdated As Date
            Public Overridable Property Name1 As String
            Public Overridable Property Name2 As String
            Public Overridable Property Name3 As String
            Public Overridable Property Name4 As String
            Public Overridable Property Name5 As String
            Public Overridable Property Name6 As String
            Public Overridable Property DateOfBirth As String
            Public Overridable Property CountryOfBirth As String
            Public Overridable Property Nationality As String
            Public Overridable Property Address1 As String
            Public Overridable Property Address2 As String
            Public Overridable Property Address3 As String
            Public Overridable Property Address4 As String
            Public Overridable Property Address5 As String
            Public Overridable Property Address6 As String
            Public Overridable Property PostCode As String
            Public Overridable Property Country As String
        End Class

        Public Partial Class SearchResultName
            Public Overridable Property SearchResultNameId As Long
            Public Overridable Property Type As String
            Public Overridable Property Title As String
            Public Overridable Property FullName As String
            Public Overridable Property ResultSimilarity As Decimal
        End Class

        Public Partial Class SearchResultNationality
            Public Overridable Property SearchResultNationalityId As Long
            Public Overridable Property Nationality As String
        End Class

        Public Partial Class SearchResultOfac
            Public Sub New()
                Addresses = New List(Of SearchResultOfacAddress)
                Akas = New List(Of SearchResultOfacAka)
                DateOfBirths = New List(Of SearchResultOfacDateOfBirth)
                Nationalities = New List(Of SearchResultOfacNationality)
                PlaceOfBirths = New List(Of SearchResultOfacPlaceOfBirth)
            End Sub

            Public Overridable Property ResultStrength As Integer
            Public Overridable Property ResultSimilarity As Decimal
            Public Overridable Property ResultResolved As Boolean
            Public Overridable Property ResultType As String
            Public Overridable Property DateUpdated As Date
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property Addresses As List(Of SearchResultOfacAddress)
            Public Overridable Property Akas As List(Of SearchResultOfacAka)
            Public Overridable Property DateOfBirths As List(Of SearchResultOfacDateOfBirth)
            Public Overridable Property Nationalities As List(Of SearchResultOfacNationality)
            Public Overridable Property PlaceOfBirths As List(Of SearchResultOfacPlaceOfBirth)
        End Class

        Public Partial Class SearchResultOfacAddress
            Public Overridable Property Address1 As String
            Public Overridable Property Address2 As String
            Public Overridable Property Address3 As String
            Public Overridable Property City As String
            Public Overridable Property State As String
            Public Overridable Property PostCode As String
            Public Overridable Property Country As String
        End Class

        Public Partial Class SearchResultOfacAka
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property Type As String
            Public Overridable Property Strength As String
        End Class

        Public Partial Class SearchResultOfacDateOfBirth
            Public Overridable Property DateOfBirth As String
        End Class

        Public Partial Class SearchResultOfacEuCitizenship
            Public Overridable Property Country As String
        End Class

        Public Partial Class SearchResultOfacNationality
            Public Overridable Property Country As String
        End Class

        Public Partial Class SearchResultOfacPlaceOfBirth
            Public Overridable Property PlaceOfBirth As String
        End Class

        Public Partial Class SearchResultOsfi
            Public Overridable Property ResultStrength As Integer
            Public Overridable Property ResultSimilarity As Decimal
            Public Overridable Property ResultResolved As Boolean
            Public Overridable Property ResultType As String
            Public Overridable Property DateUpdated As Date
            Public Overridable Property FullName As String
            Public Overridable Property Address As String
            Public Overridable Property DateOfBirth As String
            Public Overridable Property PlaceOfBirth As String
            Public Overridable Property Nationality As String
        End Class

        Public Partial Class SearchResultPlaceOfBirth
            Public Overridable Property SearchResultPlaceOfBirthId As Long
            Public Overridable Property PlaceOfBirth As String
            Public Overridable Property CountryOfBirth As String
        End Class

        Public Partial Class SearchResultRemark
            Public Overridable Property SearchResultRemarkId As Long
            Public Overridable Property Name As String
            Public Overridable Property Description As String
        End Class

        Public Partial Class SearchResults
            Public Sub New()
                EuResults = New List(Of SearchResultEu)
                HMTResults = New List(Of SearchResultHmTreasury)
                HMTUkraineResults = New List(Of SearchResultHmTreasury)
                OfacResults = New List(Of SearchResultOfac)
                OfacConsolidatedResults = New List(Of SearchResultOfac)
                DfatResults = New List(Of SearchResultDfat)
                OsfiResults = New List(Of SearchResultOsfi)
                CanadianJusticeResults = New List(Of SearchResultCanadianJustice)
                CanadianSemaResults = New List(Of SearchResultCanadianSema)
                SwissSecoResults = New List(Of SearchResultEntry)
            End Sub

            Public Overridable Property EuResults As List(Of SearchResultEu)
            Public Overridable Property HMTResults As List(Of SearchResultHmTreasury)
            Public Overridable Property HMTUkraineResults As List(Of SearchResultHmTreasury)
            Public Overridable Property OfacResults As List(Of SearchResultOfac)
            Public Overridable Property OfacConsolidatedResults As List(Of SearchResultOfac)
            Public Overridable Property DfatResults As List(Of SearchResultDfat)
            Public Overridable Property OsfiResults As List(Of SearchResultOsfi)
            Public Overridable Property CanadianJusticeResults As List(Of SearchResultCanadianJustice)
            Public Overridable Property CanadianSemaResults As List(Of SearchResultCanadianSema)
            Public Overridable Property SwissSecoResults As List(Of SearchResultEntry)
        End Class

        Public Partial Class SearchSource
            Public Overridable Property ListId As String
            Public Overridable Property ListName As String
            Public Overridable Property ListShortName As String
            Public Overridable Property IsAffectedByListUpdate As Nullable(Of Boolean)
        End Class
    End Namespace
End Namespace

VB.NET AddPepSearch DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .soap12 suffix or ?format=soap12

HTTP + SOAP12

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /soap12 HTTP/1.1 
Host: api.sanctionssearch.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>

<AddPepSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <Address>String</Address>
    <Country>String</Country>
    <DateOfBirth>String</DateOfBirth>
    <DayOneSearch>false</DayOneSearch>
    <ExcludeResults>false</ExcludeResults>
    <LinkedTo>
      <LinkedTo>
        <ClientId>0</ClientId>
        <Date>0001-01-01T00:00:00</Date>
        <Description>String</Description>
        <Id>0</Id>
        <IsArchived>false</IsArchived>
        <Name>String</Name>
        <Status>String</Status>
        <Subtype>String</Subtype>
        <Type>String</Type>
      </LinkedTo>
    </LinkedTo>
    <Name>String</Name>
    <Nationality>String</Nationality>
    <PerformSanctionsSearch>false</PerformSanctionsSearch>
    <Reference>String</Reference>
    <SelectedLists>
      <ListId>String</ListId>
    </SelectedLists>
    <SubUserName>String</SubUserName>
    <Type>String</Type>
  </Request>
</AddPepSearch>

</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>

<AddPepSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Data>
    <ResponseStatus>
      <ErrorCode>String</ErrorCode>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
      <Errors>
        <ResponseError>
          <ErrorCode>String</ErrorCode>
          <FieldName>String</FieldName>
          <Message>String</Message>
          <Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </Meta>
        </ResponseError>
      </Errors>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseStatus>
    <IncludesSanctionsSearchRecord>false</IncludesSanctionsSearchRecord>
    <LinkedTo>
      <LinkedTo>
        <ClientId>0</ClientId>
        <Date>0001-01-01T00:00:00</Date>
        <Description>String</Description>
        <Id>0</Id>
        <IsArchived>false</IsArchived>
        <Name>String</Name>
        <Status>String</Status>
        <Subtype>String</Subtype>
        <Type>String</Type>
      </LinkedTo>
    </LinkedTo>
    <SanctionsSearchRecord>
      <AffectedByUpdate>false</AffectedByUpdate>
      <ClientInResults>false</ClientInResults>
      <ClientNotInResults>false</ClientNotInResults>
      <DateArchived>0001-01-01T00:00:00</DateArchived>
      <DateSearched>0001-01-01T00:00:00</DateSearched>
      <DateUpdated>0001-01-01T00:00:00</DateUpdated>
      <Id>0</Id>
      <IsArchived>false</IsArchived>
      <ListSearchResults>
        <SearchResultEntry>
          <Addresses>
            <SearchResultAddress>
              <Address1>String</Address1>
              <Address2>String</Address2>
              <Address3>String</Address3>
              <City>String</City>
              <Country>String</Country>
              <County>String</County>
              <PostCode>String</PostCode>
              <SearchResultAddressId>0</SearchResultAddressId>
              <Type>String</Type>
            </SearchResultAddress>
          </Addresses>
          <DateUpdated>0001-01-01T00:00:00</DateUpdated>
          <DatesOfBirth>
            <SearchResultDateOfBirth>
              <DateOfBirth>String</DateOfBirth>
              <Day>0</Day>
              <Month>0</Month>
              <SearchResultDateOfBirthId>0</SearchResultDateOfBirthId>
              <Type>String</Type>
              <Year>0</Year>
            </SearchResultDateOfBirth>
          </DatesOfBirth>
          <Names>
            <SearchResultName>
              <FullName>String</FullName>
              <ResultSimilarity>0</ResultSimilarity>
              <SearchResultNameId>0</SearchResultNameId>
              <Title>String</Title>
              <Type>String</Type>
            </SearchResultName>
          </Names>
          <Nationalities>
            <SearchResultNationality>
              <Nationality>String</Nationality>
              <SearchResultNationalityId>0</SearchResultNationalityId>
            </SearchResultNationality>
          </Nationalities>
          <PlacesOfBirth>
            <SearchResultPlaceOfBirth>
              <CountryOfBirth>String</CountryOfBirth>
              <PlaceOfBirth>String</PlaceOfBirth>
              <SearchResultPlaceOfBirthId>0</SearchResultPlaceOfBirthId>
            </SearchResultPlaceOfBirth>
          </PlacesOfBirth>
          <Remarks>
            <SearchResultRemark>
              <Description>String</Description>
              <Name>String</Name>
              <SearchResultRemarkId>0</SearchResultRemarkId>
            </SearchResultRemark>
          </Remarks>
          <ResultResolved>false</ResultResolved>
          <ResultSimilarity>0</ResultSimilarity>
          <ResultStrength>0</ResultStrength>
          <ResultType>String</ResultType>
          <SanctionsListId>String</SanctionsListId>
          <SanctionsListName>String</SanctionsListName>
          <SearchResultId>0</SearchResultId>
        </SearchResultEntry>
      </ListSearchResults>
      <NumOfResults>0</NumOfResults>
      <SearchCriteria>
        <Address>String</Address>
        <Country>String</Country>
        <DateOfBirth>String</DateOfBirth>
        <Name>String</Name>
        <Nationality>String</Nationality>
        <Reference>String</Reference>
      </SearchCriteria>
      <SearchResults>
        <CanadianJusticeResults>
          <SearchResultCanadianJustice>
            <Country>String</Country>
            <DateOfBirth>String</DateOfBirth>
            <DateUpdated>0001-01-01T00:00:00</DateUpdated>
            <Name>String</Name>
            <RefId>0</RefId>
            <ResultResolved>false</ResultResolved>
            <ResultSimilarity>0</ResultSimilarity>
            <ResultStrength>0</ResultStrength>
            <ResultType>String</ResultType>
          </SearchResultCanadianJustice>
        </CanadianJusticeResults>
        <CanadianSemaResults>
          <SearchResultCanadianSema>
            <Country>String</Country>
            <DateOfBirth>String</DateOfBirth>
            <DateUpdated>0001-01-01T00:00:00</DateUpdated>
            <Item>String</Item>
            <Name>String</Name>
            <ResultResolved>false</ResultResolved>
            <ResultSimilarity>0</ResultSimilarity>
            <ResultStrength>0</ResultStrength>
            <ResultType>String</ResultType>
            <Schedule>String</Schedule>
          </SearchResultCanadianSema>
        </CanadianSemaResults>
        <DfatResults>
          <SearchResultDfat>
            <Address>String</Address>
            <DateOfBirth>String</DateOfBirth>
            <DateUpdated>0001-01-01T00:00:00</DateUpdated>
            <FullName>String</FullName>
            <Nationality>String</Nationality>
            <PlaceOfBirth>String</PlaceOfBirth>
            <ResultResolved>false</ResultResolved>
            <ResultSimilarity>0</ResultSimilarity>
            <ResultStrength>0</ResultStrength>
            <ResultType>String</ResultType>
          </SearchResultDfat>
        </DfatResults>
        <EuResults>
          <SearchResultEu>
            <Addresses>
              <SearchResultEuAddress>
                <City>String</City>
                <Country>String</Country>
                <Other>String</Other>
                <PostCode>String</PostCode>
                <Street>String</Street>
              </SearchResultEuAddress>
            </Addresses>
            <Births>
              <SearchResultEuBirth>
                <Country>String</Country>
                <Date>String</Date>
                <Place>String</Place>
              </SearchResultEuBirth>
            </Births>
            <Citizenships>
              <SearchResultOfacEuCitizenship>
                <Country>String</Country>
              </SearchResultOfacEuCitizenship>
            </Citizenships>
            <DateUpdated>0001-01-01T00:00:00</DateUpdated>
            <Names>
              <SearchResultEuName>
                <FullName>String</FullName>
                <Gender>String</Gender>
              </SearchResultEuName>
            </Names>
            <Passports>
              <SearchResultEuPassport>
                <Country>String</Country>
                <Number>String</Number>
              </SearchResultEuPassport>
            </Passports>
            <ResultResolved>false</ResultResolved>
            <ResultSimilarity>0</ResultSimilarity>
            <ResultStrength>0</ResultStrength>
            <ResultType>String</ResultType>
          </SearchResultEu>
        </EuResults>
        <HMTResults>
          <SearchResultHmTreasury>
            <Address1>String</Address1>
            <Address2>String</Address2>
            <Address3>String</Address3>
            <Address4>String</Address4>
            <Address5>String</Address5>
            <Address6>String</Address6>
            <Country>String</Country>
            <CountryOfBirth>String</CountryOfBirth>
            <DateListed>0001-01-01T00:00:00</DateListed>
            <DateOfBirth>String</DateOfBirth>
            <DateUpdated>0001-01-01T00:00:00</DateUpdated>
            <Name1>String</Name1>
            <Name2>String</Name2>
            <Name3>String</Name3>
            <Name4>String</Name4>
            <Name5>String</Name5>
            <Name6>String</Name6>
            <Nationality>String</Nationality>
            <PostCode>String</PostCode>
            <ResultResolved>false</ResultResolved>
            <ResultSimilarity>0</ResultSimilarity>
            <ResultStrength>0</ResultStrength>
            <ResultType>String</ResultType>
          </SearchResultHmTreasury>
        </HMTResults>
        <HMTUkraineResults>
          <SearchResultHmTreasury>
            <Address1>String</Address1>
            <Address2>String</Address2>
            <Address3>String</Address3>
            <Address4>String</Address4>
            <Address5>String</Address5>
            <Address6>String</Address6>
            <Country>String</Country>
            <CountryOfBirth>String</CountryOfBirth>
            <DateListed>0001-01-01T00:00:00</DateListed>
            <DateOfBirth>String</DateOfBirth>
            <DateUpdated>0001-01-01T00:00:00</DateUpdated>
            <Name1>String</Name1>
            <Name2>String</Name2>
            <Name3>String</Name3>
            <Name4>String</Name4>
            <Name5>String</Name5>
            <Name6>String</Name6>
            <Nationality>String</Nationality>
            <PostCode>String</PostCode>
            <ResultResolved>false</ResultResolved>
            <ResultSimilarity>0</ResultSimilarity>
            <ResultStrength>0</ResultStrength>
            <ResultType>String</ResultType>
          </SearchResultHmTreasury>
        </HMTUkraineResults>
        <OfacConsolidatedResults>
          <SearchResultOfac>
            <Addresses>
              <SearchResultOfacAddress>
                <Address1>String</Address1>
                <Address2>String</Address2>
                <Address3>String</Address3>
                <City>String</City>
                <Country>String</Country>
                <PostCode>String</PostCode>
                <State>String</State>
              </SearchResultOfacAddress>
            </Addresses>
            <Akas>
              <SearchResultOfacAka>
                <FirstName>String</FirstName>
                <LastName>String</LastName>
                <Strength>String</Strength>
                <Type>String</Type>
              </SearchResultOfacAka>
            </Akas>
            <DateOfBirths>
              <SearchResultOfacDateOfBirth>
                <DateOfBirth>String</DateOfBirth>
              </SearchResultOfacDateOfBirth>
            </DateOfBirths>
            <DateUpdated>0001-01-01T00:00:00</DateUpdated>
            <FirstName>String</FirstName>
            <LastName>String</LastName>
            <Nationalities>
              <SearchResultOfacNationality>
                <Country>String</Country>
              </SearchResultOfacNationality>
            </Nationalities>
            <PlaceOfBirths>
              <SearchResultOfacPlaceOfBirth>
                <PlaceOfBirth>String</PlaceOfBirth>
              </SearchResultOfacPlaceOfBirth>
            </PlaceOfBirths>
            <ResultResolved>false</ResultResolved>
            <ResultSimilarity>0</ResultSimilarity>
            <ResultStrength>0</ResultStrength>
            <ResultType>String</ResultType>
          </SearchResultOfac>
        </OfacConsolidatedResults>
        <OfacResults>
          <SearchResultOfac>
            <Addresses>
              <SearchResultOfacAddress>
                <Address1>String</Address1>
                <Address2>String</Address2>
                <Address3>String</Address3>
                <City>String</City>
                <Country>String</Country>
                <PostCode>String</PostCode>
                <State>String</State>
              </SearchResultOfacAddress>
            </Addresses>
            <Akas>
              <SearchResultOfacAka>
                <FirstName>String</FirstName>
                <LastName>String</LastName>
                <Strength>String</Strength>
                <Type>String</Type>
              </SearchResultOfacAka>
            </Akas>
            <DateOfBirths>
              <SearchResultOfacDateOfBirth>
                <DateOfBirth>String</DateOfBirth>
              </SearchResultOfacDateOfBirth>
            </DateOfBirths>
            <DateUpdated>0001-01-01T00:00:00</DateUpdated>
            <FirstName>String</FirstName>
            <LastName>String</LastName>
            <Nationalities>
              <SearchResultOfacNationality>
                <Country>String</Country>
              </SearchResultOfacNationality>
            </Nationalities>
            <PlaceOfBirths>
              <SearchResultOfacPlaceOfBirth>
                <PlaceOfBirth>String</PlaceOfBirth>
              </SearchResultOfacPlaceOfBirth>
            </PlaceOfBirths>
            <ResultResolved>false</ResultResolved>
            <ResultSimilarity>0</ResultSimilarity>
            <ResultStrength>0</ResultStrength>
            <ResultType>String</ResultType>
          </SearchResultOfac>
        </OfacResults>
        <OsfiResults>
          <SearchResultOsfi>
            <Address>String</Address>
            <DateOfBirth>String</DateOfBirth>
            <DateUpdated>0001-01-01T00:00:00</DateUpdated>
            <FullName>String</FullName>
            <Nationality>String</Nationality>
            <PlaceOfBirth>String</PlaceOfBirth>
            <ResultResolved>false</ResultResolved>
            <ResultSimilarity>0</ResultSimilarity>
            <ResultStrength>0</ResultStrength>
            <ResultType>String</ResultType>
          </SearchResultOsfi>
        </OsfiResults>
        <SwissSecoResults>
          <SearchResultEntry>
            <Addresses>
              <SearchResultAddress>
                <Address1>String</Address1>
                <Address2>String</Address2>
                <Address3>String</Address3>
                <City>String</City>
                <Country>String</Country>
                <County>String</County>
                <PostCode>String</PostCode>
                <SearchResultAddressId>0</SearchResultAddressId>
                <Type>String</Type>
              </SearchResultAddress>
            </Addresses>
            <DateUpdated>0001-01-01T00:00:00</DateUpdated>
            <DatesOfBirth>
              <SearchResultDateOfBirth>
                <DateOfBirth>String</DateOfBirth>
                <Day>0</Day>
                <Month>0</Month>
                <SearchResultDateOfBirthId>0</SearchResultDateOfBirthId>
                <Type>String</Type>
                <Year>0</Year>
              </SearchResultDateOfBirth>
            </DatesOfBirth>
            <Names>
              <SearchResultName>
                <FullName>String</FullName>
                <ResultSimilarity>0</ResultSimilarity>
                <SearchResultNameId>0</SearchResultNameId>
                <Title>String</Title>
                <Type>String</Type>
              </SearchResultName>
            </Names>
            <Nationalities>
              <SearchResultNationality>
                <Nationality>String</Nationality>
                <SearchResultNationalityId>0</SearchResultNationalityId>
              </SearchResultNationality>
            </Nationalities>
            <PlacesOfBirth>
              <SearchResultPlaceOfBirth>
                <CountryOfBirth>String</CountryOfBirth>
                <PlaceOfBirth>String</PlaceOfBirth>
                <SearchResultPlaceOfBirthId>0</SearchResultPlaceOfBirthId>
              </SearchResultPlaceOfBirth>
            </PlacesOfBirth>
            <Remarks>
              <SearchResultRemark>
                <Description>String</Description>
                <Name>String</Name>
                <SearchResultRemarkId>0</SearchResultRemarkId>
              </SearchResultRemark>
            </Remarks>
            <ResultResolved>false</ResultResolved>
            <ResultSimilarity>0</ResultSimilarity>
            <ResultStrength>0</ResultStrength>
            <ResultType>String</ResultType>
            <SanctionsListId>String</SanctionsListId>
            <SanctionsListName>String</SanctionsListName>
            <SearchResultId>0</SearchResultId>
          </SearchResultEntry>
        </SwissSecoResults>
      </SearchResults>
      <SearchSources>
        <SearchSource>
          <IsAffectedByListUpdate>false</IsAffectedByListUpdate>
          <ListId>String</ListId>
          <ListName>String</ListName>
          <ListShortName>String</ListShortName>
        </SearchSource>
      </SearchSources>
      <SearchType>String</SearchType>
    </SanctionsSearchRecord>
    <SearchRecord>
      <AffectedByUpdate>false</AffectedByUpdate>
      <ClientInResults>false</ClientInResults>
      <ClientNotInResults>false</ClientNotInResults>
      <DateArchived>0001-01-01T00:00:00</DateArchived>
      <DateRenewal>0001-01-01T00:00:00</DateRenewal>
      <DateSearched>0001-01-01T00:00:00</DateSearched>
      <DateUpdated>0001-01-01T00:00:00</DateUpdated>
      <Id>0</Id>
      <IsArchived>false</IsArchived>
      <IsDayOneSearch>false</IsDayOneSearch>
      <NumOfResults>0</NumOfResults>
      <SearchCriteria>
        <Address>String</Address>
        <Country>String</Country>
        <DateOfBirth>String</DateOfBirth>
        <Name>String</Name>
        <Nationality>String</Nationality>
        <Reference>String</Reference>
      </SearchCriteria>
      <SearchResults>
        <Results>
          <PepSearchResult>
            <Addresses>
              <PepSearchResultAddress>
                <AddressLine1>String</AddressLine1>
                <AddressLine2>String</AddressLine2>
                <AddressLine3>String</AddressLine3>
                <AddressLine4>String</AddressLine4>
                <Country>String</Country>
                <County>String</County>
                <DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
                <ISOCountry>String</ISOCountry>
                <PostCode>String</PostCode>
                <SoftDelete>false</SoftDelete>
                <Town>String</Town>
              </PepSearchResultAddress>
            </Addresses>
            <Aliases>
              <PepSearchResultAlias>
                <AlternateTitle>String</AlternateTitle>
                <BusinessName>String</BusinessName>
                <DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
                <DateOfSoftDelete>0001-01-01T00:00:00</DateOfSoftDelete>
                <Forename>String</Forename>
                <MiddleName>String</MiddleName>
                <SoftDelete>false</SoftDelete>
                <Surname>String</Surname>
                <Title>String</Title>
              </PepSearchResultAlias>
            </Aliases>
            <AlternateTitle>String</AlternateTitle>
            <Articles>
              <PepSearchResultArticle>
                <DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
                <DateOfCapture>0001-01-01T00:00:00</DateOfCapture>
                <OriginalUrl>String</OriginalUrl>
                <Snippets>
                  <PepSearchResultArticleSnippet>
                    <AdverseTerms>String</AdverseTerms>
                    <Text>String</Text>
                    <Title>String</Title>
                  </PepSearchResultArticleSnippet>
                </Snippets>
                <Source>String</Source>
                <Url>String</Url>
              </PepSearchResultArticle>
            </Articles>
            <Associations>
              <PepSearchResultIndividualAssociation>
                <DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
                <FullName>String</FullName>
                <LinkDescription>String</LinkDescription>
                <SoftDelete>false</SoftDelete>
              </PepSearchResultIndividualAssociation>
            </Associations>
            <BusinessAssociations>
              <PepSearchResultBusinessAssociation>
                <BusinessName>String</BusinessName>
                <DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
                <LinkDescription>String</LinkDescription>
                <SoftDelete>false</SoftDelete>
              </PepSearchResultBusinessAssociation>
            </BusinessAssociations>
            <BusinessName>String</BusinessName>
            <BusinessTelephone>String</BusinessTelephone>
            <Category>String</Category>
            <DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
            <DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
            <DateOfCapture>0001-01-01T00:00:00</DateOfCapture>
            <DateOfDeath>0001-01-01T00:00:00</DateOfDeath>
            <DateOfSoftDelete>0001-01-01T00:00:00</DateOfSoftDelete>
            <Description>String</Description>
            <Email>String</Email>
            <Fax>String</Fax>
            <Forename>String</Forename>
            <Gender>String</Gender>
            <HomeTelephone>String</HomeTelephone>
            <Id>0</Id>
            <Middlename>String</Middlename>
            <MobileTelephone>String</MobileTelephone>
            <Nationality>String</Nationality>
            <Notes>
              <PepSearchResultNote>
                <DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
                <Notes>String</Notes>
                <SoftDelete>false</SoftDelete>
                <Source>String</Source>
              </PepSearchResultNote>
            </Notes>
            <PepTier>0</PepTier>
            <Picture>String</Picture>
            <PoliticalPositions>
              <PepSearchResultPoliticalPosition>
                <Country>String</Country>
                <DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
                <Description>String</Description>
                <From>String</From>
                <SoftDelete>false</SoftDelete>
                <To>String</To>
              </PepSearchResultPoliticalPosition>
            </PoliticalPositions>
            <ResultIsClient>false</ResultIsClient>
            <ResultResolved>false</ResultResolved>
            <ResultSimilarity>0</ResultSimilarity>
            <SoftDelete>false</SoftDelete>
            <Source>String</Source>
            <Surname>String</Surname>
            <Telephone>String</Telephone>
            <Title>String</Title>
            <Type>String</Type>
            <Website>String</Website>
            <YearOfBirth>0</YearOfBirth>
            <YearOfDeath>0</YearOfDeath>
          </PepSearchResult>
        </Results>
      </SearchResults>
      <SearchType>String</SearchType>
    </SearchRecord>
  </Data>
</AddPepSearchResponse>

</soap12:Body>
</soap12:Envelope>