Sanctions Search API: v2

<back to all web services

AddValidIdTemplate

ValidID
The following routes are available for this service:
GET/validid/template
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class AddValidIdTemplate : BaseRequest()
{
    @DataMember
    @ApiMember(IsRequired=true)
    var clientId: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 AddValidIdTemplateResponse
{
    @DataMember
    @SerializedName("data") var Data:AddValidIdTemplateData? = null
}

open class AddValidIdTemplateData : BaseResponse()
{
    var request:AddValidIdRequest? = 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 AddValidIdRequest
{
    /**
    * If the search should be saved against a single Sub User account, specify their username here
    */
    @ApiMember(Description="If the search should be saved against a single Sub User account, specify their username here")
    var subUserName:String? = null

    @SerializedName("type") var Type:String? = null
    var addPepSearch:Boolean? = null
    var pepSearchType:String? = null
    var addSanctionsSearch:Boolean? = null
    var selectedLists:ArrayOfLists? = null
    var reference:String? = null
    /**
    * If the search should be linked to other searches, specify the them here
    */
    @ApiMember(Description="If the search should be linked to other searches, specify the them here")
    var linkedTo:ArrayOfLinkedTo? = null

    var basicRequest:ValidIdBasicRequest? = null
    var passportRequest:ValidIdPassportRequest? = null
    var drivingRequest:ValidIdDrivingRequest? = null
    var birthRequest:ValidIdBirthRequest? = null
    var niRequest:ValidIdNIRequest? = null
    var nhsRequest:ValidIdNHSRequest? = null
    var electricityRequest:ValidIdElectricityRequest? = null
    var bankRequest:ValidIdBankRequest? = null
    var cardNumberRequest:ValidIdCardNumberRequest? = null
    var travelVisaRequest:ValidIdTravelVisaRequest? = null
    var idCardRequest:ValidIdIdCardRequest? = null
    var pollNumberRequest:ValidIdPollNumberRequest? = null
    var marriageRequest:ValidIdMarriageRequest? = null
    var passportEnabled:Boolean? = null
    var passportChipEnabled:Boolean? = null
    var drivingEnabled:Boolean? = null
    var smartlinkEnabled:Boolean? = null
    var niEnabled:Boolean? = null
    var nhsEnabled:Boolean? = null
    var electricityEnabled:Boolean? = null
    var bankEnabled:Boolean? = null
    var creditActiveEnabled:Boolean? = null
    var idCardEnabled:Boolean? = null
    var bankLiveEnabled:Boolean? = null
    var companyDirectorEnabled:Boolean? = null
    var searchActivityEnabled:Boolean? = null
    var prsEnabled:Boolean? = null
}

open class ArrayOfLists : ArrayList<String>()
{
}

open class ArrayOfLinkedTo : ArrayList<LinkedTo>()
{
}

open class LinkedTo
{
    var clientId:Int? = null
    var id:Long? = null
    @SerializedName("type") var Type:String? = null
    var subtype:String? = null
    var status:String? = null
    var description:String? = null
    var isArchived:Boolean? = null
    var name:String? = null
    var date:Date? = null
}

open class ValidIdBasicRequest
{
    var name1:String? = null
    var name2:String? = null
    var name3:String? = null
    var dateOfBirth:Date? = null
    var gender:String? = null
    var address1:String? = null
    var address2:String? = null
    var address3:String? = null
    var address4:String? = null
    var address5:String? = null
    var postCode:String? = null
}

open class ValidIdPassportRequest
{
    var passport1:String? = null
    var passport2:String? = null
    var passport3:String? = null
    var passport4:String? = null
    var passport5:String? = null
    var passport6:String? = null
    var passport7:String? = null
    var passport8:String? = null
    var passportMrzLineOne1:String? = null
    var passportMrzLineOne2:String? = null
    var passportMrzLineOne3:String? = null
}

open class ValidIdDrivingRequest
{
    var driving1:String? = null
    var driving2:String? = null
    var driving3:String? = null
    var drivingPostcode:String? = null
    var drivingMailSort:String? = null
}

open class ValidIdBirthRequest
{
    var birthForeName:String? = null
    var birthMiddleName:String? = null
    var birthSurname:String? = null
    var birthMaidenName:String? = null
    var birthDistrict:String? = null
    var birthCertIssueNum:String? = null
}

open class ValidIdNIRequest
{
    var niNumber:String? = null
}

open class ValidIdNHSRequest
{
    var nhsNumber:String? = null
}

open class ValidIdElectricityRequest
{
    var mpanNumber1:String? = null
    var mpanNumber2:String? = null
    var mpanNumber3:String? = null
    var mpanNumber4:String? = null
}

open class ValidIdBankRequest
{
    var bankSortCode:String? = null
    var bankAccountNumber:String? = null
}

open class ValidIdCardNumberRequest
{
    var cardNumber:String? = null
    var cardType:String? = null
}

open class ValidIdTravelVisaRequest
{
    var travelVisa1:String? = null
    var travelVisa2:String? = null
    var travelVisa3:String? = null
    var travelVisa4:String? = null
    var travelVisa5:String? = null
    var travelVisa6:String? = null
    var travelVisa7:String? = null
    var travelVisa8:String? = null
    var travelVisa9:String? = null
}

open class ValidIdIdCardRequest
{
    var idCard1:String? = null
    var idCard2:String? = null
    var idCard3:String? = null
    var idCard4:String? = null
    var idCard5:String? = null
    var idCard6:String? = null
    var idCard7:String? = null
    var idCard8:String? = null
    var idCard9:String? = null
    var idCard10:String? = null
}

open class ValidIdPollNumberRequest
{
    var pollNumber:String? = null
}

open class ValidIdMarriageRequest
{
    var forename:String? = null
    var surname:String? = null
    var partnerForename:String? = null
    var partnerSurname:String? = null
    var date:String? = null
    var district:String? = null
    var certIssueNum:String? = null
}

Kotlin AddValidIdTemplate 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 /validid/template HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json

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

{"data":{"request":{"subUserName":"String","type":"String","addPepSearch":false,"pepSearchType":"String","addSanctionsSearch":false,"selectedLists":["String"],"reference":"String","linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}],"basicRequest":{"name1":"String","name2":"String","name3":"String","dateOfBirth":"\/Date(-62135596800000-0000)\/","gender":"String","address1":"String","address2":"String","address3":"String","address4":"String","address5":"String","postCode":"String"},"passportRequest":{"passport1":"String","passport2":"String","passport3":"String","passport4":"String","passport5":"String","passport6":"String","passport7":"String","passport8":"String","passportMrzLineOne1":"String","passportMrzLineOne2":"String","passportMrzLineOne3":"String"},"drivingRequest":{"driving1":"String","driving2":"String","driving3":"String","drivingPostcode":"String","drivingMailSort":"String"},"birthRequest":{"birthForeName":"String","birthMiddleName":"String","birthSurname":"String","birthMaidenName":"String","birthDistrict":"String","birthCertIssueNum":"String"},"niRequest":{"niNumber":"String"},"nhsRequest":{"nhsNumber":"String"},"electricityRequest":{"mpanNumber1":"String","mpanNumber2":"String","mpanNumber3":"String","mpanNumber4":"String"},"bankRequest":{"bankSortCode":"String","bankAccountNumber":"String"},"cardNumberRequest":{"cardNumber":"String","cardType":"String"},"travelVisaRequest":{"travelVisa1":"String","travelVisa2":"String","travelVisa3":"String","travelVisa4":"String","travelVisa5":"String","travelVisa6":"String","travelVisa7":"String","travelVisa8":"String","travelVisa9":"String"},"idCardRequest":{"idCard1":"String","idCard2":"String","idCard3":"String","idCard4":"String","idCard5":"String","idCard6":"String","idCard7":"String","idCard8":"String","idCard9":"String","idCard10":"String"},"pollNumberRequest":{"pollNumber":"String"},"marriageRequest":{"forename":"String","surname":"String","partnerForename":"String","partnerSurname":"String","date":"String","district":"String","certIssueNum":"String"},"passportEnabled":false,"passportChipEnabled":false,"drivingEnabled":false,"smartlinkEnabled":false,"niEnabled":false,"nhsEnabled":false,"electricityEnabled":false,"bankEnabled":false,"creditActiveEnabled":false,"idCardEnabled":false,"bankLiveEnabled":false,"companyDirectorEnabled":false,"searchActivityEnabled":false,"prsEnabled":false},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}