Sanctions Search API: v2

GetPepSearch

PEP

The following routes are available for this service:
POST	/peps/get	Get a PEP search

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using SanctionsSearch.Api2.ServiceModel.Operations.PepSearches;
using SanctionsSearch.Api2.ServiceModel.Operations.Base;
using SanctionsSearch.Api2.ServiceModel.Types;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

}

namespace SanctionsSearch.Api2.ServiceModel.Operations.PepSearches
{
    [DataContract]
    public partial class GetPepSearch
        : BaseRequest
    {
        [DataMember]
        public virtual GetPepSearchRequest Request { get; set; }
    }

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

    public partial class GetPepSearchRequest
    {
        ///<summary>
        ///If the search was created against a single Sub User account, specify their username here
        ///</summary>
        [ApiMember(Description="If the search was created against a single Sub User account, specify their username here")]
        public virtual string SubUserName { get; set; }

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

        public virtual long Id { get; set; }
    }

    [DataContract]
    public partial class GetPepSearchResponse
    {
        [DataMember]
        public virtual GetPepSearchData Data { get; set; }
    }

}

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

    [DataContract]
    public partial class Authentication
    {
        ///<summary>
        ///The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)
        ///</summary>
        [DataMember]
        [ApiMember(Description="The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)", IsRequired=true, ParameterType="header, body")]
        public virtual string ApiUserId { get; set; }

        ///<summary>
        ///The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)
        ///</summary>
        [DataMember]
        [ApiMember(Description="The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)", IsRequired=true, ParameterType="header, body")]
        public virtual string ApiUserKey { get; set; }

        ///<summary>
        ///The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).
        ///</summary>
        [DataMember]
        [ApiMember(Description="The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).", ParameterType="header, body")]
        public virtual string UserId { get; set; }
    }

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

    public partial class PepSearchRecord
    {
        public virtual long Id { get; set; }
        public virtual string SearchType { get; set; }
        public virtual DateTime DateSearched { get; set; }
        public virtual DateTime DateUpdated { get; set; }
        public virtual DateTime? DateRenewal { get; set; }
        public virtual DateTime? DateArchived { get; set; }
        public virtual bool IsArchived { get; set; }
        public virtual int NumOfResults { get; set; }
        public virtual bool ClientInResults { get; set; }
        public virtual bool ClientNotInResults { get; set; }
        public virtual bool AffectedByUpdate { get; set; }
        public virtual bool IsDayOneSearch { get; set; }
        public virtual SearchCriteria SearchCriteria { get; set; }
        public virtual PepSearchResults SearchResults { get; set; }
    }

    public partial class PepSearchResult
    {
        public PepSearchResult()
        {
            Addresses = new List<PepSearchResultAddress>{};
            Aliases = new List<PepSearchResultAlias>{};
            Articles = new List<PepSearchResultArticle>{};
            Associations = new List<PepSearchResultIndividualAssociation>{};
            BusinessAssociations = new List<PepSearchResultBusinessAssociation>{};
            Notes = new List<PepSearchResultNote>{};
            PoliticalPositions = new List<PepSearchResultPoliticalPosition>{};
        }

        public virtual decimal ResultSimilarity { get; set; }
        public virtual bool ResultResolved { get; set; }
        public virtual DateTime DateLastUpdated { get; set; }
        public virtual bool ResultIsClient { get; set; }
        public virtual long Id { get; set; }
        public virtual string Type { get; set; }
        public virtual string Title { get; set; }
        public virtual string Forename { get; set; }
        public virtual string Middlename { get; set; }
        public virtual string Surname { get; set; }
        public virtual bool? SoftDelete { get; set; }
        public virtual DateTime? DateOfSoftDelete { get; set; }
        public virtual DateTime? DateOfCapture { get; set; }
        public virtual DateTime? DateOfBirth { get; set; }
        public virtual DateTime? DateOfDeath { get; set; }
        public virtual int? YearOfBirth { get; set; }
        public virtual int? YearOfDeath { get; set; }
        public virtual string Gender { get; set; }
        public virtual string HomeTelephone { get; set; }
        public virtual string BusinessTelephone { get; set; }
        public virtual string MobileTelephone { get; set; }
        public virtual string Fax { get; set; }
        public virtual string Email { get; set; }
        public virtual string Nationality { get; set; }
        public virtual string Source { get; set; }
        public virtual string Category { get; set; }
        public virtual string Picture { get; set; }
        public virtual string AlternateTitle { get; set; }
        public virtual string BusinessName { get; set; }
        public virtual string Description { get; set; }
        public virtual string Telephone { get; set; }
        public virtual string Website { get; set; }
        public virtual int? PepTier { get; set; }
        public virtual bool? FaceIsMatch { get; set; }
        public virtual decimal? FaceIsMatchConfidence { get; set; }
        public virtual List<PepSearchResultAddress> Addresses { get; set; }
        public virtual List<PepSearchResultAlias> Aliases { get; set; }
        public virtual List<PepSearchResultArticle> Articles { get; set; }
        public virtual List<PepSearchResultIndividualAssociation> Associations { get; set; }
        public virtual List<PepSearchResultBusinessAssociation> BusinessAssociations { get; set; }
        public virtual List<PepSearchResultNote> Notes { get; set; }
        public virtual List<PepSearchResultPoliticalPosition> PoliticalPositions { get; set; }
    }

    public partial class PepSearchResultAddress
    {
        public virtual string AddressLine1 { get; set; }
        public virtual string AddressLine2 { get; set; }
        public virtual string AddressLine3 { get; set; }
        public virtual string AddressLine4 { get; set; }
        public virtual string Town { get; set; }
        public virtual string County { get; set; }
        public virtual string PostCode { get; set; }
        public virtual string Country { get; set; }
        public virtual string ISOCountry { get; set; }
        public virtual bool? SoftDelete { get; set; }
        public virtual DateTime DateLastUpdated { get; set; }
    }

    public partial class PepSearchResultAlias
    {
        public virtual string Forename { get; set; }
        public virtual string MiddleName { get; set; }
        public virtual string Surname { get; set; }
        public virtual bool? SoftDelete { get; set; }
        public virtual DateTime? DateOfSoftDelete { get; set; }
        public virtual DateTime DateLastUpdated { get; set; }
        public virtual string Title { get; set; }
        public virtual string AlternateTitle { get; set; }
        public virtual string BusinessName { get; set; }
    }

    public partial class PepSearchResultArticle
    {
        public PepSearchResultArticle()
        {
            Snippets = new List<PepSearchResultArticleSnippet>{};
        }

        public virtual string Url { get; set; }
        public virtual string OriginalUrl { get; set; }
        public virtual string Source { get; set; }
        public virtual DateTime? DateOfCapture { get; set; }
        public virtual DateTime DateLastUpdated { get; set; }
        public virtual List<PepSearchResultArticleSnippet> Snippets { get; set; }
    }

    public partial class PepSearchResultArticleSnippet
    {
        public virtual string Title { get; set; }
        public virtual string Text { get; set; }
        public virtual string AdverseTerms { get; set; }
    }

    public partial class PepSearchResultBusinessAssociation
    {
        public virtual string LinkDescription { get; set; }
        public virtual bool? SoftDelete { get; set; }
        public virtual DateTime DateLastUpdated { get; set; }
        public virtual string BusinessName { get; set; }
    }

    public partial class PepSearchResultIndividualAssociation
    {
        public virtual string LinkDescription { get; set; }
        public virtual bool? SoftDelete { get; set; }
        public virtual DateTime DateLastUpdated { get; set; }
        public virtual string FullName { get; set; }
    }

    public partial class PepSearchResultNote
    {
        public virtual string Source { get; set; }
        public virtual string Notes { get; set; }
        public virtual bool? SoftDelete { get; set; }
        public virtual DateTime DateLastUpdated { get; set; }
    }

    public partial class PepSearchResultPoliticalPosition
    {
        public virtual string Description { get; set; }
        public virtual string From { get; set; }
        public virtual string To { get; set; }
        public virtual string Country { get; set; }
        public virtual bool? SoftDelete { get; set; }
        public virtual DateTime DateLastUpdated { get; set; }
    }

    public partial class PepSearchResults
    {
        public PepSearchResults()
        {
            Results = new List<PepSearchResult>{};
        }

        public virtual List<PepSearchResult> Results { get; set; }
    }

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

}

C# 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>
    <UserId>String</UserId>
  </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>
            <FaceIsMatch>false</FaceIsMatch>
            <FaceIsMatchConfidence>0</FaceIsMatchConfidence>
            <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>