Sanctions Search API: v2

GetClientDocument

Clients

The following routes are available for this service:
GET	/clients/documents/{Id}	Gets the document image
GET	/clients/documents/{Id}/original	Get the original document image
GET	/clients/documents/{Id}/cropped	Get the cropped document image

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class GetClientDocument : BaseRequest()
{
    @DataMember
    @ApiMember(IsRequired=true, ParameterType="path")
    var id:Int? = null

    @DataMember
    var original:Boolean? = null

    @DataMember
    var mil:Int? = null

    @DataMember
    var ocrId:Int? = null
}

@DataContract
open class BaseRequest : IBaseRequest
{
    /**
    * The authentication credentials
    */
    @DataMember
    @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    var authentication:Authentication? = null
}

@DataContract
open 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")
    var apiUserId:String? = 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")
    var apiUserKey:String? = null
}

@DataContract
open class GetClientDocumentResponse
{
    @DataMember
    @SerializedName("data") var Data:GetClientDocumentData? = null
}

open class GetClientDocumentData : BaseResponse()
{
    var base64Image:String? = null
}

open class BaseResponse : IBaseDataResponse, IHasResponseStatus
{
    /**
    * The status of the response
    */
    @ApiMember(Description="The status of the response")
    var responseStatus:ResponseStatus? = null
}

open class ArrayOfResponseError : ArrayList<ResponseError>()
{
}

Kotlin GetClientDocument DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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"}}}}