Sanctions Search API: v1

<back to all web services

UpdateSearchStatus

Update/resolve a sanctions search

UpdateSearchStatus Parameters:
NameParameterData TypeRequiredDescription
AuthenticationbodyAuthenticationYesAuthentication object
RequestbodyUpdateSearchStatusRequestYesRequest object
Authentication Parameters:
NameParameterData TypeRequiredDescription
ApiUserIdformstringYesThe API User ID that will authenticate your request
ApiUserKeyformstringYesThe API User Key that will authenticate your request
UpdateSearchStatusRequest Parameters:
NameParameterData TypeRequiredDescription
IdformintegerYesThe ID of the sanctions search that is being resolved/updated.
ClientInResultsformbooleanYesWhether the search results did contain the client. Set this to "true" if the client WAS found in the search results.
ClientNotInResultsformbooleanYesWhether the search results did not contain the client. Set this to "true" if the client WAS NOT found in the search results.
UpdateSearchStatusResponse Parameters:
NameParameterData TypeRequiredDescription
DataformUpdateSearchStatusDataNoResponse object
UpdateSearchStatusData Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNoResponse status object
ResponseStatus Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StackTraceformstringNo
ErrorsformArrayOfResponseErrorNo
ResponseError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
FieldNameformstringNo
MessageformstringNo

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>

<UpdateSearchStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <ClientInResults>false</ClientInResults>
    <ClientNotInResults>false</ClientNotInResults>
    <Id>0</Id>
  </Request>
</UpdateSearchStatus>

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

<UpdateSearchStatusResponse 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>
        </ResponseError>
      </Errors>
    </ResponseStatus>
  </Data>
</UpdateSearchStatusResponse>

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