Sanctions Search API: v2

<back to all web services

RegisterAccountTemplate

Account
The following routes are available for this service:
GET/account/register/templateGet a template to create a new account
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using SanctionsSearch.Api2.ServiceModel.Operations.Account;
using SanctionsSearch.Api2.ServiceModel.Operations.Base;
using SanctionsSearch.Api2.ServiceModel.Types;

namespace SanctionsSearch.Api2.ServiceModel.Operations.Account
{
    public partial class ReferenceData
    {
        ///<summary>
        ///A list of supported country values
        ///</summary>
        [ApiMember(Description="A list of supported country values")]
        public virtual ArrayOfCountry Countries { get; set; }

        ///<summary>
        ///A list of valid industry classifications for companies
        ///</summary>
        [ApiMember(Description="A list of valid industry classifications for companies")]
        public virtual ArrayOfCompanyIndustry CompanyIndustries { get; set; }

        ///<summary>
        ///A list of accepted company types
        ///</summary>
        [ApiMember(Description="A list of accepted company types")]
        public virtual ArrayOfCompanyType CompanyTypes { get; set; }

        ///<summary>
        ///A list of countries where VAT registration is recognized
        ///</summary>
        [ApiMember(Description="A list of countries where VAT registration is recognized")]
        public virtual ArrayOfVATCountry VATCountries { get; set; }

        ///<summary>
        ///A URL linking to the terms and conditions document
        ///</summary>
        [ApiMember(Description="A URL linking to the terms and conditions document")]
        public virtual string TermsAndConditionsLink { get; set; }

        ///<summary>
        ///A URL linking to the privacy policy
        ///</summary>
        [ApiMember(Description="A URL linking to the privacy policy")]
        public virtual string PrivacyPolicyLink { get; set; }

        ///<summary>
        ///The statement regarding contact preferences
        ///</summary>
        [ApiMember(Description="The statement regarding contact preferences")]
        public virtual string ContactStatement { get; set; }

        ///<summary>
        ///The statement outlining data protection policies
        ///</summary>
        [ApiMember(Description="The statement outlining data protection policies")]
        public virtual string DataProtectionStatement { get; set; }
    }

    public partial class RegisterAccountRequest
    {
        ///<summary>
        ///The desired login username for the account
        ///</summary>
        [ApiMember(Description="The desired login username for the account", IsRequired=true)]
        public virtual string Username { get; set; }

        ///<summary>
        ///The password for account login
        ///</summary>
        [ApiMember(Description="The password for account login", IsRequired=true)]
        public virtual string Password { get; set; }

        ///<summary>
        ///The contact email address for the account holder
        ///</summary>
        [ApiMember(Description="The contact email address for the account holder", IsRequired=true)]
        public virtual string Email { get; set; }

        ///<summary>
        ///The full legal name of the account holder
        ///</summary>
        [ApiMember(Description="The full legal name of the account holder", IsRequired=true)]
        public virtual string FullName { get; set; }

        ///<summary>
        ///The registered name of the company associated with this account
        ///</summary>
        [ApiMember(Description="The registered name of the company associated with this account", IsRequired=true)]
        public virtual string CompanyName { get; set; }

        ///<summary>
        ///The primary contact phone number of the company
        ///</summary>
        [ApiMember(Description="The primary contact phone number of the company", IsRequired=true)]
        public virtual string CompanyPhone { get; set; }

        ///<summary>
        ///The first line of the company’s address (e.g., street name and number)
        ///</summary>
        [ApiMember(Description="The first line of the company’s address (e.g., street name and number)", IsRequired=true)]
        public virtual string Address1 { get; set; }

        ///<summary>
        ///The second line of the company’s address (optional)
        ///</summary>
        [ApiMember(Description="The second line of the company’s address (optional)")]
        public virtual string Address2 { get; set; }

        ///<summary>
        ///The third line of the company’s address (optional)
        ///</summary>
        [ApiMember(Description="The third line of the company’s address (optional)")]
        public virtual string Address3 { get; set; }

        ///<summary>
        ///The city where the company is located (optional)
        ///</summary>
        [ApiMember(Description="The city where the company is located (optional)")]
        public virtual string City { get; set; }

        ///<summary>
        ///The postal or ZIP code of the company’s address
        ///</summary>
        [ApiMember(Description="The postal or ZIP code of the company’s address", IsRequired=true)]
        public virtual string Postcode { get; set; }

        ///<summary>
        ///The country where the company is registered
        ///</summary>
        [ApiMember(Description="The country where the company is registered", IsRequired=true)]
        public virtual string Country { get; set; }

        ///<summary>
        ///The classification of the company (e.g., LLC, Corporation, Sole Proprietorship)
        ///</summary>
        [ApiMember(Description="The classification of the company (e.g., LLC, Corporation, Sole Proprietorship)", IsRequired=true)]
        public virtual string CompanyType { get; set; }

        ///<summary>
        ///The industry sector the company operates in
        ///</summary>
        [ApiMember(Description="The industry sector the company operates in", IsRequired=true)]
        public virtual string CompanyIndustry { get; set; }

        ///<summary>
        ///The trade body, network, or affiliation the company is a member of (if applicable)
        ///</summary>
        [ApiMember(Description="The trade body, network, or affiliation the company is a member of (if applicable)")]
        public virtual string CompanyNetwork { get; set; }

