| POST | /clients | Add a client |
|---|
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 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
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 AddClientData(BaseResponse, IBaseSearchResponse):
linked_to: Optional[ArrayOfLinkedTo] = None
client: Optional[Client] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddClientResponse:
data: Optional[AddClientData] = None
class CreateMobileClientType(str, Enum):
UNDEFINED = 'Undefined'
VALIDATE_ME = 'ValidateMe'
PASSPORT_CHIP_VERIFICATION = 'PassportChipVerification'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddClientRequest:
# @ApiMember(Description="The full name of the client", IsRequired=true)
name: Optional[str] = None
"""
The full name of the client
"""
# @ApiMember(Description="The email address of the client", IsRequired=true)
email: Optional[str] = None
"""
The email address of the client
"""
# @ApiMember(Description="The client's mobile phone number in international format (e.g. '+447123456789')", IsRequired=true)
mobile_international: Optional[str] = None
"""
The client's mobile phone number in international format (e.g. '+447123456789')
"""
# @ApiMember(Description="The postal code of the client's address. Used in emails sent to the client to help them recognize the communication as genuine", IsRequired=true)
post_code: Optional[str] = None
"""
The postal code of the client's address. Used in emails sent to the client to help them recognize the communication as genuine
"""
# @ApiMember(Description="Specifies the type of ValidateMe preset. Possible values are 'ValidateMe' for configuring RequiredDocuments, or 'PassportChipVerification' for setting the Passport as Proof of Name", IsRequired=true)
proof_of_preset: Optional[CreateMobileClientType] = None
"""
Specifies the type of ValidateMe preset. Possible values are 'ValidateMe' for configuring RequiredDocuments, or 'PassportChipVerification' for setting the Passport as Proof of Name
"""
# @ApiMember(Description="The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe'")
proof_of_document_categories: Optional[ArrayOfProofOfDocumentCategories] = None
"""
The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe'
"""
# @ApiMember(Description="If the client should be linked to other searches, specify the them here")
linked_to: Optional[ArrayOfLinkedTo] = None
"""
If the client should be linked to other searches, specify the them here
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddClient(BaseRequest):
request: Optional[AddClientRequest] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /clients HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<Email>String</Email>
<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>
<MobileInternational>String</MobileInternational>
<Name>String</Name>
<PostCode>String</PostCode>
<ProofOfDocumentCategories>
<CategoryId>
<Id>0</Id>
<ProofOf>String</ProofOf>
<ProofOfDocuments>
<DocumentId>
<Id>0</Id>
<Name>String</Name>
</DocumentId>
</ProofOfDocuments>
</CategoryId>
</ProofOfDocumentCategories>
<ProofOfPreset>Undefined</ProofOfPreset>
</Request>
</AddClient>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AddClientResponse 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>
<Client>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DrivingLicences>
<Passport>
<Address>String</Address>
<ClientFileId>0</ClientFileId>
<DateOfBirth>String</DateOfBirth>
<DrivingLicenceNumber>String</DrivingLicenceNumber>
<FaceMatchConfidence>0</FaceMatchConfidence>
<FirstName>String</FirstName>
<HasDfaSearch>false</HasDfaSearch>
<Images>
<CategoryId>
<Id>0</Id>
<Name>String</Name>
<OcrId>0</OcrId>
<Url>String</Url>
</CategoryId>
</Images>
<IsFaceMatch>false</IsFaceMatch>
<IsVerified>false</IsVerified>
<LastName>String</LastName>
<MiddleName>String</MiddleName>
</Passport>
</DrivingLicences>
<Email>String</Email>
<Face>
<Accessories>String</Accessories>
<Age>0</Age>
<Emotion>String</Emotion>
<FacialHair>String</FacialHair>
<Gender>String</Gender>
<Glasses>String</Glasses>
<HairColour>String</HairColour>
<Makeup>String</Makeup>
<Smile>0</Smile>
</Face>
<Id>0</Id>
<IsValidateMe>false</IsValidateMe>
<Location>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
</Location>
<MobileInternational>String</MobileInternational>
<Name>String</Name>
<NumOfDocuments>0</NumOfDocuments>
<OtherDocuments>
<OtherDocument>
<ClientFileId>0</ClientFileId>
<CroppedImageUrl>String</CroppedImageUrl>
<Description>String</Description>
<IsVerified>false</IsVerified>
<OriginalImageUrl>String</OriginalImageUrl>
<Type>String</Type>
<TypeOther>String</TypeOther>
</OtherDocument>
</OtherDocuments>
<Passports>
<Passport>
<ClientFileId>0</ClientFileId>
<DateOfBirth>String</DateOfBirth>
<FaceMatchConfidence>0</FaceMatchConfidence>
<FirstName>String</FirstName>
<Gender>String</Gender>
<HasDfaSearch>false</HasDfaSearch>
<HasPcvSearch>false</HasPcvSearch>
<Images>
<CategoryId>
<Id>0</Id>
<Name>String</Name>
<OcrId>0</OcrId>
<Url>String</Url>
</CategoryId>
</Images>
<IsEligibleForDfa>false</IsEligibleForDfa>
<IsEligibleForPcv>false</IsEligibleForPcv>
<IsFaceMatch>false</IsFaceMatch>
<IsPassportChipVerified>false</IsPassportChipVerified>
<IsVerified>false</IsVerified>
<LastName>String</LastName>
<MiddleName>String</MiddleName>
<MrzLineOne>String</MrzLineOne>
<MrzLineTwo1>String</MrzLineTwo1>
<MrzLineTwo2>String</MrzLineTwo2>
<MrzLineTwo3>String</MrzLineTwo3>
<MrzLineTwo4>String</MrzLineTwo4>
<MrzLineTwo5>String</MrzLineTwo5>
<MrzLineTwo6>String</MrzLineTwo6>
<MrzLineTwo7>String</MrzLineTwo7>
<MrzLineTwo8>String</MrzLineTwo8>
<PassportChipData>
<DataGroupsFailed xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:int>0</d7p1:int>
</DataGroupsFailed>
<DataGroupsVerified xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:int>0</d7p1:int>
</DataGroupsVerified>
<FaceMatchConfidence>0</FaceMatchConfidence>
<IsFaceMatch>false</IsFaceMatch>
<IsIssuerVerified>false</IsIssuerVerified>
<IsMrzLine1Verified>false</IsMrzLine1Verified>
<IsMrzLine2Verified>false</IsMrzLine2Verified>
<IssuerCommonName>String</IssuerCommonName>
<IssuerCountry>String</IssuerCountry>
<IssuerOrganisationName>String</IssuerOrganisationName>
<MRZLine1>String</MRZLine1>
<MRZLine2>String</MRZLine2>
</PassportChipData>
</Passport>
</Passports>
<PostCode>String</PostCode>
<ProofOfDocumentCategories>
<CategoryId>
<Id>0</Id>
<ProofOf>String</ProofOf>
<ProofOfDocuments>
<DocumentId>
<Id>0</Id>
<Name>String</Name>
</DocumentId>
</ProofOfDocuments>
</CategoryId>
</ProofOfDocumentCategories>
<Reference>String</Reference>
<State>Undefined</State>
<Video>
<Id>0</Id>
<ImageUrl>String</ImageUrl>
<VideoTimestamps>
<VideoTimestamp>
<ImageUrl>String</ImageUrl>
<Milli>0</Milli>
<TagName>String</TagName>
</VideoTimestamp>
</VideoTimestamps>
<VideoUrl>String</VideoUrl>
</Video>
</Client>
<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>
</Data>
</AddClientResponse>