Sanctions Search API: v2

<back to all web services

AddValidIdTemplate

ValidID
The following routes are available for this service:
GET/validid/template
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Authentication:
    # @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    api_user_id: Optional[str] = None
    """
    The API User ID provided by us when you signed up to use our API
    """


    # @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    api_user_key: Optional[str] = None
    """
    The API User Key provided by us when you signed up to use our API
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseRequest(IBaseRequest):
    # @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    authentication: Optional[Authentication] = None
    """
    The authentication credentials
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResponseError:
    error_code: Optional[str] = None
    field_name: Optional[str] = None
    message: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArrayOfResponseError(List[ResponseError]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResponseStatus:
    error_code: Optional[str] = None
    message: Optional[str] = None
    stack_trace: Optional[str] = None
    errors: Optional[ArrayOfResponseError] = None
    meta: Optional[Dict[str, str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse(IBaseDataResponse, IHasResponseStatus):
    # @ApiMember(Description="The status of the response")
    response_status: Optional[ResponseStatus] = None
    """
    The status of the response
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArrayOfLists(List[str]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LinkedTo:
    client_id: Optional[int] = None
    id: Optional[int] = None
    type: Optional[str] = None
    subtype: Optional[str] = None
    status: Optional[str] = None
    description: Optional[str] = None
    is_archived: Optional[bool] = None
    name: Optional[str] = None
    date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArrayOfLinkedTo(List[LinkedTo]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidIdBasicRequest:
    name1: Optional[str] = None
    name2: Optional[str] = None
    name3: Optional[str] = None
    date_of_birth: Optional[datetime.datetime] = None
    gender: Optional[str] = None
    address1: Optional[str] = None
    address2: Optional[str] = None
    address3: Optional[str] = None
    address4: Optional[str] = None
    address5: Optional[str] = None
    post_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidIdPassportRequest:
    passport1: Optional[str] = None
    passport2: Optional[str] = None
    passport3: Optional[str] = None
    passport4: Optional[str] = None
    passport5: Optional[str] = None
    passport6: Optional[str] = None
    passport7: Optional[str] = None
    passport8: Optional[str] = None
    passport_mrz_line_one1: Optional[str] = None
    passport_mrz_line_one2: Optional[str] = None
    passport_mrz_line_one3: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidIdDrivingRequest:
    driving1: Optional[str] = None
    driving2: Optional[str] = None
    driving3: Optional[str] = None
    driving_postcode: Optional[str] = None
    driving_mail_sort: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidIdBirthRequest:
    birth_fore_name: Optional[str] = None
    birth_middle_name: Optional[str] = None
    birth_surname: Optional[str] = None
    birth_maiden_name: Optional[str] = None
    birth_district: Optional[str] = None
    birth_cert_issue_num: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidIdNIRequest:
    ni_number: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidIdNHSRequest:
    nhs_number: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidIdElectricityRequest:
    mpan_number1: Optional[str] = None
    mpan_number2: Optional[str] = None
    mpan_number3: Optional[str] = None
    mpan_number4: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidIdBankRequest:
    bank_sort_code: Optional[str] = None
    bank_account_number: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidIdCardNumberRequest:
    card_number: Optional[str] = None
    card_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidIdTravelVisaRequest:
    travel_visa1: Optional[str] = None
    travel_visa2: Optional[str] = None
    travel_visa3: Optional[str] = None
    travel_visa4: Optional[str] = None
    travel_visa5: Optional[str] = None
    travel_visa6: Optional[str] = None
    travel_visa7: Optional[str] = None
    travel_visa8: Optional[str] = None
    travel_visa9: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidIdIdCardRequest:
    id_card1: Optional[str] = None
    id_card2: Optional[str] = None
    id_card3: Optional[str] = None
    id_card4: Optional[str] = None
    id_card5: Optional[str] = None
    id_card6: Optional[str] = None
    id_card7: Optional[str] = None
    id_card8: Optional[str] = None
    id_card9: Optional[str] = None
    id_card10: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidIdPollNumberRequest:
    poll_number: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidIdMarriageRequest:
    forename: Optional[str] = None
    surname: Optional[str] = None
    partner_forename: Optional[str] = None
    partner_surname: Optional[str] = None
    date: Optional[str] = None
    district: Optional[str] = None
    cert_issue_num: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddValidIdRequest:
    # @ApiMember(Description="If the search should be saved against a single Sub User account, specify their username here")
    sub_user_name: Optional[str] = None
    """
    If the search should be saved against a single Sub User account, specify their username here
    """


    type: Optional[str] = None
    add_pep_search: bool = False
    pep_search_type: Optional[str] = None
    add_sanctions_search: bool = False
    selected_lists: Optional[ArrayOfLists] = None
    reference: Optional[str] = None
    # @ApiMember(Description="If the search should be linked to other searches, specify the them here")
    linked_to: Optional[ArrayOfLinkedTo] = None
    """
    If the search should be linked to other searches, specify the them here
    """


    basic_request: Optional[ValidIdBasicRequest] = None
    passport_request: Optional[ValidIdPassportRequest] = None
    driving_request: Optional[ValidIdDrivingRequest] = None
    birth_request: Optional[ValidIdBirthRequest] = None
    ni_request: Optional[ValidIdNIRequest] = None
    nhs_request: Optional[ValidIdNHSRequest] = None
    electricity_request: Optional[ValidIdElectricityRequest] = None
    bank_request: Optional[ValidIdBankRequest] = None
    card_number_request: Optional[ValidIdCardNumberRequest] = None
    travel_visa_request: Optional[ValidIdTravelVisaRequest] = None
    id_card_request: Optional[ValidIdIdCardRequest] = None
    poll_number_request: Optional[ValidIdPollNumberRequest] = None
    marriage_request: Optional[ValidIdMarriageRequest] = None
    passport_enabled: bool = False
    passport_chip_enabled: bool = False
    driving_enabled: bool = False
    smartlink_enabled: bool = False
    ni_enabled: bool = False
    nhs_enabled: bool = False
    electricity_enabled: bool = False
    bank_enabled: bool = False
    credit_active_enabled: bool = False
    id_card_enabled: bool = False
    bank_live_enabled: bool = False
    company_director_enabled: bool = False
    search_activity_enabled: bool = False
    prs_enabled: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddValidIdTemplateData(BaseResponse):
    request: Optional[AddValidIdRequest] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddValidIdTemplateResponse:
    data: Optional[AddValidIdTemplateData] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddValidIdTemplate(BaseRequest):
    # @ApiMember(IsRequired=true)
    client_id: int = 0

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