| GET | /clients/proofs/defaults | Get the configured default categories of proof and their documents | |
|---|---|---|---|
| GET | /clients/proofs | Get all categories of proof and their documents |
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
@DataContract
open class GetProofOfDocumentCategories : BaseRequest()
{
@DataMember
var onlyDefaults:Boolean? = 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 GetProofOfDocumentCategoriesResponse
{
@DataMember
@SerializedName("data") var Data:GetProofOfDocumentCategoriesData? = null
}
open class GetProofOfDocumentCategoriesData : BaseResponse()
{
var proofOfDocumentCategories:ArrayOfProofOfDocumentCategories? = 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>()
{
}
open class ArrayOfProofOfDocumentCategories : ArrayList<ProofOfDocumentCategory>()
{
}
open class ProofOfDocumentCategory
{
/**
* The ID of the ProofOfDocumentCategory
*/
@ApiMember(Description="The ID of the ProofOfDocumentCategory", IsRequired=true)
var id:Int? = null
/**
* The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')
*/
@ApiMember(Description="The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')", IsRequired=true)
var proofOf:String? = null
/**
* The documents that can be used to provide proof for the specified category.
*/
@ApiMember(Description="The documents that can be used to provide proof for the specified category.", IsRequired=true)
var proofOfDocuments:ArrayOfProofOfDocuments? = null
}
open class ArrayOfProofOfDocuments : ArrayList<ProofOfDocument>()
{
}
open class ProofOfDocument
{
/**
* The ID of the ProofOfDocument
*/
@ApiMember(Description="The ID of the ProofOfDocument", IsRequired=true)
var id:Int? = null
/**
* The name of the ProofOfDocument
*/
@ApiMember(Description="The name of the ProofOfDocument", IsRequired=true)
var name:String? = null
}
Kotlin GetProofOfDocumentCategories 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /clients/proofs/defaults HTTP/1.1 Host: api.sanctionssearch.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"proofOfDocumentCategories":[{"id":0,"proofOf":"String","proofOfDocuments":[{"id":0,"name":"String"}]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}