AffiliationDetails

• Usage: Required IF AFFILIATION="true"

There two options for providing AffiliationDetails:

Option 1: Link to an existing IBKR EmployeeTrack Account

• Attributes

  XSD

  Copy

  <xsd:ComplexType name="AffiliationDetails" use="required IF AFFILIATION="true" />
  <xsd:attribute name="is_duplicate_stmt_requred" type="Boolean" use="Optional" />
  <xsd:sequence>
   <xsd:element name="affiliation_relationship" type="code" use="Required" />
   <xsd:element name="person_name" type="Boolean" use="Required" />
   <xsd:element name="company_id" type="String" use="Required" />
  </xsd:sequence>

  Parameters

  Name	Type	Description
  is_duplicate_stmt_required	true false	Indicates if IBKR should send duplicated statements to customers. For those included on FINRA Rule 3210 or equivalent on his/her jurisdiction, the expected answer is true, as they need to submit one copy to his/her employer compliance office.
  affiliation_relationship	Other Spouse Parent Child Self	Relationship of the affiliated person to the applicant.
  person_name	String	Name of the affiliated person.
  company_id	String	If the employer has an EmployeeTrack account with IBKR,  you can link the account to the EmployeeTrack account. The Employer will automatically receive duplicate statements for the account. Use /getEnumerations 'company_id' to query list of companies with active EmployeeTrack accounts at Interactive Brokers.

• Sample

  Copy

  <RegulatoryInformation>
   <RegulatoryDetail code="EmployeePubTrade" status="false"/>
   <RegulatoryDetail code="ControlPubTraded" status="false"/>
   <RegulatoryDetail code="AFFILIATION" status="true"/>
   <AffiliationDetails is_duplicate_stmt_requred="true" /> 
    <affiliation_relationship>Spouse</affiliation_relationship> 
    <person_name>John Smith</person_name>
    <company_id>14</company_id>                      
  </AffiliationDetails>
  </RegulatoryInformation>

Option 2: Provide Company Details (used if the Employer does not have an EmployeeTrack account with IBKR)

• Attributes

  XSD

  Copy

  <xsd:ComplexType name="AffiliationDetails" use="required IF AFFILIATION="true" />
  <xsd:attribute name="is_duplicate_stmt_requred" type="Boolean" use="Optional" />
  <xsd:sequence>
   <xsd:element name="affiliation_relationship" type="code" use="Required" />
   <xsd:element name="person_name" type="Boolean" use="Required" />
   <xsd:element name="company" type="String" use="Optional" />
  <xsd:element name="company_phone" type="String" use="Optional" />
   <xsd:element name="company_email_address" type="String" use="Optional" />
   <xsd:element name="company_mailing_address" use="Optional" />
   <xsd:attribute name="state" type="state" use="Optional" />
   <xsd:attribute name="country" type="country" use="Optional" />
   <xsd:attribute name="postal_code" type="Numeric" use="Optional" />
   <xsd:attribute name="city" type="String" use="Optional" />
   <xsd:attribute name="street_1" type="String" use="Optional" />
  </xsd:sequence>

  Parameters

  Name	Type	Description
  is_duplicate_stmt_required	true false	Indicates if IBKR should send duplicated statements to customers. For those included on FINRA Rule 3210 or equivalent on his/her jurisdiction, the expected answer is true, as they need to submit one copy to his/her employer compliance office.
  affiliation_relationship	Other Spouse Parent Child Self	Relationship of the affiliated person to the applicant.
  person_name	String; max characters 48	Name of the affiliated person.
  company	String; max characters 400	Name of the company where the affiliated person is employed.
  company_phone	String; max characters 18	Phone number of the compliance officer at the company. We use Google API to validate the Phone Number. The API allows for country code to be passed along with the phone number. Google Phone Library to version 8.12.2 https://github.com/google/libphonenumber
  company_email_address	String; max characters 80	Email address of the compliance officer at the company. We validate the email address using Regular Expression (REGEX) ^[A-Z0-9][A-Z0-9._%+-]{0,63}@(?:(?=[A-Z0-9-]{1,63}[.])[A-Z0-9]+(?:-[A-Z0-9]+)*[.]){1,8}[A-Z]{2,63}$
  country	3 Digit ISO Code	Country which the employer is located.
  state	3166-2 ISO Code	State/Province which the employer is located.
  city	String; Max characters 100	City which the employer is located.
  postal_code	String; Max characters 20	Postal / Zip code. For countries that do not provide postal code, please enter “00000"

• Sample

  Copy

  <RegulatoryInformation>
   <RegulatoryDetail code="EmployeePubTrade" status="false"/>
   <RegulatoryDetail code="ControlPubTraded" status="false"/>
   <RegulatoryDetail code="AFFILIATION" status="true"/>
    <AffiliationDetails is_duplicate_stmt_requred="true" />
    <affiliation_relationship>Wife</affiliation_relationship>
    <person_name>John Smith</person_name>
    <company>IBKR</company>
    <company_mailing_address postal_code="02110" country="USA" state="MA" city="Boston" street_1="175 Federal street, suite 825"/>
    <company_phone>18668253005</company_phone>
    <company_email_address>test@ibkr.com</company_email_address>
   </AffiliationDetails>
  </RegulatoryInformation>