Sanctions Search API: v2

AddValidIdTemplate

ValidID

The following routes are available for this service:
GET	/validid/template

namespace SanctionsSearch.Api2.ServiceModel.Operations.Base

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type ResponseError() = 
        [<DataMember(Order=1)>]
        member val ErrorCode:String = null with get,set

        [<DataMember(Order=2)>]
        member val FieldName:String = null with get,set

        [<DataMember(Order=3)>]
        member val Message:String = null with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type ArrayOfResponseError() = 
        inherit ResizeArray<ResponseError>()

    [<DataContract>]
    [<AllowNullLiteral>]
    type ResponseStatus() = 
        [<DataMember(Order=1)>]
        member val ErrorCode:String = null with get,set

        [<DataMember(Order=2)>]
        member val Message:String = null with get,set

        [<DataMember(Order=3)>]
        member val StackTrace:String = null with get,set

        [<DataMember(Order=4)>]
        member val Errors:ArrayOfResponseError = null with get,set

        [<DataMember(Order=5)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///The status of the response
        ///</summary>
        [<ApiMember(Description="The status of the response")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type ArrayOfLists() = 
        inherit ResizeArray<String>()

    [<AllowNullLiteral>]
    type LinkedTo() = 
        member val ClientId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val Type:String = null with get,set
        member val Subtype:String = null with get,set
        member val Status:String = null with get,set
        member val Description:String = null with get,set
        member val IsArchived:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val Name:String = null with get,set
        member val Date:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type ArrayOfLinkedTo() = 
        inherit ResizeArray<LinkedTo>()

    [<AllowNullLiteral>]
    type ValidIdBasicRequest() = 
        member val Name1:String = null with get,set
        member val Name2:String = null with get,set
        member val Name3:String = null with get,set
        member val DateOfBirth:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Gender:String = null with get,set
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val Address3:String = null with get,set
        member val Address4:String = null with get,set
        member val Address5:String = null with get,set
        member val PostCode:String = null with get,set

    [<AllowNullLiteral>]
    type ValidIdPassportRequest() = 
        member val Passport1:String = null with get,set
        member val Passport2:String = null with get,set
        member val Passport3:String = null with get,set
        member val Passport4:String = null with get,set
        member val Passport5:String = null with get,set
        member val Passport6:String = null with get,set
        member val Passport7:String = null with get,set
        member val Passport8:String = null with get,set
        member val PassportMrzLineOne1:String = null with get,set
        member val PassportMrzLineOne2:String = null with get,set
        member val PassportMrzLineOne3:String = null with get,set

    [<AllowNullLiteral>]
    type ValidIdDrivingRequest() = 
        member val Driving1:String = null with get,set
        member val Driving2:String = null with get,set
        member val Driving3:String = null with get,set
        member val DrivingPostcode:String = null with get,set
        member val DrivingMailSort:String = null with get,set

    [<AllowNullLiteral>]
    type ValidIdBirthRequest() = 
        member val BirthForeName:String = null with get,set
        member val BirthMiddleName:String = null with get,set
        member val BirthSurname:String = null with get,set
        member val BirthMaidenName:String = null with get,set
        member val BirthDistrict:String = null with get,set
        member val BirthCertIssueNum:String = null with get,set

    [<AllowNullLiteral>]
    type ValidIdNIRequest() = 
        member val NINumber:String = null with get,set

    [<AllowNullLiteral>]
    type ValidIdNHSRequest() = 
        member val NHSNumber:String = null with get,set

    [<AllowNullLiteral>]
    type ValidIdElectricityRequest() = 
        member val MPANNumber1:String = null with get,set
        member val MPANNumber2:String = null with get,set
        member val MPANNumber3:String = null with get,set
        member val MPANNumber4:String = null with get,set

    [<AllowNullLiteral>]
    type ValidIdBankRequest() = 
        member val BankSortCode:String = null with get,set
        member val BankAccountNumber:String = null with get,set

    [<AllowNullLiteral>]
    type ValidIdCardNumberRequest() = 
        member val CardNumber:String = null with get,set
        member val CardType:String = null with get,set

    [<AllowNullLiteral>]
    type ValidIdTravelVisaRequest() = 
        member val TravelVisa1:String = null with get,set
        member val TravelVisa2:String = null with get,set
        member val TravelVisa3:String = null with get,set
        member val TravelVisa4:String = null with get,set
        member val TravelVisa5:String = null with get,set
        member val TravelVisa6:String = null with get,set
        member val TravelVisa7:String = null with get,set
        member val TravelVisa8:String = null with get,set
        member val TravelVisa9:String = null with get,set

    [<AllowNullLiteral>]
    type ValidIdIdCardRequest() = 
        member val IdCard1:String = null with get,set
        member val IdCard2:String = null with get,set
        member val IdCard3:String = null with get,set
        member val IdCard4:String = null with get,set
        member val IdCard5:String = null with get,set
        member val IdCard6:String = null with get,set
        member val IdCard7:String = null with get,set
        member val IdCard8:String = null with get,set
        member val IdCard9:String = null with get,set
        member val IdCard10:String = null with get,set

    [<AllowNullLiteral>]
    type ValidIdPollNumberRequest() = 
        member val PollNumber:String = null with get,set

    [<AllowNullLiteral>]
    type ValidIdMarriageRequest() = 
        member val Forename:String = null with get,set
        member val Surname:String = null with get,set
        member val PartnerForename:String = null with get,set
        member val PartnerSurname:String = null with get,set
        member val Date:String = null with get,set
        member val District:String = null with get,set
        member val CertIssueNum:String = null with get,set

    [<AllowNullLiteral>]
    type AddValidIdRequest() = 
        ///<summary>
        ///If the search should be saved against a single Sub User account, specify their username here
        ///</summary>
        [<ApiMember(Description="If the search should be saved against a single Sub User account, specify their username here")>]
        member val SubUserName:String = null with get,set

        member val Type:String = null with get,set
        member val AddPepSearch:Boolean = new Boolean() with get,set
        member val PepSearchType:String = null with get,set
        member val AddSanctionsSearch:Boolean = new Boolean() with get,set
        member val SelectedLists:ArrayOfLists = null with get,set
        member val Reference:String = null with get,set
        ///<summary>
        ///If the search should be linked to other searches, specify the them here
        ///</summary>
        [<ApiMember(Description="If the search should be linked to other searches, specify the them here")>]
        member val LinkedTo:ArrayOfLinkedTo = null with get,set

        member val BasicRequest:ValidIdBasicRequest = null with get,set
        member val PassportRequest:ValidIdPassportRequest = null with get,set
        member val DrivingRequest:ValidIdDrivingRequest = null with get,set
        member val BirthRequest:ValidIdBirthRequest = null with get,set
        member val NIRequest:ValidIdNIRequest = null with get,set
        member val NHSRequest:ValidIdNHSRequest = null with get,set
        member val ElectricityRequest:ValidIdElectricityRequest = null with get,set
        member val BankRequest:ValidIdBankRequest = null with get,set
        member val CardNumberRequest:ValidIdCardNumberRequest = null with get,set
        member val TravelVisaRequest:ValidIdTravelVisaRequest = null with get,set
        member val IdCardRequest:ValidIdIdCardRequest = null with get,set
        member val PollNumberRequest:ValidIdPollNumberRequest = null with get,set
        member val MarriageRequest:ValidIdMarriageRequest = null with get,set
        member val PassportEnabled:Boolean = new Boolean() with get,set
        member val PassportChipEnabled:Boolean = new Boolean() with get,set
        member val DrivingEnabled:Boolean = new Boolean() with get,set
        member val SmartlinkEnabled:Boolean = new Boolean() with get,set
        member val NIEnabled:Boolean = new Boolean() with get,set
        member val NHSEnabled:Boolean = new Boolean() with get,set
        member val ElectricityEnabled:Boolean = new Boolean() with get,set
        member val BankEnabled:Boolean = new Boolean() with get,set
        member val CreditActiveEnabled:Boolean = new Boolean() with get,set
        member val IdCardEnabled:Boolean = new Boolean() with get,set
        member val BankLiveEnabled:Boolean = new Boolean() with get,set
        member val CompanyDirectorEnabled:Boolean = new Boolean() with get,set
        member val SearchActivityEnabled:Boolean = new Boolean() with get,set
        member val PRSEnabled:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type AddValidIdTemplateData() = 
        inherit BaseResponse()
        member val Request:AddValidIdRequest = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AddValidIdTemplateResponse() = 
        [<DataMember>]
        member val Data:AddValidIdTemplateData = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type Authentication() = 
        ///<summary>
        ///The API User ID provided by us when you signed up to use our API
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")>]
        member val ApiUserId:String = null with get,set

        ///<summary>
        ///The API User Key provided by us when you signed up to use our API
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")>]
        member val ApiUserKey:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseRequest() = 
        ///<summary>
        ///The authentication credentials
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")>]
        member val Authentication:Authentication = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AddValidIdTemplate() = 
        inherit BaseRequest()
        [<DataMember>]
        [<ApiMember(IsRequired=true)>]
        member val ClientId:Int32 = new Int32() with get,set

F# AddValidIdTemplate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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/xml

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

<AddValidIdTemplateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Data>
    <ResponseStatus>
      <ErrorCode>String</ErrorCode>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
      <Errors>
        <ResponseError>
          <ErrorCode>String</ErrorCode>
          <FieldName>String</FieldName>
          <Message>String</Message>
          <Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </Meta>
        </ResponseError>
      </Errors>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseStatus>
    <Request>
      <AddPepSearch>false</AddPepSearch>
      <AddSanctionsSearch>false</AddSanctionsSearch>
      <BankEnabled>false</BankEnabled>
      <BankLiveEnabled>false</BankLiveEnabled>
      <BankRequest>
        <BankAccountNumber>String</BankAccountNumber>
        <BankSortCode>String</BankSortCode>
      </BankRequest>
      <BasicRequest>
        <Address1>String</Address1>
        <Address2>String</Address2>
        <Address3>String</Address3>
        <Address4>String</Address4>
        <Address5>String</Address5>
        <DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
        <Gender>String</Gender>
        <Name1>String</Name1>
        <Name2>String</Name2>
        <Name3>String</Name3>
        <PostCode>String</PostCode>
      </BasicRequest>
      <BirthRequest>
        <BirthCertIssueNum>String</BirthCertIssueNum>
        <BirthDistrict>String</BirthDistrict>
        <BirthForeName>String</BirthForeName>
        <BirthMaidenName>String</BirthMaidenName>
        <BirthMiddleName>String</BirthMiddleName>
        <BirthSurname>String</BirthSurname>
      </BirthRequest>
      <CardNumberRequest>
        <CardNumber>String</CardNumber>
        <CardType>String</CardType>
      </CardNumberRequest>
      <CompanyDirectorEnabled>false</CompanyDirectorEnabled>
      <CreditActiveEnabled>false</CreditActiveEnabled>
      <DrivingEnabled>false</DrivingEnabled>
      <DrivingRequest>
        <Driving1>String</Driving1>
        <Driving2>String</Driving2>
        <Driving3>String</Driving3>
        <DrivingMailSort>String</DrivingMailSort>
        <DrivingPostcode>String</DrivingPostcode>
      </DrivingRequest>
      <ElectricityEnabled>false</ElectricityEnabled>
      <ElectricityRequest>
        <MPANNumber1>String</MPANNumber1>
        <MPANNumber2>String</MPANNumber2>
        <MPANNumber3>String</MPANNumber3>
        <MPANNumber4>String</MPANNumber4>
      </ElectricityRequest>
      <IdCardEnabled>false</IdCardEnabled>
      <IdCardRequest>
        <IdCard1>String</IdCard1>
        <IdCard10>String</IdCard10>
        <IdCard2>String</IdCard2>
        <IdCard3>String</IdCard3>
        <IdCard4>String</IdCard4>
        <IdCard5>String</IdCard5>
        <IdCard6>String</IdCard6>
        <IdCard7>String</IdCard7>
        <IdCard8>String</IdCard8>
        <IdCard9>String</IdCard9>
      </IdCardRequest>
      <LinkedTo>
        <LinkedTo>
          <ClientId>0</ClientId>
          <Date>0001-01-01T00:00:00</Date>
          <Description>String</Description>
          <Id>0</Id>
          <IsArchived>false</IsArchived>
          <Name>String</Name>
          <Status>String</Status>
          <Subtype>String</Subtype>
          <Type>String</Type>
        </LinkedTo>
      </LinkedTo>
      <MarriageRequest>
        <CertIssueNum>String</CertIssueNum>
        <Date>String</Date>
        <District>String</District>
        <Forename>String</Forename>
        <PartnerForename>String</PartnerForename>
        <PartnerSurname>String</PartnerSurname>
        <Surname>String</Surname>
      </MarriageRequest>
      <NHSEnabled>false</NHSEnabled>
      <NHSRequest>
        <NHSNumber>String</NHSNumber>
      </NHSRequest>
      <NIEnabled>false</NIEnabled>
      <NIRequest>
        <NINumber>String</NINumber>
      </NIRequest>
      <PRSEnabled>false</PRSEnabled>
      <PassportChipEnabled>false</PassportChipEnabled>
      <PassportEnabled>false</PassportEnabled>
      <PassportRequest>
        <Passport1>String</Passport1>
        <Passport2>String</Passport2>
        <Passport3>String</Passport3>
        <Passport4>String</Passport4>
        <Passport5>String</Passport5>
        <Passport6>String</Passport6>
        <Passport7>String</Passport7>
        <Passport8>String</Passport8>
        <PassportMrzLineOne1>String</PassportMrzLineOne1>
        <PassportMrzLineOne2>String</PassportMrzLineOne2>
        <PassportMrzLineOne3>String</PassportMrzLineOne3>
      </PassportRequest>
      <PepSearchType>String</PepSearchType>
      <PollNumberRequest>
        <PollNumber>String</PollNumber>
      </PollNumberRequest>
      <Reference>String</Reference>
      <SearchActivityEnabled>false</SearchActivityEnabled>
      <SelectedLists>
        <ListId>String</ListId>
      </SelectedLists>
      <SmartlinkEnabled>false</SmartlinkEnabled>
      <SubUserName>String</SubUserName>
      <TravelVisaRequest>
        <TravelVisa1>String</TravelVisa1>
        <TravelVisa2>String</TravelVisa2>
        <TravelVisa3>String</TravelVisa3>
        <TravelVisa4>String</TravelVisa4>
        <TravelVisa5>String</TravelVisa5>
        <TravelVisa6>String</TravelVisa6>
        <TravelVisa7>String</TravelVisa7>
        <TravelVisa8>String</TravelVisa8>
        <TravelVisa9>String</TravelVisa9>
      </TravelVisaRequest>
      <Type>String</Type>
    </Request>
  </Data>
</AddValidIdTemplateResponse>