Simplified.ID 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 java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class AddValidIdTemplate : BaseRequest()
{
    @DataMember
    @ApiMember(IsRequired=true)
    open var clientId:Int? = null
}

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

@DataContract
open class Authentication
{
    /**
    * The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)
    */
    @DataMember
    @ApiMember(Description="The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)", IsRequired=true, ParameterType="header, body")
    open var apiUserId:String? = null

    /**
    * The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)
    */
    @DataMember
    @ApiMember(Description="The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)", IsRequired=true, ParameterType="header, body")
    open var apiUserKey:String? = null

    /**
    * The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).
    */
    @DataMember
    @ApiMember(Description="The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).", ParameterType="header, body")
    open var userId:String? = null
}

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

open class AddValidIdTemplateData : BaseResponse()
{
    open var request:AddValidIdRequest? = null
}

open class BaseResponse : IBaseDataResponse, IHasResponseStatus
{
    /**
    * The status of the response
    */
    @ApiMember(Description="The status of the response")
    override 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")
    open var subUserName:String? = null

    @SerializedName("type") open var Type:String? = null
    open var addPepSearch:Boolean? = null
    open var pepSearchType:String? = null
    open var addSanctionsSearch:Boolean? = null
    open var selectedLists:ArrayOfLists? = null
    open 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")
    open var linkedTo:ArrayOfLinkedTo? = null

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

open class ValidIdMarriageRequest
{
    open var forename:String? = null
    open var surname:String? = null
    open var partnerForename:String? = null
    open var partnerSurname:String? = null
    open var date:String? = null
    open var district:String? = null
    open 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.simplified.id 
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","drivingExpiryDate":"\/Date(-62135596800000-0000)\/"},"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"}}}}