Sanctions Search API: v2

<back to all web services

AddValidIdTemplate

ValidID
The following routes are available for this service:
GET/validid/template
import Foundation
import ServiceStack

// @DataContract
public class AddValidIdTemplate : BaseRequest
{
    // @DataMember
    // @ApiMember(IsRequired=true)
    public var clientId:Int

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case clientId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        clientId = try container.decodeIfPresent(Int.self, forKey: .clientId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if clientId != nil { try container.encode(clientId, forKey: .clientId) }
    }
}

// @DataContract
public class BaseRequest : IBaseRequest, Codable
{
    /**
    * The authentication credentials
    */
    // @DataMember
    // @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    public var authentication:Authentication

    required public init(){}
}

// @DataContract
public class Authentication : Codable
{
    /**
    * 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 var apiUserId:String

    /**
    * 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 var apiUserKey:String

    required public init(){}
}

// @DataContract
public class AddValidIdTemplateResponse : Codable
{
    // @DataMember
    public var data:AddValidIdTemplateData

    required public init(){}
}

public class AddValidIdTemplateData : BaseResponse
{
    public var request:AddValidIdRequest

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case request
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        request = try container.decodeIfPresent(AddValidIdRequest.self, forKey: .request)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if request != nil { try container.encode(request, forKey: .request) }
    }
}

public class BaseResponse : IBaseDataResponse, IHasResponseStatus, Codable
{
    /**
    * The status of the response
    */
    // @ApiMember(Description="The status of the response")
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ArrayOfResponseError : List<ResponseError>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class AddValidIdRequest : Codable
{
    /**
    * 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 var subUserName:String

    public var type:String
    public var addPepSearch:Bool
    public var pepSearchType:String
    public var addSanctionsSearch:Bool
    public var selectedLists:ArrayOfLists
    public var reference:String
    /**
    * 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 var linkedTo:ArrayOfLinkedTo

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

    required public init(){}
}

public class ArrayOfLists : List<String>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class ArrayOfLinkedTo : List<LinkedTo>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class LinkedTo : Codable
{
    public var clientId:Int?
    public var id:Int?
    public var type:String
    public var subtype:String
    public var status:String
    public var Description:String
    public var isArchived:Bool?
    public var name:String
    public var date:Date?

    required public init(){}
}

public class ValidIdBasicRequest : Codable
{
    public var name1:String
    public var name2:String
    public var name3:String
    public var dateOfBirth:Date?
    public var gender:String
    public var address1:String
    public var address2:String
    public var address3:String
    public var address4:String
    public var address5:String
    public var postCode:String

    required public init(){}
}

public class ValidIdPassportRequest : Codable
{
    public var passport1:String
    public var passport2:String
    public var passport3:String
    public var passport4:String
    public var passport5:String
    public var passport6:String
    public var passport7:String
    public var passport8:String
    public var passportMrzLineOne1:String
    public var passportMrzLineOne2:String
    public var passportMrzLineOne3:String

    required public init(){}
}

public class ValidIdDrivingRequest : Codable
{
    public var driving1:String
    public var driving2:String
    public var driving3:String
    public var drivingPostcode:String
    public var drivingMailSort:String

    required public init(){}
}

public class ValidIdBirthRequest : Codable
{
    public var birthForeName:String
    public var birthMiddleName:String
    public var birthSurname:String
    public var birthMaidenName:String
    public var birthDistrict:String
    public var birthCertIssueNum:String

    required public init(){}
}

public class ValidIdNIRequest : Codable
{
    public var niNumber:String

    required public init(){}
}

public class ValidIdNHSRequest : Codable
{
    public var nhsNumber:String

    required public init(){}
}

public class ValidIdElectricityRequest : Codable
{
    public var mpanNumber1:String
    public var mpanNumber2:String
    public var mpanNumber3:String
    public var mpanNumber4:String

    required public init(){}
}

public class ValidIdBankRequest : Codable
{
    public var bankSortCode:String
    public var bankAccountNumber:String

    required public init(){}
}

public class ValidIdCardNumberRequest : Codable
{
    public var cardNumber:String
    public var cardType:String

    required public init(){}
}

public class ValidIdTravelVisaRequest : Codable
{
    public var travelVisa1:String
    public var travelVisa2:String
    public var travelVisa3:String
    public var travelVisa4:String
    public var travelVisa5:String
    public var travelVisa6:String
    public var travelVisa7:String
    public var travelVisa8:String
    public var travelVisa9:String

    required public init(){}
}

public class ValidIdIdCardRequest : Codable
{
    public var idCard1:String
    public var idCard2:String
    public var idCard3:String
    public var idCard4:String
    public var idCard5:String
    public var idCard6:String
    public var idCard7:String
    public var idCard8:String
    public var idCard9:String
    public var idCard10:String

    required public init(){}
}

public class ValidIdPollNumberRequest : Codable
{
    public var pollNumber:String

    required public init(){}
}

public class ValidIdMarriageRequest : Codable
{
    public var forename:String
    public var surname:String
    public var partnerForename:String
    public var partnerSurname:String
    public var date:String
    public var district:String
    public var certIssueNum:String

    required public init(){}
}

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