| GET | /account/register/template | Get a template to create a new account |
|---|
// @DataContract
export class ResponseError
{
// @DataMember(Order=1)
public errorCode: string;
// @DataMember(Order=2)
public fieldName: string;
// @DataMember(Order=3)
public message: string;
// @DataMember(Order=4)
public meta: { [index: string]: string; };
public constructor(init?: Partial<ResponseError>) { (Object as any).assign(this, init); }
}
export class ArrayOfResponseError extends Array<ResponseError>
{
public constructor(init?: Partial<ArrayOfResponseError>) { super(); (Object as any).assign(this, init); }
}
// @DataContract
export class ResponseStatus
{
// @DataMember(Order=1)
public errorCode: string;
// @DataMember(Order=2)
public message: string;
// @DataMember(Order=3)
public stackTrace: string;
// @DataMember(Order=4)
public errors: ArrayOfResponseError;
// @DataMember(Order=5)
public meta: { [index: string]: string; };
public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}
export class BaseResponse implements IBaseDataResponse, IHasResponseStatus
{
/** @description The status of the response */
// @ApiMember(Description="The status of the response")
public responseStatus: ResponseStatus;
public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}
export class RegisterAccountRequest
{
/** @description The desired login username for the account */
// @ApiMember(Description="The desired login username for the account", IsRequired=true)
public username: string;
/** @description The password for account login */
// @ApiMember(Description="The password for account login", IsRequired=true)
public password: string;
/** @description The contact email address for the account holder */
// @ApiMember(Description="The contact email address for the account holder", IsRequired=true)
public email: string;
/** @description The full legal name of the account holder */
// @ApiMember(Description="The full legal name of the account holder", IsRequired=true)
public fullName: string;
/** @description The registered name of the company associated with this account */
// @ApiMember(Description="The registered name of the company associated with this account", IsRequired=true)
public companyName: string;
/** @description The primary contact phone number of the company */
// @ApiMember(Description="The primary contact phone number of the company", IsRequired=true)
public companyPhone: string;
/** @description The first line of the company’s address (e.g., street name and number) */
// @ApiMember(Description="The first line of the company’s address (e.g., street name and number)", IsRequired=true)
public address1: string;
/** @description The second line of the company’s address (optional) */
// @ApiMember(Description="The second line of the company’s address (optional)")
public address2: string;
/** @description The third line of the company’s address (optional) */
// @ApiMember(Description="The third line of the company’s address (optional)")
public address3: string;
/** @description The city where the company is located (optional) */
// @ApiMember(Description="The city where the company is located (optional)")
public city: string;
/** @description The postal or ZIP code of the company’s address */
// @ApiMember(Description="The postal or ZIP code of the company’s address", IsRequired=true)
public postcode: string;
/** @description The country where the company is registered */
// @ApiMember(Description="The country where the company is registered", IsRequired=true)
public country: string;
/** @description The classification of the company (e.g., LLC, Corporation, Sole Proprietorship) */
// @ApiMember(Description="The classification of the company (e.g., LLC, Corporation, Sole Proprietorship)", IsRequired=true)
public companyType: string;
/** @description The industry sector the company operates in */
// @ApiMember(Description="The industry sector the company operates in", IsRequired=true)
public companyIndustry: string;
/** @description The trade body, network, or affiliation the company is a member of (if applicable) */
// @ApiMember(Description="The trade body, network, or affiliation the company is a member of (if applicable)")
public companyNetwork: string;
/** @description Indicates agreement to the terms and conditions (required) */
// @ApiMember(Description="Indicates agreement to the terms and conditions (required)", IsRequired=true)
public agreeToTerms: boolean;
/** @description Indicates agreement to the data protection statement (required) */
// @ApiMember(Description="Indicates agreement to the data protection statement (required)", IsRequired=true)
public agreeToDataProtection: boolean;
/** @description Indicates consent to be contacted (optional) */
// @ApiMember(Description="Indicates consent to be contacted (optional)")
public agreeToContact: boolean;
/** @description Indicates agreement to the privacy policy (required) */
// @ApiMember(Description="Indicates agreement to the privacy policy (required)", IsRequired=true)
public agreeToPrivacy: boolean;
/** @description An optional voucher code for discounts or promotions */
// @ApiMember(Description="An optional voucher code for discounts or promotions")
public voucherCode: string;
/** @description An optional code that grants access to certain features or subscriptions */
// @ApiMember(Description="An optional code that grants access to certain features or subscriptions")
public accountActivationCode: string;
/** @description The company's VAT registration number (if applicable) */
// @ApiMember(Description="The company's VAT registration number (if applicable)")
public vatNumber: string;
/** @description The country where the company is VAT-registered */
// @ApiMember(Description="The country where the company is VAT-registered")
public vatCountry: string;
public constructor(init?: Partial<RegisterAccountRequest>) { (Object as any).assign(this, init); }
}
export class ArrayOfCountry extends Array<string>
{
public constructor(init?: Partial<ArrayOfCountry>) { super(); (Object as any).assign(this, init); }
}
export class ArrayOfCompanyIndustry extends Array<string>
{
public constructor(init?: Partial<ArrayOfCompanyIndustry>) { super(); (Object as any).assign(this, init); }
}
export class ArrayOfCompanyType extends Array<string>
{
public constructor(init?: Partial<ArrayOfCompanyType>) { super(); (Object as any).assign(this, init); }
}
export class ArrayOfVATCountry extends Array<string>
{
public constructor(init?: Partial<ArrayOfVATCountry>) { super(); (Object as any).assign(this, init); }
}
export class ReferenceData
{
/** @description A list of supported country values */
// @ApiMember(Description="A list of supported country values")
public countries: ArrayOfCountry;
/** @description A list of valid industry classifications for companies */
// @ApiMember(Description="A list of valid industry classifications for companies")
public companyIndustries: ArrayOfCompanyIndustry;
/** @description A list of accepted company types */
// @ApiMember(Description="A list of accepted company types")
public companyTypes: ArrayOfCompanyType;
/** @description A list of countries where VAT registration is recognized */
// @ApiMember(Description="A list of countries where VAT registration is recognized")
public vatCountries: ArrayOfVATCountry;
/** @description A URL linking to the terms and conditions document */
// @ApiMember(Description="A URL linking to the terms and conditions document")
public termsAndConditionsLink: string;
/** @description A URL linking to the privacy policy */
// @ApiMember(Description="A URL linking to the privacy policy")
public privacyPolicyLink: string;
/** @description The statement regarding contact preferences */
// @ApiMember(Description="The statement regarding contact preferences")
public contactStatement: string;
/** @description The statement outlining data protection policies */
// @ApiMember(Description="The statement outlining data protection policies")
public dataProtectionStatement: string;
public constructor(init?: Partial<ReferenceData>) { (Object as any).assign(this, init); }
}
export class RegisterAccountTemplateData extends BaseResponse
{
/** @description The request body of the RegisterAccount endpoint */
// @ApiMember(Description="The request body of the RegisterAccount endpoint")
public request: RegisterAccountRequest;
/** @description Reference data to fill out the RegisterAccount body */
// @ApiMember(Description="Reference data to fill out the RegisterAccount body")
public referenceData: ReferenceData;
public constructor(init?: Partial<RegisterAccountTemplateData>) { super(init); (Object as any).assign(this, init); }
}
// @DataContract
export class RegisterAccountTemplateResponse
{
/** @description The response data */
// @DataMember
// @ApiMember(Description="The response data")
public data: RegisterAccountTemplateData;
public constructor(init?: Partial<RegisterAccountTemplateResponse>) { (Object as any).assign(this, init); }
}
// @DataContract
export class RegisterAccountTemplate
{
public constructor(init?: Partial<RegisterAccountTemplate>) { (Object as any).assign(this, init); }
}
TypeScript RegisterAccountTemplate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>