""" Options: Date: 2025-03-15 04:38:59 Version: 8.30 Tip: To override a DTO option, remove "#" prefix before updating BaseUrl: https://api.sanctionssearch.com/v2 #GlobalNamespace: #AddServiceStackTypes: True #AddResponseStatus: False #AddImplicitVersion: #AddDescriptionAsComments: True IncludeTypes: UpdateClient.* #ExcludeTypes: #DefaultImports: datetime,decimal,marshmallow.fields:*,servicestack:*,typing:*,dataclasses:dataclass/field,dataclasses_json:dataclass_json/LetterCase/Undefined/config,enum:Enum/IntEnum #DataClass: #DataClassJson: """ 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 """ class IBaseRequest: authentication: Optional[Authentication] = None class ClientState(str, Enum): UNDEFINED = 'Undefined' PENDING_COMPLETION = 'PendingCompletion' PENDING_OCR = 'PendingOcr' PENDING_VERIFICATION = 'PendingVerification' VERIFIED = 'Verified' @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class Face: age: Optional[float] = None gender: Optional[str] = None emotion: Optional[str] = None smile: Optional[float] = None hair_colour: Optional[str] = None facial_hair: Optional[str] = None makeup: Optional[str] = None glasses: Optional[str] = None accessories: Optional[str] = None @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class VideoTimestamp: tag_name: Optional[str] = None milli: Optional[int] = None image_url: Optional[str] = None @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class Video: id: int = 0 video_url: Optional[str] = None image_url: Optional[str] = None video_timestamps: Optional[List[VideoTimestamp]] = None @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class Location: latitude: float = 0.0 longitude: float = 0.0 @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class Image: id: int = 0 name: Optional[str] = None ocr_id: Optional[int] = None url: Optional[str] = None @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ArrayOfImages(List[Image]): pass @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class PassportChipData: is_issuer_verified: bool = False issuer_common_name: Optional[str] = None issuer_organisation_name: Optional[str] = None issuer_country: Optional[str] = None mrz_line1: Optional[str] = None mrz_line2: Optional[str] = None is_mrz_line1_verified: bool = False is_mrz_line2_verified: bool = False data_groups_verified: Optional[List[int]] = None data_groups_failed: Optional[List[int]] = None is_face_match: bool = False face_match_confidence: Optional[Decimal] = None @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class Passport: client_file_id: int = 0 first_name: Optional[str] = None middle_name: Optional[str] = None last_name: Optional[str] = None date_of_birth: Optional[str] = None gender: Optional[str] = None mrz_line_one: Optional[str] = None mrz_line_two1: Optional[str] = None mrz_line_two2: Optional[str] = None mrz_line_two3: Optional[str] = None mrz_line_two4: Optional[str] = None mrz_line_two5: Optional[str] = None mrz_line_two6: Optional[str] = None mrz_line_two7: Optional[str] = None mrz_line_two8: Optional[str] = None images: Optional[ArrayOfImages] = None is_verified: bool = False is_face_match: Optional[bool] = None face_match_confidence: Optional[Decimal] = None has_pcv_search: bool = False has_dfa_search: bool = False is_passport_chip_verified: Optional[bool] = None passport_chip_data: Optional[PassportChipData] = None is_eligible_for_pcv: bool = False is_eligible_for_dfa: bool = False @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ArrayOfPassports(List[Passport]): pass @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class DrivingLicence: client_file_id: int = 0 first_name: Optional[str] = None middle_name: Optional[str] = None last_name: Optional[str] = None date_of_birth: Optional[str] = None address: Optional[str] = None driving_licence_number: Optional[str] = None images: Optional[ArrayOfImages] = None is_verified: bool = False is_face_match: Optional[bool] = None face_match_confidence: Optional[Decimal] = None has_dfa_search: bool = False @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ArrayOfDrivingLicences(List[DrivingLicence]): pass @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class OtherDocument: client_file_id: int = 0 type: Optional[str] = None type_other: Optional[str] = None description: Optional[str] = None original_image_url: Optional[str] = None cropped_image_url: Optional[str] = None is_verified: bool = False @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ArrayOfOtherDocuments(List[OtherDocument]): pass @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ProofOfDocument: # @ApiMember(Description="The ID of the ProofOfDocument", IsRequired=true) id: int = 0 """ The ID of the ProofOfDocument """ # @ApiMember(Description="The name of the ProofOfDocument", IsRequired=true) name: Optional[str] = None """ The name of the ProofOfDocument """ @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ArrayOfProofOfDocuments(List[ProofOfDocument]): pass @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ProofOfDocumentCategory: # @ApiMember(Description="The ID of the ProofOfDocumentCategory", IsRequired=true) id: int = 0 """ The ID of the ProofOfDocumentCategory """ # @ApiMember(Description="The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')", IsRequired=true) proof_of: Optional[str] = None """ The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work') """ # @ApiMember(Description="The documents that can be used to provide proof for the specified category.", IsRequired=true) proof_of_documents: Optional[ArrayOfProofOfDocuments] = None """ The documents that can be used to provide proof for the specified category. """ @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ArrayOfProofOfDocumentCategories(List[ProofOfDocumentCategory]): pass @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class Client: id: int = 0 date_created: datetime.datetime = datetime.datetime(1, 1, 1) name: Optional[str] = None email: Optional[str] = None reference: Optional[str] = None state: Optional[ClientState] = None mobile_international: Optional[str] = None post_code: Optional[str] = None is_validate_me: bool = False face: Optional[Face] = None video: Optional[Video] = None location: Optional[Location] = None num_of_documents: int = 0 passports: Optional[ArrayOfPassports] = None driving_licences: Optional[ArrayOfDrivingLicences] = None other_documents: Optional[ArrayOfOtherDocuments] = None proof_of_document_categories: Optional[ArrayOfProofOfDocumentCategories] = 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 UpdateClientData(BaseResponse): client: Optional[Client] = None class IBaseDataResponse: response_status: Optional[ResponseStatus] = None class IHasResponseStatus: response_status: Optional[ResponseStatus] = None @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class UpdateClientResponse: data: Optional[UpdateClientData] = None # @Route("/clients/{Id}", "PUT") @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class UpdateClient(BaseRequest, IReturn[UpdateClientResponse]): # @ApiMember(IsRequired=true, ParameterType="path") id: int = 0 request: Optional[Client] = None