Residence

  • Provide the Residential Address where the applicant physically resides within Residence element.

    • If the mailing address is different from the address provided in Residence element, THEN you will also include MailingAddress element.

  • Fully Disclosed Client (Individual, Joint, Retirement, Org, Trust)

  • Advisor Client (Individual, Joint, Retirement, Org, Trust)

  • Non-Disclosed- NonQI Client (Individual, Joint, Org, Trust)

  • Non-Disclosed- QI Client with Trading (Individual, Joint, Org, Trust)

  • Non-Disclosed- QI Client with No Trading (Individual, Joint, Org, Trust)

  • Individual: AccountHolder

  • Retirement: AccountHolderDetails, PrimaryBeneficiary

  • Joint: FirstHolderDetails, SecondHolderDetails

  • Org: AssociatedIndividual

  • Trust: Individual

  • Post Office Box is not accepted for Residential Address.

  • Our system validates street_1 and street_2 included within Residence attribute to ensure Post Office Box address is not provided.

    • An error will be thrown if the below combinations are included within street_1 OR street_2:

  • PB

  • PO Box

  • Post Office Box

  • P.O. Box

  • In care of

  • General Delivery

Copy
Regular Expression to validate street_1 and street_2: 
English: (?:P(?:ost(?:al)?)?[\.\-\s]*(?:(?:O(?:ffice)?[\.\\s]*)?B(?:ox|in|\b|\d)|o(?:ffice|\b)(?:[-\s]*\d)|code)|box[-\s]*\d)
Chinese Simplified: PO Box    (?i)\b((邮政信箱) [0-9]*)\b
Chinese Traditional: PO Box   (?i)\b((郵政信箱) [0-9]*)\b
Copy
Error if PO Box is included within the Residence element.
<Application External_ID="tester12345" Status="Error">
      <Customer>John Smith</Customer>
      <Errors>
        <Error>PO Box not accepted as residential address</Error>
      </Errors>
    </Application>
 

XSD

Copy 
<xsd:element name="Residence" max use="Required" minOccurs="1" maxOccurs="1" /> 
<xsd:sequence>
 <xsd:attribute name="country" type="country" use="Required"/>
 <xsd:attribute name="state" type="state" use="Required except for ND-QI with no access to trading" />
 <xsd:attribute name="postal_code" type="String" use="Required except for ND-QI with no access to trading" />
 <xsd:attribute name="city" type="String" use="Required except for ND-QI with no access to trading"/>
 <xsd:attribute name="street_1" type="String" use="Required except for ND-QI with no access to trading" />
 <xsd:attribute name="street_2" type="String" use="Optional" />
</xsd:sequence>
 

Parameters

Name

Type

Description

country

3 Digit ISO Code

Country which the applicant resides.

state

3166-2 ISO Code

State/Province which the applicant resides.

city

String; Max characters 100

City which the applicant resides.

postal_code

String; Max characters 20

Postal / Zip code.

For countries that do not provide postal code, please enter “00000"

street_1

String; Max characters 200

Street which applicant resides

street_2

String; Max characters 200

Street which applicant resides
Copy
Fully-Disclosed, Advisor, ND-NonQI, and ND-QI with Trading Access
<AccountHolderDetails external_id="TestTester1234" same_mail_address="true">
<Residence city="Stamford" country="USA" postal_code="06901" state="US-CT" street_1="2 Pickwick Plaza"/>
 
Copy
ND-QI with No Trading Access
<AccountHolderDetails external_id="TestTester1234" same_mail_address="true">
<Residence country="USA" />