| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"request":{"name":"String","email":"String","mobileInternational":"String","postCode":"String","proofOfPreset":"Undefined","proofOfDocumentCategories":[{"id":0,"proofOf":"String","proofOfDocuments":[{"id":0,"name":"String"}]}],"linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}]},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}],"client":{"id":0,"dateCreated":"\/Date(-62135596800000-0000)\/","name":"String","email":"String","reference":"String","state":"Undefined","mobileInternational":"String","postCode":"String","isValidateMe":false,"face":{"age":0,"gender":"String","emotion":"String","smile":0,"hairColour":"String","facialHair":"String","makeup":"String","glasses":"String","accessories":"String"},"video":{"id":0,"videoUrl":"String","imageUrl":"String","videoTimestamps":[{"tagName":"String","milli":0,"imageUrl":"String"}]},"location":{"latitude":0,"longitude":0},"numOfDocuments":0,"passports":[{"clientFileId":0,"firstName":"String","middleName":"String","lastName":"String","dateOfBirth":"String","gender":"String","mrzLineOne":"String","mrzLineTwo1":"String","mrzLineTwo2":"String","mrzLineTwo3":"String","mrzLineTwo4":"String","mrzLineTwo5":"String","mrzLineTwo6":"String","mrzLineTwo7":"String","mrzLineTwo8":"String","images":[{"id":0,"name":"String","ocrId":0,"url":"String"}],"isVerified":false,"isFaceMatch":false,"faceMatchConfidence":0,"hasPcvSearch":false,"hasDfaSearch":false,"isPassportChipVerified":false,"passportChipData":{"isIssuerVerified":false,"issuerCommonName":"String","issuerOrganisationName":"String","issuerCountry":"String","mrzLine1":"String","mrzLine2":"String","isMrzLine1Verified":false,"isMrzLine2Verified":false,"dataGroupsVerified":[0],"dataGroupsFailed":[0],"isFaceMatch":false,"faceMatchConfidence":0},"isEligibleForPcv":false,"isEligibleForDfa":false}],"drivingLicences":[{"clientFileId":0,"firstName":"String","middleName":"String","lastName":"String","dateOfBirth":"String","address":"String","drivingLicenceNumber":"String","images":[{"id":0,"name":"String","ocrId":0,"url":"String"}],"isVerified":false,"isFaceMatch":false,"faceMatchConfidence":0,"hasDfaSearch":false}],"otherDocuments":[{"clientFileId":0,"type":"String","typeOther":"String","description":"String","originalImageUrl":"String","croppedImageUrl":"String","isVerified":false}],"proofOfDocumentCategories":[{"id":0,"proofOf":"String","proofOfDocuments":[{"id":0,"name":"String"}]}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}