Sanctions Search API: v2

<back to all web services

AddBulkSearch

Create a bulk search
AddBulkSearch Parameters:
NameParameterData TypeRequiredDescription
RequestbodyAddBulkSearchRequestNo
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
AddBulkSearchRequest Parameters:
NameParameterData TypeRequiredDescription
IsSanctionsSearchformboolNo
IsPepSearchformboolNo
TypeformstringNo
SelectedListsformArrayOfListsNo
AddBulkSearchResponse Parameters:
NameParameterData TypeRequiredDescription
DataformAddBulkSearchDataNo
AddBulkSearchData Parameters:
NameParameterData TypeRequiredDescription
BulkSearchStatusformBulkSearchStatusNo
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
BulkSearchStatus Parameters:
NameParameterData TypeRequiredDescription
BulkSearchIdformintNo
SuccessformboolNo
StatusformstringNo
TotalformintNo
MessageformstringNo
ProcessedformintNo
IsPepSearchformboolNo
IsSanctionsSearchformboolNo
TotalPepformintNo
ProcessedPepformintNo
TotalSanctionsformintNo
ProcessedSanctionsformintNo

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

HTTP + SOAP12

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

POST /soap12 HTTP/1.1 
Host: api.sanctionssearch.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>

<AddBulkSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <IsPepSearch>false</IsPepSearch>
    <IsSanctionsSearch>false</IsSanctionsSearch>
    <SelectedLists>
      <ListId>String</ListId>
    </SelectedLists>
    <Type>String</Type>
  </Request>
</AddBulkSearch>

</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>

<AddBulkSearchResponse 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>
    <BulkSearchStatus>
      <BulkSearchId>0</BulkSearchId>
      <IsPepSearch>false</IsPepSearch>
      <IsSanctionsSearch>false</IsSanctionsSearch>
      <Message>String</Message>
      <Processed>0</Processed>
      <ProcessedPep>0</ProcessedPep>
      <ProcessedSanctions>0</ProcessedSanctions>
      <Status>String</Status>
      <Success>false</Success>
      <Total>0</Total>
      <TotalPep>0</TotalPep>
      <TotalSanctions>0</TotalSanctions>
    </BulkSearchStatus>
  </Data>
</AddBulkSearchResponse>

</soap12:Body>
</soap12:Envelope>