Sanctions Search API: v2

<back to all web services

AddValidIdTemplate

ValidID
The following routes are available for this service:
GET/validid/template
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports SanctionsSearch.Api2.ServiceModel.Operations.ValidId
Imports SanctionsSearch.Api2.ServiceModel.Operations.Base
Imports SanctionsSearch.Api2.ServiceModel.Types

Namespace Global

    Namespace SanctionsSearch.Api2.ServiceModel.Operations.Base

        Public Partial Class ArrayOfResponseError
            Inherits List(Of ResponseError)
        End Class

        <DataContract>
        Public Partial Class BaseRequest
            Implements IBaseRequest
            '''<Summary>
            '''The authentication credentials
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="The authentication credentials", IsRequired:=true, ParameterType:="header, body")>
            Public Overridable Property Authentication As Authentication
        End Class

        Public Partial Class BaseResponse
            Implements IBaseDataResponse
            Implements IHasResponseStatus
            '''<Summary>
            '''The status of the response
            '''</Summary>
            <ApiMember(Description:="The status of the response")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        <DataContract>
        Public Partial Class ResponseError
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property ErrorCode As String

            <DataMember(Order:=2)>
            Public Overridable Property FieldName As String

            <DataMember(Order:=3)>
            Public Overridable Property Message As String

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        <DataContract>
        Public Partial Class ResponseStatus
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property ErrorCode As String

            <DataMember(Order:=2)>
            Public Overridable Property Message As String

            <DataMember(Order:=3)>
            Public Overridable Property StackTrace As String

            <DataMember(Order:=4)>
            Public Overridable Property Errors As ArrayOfResponseError

            <DataMember(Order:=5)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class
    End Namespace

    Namespace SanctionsSearch.Api2.ServiceModel.Operations.ValidId

        Public Partial Class 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")>
            Public Overridable Property SubUserName As String

            Public Overridable Property Type As String
            Public Overridable Property AddPepSearch As Boolean
            Public Overridable Property PepSearchType As String
            Public Overridable Property AddSanctionsSearch As Boolean
            Public Overridable Property SelectedLists As ArrayOfLists
            Public Overridable Property Reference As String
            '''<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")>
            Public Overridable Property LinkedTo As ArrayOfLinkedTo

            Public Overridable Property BasicRequest As ValidIdBasicRequest
            Public Overridable Property PassportRequest As ValidIdPassportRequest
            Public Overridable Property DrivingRequest As ValidIdDrivingRequest
            Public Overridable Property BirthRequest As ValidIdBirthRequest
            Public Overridable Property NIRequest As ValidIdNIRequest
            Public Overridable Property NHSRequest As ValidIdNHSRequest
            Public Overridable Property ElectricityRequest As ValidIdElectricityRequest
            Public Overridable Property BankRequest As ValidIdBankRequest
            Public Overridable Property CardNumberRequest As ValidIdCardNumberRequest
            Public Overridable Property TravelVisaRequest As ValidIdTravelVisaRequest
            Public Overridable Property IdCardRequest As ValidIdIdCardRequest
            Public Overridable Property PollNumberRequest As ValidIdPollNumberRequest
            Public Overridable Property MarriageRequest As ValidIdMarriageRequest
            Public Overridable Property PassportEnabled As Boolean
            Public Overridable Property PassportChipEnabled As Boolean
            Public Overridable Property DrivingEnabled As Boolean
            Public Overridable Property SmartlinkEnabled As Boolean
            Public Overridable Property NIEnabled As Boolean
            Public Overridable Property NHSEnabled As Boolean
            Public Overridable Property ElectricityEnabled As Boolean
            Public Overridable Property BankEnabled As Boolean
            Public Overridable Property CreditActiveEnabled As Boolean
            Public Overridable Property IdCardEnabled As Boolean
            Public Overridable Property BankLiveEnabled As Boolean
            Public Overridable Property CompanyDirectorEnabled As Boolean
            Public Overridable Property SearchActivityEnabled As Boolean
            Public Overridable Property PRSEnabled As Boolean
        End Class

        <DataContract>
        Public Partial Class AddValidIdTemplate
            Inherits BaseRequest
            <DataMember>
            <ApiMember(IsRequired:=true)>
            Public Overridable Property ClientId As Integer
        End Class

        Public Partial Class AddValidIdTemplateData
            Inherits BaseResponse
            Public Overridable Property Request As AddValidIdRequest
        End Class

        <DataContract>
        Public Partial Class AddValidIdTemplateResponse
            <DataMember>
            Public Overridable Property Data As AddValidIdTemplateData
        End Class
    End Namespace

    Namespace SanctionsSearch.Api2.ServiceModel.Types

        Public Partial Class ArrayOfLinkedTo
            Inherits List(Of LinkedTo)
        End Class

        Public Partial Class ArrayOfLists
            Inherits List(Of String)
        End Class

        <DataContract>
        Public Partial Class 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")>
            Public Overridable Property ApiUserId As String

            '''<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")>
            Public Overridable Property ApiUserKey As String
        End Class

        Public Partial Class LinkedTo
            Public Overridable Property ClientId As Nullable(Of Integer)
            Public Overridable Property Id As Nullable(Of Long)
            Public Overridable Property Type As String
            Public Overridable Property Subtype As String
            Public Overridable Property Status As String
            Public Overridable Property Description As String
            Public Overridable Property IsArchived As Nullable(Of Boolean)
            Public Overridable Property Name As String
            Public Overridable Property [Date] As Nullable(Of Date)
        End Class

        Public Partial Class ValidIdBankRequest
            Public Overridable Property BankSortCode As String
            Public Overridable Property BankAccountNumber As String
        End Class

        Public Partial Class ValidIdBasicRequest
            Public Overridable Property Name1 As String
            Public Overridable Property Name2 As String
            Public Overridable Property Name3 As String
            Public Overridable Property DateOfBirth As Nullable(Of Date)
            Public Overridable Property Gender As String
            Public Overridable Property Address1 As String
            Public Overridable Property Address2 As String
            Public Overridable Property Address3 As String
            Public Overridable Property Address4 As String
            Public Overridable Property Address5 As String
            Public Overridable Property PostCode As String
        End Class

        Public Partial Class ValidIdBirthRequest
            Public Overridable Property BirthForeName As String
            Public Overridable Property BirthMiddleName As String
            Public Overridable Property BirthSurname As String
            Public Overridable Property BirthMaidenName As String
            Public Overridable Property BirthDistrict As String
            Public Overridable Property BirthCertIssueNum As String
        End Class

        Public Partial Class ValidIdCardNumberRequest
            Public Overridable Property CardNumber As String
            Public Overridable Property CardType As String
        End Class

        Public Partial Class ValidIdDrivingRequest
            Public Overridable Property Driving1 As String
            Public Overridable Property Driving2 As String
            Public Overridable Property Driving3 As String
            Public Overridable Property DrivingPostcode As String
            Public Overridable Property DrivingMailSort As String
        End Class

        Public Partial Class ValidIdElectricityRequest
            Public Overridable Property MPANNumber1 As String
            Public Overridable Property MPANNumber2 As String
            Public Overridable Property MPANNumber3 As String
            Public Overridable Property MPANNumber4 As String
        End Class

        Public Partial Class ValidIdIdCardRequest
            Public Overridable Property IdCard1 As String
            Public Overridable Property IdCard2 As String
            Public Overridable Property IdCard3 As String
            Public Overridable Property IdCard4 As String
            Public Overridable Property IdCard5 As String
            Public Overridable Property IdCard6 As String
            Public Overridable Property IdCard7 As String
            Public Overridable Property IdCard8 As String
            Public Overridable Property IdCard9 As String
            Public Overridable Property IdCard10 As String
        End Class

        Public Partial Class ValidIdMarriageRequest
            Public Overridable Property Forename As String
            Public Overridable Property Surname As String
            Public Overridable Property PartnerForename As String
            Public Overridable Property PartnerSurname As String
            Public Overridable Property [Date] As String
            Public Overridable Property District As String
            Public Overridable Property CertIssueNum As String
        End Class

        Public Partial Class ValidIdNHSRequest
            Public Overridable Property NHSNumber As String
        End Class

        Public Partial Class ValidIdNIRequest
            Public Overridable Property NINumber As String
        End Class

        Public Partial Class ValidIdPassportRequest
            Public Overridable Property Passport1 As String
            Public Overridable Property Passport2 As String
            Public Overridable Property Passport3 As String
            Public Overridable Property Passport4 As String
            Public Overridable Property Passport5 As String
            Public Overridable Property Passport6 As String
            Public Overridable Property Passport7 As String
            Public Overridable Property Passport8 As String
            Public Overridable Property PassportMrzLineOne1 As String
            Public Overridable Property PassportMrzLineOne2 As String
            Public Overridable Property PassportMrzLineOne3 As String
        End Class

        Public Partial Class ValidIdPollNumberRequest
            Public Overridable Property PollNumber As String
        End Class

        Public Partial Class ValidIdTravelVisaRequest
            Public Overridable Property TravelVisa1 As String
            Public Overridable Property TravelVisa2 As String
            Public Overridable Property TravelVisa3 As String
            Public Overridable Property TravelVisa4 As String
            Public Overridable Property TravelVisa5 As String
            Public Overridable Property TravelVisa6 As String
            Public Overridable Property TravelVisa7 As String
            Public Overridable Property TravelVisa8 As String
            Public Overridable Property TravelVisa9 As String
        End Class
    End Namespace
End Namespace

VB.NET 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>