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.*;

public class dtos
{

    @DataContract
    public static class AddValidIdTemplate extends BaseRequest
    {
        @DataMember
        @ApiMember(IsRequired=true)
        public Integer clientId = null;
        
        public Integer getClientId() { return clientId; }
        public AddValidIdTemplate setClientId(Integer value) { this.clientId = value; return this; }
    }

    @DataContract
    public static class BaseRequest implements IBaseRequest
    {
        /**
        * The authentication credentials
        */
        @DataMember
        @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
        public Authentication authentication = null;
        
        public Authentication getAuthentication() { return authentication; }
        public BaseRequest setAuthentication(Authentication value) { this.authentication = value; return this; }
    }

    @DataContract
    public static 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")
        public String apiUserId = 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")
        public String apiUserKey = null;
        
        public String getApiUserId() { return apiUserId; }
        public Authentication setApiUserId(String value) { this.apiUserId = value; return this; }
        public String getApiUserKey() { return apiUserKey; }
        public Authentication setApiUserKey(String value) { this.apiUserKey = value; return this; }
    }

    @DataContract
    public static class AddValidIdTemplateResponse
    {
        @DataMember
        public AddValidIdTemplateData data = null;
        
        public AddValidIdTemplateData getData() { return data; }
        public AddValidIdTemplateResponse setData(AddValidIdTemplateData value) { this.data = value; return this; }
    }

    public static class AddValidIdTemplateData extends BaseResponse
    {
        public AddValidIdRequest request = null;
        
        public AddValidIdRequest getRequest() { return request; }
        public AddValidIdTemplateData setRequest(AddValidIdRequest value) { this.request = value; return this; }
    }

    public static class BaseResponse implements IBaseDataResponse, IHasResponseStatus
    {
        /**
        * The status of the response
        */
        @ApiMember(Description="The status of the response")
        public ResponseStatus responseStatus = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public BaseResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static class ArrayOfResponseError extends ArrayList<ResponseError>
    {
        
    }

    public static 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")
        public String subUserName = null;

        public String type = null;
        public Boolean addPepSearch = null;
        public String pepSearchType = null;
        public Boolean addSanctionsSearch = null;
        public ArrayOfLists selectedLists = null;
        public String reference = 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")
        public ArrayOfLinkedTo linkedTo = null;

        public ValidIdBasicRequest basicRequest = null;
        public ValidIdPassportRequest passportRequest = null;
        public ValidIdDrivingRequest drivingRequest = null;
        public ValidIdBirthRequest birthRequest = null;
        public ValidIdNIRequest niRequest = null;
        public ValidIdNHSRequest nhsRequest = null;
        public ValidIdElectricityRequest electricityRequest = null;
        public ValidIdBankRequest bankRequest = null;
        public ValidIdCardNumberRequest cardNumberRequest = null;
        public ValidIdTravelVisaRequest travelVisaRequest = null;
        public ValidIdIdCardRequest idCardRequest = null;
        public ValidIdPollNumberRequest pollNumberRequest = null;
        public ValidIdMarriageRequest marriageRequest = null;
        public Boolean passportEnabled = null;
        public Boolean passportChipEnabled = null;
        public Boolean drivingEnabled = null;
        public Boolean smartlinkEnabled = null;
        public Boolean niEnabled = null;
        public Boolean nhsEnabled = null;
        public Boolean electricityEnabled = null;
        public Boolean bankEnabled = null;
        public Boolean creditActiveEnabled = null;
        public Boolean idCardEnabled = null;
        public Boolean bankLiveEnabled = null;
        public Boolean companyDirectorEnabled = null;
        public Boolean searchActivityEnabled = null;
        public Boolean prsEnabled = null;
        
        public String getSubUserName() { return subUserName; }
        public AddValidIdRequest setSubUserName(String value) { this.subUserName = value; return this; }
        public String getType() { return type; }
        public AddValidIdRequest setType(String value) { this.type = value; return this; }
        public Boolean isAddPepSearch() { return addPepSearch; }
        public AddValidIdRequest setAddPepSearch(Boolean value) { this.addPepSearch = value; return this; }
        public String getPepSearchType() { return pepSearchType; }
        public AddValidIdRequest setPepSearchType(String value) { this.pepSearchType = value; return this; }
        public Boolean isAddSanctionsSearch() { return addSanctionsSearch; }
        public AddValidIdRequest setAddSanctionsSearch(Boolean value) { this.addSanctionsSearch = value; return this; }
        public ArrayOfLists getSelectedLists() { return selectedLists; }
        public AddValidIdRequest setSelectedLists(ArrayOfLists value) { this.selectedLists = value; return this; }
        public String getReference() { return reference; }
        public AddValidIdRequest setReference(String value) { this.reference = value; return this; }
        public ArrayOfLinkedTo getLinkedTo() { return linkedTo; }
        public AddValidIdRequest setLinkedTo(ArrayOfLinkedTo value) { this.linkedTo = value; return this; }
        public ValidIdBasicRequest getBasicRequest() { return basicRequest; }
        public AddValidIdRequest setBasicRequest(ValidIdBasicRequest value) { this.basicRequest = value; return this; }
        public ValidIdPassportRequest getPassportRequest() { return passportRequest; }
        public AddValidIdRequest setPassportRequest(ValidIdPassportRequest value) { this.passportRequest = value; return this; }
        public ValidIdDrivingRequest getDrivingRequest() { return drivingRequest; }
        public AddValidIdRequest setDrivingRequest(ValidIdDrivingRequest value) { this.drivingRequest = value; return this; }
        public ValidIdBirthRequest getBirthRequest() { return birthRequest; }
        public AddValidIdRequest setBirthRequest(ValidIdBirthRequest value) { this.birthRequest = value; return this; }
        public ValidIdNIRequest getNiRequest() { return niRequest; }
        public AddValidIdRequest setNiRequest(ValidIdNIRequest value) { this.niRequest = value; return this; }
        public ValidIdNHSRequest getNhsRequest() { return nhsRequest; }
        public AddValidIdRequest setNhsRequest(ValidIdNHSRequest value) { this.nhsRequest = value; return this; }
        public ValidIdElectricityRequest getElectricityRequest() { return electricityRequest; }
        public AddValidIdRequest setElectricityRequest(ValidIdElectricityRequest value) { this.electricityRequest = value; return this; }
        public ValidIdBankRequest getBankRequest() { return bankRequest; }
        public AddValidIdRequest setBankRequest(ValidIdBankRequest value) { this.bankRequest = value; return this; }
        public ValidIdCardNumberRequest getCardNumberRequest() { return cardNumberRequest; }
        public AddValidIdRequest setCardNumberRequest(ValidIdCardNumberRequest value) { this.cardNumberRequest = value; return this; }
        public ValidIdTravelVisaRequest getTravelVisaRequest() { return travelVisaRequest; }
        public AddValidIdRequest setTravelVisaRequest(ValidIdTravelVisaRequest value) { this.travelVisaRequest = value; return this; }
        public ValidIdIdCardRequest getIdCardRequest() { return idCardRequest; }
        public AddValidIdRequest setIdCardRequest(ValidIdIdCardRequest value) { this.idCardRequest = value; return this; }
        public ValidIdPollNumberRequest getPollNumberRequest() { return pollNumberRequest; }
        public AddValidIdRequest setPollNumberRequest(ValidIdPollNumberRequest value) { this.pollNumberRequest = value; return this; }
        public ValidIdMarriageRequest getMarriageRequest() { return marriageRequest; }
        public AddValidIdRequest setMarriageRequest(ValidIdMarriageRequest value) { this.marriageRequest = value; return this; }
        public Boolean isPassportEnabled() { return passportEnabled; }
        public AddValidIdRequest setPassportEnabled(Boolean value) { this.passportEnabled = value; return this; }
        public Boolean isPassportChipEnabled() { return passportChipEnabled; }
        public AddValidIdRequest setPassportChipEnabled(Boolean value) { this.passportChipEnabled = value; return this; }
        public Boolean isDrivingEnabled() { return drivingEnabled; }
        public AddValidIdRequest setDrivingEnabled(Boolean value) { this.drivingEnabled = value; return this; }
        public Boolean isSmartlinkEnabled() { return smartlinkEnabled; }
        public AddValidIdRequest setSmartlinkEnabled(Boolean value) { this.smartlinkEnabled = value; return this; }
        public Boolean isNiEnabled() { return niEnabled; }
        public AddValidIdRequest setNiEnabled(Boolean value) { this.niEnabled = value; return this; }
        public Boolean isNhsEnabled() { return nhsEnabled; }
        public AddValidIdRequest setNhsEnabled(Boolean value) { this.nhsEnabled = value; return this; }
        public Boolean isElectricityEnabled() { return electricityEnabled; }
        public AddValidIdRequest setElectricityEnabled(Boolean value) { this.electricityEnabled = value; return this; }
        public Boolean isBankEnabled() { return bankEnabled; }
        public AddValidIdRequest setBankEnabled(Boolean value) { this.bankEnabled = value; return this; }
        public Boolean isCreditActiveEnabled() { return creditActiveEnabled; }
        public AddValidIdRequest setCreditActiveEnabled(Boolean value) { this.creditActiveEnabled = value; return this; }
        public Boolean isIdCardEnabled() { return idCardEnabled; }
        public AddValidIdRequest setIdCardEnabled(Boolean value) { this.idCardEnabled = value; return this; }
        public Boolean isBankLiveEnabled() { return bankLiveEnabled; }
        public AddValidIdRequest setBankLiveEnabled(Boolean value) { this.bankLiveEnabled = value; return this; }
        public Boolean isCompanyDirectorEnabled() { return companyDirectorEnabled; }
        public AddValidIdRequest setCompanyDirectorEnabled(Boolean value) { this.companyDirectorEnabled = value; return this; }
        public Boolean isSearchActivityEnabled() { return searchActivityEnabled; }
        public AddValidIdRequest setSearchActivityEnabled(Boolean value) { this.searchActivityEnabled = value; return this; }
        public Boolean isPrsEnabled() { return prsEnabled; }
        public AddValidIdRequest setPrsEnabled(Boolean value) { this.prsEnabled = value; return this; }
    }

    public static class ArrayOfLists extends ArrayList<String>
    {
        
    }

    public static class ArrayOfLinkedTo extends ArrayList<LinkedTo>
    {
        
    }

    public static class LinkedTo
    {
        public Integer clientId = null;
        public Long id = null;
        public String type = null;
        public String subtype = null;
        public String status = null;
        public String description = null;
        public Boolean isArchived = null;
        public String name = null;
        public Date date = null;
        
        public Integer getClientId() { return clientId; }
        public LinkedTo setClientId(Integer value) { this.clientId = value; return this; }
        public Long getId() { return id; }
        public LinkedTo setId(Long value) { this.id = value; return this; }
        public String getType() { return type; }
        public LinkedTo setType(String value) { this.type = value; return this; }
        public String getSubtype() { return subtype; }
        public LinkedTo setSubtype(String value) { this.subtype = value; return this; }
        public String getStatus() { return status; }
        public LinkedTo setStatus(String value) { this.status = value; return this; }
        public String getDescription() { return description; }
        public LinkedTo setDescription(String value) { this.description = value; return this; }
        public Boolean getIsArchived() { return isArchived; }
        public LinkedTo setIsArchived(Boolean value) { this.isArchived = value; return this; }
        public String getName() { return name; }
        public LinkedTo setName(String value) { this.name = value; return this; }
        public Date getDate() { return date; }
        public LinkedTo setDate(Date value) { this.date = value; return this; }
    }

    public static class ValidIdBasicRequest
    {
        public String name1 = null;
        public String name2 = null;
        public String name3 = null;
        public Date dateOfBirth = null;
        public String gender = null;
        public String address1 = null;
        public String address2 = null;
        public String address3 = null;
        public String address4 = null;
        public String address5 = null;
        public String postCode = null;
        
        public String getName1() { return name1; }
        public ValidIdBasicRequest setName1(String value) { this.name1 = value; return this; }
        public String getName2() { return name2; }
        public ValidIdBasicRequest setName2(String value) { this.name2 = value; return this; }
        public String getName3() { return name3; }
        public ValidIdBasicRequest setName3(String value) { this.name3 = value; return this; }
        public Date getDateOfBirth() { return dateOfBirth; }
        public ValidIdBasicRequest setDateOfBirth(Date value) { this.dateOfBirth = value; return this; }
        public String getGender() { return gender; }
        public ValidIdBasicRequest setGender(String value) { this.gender = value; return this; }
        public String getAddress1() { return address1; }
        public ValidIdBasicRequest setAddress1(String value) { this.address1 = value; return this; }
        public String getAddress2() { return address2; }
        public ValidIdBasicRequest setAddress2(String value) { this.address2 = value; return this; }
        public String getAddress3() { return address3; }
        public ValidIdBasicRequest setAddress3(String value) { this.address3 = value; return this; }
        public String getAddress4() { return address4; }
        public ValidIdBasicRequest setAddress4(String value) { this.address4 = value; return this; }
        public String getAddress5() { return address5; }
        public ValidIdBasicRequest setAddress5(String value) { this.address5 = value; return this; }
        public String getPostCode() { return postCode; }
        public ValidIdBasicRequest setPostCode(String value) { this.postCode = value; return this; }
    }

    public static class ValidIdPassportRequest
    {
        public String passport1 = null;
        public String passport2 = null;
        public String passport3 = null;
        public String passport4 = null;
        public String passport5 = null;
        public String passport6 = null;
        public String passport7 = null;
        public String passport8 = null;
        public String passportMrzLineOne1 = null;
        public String passportMrzLineOne2 = null;
        public String passportMrzLineOne3 = null;
        
        public String getPassport1() { return passport1; }
        public ValidIdPassportRequest setPassport1(String value) { this.passport1 = value; return this; }
        public String getPassport2() { return passport2; }
        public ValidIdPassportRequest setPassport2(String value) { this.passport2 = value; return this; }
        public String getPassport3() { return passport3; }
        public ValidIdPassportRequest setPassport3(String value) { this.passport3 = value; return this; }
        public String getPassport4() { return passport4; }
        public ValidIdPassportRequest setPassport4(String value) { this.passport4 = value; return this; }
        public String getPassport5() { return passport5; }
        public ValidIdPassportRequest setPassport5(String value) { this.passport5 = value; return this; }
        public String getPassport6() { return passport6; }
        public ValidIdPassportRequest setPassport6(String value) { this.passport6 = value; return this; }
        public String getPassport7() { return passport7; }
        public ValidIdPassportRequest setPassport7(String value) { this.passport7 = value; return this; }
        public String getPassport8() { return passport8; }
        public ValidIdPassportRequest setPassport8(String value) { this.passport8 = value; return this; }
        public String getPassportMrzLineOne1() { return passportMrzLineOne1; }
        public ValidIdPassportRequest setPassportMrzLineOne1(String value) { this.passportMrzLineOne1 = value; return this; }
        public String getPassportMrzLineOne2() { return passportMrzLineOne2; }
        public ValidIdPassportRequest setPassportMrzLineOne2(String value) { this.passportMrzLineOne2 = value; return this; }
        public String getPassportMrzLineOne3() { return passportMrzLineOne3; }
        public ValidIdPassportRequest setPassportMrzLineOne3(String value) { this.passportMrzLineOne3 = value; return this; }
    }

    public static class ValidIdDrivingRequest
    {
        public String driving1 = null;
        public String driving2 = null;
        public String driving3 = null;
        public String drivingPostcode = null;
        public String drivingMailSort = null;
        
        public String getDriving1() { return driving1; }
        public ValidIdDrivingRequest setDriving1(String value) { this.driving1 = value; return this; }
        public String getDriving2() { return driving2; }
        public ValidIdDrivingRequest setDriving2(String value) { this.driving2 = value; return this; }
        public String getDriving3() { return driving3; }
        public ValidIdDrivingRequest setDriving3(String value) { this.driving3 = value; return this; }
        public String getDrivingPostcode() { return drivingPostcode; }
        public ValidIdDrivingRequest setDrivingPostcode(String value) { this.drivingPostcode = value; return this; }
        public String getDrivingMailSort() { return drivingMailSort; }
        public ValidIdDrivingRequest setDrivingMailSort(String value) { this.drivingMailSort = value; return this; }
    }

    public static class ValidIdBirthRequest
    {
        public String birthForeName = null;
        public String birthMiddleName = null;
        public String birthSurname = null;
        public String birthMaidenName = null;
        public String birthDistrict = null;
        public String birthCertIssueNum = null;
        
        public String getBirthForeName() { return birthForeName; }
        public ValidIdBirthRequest setBirthForeName(String value) { this.birthForeName = value; return this; }
        public String getBirthMiddleName() { return birthMiddleName; }
        public ValidIdBirthRequest setBirthMiddleName(String value) { this.birthMiddleName = value; return this; }
        public String getBirthSurname() { return birthSurname; }
        public ValidIdBirthRequest setBirthSurname(String value) { this.birthSurname = value; return this; }
        public String getBirthMaidenName() { return birthMaidenName; }
        public ValidIdBirthRequest setBirthMaidenName(String value) { this.birthMaidenName = value; return this; }
        public String getBirthDistrict() { return birthDistrict; }
        public ValidIdBirthRequest setBirthDistrict(String value) { this.birthDistrict = value; return this; }
        public String getBirthCertIssueNum() { return birthCertIssueNum; }
        public ValidIdBirthRequest setBirthCertIssueNum(String value) { this.birthCertIssueNum = value; return this; }
    }

    public static class ValidIdNIRequest
    {
        public String niNumber = null;
        
        public String getNiNumber() { return niNumber; }
        public ValidIdNIRequest setNiNumber(String value) { this.niNumber = value; return this; }
    }

    public static class ValidIdNHSRequest
    {
        public String nhsNumber = null;
        
        public String getNhsNumber() { return nhsNumber; }
        public ValidIdNHSRequest setNhsNumber(String value) { this.nhsNumber = value; return this; }
    }

    public static class ValidIdElectricityRequest
    {
        public String mpanNumber1 = null;
        public String mpanNumber2 = null;
        public String mpanNumber3 = null;
        public String mpanNumber4 = null;
        
        public String getMpanNumber1() { return mpanNumber1; }
        public ValidIdElectricityRequest setMpanNumber1(String value) { this.mpanNumber1 = value; return this; }
        public String getMpanNumber2() { return mpanNumber2; }
        public ValidIdElectricityRequest setMpanNumber2(String value) { this.mpanNumber2 = value; return this; }
        public String getMpanNumber3() { return mpanNumber3; }
        public ValidIdElectricityRequest setMpanNumber3(String value) { this.mpanNumber3 = value; return this; }
        public String getMpanNumber4() { return mpanNumber4; }
        public ValidIdElectricityRequest setMpanNumber4(String value) { this.mpanNumber4 = value; return this; }
    }

    public static class ValidIdBankRequest
    {
        public String bankSortCode = null;
        public String bankAccountNumber = null;
        
        public String getBankSortCode() { return bankSortCode; }
        public ValidIdBankRequest setBankSortCode(String value) { this.bankSortCode = value; return this; }
        public String getBankAccountNumber() { return bankAccountNumber; }
        public ValidIdBankRequest setBankAccountNumber(String value) { this.bankAccountNumber = value; return this; }
    }

    public static class ValidIdCardNumberRequest
    {
        public String cardNumber = null;
        public String cardType = null;
        
        public String getCardNumber() { return cardNumber; }
        public ValidIdCardNumberRequest setCardNumber(String value) { this.cardNumber = value; return this; }
        public String getCardType() { return cardType; }
        public ValidIdCardNumberRequest setCardType(String value) { this.cardType = value; return this; }
    }

    public static class ValidIdTravelVisaRequest
    {
        public String travelVisa1 = null;
        public String travelVisa2 = null;
        public String travelVisa3 = null;
        public String travelVisa4 = null;
        public String travelVisa5 = null;
        public String travelVisa6 = null;
        public String travelVisa7 = null;
        public String travelVisa8 = null;
        public String travelVisa9 = null;
        
        public String getTravelVisa1() { return travelVisa1; }
        public ValidIdTravelVisaRequest setTravelVisa1(String value) { this.travelVisa1 = value; return this; }
        public String getTravelVisa2() { return travelVisa2; }
        public ValidIdTravelVisaRequest setTravelVisa2(String value) { this.travelVisa2 = value; return this; }
        public String getTravelVisa3() { return travelVisa3; }
        public ValidIdTravelVisaRequest setTravelVisa3(String value) { this.travelVisa3 = value; return this; }
        public String getTravelVisa4() { return travelVisa4; }
        public ValidIdTravelVisaRequest setTravelVisa4(String value) { this.travelVisa4 = value; return this; }
        public String getTravelVisa5() { return travelVisa5; }
        public ValidIdTravelVisaRequest setTravelVisa5(String value) { this.travelVisa5 = value; return this; }
        public String getTravelVisa6() { return travelVisa6; }
        public ValidIdTravelVisaRequest setTravelVisa6(String value) { this.travelVisa6 = value; return this; }
        public String getTravelVisa7() { return travelVisa7; }
        public ValidIdTravelVisaRequest setTravelVisa7(String value) { this.travelVisa7 = value; return this; }
        public String getTravelVisa8() { return travelVisa8; }
        public ValidIdTravelVisaRequest setTravelVisa8(String value) { this.travelVisa8 = value; return this; }
        public String getTravelVisa9() { return travelVisa9; }
        public ValidIdTravelVisaRequest setTravelVisa9(String value) { this.travelVisa9 = value; return this; }
    }

    public static class ValidIdIdCardRequest
    {
        public String idCard1 = null;
        public String idCard2 = null;
        public String idCard3 = null;
        public String idCard4 = null;
        public String idCard5 = null;
        public String idCard6 = null;
        public String idCard7 = null;
        public String idCard8 = null;
        public String idCard9 = null;
        public String idCard10 = null;
        
        public String getIdCard1() { return idCard1; }
        public ValidIdIdCardRequest setIdCard1(String value) { this.idCard1 = value; return this; }
        public String getIdCard2() { return idCard2; }
        public ValidIdIdCardRequest setIdCard2(String value) { this.idCard2 = value; return this; }
        public String getIdCard3() { return idCard3; }
        public ValidIdIdCardRequest setIdCard3(String value) { this.idCard3 = value; return this; }
        public String getIdCard4() { return idCard4; }
        public ValidIdIdCardRequest setIdCard4(String value) { this.idCard4 = value; return this; }
        public String getIdCard5() { return idCard5; }
        public ValidIdIdCardRequest setIdCard5(String value) { this.idCard5 = value; return this; }
        public String getIdCard6() { return idCard6; }
        public ValidIdIdCardRequest setIdCard6(String value) { this.idCard6 = value; return this; }
        public String getIdCard7() { return idCard7; }
        public ValidIdIdCardRequest setIdCard7(String value) { this.idCard7 = value; return this; }
        public String getIdCard8() { return idCard8; }
        public ValidIdIdCardRequest setIdCard8(String value) { this.idCard8 = value; return this; }
        public String getIdCard9() { return idCard9; }
        public ValidIdIdCardRequest setIdCard9(String value) { this.idCard9 = value; return this; }
        public String getIdCard10() { return idCard10; }
        public ValidIdIdCardRequest setIdCard10(String value) { this.idCard10 = value; return this; }
    }

    public static class ValidIdPollNumberRequest
    {
        public String pollNumber = null;
        
        public String getPollNumber() { return pollNumber; }
        public ValidIdPollNumberRequest setPollNumber(String value) { this.pollNumber = value; return this; }
    }

    public static class ValidIdMarriageRequest
    {
        public String forename = null;
        public String surname = null;
        public String partnerForename = null;
        public String partnerSurname = null;
        public String date = null;
        public String district = null;
        public String certIssueNum = null;
        
        public String getForename() { return forename; }
        public ValidIdMarriageRequest setForename(String value) { this.forename = value; return this; }
        public String getSurname() { return surname; }
        public ValidIdMarriageRequest setSurname(String value) { this.surname = value; return this; }
        public String getPartnerForename() { return partnerForename; }
        public ValidIdMarriageRequest setPartnerForename(String value) { this.partnerForename = value; return this; }
        public String getPartnerSurname() { return partnerSurname; }
        public ValidIdMarriageRequest setPartnerSurname(String value) { this.partnerSurname = value; return this; }
        public String getDate() { return date; }
        public ValidIdMarriageRequest setDate(String value) { this.date = value; return this; }
        public String getDistrict() { return district; }
        public ValidIdMarriageRequest setDistrict(String value) { this.district = value; return this; }
        public String getCertIssueNum() { return certIssueNum; }
        public ValidIdMarriageRequest setCertIssueNum(String value) { this.certIssueNum = value; return this; }
    }

}

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