Sanctions Search API: v2

<back to all web services

ActivateValidId

Activate ValidID
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class ActivateValidId extends BaseRequest
    {
        @DataMember
        public ActivateValidIdRequest request = null;
        
        public ActivateValidIdRequest getRequest() { return request; }
        public ActivateValidId setRequest(ActivateValidIdRequest value) { this.request = value; return this; }
    }

    @DataContract
    public static class BaseRequest implements IBaseRequest
    {
        /**
        * The authentication credentials
        */
        @DataMember
        @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
        public Authentication authentication = null;
        
        public Authentication getAuthentication() { return authentication; }
        public BaseRequest setAuthentication(Authentication value) { this.authentication = value; return this; }
    }

    @DataContract
    public static class Authentication
    {
        /**
        * The API User ID provided by us when you signed up to use our API
        */
        @DataMember
        @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
        public String apiUserId = null;

        /**
        * The API User Key provided by us when you signed up to use our API
        */
        @DataMember
        @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
        public String apiUserKey = null;
        
        public String getApiUserId() { return apiUserId; }
        public Authentication setApiUserId(String value) { this.apiUserId = value; return this; }
        public String getApiUserKey() { return apiUserKey; }
        public Authentication setApiUserKey(String value) { this.apiUserKey = value; return this; }
    }

    public static class ActivateValidIdRequest
    {
        public String companyName = null;
        public String companyAddress = null;
        public String companyNumber = null;
        public String name = null;
        public String position = null;
        public String signature = null;
        public String dpaNumber = null;
        public String amlBodyNumber = null;
        public String purpose = null;
        public Integer classificationId = null;
        public Boolean agreeToTerms = null;
        
        public String getCompanyName() { return companyName; }
        public ActivateValidIdRequest setCompanyName(String value) { this.companyName = value; return this; }
        public String getCompanyAddress() { return companyAddress; }
        public ActivateValidIdRequest setCompanyAddress(String value) { this.companyAddress = value; return this; }
        public String getCompanyNumber() { return companyNumber; }
        public ActivateValidIdRequest setCompanyNumber(String value) { this.companyNumber = value; return this; }
        public String getName() { return name; }
        public ActivateValidIdRequest setName(String value) { this.name = value; return this; }
        public String getPosition() { return position; }
        public ActivateValidIdRequest setPosition(String value) { this.position = value; return this; }
        public String getSignature() { return signature; }
        public ActivateValidIdRequest setSignature(String value) { this.signature = value; return this; }
        public String getDpaNumber() { return dpaNumber; }
        public ActivateValidIdRequest setDpaNumber(String value) { this.dpaNumber = value; return this; }
        public String getAmlBodyNumber() { return amlBodyNumber; }
        public ActivateValidIdRequest setAmlBodyNumber(String value) { this.amlBodyNumber = value; return this; }
        public String getPurpose() { return purpose; }
        public ActivateValidIdRequest setPurpose(String value) { this.purpose = value; return this; }
        public Integer getClassificationId() { return classificationId; }
        public ActivateValidIdRequest setClassificationId(Integer value) { this.classificationId = value; return this; }
        public Boolean isAgreeToTerms() { return agreeToTerms; }
        public ActivateValidIdRequest setAgreeToTerms(Boolean value) { this.agreeToTerms = value; return this; }
    }

    @DataContract
    public static class ActivateValidIdResponse
    {
        @DataMember
        public ActivateValidIdData data = null;
        
        public ActivateValidIdData getData() { return data; }
        public ActivateValidIdResponse setData(ActivateValidIdData value) { this.data = value; return this; }
    }

    public static class ActivateValidIdData extends BaseResponse
    {
        public Boolean validIdActivated = null;
        public String agreementText = null;
        
        public Boolean isValidIdActivated() { return validIdActivated; }
        public ActivateValidIdData setValidIdActivated(Boolean value) { this.validIdActivated = value; return this; }
        public String getAgreementText() { return agreementText; }
        public ActivateValidIdData setAgreementText(String value) { this.agreementText = value; return this; }
    }

    public static class BaseResponse implements IBaseDataResponse, IHasResponseStatus
    {
        /**
        * The status of the response
        */
        @ApiMember(Description="The status of the response")
        public ResponseStatus responseStatus = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public BaseResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static class ArrayOfResponseError extends ArrayList<ResponseError>
    {
        
    }

}

Java ActivateValidId DTOs

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>

<ActivateValidId xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <AMLBodyNumber>String</AMLBodyNumber>
    <AgreeToTerms>false</AgreeToTerms>
    <ClassificationId>0</ClassificationId>
    <CompanyAddress>String</CompanyAddress>
    <CompanyName>String</CompanyName>
    <CompanyNumber>String</CompanyNumber>
    <DPANumber>String</DPANumber>
    <Name>String</Name>
    <Position>String</Position>
    <Purpose>String</Purpose>
    <Signature>String</Signature>
  </Request>
</ActivateValidId>

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

<ActivateValidIdResponse 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>
    <AgreementText>String</AgreementText>
    <ValidIdActivated>false</ValidIdActivated>
  </Data>
</ActivateValidIdResponse>

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