Sanctions Search API: v2

<back to all web services

CountUnresolvedPepSearches

PEP
The following routes are available for this service:
POST/peps/unresolved/countGet the count of unresolved PEP searches
CountUnresolvedPepSearches Parameters:
NameParameterData TypeRequiredDescription
RequestbodyCountUnresolvedPepSearchesRequestNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
Authenticationheader, bodyAuthenticationYesThe authentication credentials
Authentication Parameters:
NameParameterData TypeRequiredDescription
ApiUserIdheader, bodystringYesThe API User ID provided by us when you signed up to use our API
ApiUserKeyheader, bodystringYesThe API User Key provided by us when you signed up to use our API
CountUnresolvedPepSearchesRequest Parameters:
NameParameterData TypeRequiredDescription
IncludeSearchesFromOtherUsersformboolNo
CountUnresolvedPepSearchesResponse Parameters:
NameParameterData TypeRequiredDescription
DataformCountUnresolvedPepSearchesDataNo
CountUnresolvedPepSearchesData Parameters:
NameParameterData TypeRequiredDescription
NumberOfUnresolvedPepSearchesformlongNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNoThe status of the response
ResponseStatus Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StackTraceformstringNo
ErrorsformArrayOfResponseErrorNo
MetaformDictionary<string, string>No
ResponseError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
FieldNameformstringNo
MessageformstringNo
MetaformDictionary<string, 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/unresolved/count HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CountUnresolvedPepSearches xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <IncludeSearchesFromOtherUsers>false</IncludeSearchesFromOtherUsers>
  </Request>
</CountUnresolvedPepSearches>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CountUnresolvedPepSearchesResponse 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>
    <NumberOfUnresolvedPepSearches>0</NumberOfUnresolvedPepSearches>
  </Data>
</CountUnresolvedPepSearchesResponse>