| POST | /account/register | Create a new account |
|---|
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 RegisterAccountData(BaseResponse):
# @ApiMember(Description="A unique identifier for the users API access")
api_user_id: Optional[str] = None
"""
A unique identifier for the users API access
"""
# @ApiMember(Description="A secure, randomly generated key used for API authentication")
api_user_key: Optional[str] = None
"""
A secure, randomly generated key used for API authentication
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegisterAccountResponse:
# @ApiMember(Description="The response data")
data: Optional[RegisterAccountData] = None
"""
The response data
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegisterAccountRequest:
# @ApiMember(Description="The desired login username for the account", IsRequired=true)
username: Optional[str] = None
"""
The desired login username for the account
"""
# @ApiMember(Description="The password for account login", IsRequired=true)
password: Optional[str] = None
"""
The password for account login
"""
# @ApiMember(Description="The contact email address for the account holder", IsRequired=true)
email: Optional[str] = None
"""
The contact email address for the account holder
"""
# @ApiMember(Description="The full legal name of the account holder", IsRequired=true)
full_name: Optional[str] = None
"""
The full legal name of the account holder
"""
# @ApiMember(Description="The registered name of the company associated with this account", IsRequired=true)
company_name: Optional[str] = None
"""
The registered name of the company associated with this account
"""
# @ApiMember(Description="The primary contact phone number of the company", IsRequired=true)
company_phone: Optional[str] = None
"""
The primary contact phone number of the company
"""
# @ApiMember(Description="The first line of the company’s address (e.g., street name and number)", IsRequired=true)
address1: Optional[str] = None
"""
The first line of the company’s address (e.g., street name and number)
"""
# @ApiMember(Description="The second line of the company’s address (optional)")
address2: Optional[str] = None
"""
The second line of the company’s address (optional)
"""
# @ApiMember(Description="The third line of the company’s address (optional)")
address3: Optional[str] = None
"""
The third line of the company’s address (optional)
"""
# @ApiMember(Description="The city where the company is located (optional)")
city: Optional[str] = None
"""
The city where the company is located (optional)
"""
# @ApiMember(Description="The postal or ZIP code of the company’s address", IsRequired=true)
postcode: Optional[str] = None
"""
The postal or ZIP code of the company’s address
"""
# @ApiMember(Description="The country where the company is registered", IsRequired=true)
country: Optional[str] = None
"""
The country where the company is registered
"""
# @ApiMember(Description="The classification of the company (e.g., LLC, Corporation, Sole Proprietorship)", IsRequired=true)
company_type: Optional[str] = None
"""
The classification of the company (e.g., LLC, Corporation, Sole Proprietorship)
"""
# @ApiMember(Description="The industry sector the company operates in", IsRequired=true)
company_industry: Optional[str] = None
"""
The industry sector the company operates in
"""
# @ApiMember(Description="The trade body, network, or affiliation the company is a member of (if applicable)")
company_network: Optional[str] = None
"""
The trade body, network, or affiliation the company is a member of (if applicable)
"""
# @ApiMember(Description="Indicates agreement to the terms and conditions (required)", IsRequired=true)
agree_to_terms: bool = False
"""
Indicates agreement to the terms and conditions (required)
"""
# @ApiMember(Description="Indicates agreement to the data protection statement (required)", IsRequired=true)
agree_to_data_protection: bool = False
"""
Indicates agreement to the data protection statement (required)
"""
# @ApiMember(Description="Indicates consent to be contacted (optional)")
agree_to_contact: bool = False
"""
Indicates consent to be contacted (optional)
"""
# @ApiMember(Description="Indicates agreement to the privacy policy (required)", IsRequired=true)
agree_to_privacy: bool = False
"""
Indicates agreement to the privacy policy (required)
"""
# @ApiMember(Description="An optional voucher code for discounts or promotions")
voucher_code: Optional[str] = None
"""
An optional voucher code for discounts or promotions
"""
# @ApiMember(Description="An optional code that grants access to certain features or subscriptions")
account_activation_code: Optional[str] = None
"""
An optional code that grants access to certain features or subscriptions
"""
# @ApiMember(Description="The company's VAT registration number (if applicable)")
vat_number: Optional[str] = None
"""
The company's VAT registration number (if applicable)
"""
# @ApiMember(Description="The country where the company is VAT-registered")
vat_country: Optional[str] = None
"""
The country where the company is VAT-registered
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegisterAccount(BaseRequest):
request: Optional[RegisterAccountRequest] = 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 /account/register HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"username":"String","password":"String","email":"String","fullName":"String","companyName":"String","companyPhone":"String","address1":"String","address2":"String","address3":"String","city":"String","postcode":"String","country":"String","companyType":"String","companyIndustry":"String","companyNetwork":"String","agreeToTerms":false,"agreeToDataProtection":false,"agreeToContact":false,"agreeToPrivacy":false,"voucherCode":"String","accountActivationCode":"String","vatNumber":"String","vatCountry":"String"},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"apiUserId":"String","apiUserKey":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}