        ///<summary>
        ///Indicates agreement to the terms and conditions (required)
        ///</summary>
        [ApiMember(Description="Indicates agreement to the terms and conditions (required)", IsRequired=true)]
        public virtual bool AgreeToTerms { get; set; }

        ///<summary>
        ///Indicates agreement to the data protection statement (required)
        ///</summary>
        [ApiMember(Description="Indicates agreement to the data protection statement (required)", IsRequired=true)]
        public virtual bool AgreeToDataProtection { get; set; }

        ///<summary>
        ///Indicates consent to be contacted (optional)
        ///</summary>
        [ApiMember(Description="Indicates consent to be contacted (optional)")]
        public virtual bool AgreeToContact { get; set; }

        ///<summary>
        ///Indicates agreement to the privacy policy (required)
        ///</summary>
        [ApiMember(Description="Indicates agreement to the privacy policy (required)", IsRequired=true)]
        public virtual bool AgreeToPrivacy { get; set; }

        ///<summary>
        ///An optional voucher code for discounts or promotions
        ///</summary>
        [ApiMember(Description="An optional voucher code for discounts or promotions")]
        public virtual string VoucherCode { get; set; }

        ///<summary>
        ///An optional code that grants access to certain features or subscriptions
        ///</summary>
        [ApiMember(Description="An optional code that grants access to certain features or subscriptions")]
        public virtual string AccountActivationCode { get; set; }

        ///<summary>
        ///The company's VAT registration number (if applicable)
        ///</summary>
        [ApiMember(Description="The company's VAT registration number (if applicable)")]
        public virtual string VATNumber { get; set; }

        ///<summary>
        ///The country where the company is VAT-registered
        ///</summary>
        [ApiMember(Description="The country where the company is VAT-registered")]
        public virtual string VATCountry { get; set; }
    }

    [DataContract]
    public partial class RegisterAccountTemplate
    {
    }

    public partial class RegisterAccountTemplateData
        : BaseResponse
    {
        ///<summary>
        ///The request body of the RegisterAccount endpoint
        ///</summary>
        [ApiMember(Description="The request body of the RegisterAccount endpoint")]
        public virtual RegisterAccountRequest Request { get; set; }

        ///<summary>
        ///Reference data to fill out the RegisterAccount body
        ///</summary>
        [ApiMember(Description="Reference data to fill out the RegisterAccount body")]
        public virtual ReferenceData ReferenceData { get; set; }
    }

    [DataContract]
    public partial class RegisterAccountTemplateResponse
    {
        ///<summary>
        ///The response data
        ///</summary>
        [DataMember]
        [ApiMember(Description="The response data")]
        public virtual RegisterAccountTemplateData Data { get; set; }
    }

}

namespace SanctionsSearch.Api2.ServiceModel.Operations.Base
{
    public partial class ArrayOfResponseError
        : List<ResponseError>
    {
    }

    public partial class BaseResponse
        : IBaseDataResponse, IHasResponseStatus
    {
        ///<summary>
        ///The status of the response
        ///</summary>
        [ApiMember(Description="The status of the response")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public partial class ResponseError
    {
        public ResponseError()
        {
            Meta = new Dictionary<string, string>{};
        }

        [DataMember(Order=1)]
        public virtual string ErrorCode { get; set; }

        [DataMember(Order=2)]
        public virtual string FieldName { get; set; }

        [DataMember(Order=3)]
        public virtual string Message { get; set; }

        [DataMember(Order=4)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public partial class ResponseStatus
    {
        public ResponseStatus()
        {
            Meta = new Dictionary<string, string>{};
        }

        [DataMember(Order=1)]
        public virtual string ErrorCode { get; set; }

        [DataMember(Order=2)]
        public virtual string Message { get; set; }

        [DataMember(Order=3)]
        public virtual string StackTrace { get; set; }

        [DataMember(Order=4)]
        public virtual ArrayOfResponseError Errors { get; set; }

        [DataMember(Order=5)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

}

namespace SanctionsSearch.Api2.ServiceModel.Types
{
    public partial class ArrayOfCompanyIndustry
        : List<string>
    {
    }

    public partial class ArrayOfCompanyType
        : List<string>
    {
    }

    public partial class ArrayOfCountry
        : List<string>
    {
    }

    public partial class ArrayOfVATCountry
        : List<string>
    {
    }

}

C# RegisterAccountTemplate DTOs

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.

GET /account/register/template HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml

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

<RegisterAccountTemplateResponse 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>
    <ReferenceData>
      <CompanyIndustries>
        <CompanyIndustry>String</CompanyIndustry>
      </CompanyIndustries>
      <CompanyTypes>
        <CompanyType>String</CompanyType>
      </CompanyTypes>
      <ContactStatement>String</ContactStatement>
      <Countries>
        <Country>String</Country>
      </Countries>
      <DataProtectionStatement>String</DataProtectionStatement>
      <PrivacyPolicyLink>String</PrivacyPolicyLink>
      <TermsAndConditionsLink>String</TermsAndConditionsLink>
      <VATCountries>
        <VATCountry>String</VATCountry>
      </VATCountries>
    </ReferenceData>
    <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>
  </Data>
</RegisterAccountTemplateResponse>