Sanctions Search API: v2

<back to all web services

ActivateValidId

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

POST /validid/activate HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"companyName":"String","companyAddress":"String","companyNumber":"String","name":"String","position":"String","signature":"String","dpaNumber":"String","amlBodyNumber":"String","purpose":"String","classificationId":0,"agreeToTerms":false},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"validIdActivated":false,"agreementText":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}