Sanctions Search API: v2

<back to all web services

AddValidIdTemplate

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using SanctionsSearch.Api2.ServiceModel.Operations.ValidId;
using SanctionsSearch.Api2.ServiceModel.Operations.Base;
using SanctionsSearch.Api2.ServiceModel.Types;

namespace SanctionsSearch.Api2.ServiceModel.Operations.Base
{
    public partial class ArrayOfResponseError
        : List<ResponseError>
    {
    }

    [DataContract]
    public partial class BaseRequest
        : IBaseRequest
    {
        ///<summary>
        ///The authentication credentials
        ///</summary>
        [DataMember]
        [ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")]
        public virtual Authentication Authentication { get; set; }
    }

    public partial class BaseResponse
        : IBaseDataResponse, IHasResponseStatus
    {
        ///<summary>
        ///The status of the response
        ///</summary>
        [ApiMember(Description="The status of the response")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public partial class ResponseError
    {
        public ResponseError()
        {
            Meta = new Dictionary<string, string>{};
        }

        [DataMember(Order=1)]
        public virtual string ErrorCode { get; set; }

        [DataMember(Order=2)]
        public virtual string FieldName { get; set; }

        [DataMember(Order=3)]
        public virtual string Message { get; set; }

        [DataMember(Order=4)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public partial class ResponseStatus
    {
        public ResponseStatus()
        {
            Meta = new Dictionary<string, string>{};
        }

        [DataMember(Order=1)]
        public virtual string ErrorCode { get; set; }

        [DataMember(Order=2)]
        public virtual string Message { get; set; }

        [DataMember(Order=3)]
        public virtual string StackTrace { get; set; }

        [DataMember(Order=4)]
        public virtual ArrayOfResponseError Errors { get; set; }

        [DataMember(Order=5)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

}

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 virtual string SubUserName { get; set; }

        public virtual string Type { get; set; }
        public virtual bool AddPepSearch { get; set; }
        public virtual string PepSearchType { get; set; }
        public virtual bool AddSanctionsSearch { get; set; }
        public virtual ArrayOfLists SelectedLists { get; set; }
        public virtual string Reference { 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")]
        public virtual ArrayOfLinkedTo LinkedTo { get; set; }

        public virtual ValidIdBasicRequest BasicRequest { get; set; }
        public virtual ValidIdPassportRequest PassportRequest { get; set; }
        public virtual ValidIdDrivingRequest DrivingRequest { get; set; }
        public virtual ValidIdBirthRequest BirthRequest { get; set; }
        public virtual ValidIdNIRequest NIRequest { get; set; }
        public virtual ValidIdNHSRequest NHSRequest { get; set; }
        public virtual ValidIdElectricityRequest ElectricityRequest { get; set; }
        public virtual ValidIdBankRequest BankRequest { get; set; }
        public virtual ValidIdCardNumberRequest CardNumberRequest { get; set; }
        public virtual ValidIdTravelVisaRequest TravelVisaRequest { get; set; }
        public virtual ValidIdIdCardRequest IdCardRequest { get; set; }
        public virtual ValidIdPollNumberRequest PollNumberRequest { get; set; }
        public virtual ValidIdMarriageRequest MarriageRequest { get; set; }
        public virtual bool PassportEnabled { get; set; }
        public virtual bool PassportChipEnabled { get; set; }
        public virtual bool DrivingEnabled { get; set; }
        public virtual bool SmartlinkEnabled { get; set; }
        public virtual bool NIEnabled { get; set; }
        public virtual bool NHSEnabled { get; set; }
        public virtual bool ElectricityEnabled { get; set; }
        public virtual bool BankEnabled { get; set; }
        public virtual bool CreditActiveEnabled { get; set; }
        public virtual bool IdCardEnabled { get; set; }
        public virtual bool BankLiveEnabled { get; set; }
        public virtual bool CompanyDirectorEnabled { get; set; }
        public virtual bool SearchActivityEnabled { get; set; }
        public virtual bool PRSEnabled { get; set; }
    }

    [DataContract]
    public partial class AddValidIdTemplate
        : BaseRequest
    {
        [DataMember]
        [ApiMember(IsRequired=true)]
        public virtual int ClientId { get; set; }
    }

    public partial class AddValidIdTemplateData
        : BaseResponse
    {
        public virtual AddValidIdRequest Request { get; set; }
    }

    [DataContract]
    public partial class AddValidIdTemplateResponse
    {
        [DataMember]
        public virtual AddValidIdTemplateData Data { get; set; }
    }

}

namespace SanctionsSearch.Api2.ServiceModel.Types
{
    public partial class ArrayOfLinkedTo
        : List<LinkedTo>
    {
    }

    public partial class ArrayOfLists
        : List<string>
    {
    }

    [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 virtual string ApiUserId { 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")]
        public virtual string ApiUserKey { get; set; }
    }

    public partial class LinkedTo
    {
        public virtual int? ClientId { get; set; }
        public virtual long? Id { get; set; }
        public virtual string Type { get; set; }
        public virtual string Subtype { get; set; }
        public virtual string Status { get; set; }
        public virtual string Description { get; set; }
        public virtual bool? IsArchived { get; set; }
        public virtual string Name { get; set; }
        public virtual DateTime? Date { get; set; }
    }

    public partial class ValidIdBankRequest
    {
        public virtual string BankSortCode { get; set; }
        public virtual string BankAccountNumber { get; set; }
    }

    public partial class ValidIdBasicRequest
    {
        public virtual string Name1 { get; set; }
        public virtual string Name2 { get; set; }
        public virtual string Name3 { get; set; }
        public virtual DateTime? DateOfBirth { get; set; }
        public virtual string Gender { get; set; }
        public virtual string Address1 { get; set; }
        public virtual string Address2 { get; set; }
        public virtual string Address3 { get; set; }
        public virtual string Address4 { get; set; }
        public virtual string Address5 { get; set; }
        public virtual string PostCode { get; set; }
    }

    public partial class ValidIdBirthRequest
    {
        public virtual string BirthForeName { get; set; }
        public virtual string BirthMiddleName { get; set; }
        public virtual string BirthSurname { get; set; }
        public virtual string BirthMaidenName { get; set; }
        public virtual string BirthDistrict { get; set; }
        public virtual string BirthCertIssueNum { get; set; }
    }

    public partial class ValidIdCardNumberRequest
    {
        public virtual string CardNumber { get; set; }
        public virtual string CardType { get; set; }
    }

    public partial class ValidIdDrivingRequest
    {
        public virtual string Driving1 { get; set; }
        public virtual string Driving2 { get; set; }
        public virtual string Driving3 { get; set; }
        public virtual string DrivingPostcode { get; set; }
        public virtual string DrivingMailSort { get; set; }
    }

    public partial class ValidIdElectricityRequest
    {
        public virtual string MPANNumber1 { get; set; }
        public virtual string MPANNumber2 { get; set; }
        public virtual string MPANNumber3 { get; set; }
        public virtual string MPANNumber4 { get; set; }
    }

    public partial class ValidIdIdCardRequest
    {
        public virtual string IdCard1 { get; set; }
        public virtual string IdCard2 { get; set; }
        public virtual string IdCard3 { get; set; }
        public virtual string IdCard4 { get; set; }
        public virtual string IdCard5 { get; set; }
        public virtual string IdCard6 { get; set; }
        public virtual string IdCard7 { get; set; }
        public virtual string IdCard8 { get; set; }
        public virtual string IdCard9 { get; set; }
        public virtual string IdCard10 { get; set; }
    }

    public partial class ValidIdMarriageRequest
    {
        public virtual string Forename { get; set; }
        public virtual string Surname { get; set; }
        public virtual string PartnerForename { get; set; }
        public virtual string PartnerSurname { get; set; }
        public virtual string Date { get; set; }
        public virtual string District { get; set; }
        public virtual string CertIssueNum { get; set; }
    }

    public partial class ValidIdNHSRequest
    {
        public virtual string NHSNumber { get; set; }
    }

    public partial class ValidIdNIRequest
    {
        public virtual string NINumber { get; set; }
    }

    public partial class ValidIdPassportRequest
    {
        public virtual string Passport1 { get; set; }
        public virtual string Passport2 { get; set; }
        public virtual string Passport3 { get; set; }
        public virtual string Passport4 { get; set; }
        public virtual string Passport5 { get; set; }
        public virtual string Passport6 { get; set; }
        public virtual string Passport7 { get; set; }
        public virtual string Passport8 { get; set; }
        public virtual string PassportMrzLineOne1 { get; set; }
        public virtual string PassportMrzLineOne2 { get; set; }
        public virtual string PassportMrzLineOne3 { get; set; }
    }

    public partial class ValidIdPollNumberRequest
    {
        public virtual string PollNumber { get; set; }
    }

    public partial class ValidIdTravelVisaRequest
    {
        public virtual string TravelVisa1 { get; set; }
        public virtual string TravelVisa2 { get; set; }
        public virtual string TravelVisa3 { get; set; }
        public virtual string TravelVisa4 { get; set; }
        public virtual string TravelVisa5 { get; set; }
        public virtual string TravelVisa6 { get; set; }
        public virtual string TravelVisa7 { get; set; }
        public virtual string TravelVisa8 { get; set; }
        public virtual string TravelVisa9 { get; set; }
    }

}

C# AddValidIdTemplate DTOs

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

HTTP + SOAP12

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /soap12 HTTP/1.1 
Host: api.sanctionssearch.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>

<AddValidIdTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <ClientId>0</ClientId>
</AddValidIdTemplate>

</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>

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

</soap12:Body>
</soap12:Envelope>