| GET | /account/register/template | Get a template to create a new account |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | RegisterAccountTemplateData | No | The response data |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Request | form | RegisterAccountRequest | No | The request body of the RegisterAccount endpoint |
| ReferenceData | form | ReferenceData | No | Reference data to fill out the RegisterAccount body |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | The status of the response |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ErrorCode | form | string | No | |
| Message | form | string | No | |
| StackTrace | form | string | No | |
| Errors | form | ArrayOfResponseError | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ErrorCode | form | string | No | |
| FieldName | form | string | No | |
| Message | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| 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 |
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Countries | form | ArrayOfCountry | No | A list of supported country values |
| CompanyIndustries | form | ArrayOfCompanyIndustry | No | A list of valid industry classifications for companies |
| CompanyTypes | form | ArrayOfCompanyType | No | A list of accepted company types |
| VATCountries | form | ArrayOfVATCountry | No | A list of countries where VAT registration is recognized |
| TermsAndConditionsLink | form | string | No | A URL linking to the terms and conditions document |
| PrivacyPolicyLink | form | string | No | A URL linking to the privacy policy |
| ContactStatement | form | string | No | The statement regarding contact preferences |
| DataProtectionStatement | form | string | No | The statement outlining data protection policies |
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 /account/register/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":{"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"},"referenceData":{"countries":["String"],"companyIndustries":["String"],"companyTypes":["String"],"vatCountries":["String"],"termsAndConditionsLink":"String","privacyPolicyLink":"String","contactStatement":"String","dataProtectionStatement":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}