Sanctions Search API: v2

RegisterAccount

Account

The following routes are available for this service:
POST	/account/register	Create a new account

**RegisterAccount** Parameters:
Name	Parameter	Data Type	Required	Description
Request	body	RegisterAccountRequest	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Authentication	header, body	Authentication	Yes	The authentication credentials

**Authentication** Parameters:
Name	Parameter	Data Type	Required	Description
ApiUserId	header, body	string	Yes	The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)
ApiUserKey	header, body	string	Yes	The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)
UserId	header, body	string	No	The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).

**RegisterAccountRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Username	form	string	Yes	The desired login username for the account
Password	form	string	Yes	The password for account login
Email	form	string	Yes	The contact email address for the account holder
FullName	form	string	Yes	The full legal name of the account holder
CompanyName	form	string	Yes	The registered name of the company associated with this account
CompanyPhone	form	string	Yes	The primary contact phone number of the company
Address1	form	string	Yes	The first line of the company’s address (e.g., street name and number)
Address2	form	string	No	The second line of the company’s address (optional)
Address3	form	string	No	The third line of the company’s address (optional)
City	form	string	No	The city where the company is located (optional)
Postcode	form	string	Yes	The postal or ZIP code of the company’s address
Country	form	string	Yes	The country where the company is registered
CompanyType	form	string	Yes	The classification of the company (e.g., LLC, Corporation, Sole Proprietorship)
CompanyIndustry	form	string	Yes	The industry sector the company operates in
CompanyNetwork	form	string	No	The trade body, network, or affiliation the company is a member of (if applicable)
AgreeToTerms	form	bool	Yes	Indicates agreement to the terms and conditions (required)
AgreeToDataProtection	form	bool	Yes	Indicates agreement to the data protection statement (required)
AgreeToContact	form	bool	No	Indicates consent to be contacted (optional)
AgreeToPrivacy	form	bool	Yes	Indicates agreement to the privacy policy (required)
VoucherCode	form	string	No	An optional voucher code for discounts or promotions
AccountActivationCode	form	string	No	An optional code that grants access to certain features or subscriptions
VATNumber	form	string	No	The company's VAT registration number (if applicable)
VATCountry	form	string	No	The country where the company is VAT-registered

**RegisterAccountResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	RegisterAccountData	No	The response data

**RegisterAccountData** Parameters:
Name	Parameter	Data Type	Required	Description
ApiUserId	form	string	No	A unique identifier for the users API access
ApiUserKey	form	string	No	A secure, randomly generated key used for API authentication

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No	The status of the response

**ResponseStatus** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StackTrace	form	string	No
Errors	form	ArrayOfResponseError	No
Meta	form	Dictionary<string, string>	No

**ResponseError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
FieldName	form	string	No
Message	form	string	No
Meta	form	Dictionary<string, string>	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<RegisterAccount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
    <UserId>String</UserId>
  </Authentication>
  <Request>
    <AccountActivationCode>String</AccountActivationCode>
    <Address1>String</Address1>
    <Address2>String</Address2>
    <Address3>String</Address3>
    <AgreeToContact>false</AgreeToContact>
    <AgreeToDataProtection>false</AgreeToDataProtection>
    <AgreeToPrivacy>false</AgreeToPrivacy>
    <AgreeToTerms>false</AgreeToTerms>
    <City>String</City>
    <CompanyIndustry>String</CompanyIndustry>
    <CompanyName>String</CompanyName>
    <CompanyNetwork>String</CompanyNetwork>
    <CompanyPhone>String</CompanyPhone>
    <CompanyType>String</CompanyType>
    <Country>String</Country>
    <Email>String</Email>
    <FullName>String</FullName>
    <Password>String</Password>
    <Postcode>String</Postcode>
    <Username>String</Username>
    <VATCountry>String</VATCountry>
    <VATNumber>String</VATNumber>
    <VoucherCode>String</VoucherCode>
  </Request>
</RegisterAccount>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegisterAccountResponse 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>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Data>
</RegisterAccountResponse>