Sanctions Search API: v2

GetPepSearches

PEP

The following routes are available for this service:
POST	/peps/list	Get all PEP searches

**GetPepSearches** Parameters:
Name	Parameter	Data Type	Required	Description
Request	body	GetPepSearchesRequest	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).

**GetPepSearchesRequest** Parameters:
Name	Parameter	Data Type	Required	Description
SubUserName	form	string	No	If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view
ListUnresolvedSearches	form	bool?	No
ListUpdatedSearches	form	bool?	No
ListExpiringSearches	form	bool?	No
ListArchivedSearches	form	bool	No
Page	form	int	No
SortOrder	form	string	No
NameSearch	form	string	No
NameSearchExact	form	bool	No
FilterNameExcludes	form	string	No
FilterReference	form	string	No
FilterReferenceExcludes	form	string	No
FilterPepType	form	string	No
FilterType	form	string	No
FilterDateFrom	form	DateTime?	No
FilterDateTo	form	DateTime?	No
FilterDateRenewal	form	DateTime?	No
FilterUserName	form	string	No	If set, will only return searches created by the user

**GetPepSearchesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	GetPepSearchesData	No

**GetPepSearchesData** Parameters:
Name	Parameter	Data Type	Required
TotalSearchRecords	form	int	No
CurrentPageNum	form	int	No
MaxPageNum	form	int	No
SearchRecords	form	ArrayOfPepSearchListItem	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

**PepSearchListItem** 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

**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

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/list HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetPepSearches 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>
    <FilterDateFrom>0001-01-01T00:00:00</FilterDateFrom>
    <FilterDateRenewal>0001-01-01T00:00:00</FilterDateRenewal>
    <FilterDateTo>0001-01-01T00:00:00</FilterDateTo>
    <FilterNameExcludes>String</FilterNameExcludes>
    <FilterPepType>String</FilterPepType>
    <FilterReference>String</FilterReference>
    <FilterReferenceExcludes>String</FilterReferenceExcludes>
    <FilterType>String</FilterType>
    <FilterUserName>String</FilterUserName>
    <ListArchivedSearches>false</ListArchivedSearches>
    <ListExpiringSearches>false</ListExpiringSearches>
    <ListUnresolvedSearches>false</ListUnresolvedSearches>
    <ListUpdatedSearches>false</ListUpdatedSearches>
    <NameSearch>String</NameSearch>
    <NameSearchExact>false</NameSearchExact>
    <Page>0</Page>
    <SortOrder>String</SortOrder>
    <SubUserName>String</SubUserName>
  </Request>
</GetPepSearches>

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

<GetPepSearchesResponse 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>
    <CurrentPageNum>0</CurrentPageNum>
    <MaxPageNum>0</MaxPageNum>
    <SearchRecords>
      <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>
        <SearchType>String</SearchType>
      </SearchRecord>
    </SearchRecords>
    <TotalSearchRecords>0</TotalSearchRecords>
  </Data>
</GetPepSearchesResponse>