| GET | /clients/template | Get a template for adding 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
"""
class CreateMobileClientType(str, Enum):
UNDEFINED = 'Undefined'
VALIDATE_ME = 'ValidateMe'
PASSPORT_CHIP_VERIFICATION = 'PassportChipVerification'
@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 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 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 AddClientTemplateData(BaseResponse):
request: Optional[AddClientRequest] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddClientTemplateResponse:
data: Optional[AddClientTemplateData] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddClientTemplate(BaseRequest):
pass
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.
GET /clients/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":{"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)\/"}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}