Sanctions Search API: v2

ActivateValidId

ValidID

The following routes are available for this service:
POST	/validid/activate	Activate ValidID

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


@DataContract
open class ActivateValidId : BaseRequest()
{
    @DataMember
    var request:ActivateValidIdRequest? = 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
}

open class ActivateValidIdRequest
{
    var companyName:String? = null
    var companyAddress:String? = null
    var companyNumber:String? = null
    var name:String? = null
    var position:String? = null
    var signature:String? = null
    var dpaNumber:String? = null
    var amlBodyNumber:String? = null
    var purpose:String? = null
    var classificationId:Int? = null
    var agreeToTerms:Boolean? = null
}

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

open class ActivateValidIdData : BaseResponse()
{
    var validIdActivated:Boolean? = null
    var agreementText: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 ActivateValidId 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.

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