Sanctions Search API: v2

<back to all web services

GetClientDocument

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

public class dtos
{

    @DataContract
    public static class GetClientDocument extends BaseRequest
    {
        @DataMember
        @ApiMember(IsRequired=true, ParameterType="path")
        public Integer id = null;

        @DataMember
        public Boolean original = null;

        @DataMember
        public Integer mil = null;

        @DataMember
        public Integer ocrId = null;
        
        public Integer getId() { return id; }
        public GetClientDocument setId(Integer value) { this.id = value; return this; }
        public Boolean isOriginal() { return original; }
        public GetClientDocument setOriginal(Boolean value) { this.original = value; return this; }
        public Integer getMil() { return mil; }
        public GetClientDocument setMil(Integer value) { this.mil = value; return this; }
        public Integer getOcrId() { return ocrId; }
        public GetClientDocument setOcrId(Integer value) { this.ocrId = 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; }
    }

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

    public static class GetClientDocumentData extends BaseResponse
    {
        public String base64Image = null;
        
        public String getBase64Image() { return base64Image; }
        public GetClientDocumentData setBase64Image(String value) { this.base64Image = 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 GetClientDocument DTOs

GET /clients/documents/{Id} HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json

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

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