Sanctions Search API: v2

GetPepSearch

PEP

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

**GetPepSearch** Parameters:
Name	Parameter	Data Type	Required	Description
Request	body	GetPepSearchRequest	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Authentication	header, body	Authentication	Yes	The authentication credentials

**Authentication** Parameters:
Name	Parameter	Data Type	Required	Description
ApiUserId	header, body	string	Yes	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)
ApiUserKey	header, body	string	Yes	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)
UserId	header, body	string	No	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).

**GetPepSearchRequest** Parameters:
Name	Parameter	Data Type	Required	Description
SubUserName	form	string	No	If the search was created against a single Sub User account, specify their username here
OnlyShowUnresolvedResults	form	bool	No	If set to true, the response will exclude resolved search results, it will only include unresolved results
Id	form	long	No

**GetPepSearchResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	GetPepSearchData	No

**GetPepSearchData** Parameters:
Name	Parameter	Data Type	Required	Description
LinkedTo	form	ArrayOfLinkedTo	No
SearchRecord	form	PepSearchRecord	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No	The status of the response

**ResponseStatus** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StackTrace	form	string	No
Errors	form	ArrayOfResponseError	No
Meta	form	Dictionary<string, string>	No

**ResponseError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
FieldName	form	string	No
Message	form	string	No
Meta	form	Dictionary<string, string>	No

**LinkedTo** Parameters:
Name	Parameter	Data Type	Required
ClientId	form	int?	No
Id	form	long?	No
Type	form	string	No
Subtype	form	string	No
Status	form	string	No
Description	form	string	No
IsArchived	form	bool?	No
Name	form	string	No
Date	form	DateTime?	No

**PepSearchRecord** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
SearchType	form	string	No
DateSearched	form	DateTime	No
DateUpdated	form	DateTime	No
DateRenewal	form	DateTime?	No
DateArchived	form	DateTime?	No
IsArchived	form	bool	No
NumOfResults	form	int	No
ClientInResults	form	bool	No
ClientNotInResults	form	bool	No
AffectedByUpdate	form	bool	No
IsDayOneSearch	form	bool	No
SearchCriteria	form	SearchCriteria	No
SearchResults	form	PepSearchResults	No

**SearchCriteria** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Address	form	string	No
Country	form	string	No
DateOfBirth	form	string	No
Nationality	form	string	No
Reference	form	string	No

**PepSearchResults** Parameters:
Name	Parameter	Data Type	Required	Description
Results	form	List<PepSearchResult>	No

**PepSearchResult** Parameters:
Name	Parameter	Data Type	Required
ResultSimilarity	form	decimal	No
ResultResolved	form	bool	No
DateLastUpdated	form	DateTime	No
ResultIsClient	form	bool	No
Id	form	long	No
Type	form	string	No
Title	form	string	No
Forename	form	string	No
Middlename	form	string	No
Surname	form	string	No
SoftDelete	form	bool?	No
DateOfSoftDelete	form	DateTime?	No
DateOfCapture	form	DateTime?	No
DateOfBirth	form	DateTime?	No
DateOfDeath	form	DateTime?	No
YearOfBirth	form	int?	No
YearOfDeath	form	int?	No
Gender	form	string	No
HomeTelephone	form	string	No
BusinessTelephone	form	string	No
MobileTelephone	form	string	No
Fax	form	string	No
Email	form	string	No
Nationality	form	string	No
Source	form	string	No
Category	form	string	No
Picture	form	string	No
AlternateTitle	form	string	No
BusinessName	form	string	No
Description	form	string	No
Telephone	form	string	No
Website	form	string	No
PepTier	form	int?	No
FaceIsMatch	form	bool?	No
FaceIsMatchConfidence	form	decimal?	No
Addresses	form	List<PepSearchResultAddress>	No
Aliases	form	List<PepSearchResultAlias>	No
Articles	form	List<PepSearchResultArticle>	No
Associations	form	List<PepSearchResultIndividualAssociation>	No
BusinessAssociations	form	List<PepSearchResultBusinessAssociation>	No
Notes	form	List<PepSearchResultNote>	No
PoliticalPositions	form	List<PepSearchResultPoliticalPosition>	No

**PepSearchResultAddress** Parameters:
Name	Parameter	Data Type	Required
AddressLine1	form	string	No
AddressLine2	form	string	No
AddressLine3	form	string	No
AddressLine4	form	string	No
Town	form	string	No
County	form	string	No
PostCode	form	string	No
Country	form	string	No
ISOCountry	form	string	No
SoftDelete	form	bool?	No
DateLastUpdated	form	DateTime	No

**PepSearchResultAlias** Parameters:
Name	Parameter	Data Type	Required
Forename	form	string	No
MiddleName	form	string	No
Surname	form	string	No
SoftDelete	form	bool?	No
DateOfSoftDelete	form	DateTime?	No
DateLastUpdated	form	DateTime	No
Title	form	string	No
AlternateTitle	form	string	No
BusinessName	form	string	No

**PepSearchResultArticle** Parameters:
Name	Parameter	Data Type	Required
Url	form	string	No
OriginalUrl	form	string	No
Source	form	string	No
DateOfCapture	form	DateTime?	No
DateLastUpdated	form	DateTime	No
Snippets	form	List<PepSearchResultArticleSnippet>	No

**PepSearchResultArticleSnippet** Parameters:
Name	Parameter	Data Type	Required
Title	form	string	No
Text	form	string	No
AdverseTerms	form	string	No

**PepSearchResultIndividualAssociation** Parameters:
Name	Parameter	Data Type	Required
LinkDescription	form	string	No
SoftDelete	form	bool?	No
DateLastUpdated	form	DateTime	No
FullName	form	string	No

**PepSearchResultBusinessAssociation** Parameters:
Name	Parameter	Data Type	Required
LinkDescription	form	string	No
SoftDelete	form	bool?	No
DateLastUpdated	form	DateTime	No
BusinessName	form	string	No

**PepSearchResultNote** Parameters:
Name	Parameter	Data Type	Required
Source	form	string	No
Notes	form	string	No
SoftDelete	form	bool?	No
DateLastUpdated	form	DateTime	No

**PepSearchResultPoliticalPosition** Parameters:
Name	Parameter	Data Type	Required
Description	form	string	No
From	form	string	No
To	form	string	No
Country	form	string	No
SoftDelete	form	bool?	No
DateLastUpdated	form	DateTime	No

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>