Sanctions Search API: v2

<back to all web services

GetPepSearch

PEP
The following routes are available for this service:
POST/peps/getGet a PEP search
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class GetPepSearch : BaseRequest()
{
    @DataMember
    var request:GetPepSearchRequest? = null
}

@DataContract
open class BaseRequest : IBaseRequest
{
    /**
    * The authentication credentials
    */
    @DataMember
    @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    var authentication:Authentication? = null
}

@DataContract
open class Authentication
{
    /**
    * The API User ID provided by us when you signed up to use our API
    */
    @DataMember
    @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    var apiUserId:String? = null

    /**
    * The API User Key provided by us when you signed up to use our API
    */
    @DataMember
    @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    var apiUserKey:String? = null
}

open class GetPepSearchRequest
{
    /**
    * If the search was created against a single Sub User account, specify their username here
    */
    @ApiMember(Description="If the search was created against a single Sub User account, specify their username here")
    var subUserName:String? = null

    /**
    * If set to true, the response will exclude resolved search results, it will only include unresolved results
    */
    @ApiMember(Description="If set to true, the response will exclude resolved search results, it will only include unresolved results")
    var onlyShowUnresolvedResults:Boolean? = null

    var id:Long? = null
}

@DataContract
open class GetPepSearchResponse
{
    @DataMember
    @SerializedName("data") var Data:GetPepSearchData? = null
}

open class GetPepSearchData : BaseResponse(), IBaseSearchResponse
{
    var linkedTo:ArrayOfLinkedTo? = null
    var searchRecord:PepSearchRecord? = null
}

open class BaseResponse : IBaseDataResponse, IHasResponseStatus
{
    /**
    * The status of the response
    */
    @ApiMember(Description="The status of the response")
    var responseStatus:ResponseStatus? = null
}

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

open class ArrayOfLinkedTo : ArrayList<LinkedTo>()
{
}

open class LinkedTo
{
    var clientId:Int? = null
    var id:Long? = null
    @SerializedName("type") var Type:String? = null
    var subtype:String? = null
    var status:String? = null
    var description:String? = null
    var isArchived:Boolean? = null
    var name:String? = null
    var date:Date? = null
}

open class PepSearchRecord
{
    var id:Long? = null
    var searchType:String? = null
    var dateSearched:Date? = null
    var dateUpdated:Date? = null
    var dateRenewal:Date? = null
    var dateArchived:Date? = null
    var isArchived:Boolean? = null
    var numOfResults:Int? = null
    var clientInResults:Boolean? = null
    var clientNotInResults:Boolean? = null
    var affectedByUpdate:Boolean? = null
    var isDayOneSearch:Boolean? = null
    var searchCriteria:SearchCriteria? = null
    var searchResults:PepSearchResults? = null
}

open class SearchCriteria
{
    var name:String? = null
    var address:String? = null
    var country:String? = null
    var dateOfBirth:String? = null
    var nationality:String? = null
    var reference:String? = null
}

open class PepSearchResults
{
    var results:ArrayList<PepSearchResult> = ArrayList<PepSearchResult>()
}

open class PepSearchResult
{
    var resultSimilarity:BigDecimal? = null
    var resultResolved:Boolean? = null
    var dateLastUpdated:Date? = null
    var resultIsClient:Boolean? = null
    var id:Long? = null
    @SerializedName("type") var Type:String? = null
    var title:String? = null
    var forename:String? = null
    var middlename:String? = null
    var surname:String? = null
    var softDelete:Boolean? = null
    var dateOfSoftDelete:Date? = null
    var dateOfCapture:Date? = null
    var dateOfBirth:Date? = null
    var dateOfDeath:Date? = null
    var yearOfBirth:Int? = null
    var yearOfDeath:Int? = null
    var gender:String? = null
    var homeTelephone:String? = null
    var businessTelephone:String? = null
    var mobileTelephone:String? = null
    var fax:String? = null
    var email:String? = null
    var nationality:String? = null
    var source:String? = null
    var category:String? = null
    var picture:String? = null
    var alternateTitle:String? = null
    var businessName:String? = null
    var description:String? = null
    var telephone:String? = null
    var website:String? = null
    var pepTier:Int? = null
    var addresses:ArrayList<PepSearchResultAddress> = ArrayList<PepSearchResultAddress>()
    var aliases:ArrayList<PepSearchResultAlias> = ArrayList<PepSearchResultAlias>()
    var articles:ArrayList<PepSearchResultArticle> = ArrayList<PepSearchResultArticle>()
    var associations:ArrayList<PepSearchResultIndividualAssociation> = ArrayList<PepSearchResultIndividualAssociation>()
    var businessAssociations:ArrayList<PepSearchResultBusinessAssociation> = ArrayList<PepSearchResultBusinessAssociation>()
    var notes:ArrayList<PepSearchResultNote> = ArrayList<PepSearchResultNote>()
    var politicalPositions:ArrayList<PepSearchResultPoliticalPosition> = ArrayList<PepSearchResultPoliticalPosition>()
}

open class PepSearchResultAddress
{
    var addressLine1:String? = null
    var addressLine2:String? = null
    var addressLine3:String? = null
    var addressLine4:String? = null
    var town:String? = null
    var county:String? = null
    var postCode:String? = null
    var country:String? = null
    var isoCountry:String? = null
    var softDelete:Boolean? = null
    var dateLastUpdated:Date? = null
}

open class PepSearchResultAlias
{
    var forename:String? = null
    var middleName:String? = null
    var surname:String? = null
    var softDelete:Boolean? = null
    var dateOfSoftDelete:Date? = null
    var dateLastUpdated:Date? = null
    var title:String? = null
    var alternateTitle:String? = null
    var businessName:String? = null
}

open class PepSearchResultArticle
{
    var url:String? = null
    var originalUrl:String? = null
    var source:String? = null
    var dateOfCapture:Date? = null
    var dateLastUpdated:Date? = null
    var snippets:ArrayList<PepSearchResultArticleSnippet> = ArrayList<PepSearchResultArticleSnippet>()
}

open class PepSearchResultArticleSnippet
{
    var title:String? = null
    var text:String? = null
    var adverseTerms:String? = null
}

open class PepSearchResultIndividualAssociation
{
    var linkDescription:String? = null
    var softDelete:Boolean? = null
    var dateLastUpdated:Date? = null
    var fullName:String? = null
}

open class PepSearchResultBusinessAssociation
{
    var linkDescription:String? = null
    var softDelete:Boolean? = null
    var dateLastUpdated:Date? = null
    var businessName:String? = null
}

open class PepSearchResultNote
{
    var source:String? = null
    var notes:String? = null
    var softDelete:Boolean? = null
    var dateLastUpdated:Date? = null
}

open class PepSearchResultPoliticalPosition
{
    var description:String? = null
    var from:String? = null
    var to:String? = null
    var country:String? = null
    var softDelete:Boolean? = null
    var dateLastUpdated:Date? = null
}

Kotlin GetPepSearch DTOs

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

HTTP + XML

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

POST /peps/get HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetPepSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <Id>0</Id>
    <OnlyShowUnresolvedResults>false</OnlyShowUnresolvedResults>
    <SubUserName>String</SubUserName>
  </Request>
</GetPepSearch>

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

<GetPepSearchResponse 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>
    <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>
    <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>
</GetPepSearchResponse>