ProhibitedCountryQuestionnaire
https://[domain]/ws/eca/update
-
If citizenship, citizenship2, citizenship3 or CountryOfBirth is prohibited country then ProhibitedCountryQuestionnaire (Task 3442) will be assigned to the account.
-
List of Prohibited Countries can be obtained using /getEnumerations
-
Who is this applicable for?
-
Fully Disclosed Client (Individual, Joint, Retirement)
-
Advisor Client (Individual, Joint, Retirement)
-
Non-Disclosed- NonQI Client (Individual/Joint)
-
Non-Disclosed- QI Client with Trading (Individual/Joint)
-
Non-Disclosed- QI Client with No Trading (Individual/Joint)
Request Parameters
|
Name |
Type |
Description |
|---|---|---|
|
reference_account_id |
String |
IBKR account ID of the client account which ProhibitedCountryQuestionnaire is being submitted for. |
|
code |
PASSPORT CITIZENSHIP BUSINESSDEALINGS FINANCIALACCOUNTS RESIDENT MULTI BIRTH |
PASSPORT: Do you currently hold a passport from a Prohibited Country? CITIZENSHIP: Do you currently hold a citizenship from a Prohibited Country? BUSINESSDEALINGS: Do you currently have business dealings in a Prohibited Country? FINANCIALACCOUNTS: Do you currently have financial accounts in a Prohibited Country? RESIDENT: Do you currently have plans to reside in a Prohibited Country? MULTI: Do you hold citizenship and/or residency status in multiple countries BIRTH: Were you born in any of the following countries <Prohibited Country> |
|
external_id |
String |
External ID associated with the account holder. This should be the same external ID that was included in the XML request to create the account. |
|
status |
true false |
|
|
details |
string |
Required if status="true"; provide a description. |
XSD
<xsd:complexType name="ProhibitedCountryQuestionnaire">
<xsd:element name="ProhibitedCountryQuestionnaire" type="ProhibitedCountryQuestionnaireList" minOccurs="0" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
Required if Prohibited Country is included in
citizenship or CountryOfBirth within AccountHolderDetails,
FirstHolderDetails or SecondHolderDetails node.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</<xsd:complexType>
<xsd:complexType name="ProhibitedCountryQuestionnaireList">
<xsd:sequence>
<xsd:element name="ProhibitedQuestionnaireDetail" type="ProhibitedQuestionnaireDetail"
minOccurs="1" maxOccurs="unbounded" />
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="ProhibitedQuestionnaireDetail">
<xsd:annotation>
<xsd:documentation>
Prohibited Country Questionnaire details.
</xsd:documentation>
</xsd:annotation>
<xsd:attribute name="code" type="ProhibitedQuestionnaireCode" use="required" />
<xsd:attribute name="status" type="xsd:boolean" use="required" />
<xsd:attribute name="details" type="xsd:string" use="optional" />
</xsd:complexType>
<xsd:simpleType name="ProhibitedQuestionnaireCode">
<xsd:restriction base="xsd:token">
<xsd:enumeration value="PASSPORT" />
<xsd:enumeration value="CITIZENSHIP" />
<xsd:enumeration value="BUSINESSDEALINGS" />
<xsd:enumeration value="FINANCIALACCOUNTS" />
<xsd:enumeration value="RESIDENT" />
<xsd:enumeration value="MULTI" />
<xsd:enumeration value="BIRTH" />
</xsd:restriction>
</xsd:simpleType>Sample
<?xml version="1.0" encoding="US-ASCII" standalone="yes"?>
<AcctMgmtRequests xmlns=http://www.interactivebrokers.com/schemas/IBCust_import>
<ProhibitedCountryQuestionnaire reference_account_id="U1234567" external_id="firstholder1234">
<ProhibitedQuestionnaireDetail code="PASSPORT" ="<InsertResponseHere>"/>
<ProhibitedQuestionnaireDetail code="BIRTH" detail="<InsertResponseHere>"/>
<ProhibitedQuestionnaireDetail code="CITIZENSHIP" details="<InsertResponseHere>"/>
<ProhibitedQuestionnaireDetail code="BUSINESSDEALINGS" status="true" details="<InsertResponseHere>"/>
<ProhibitedQuestionnaireDetail code="FINANCIALACCOUNTS" status="true" details="<InsertResponseHere>"/>
<ProhibitedQuestionnaireDetail code="RESIDENT" status="true" details="<InsertResponseHere>"/>
<ProhibitedQuestionnaireDetail code="MULTI" status="true" details="<InsertResponseHere>"/>
</ProhibitedCountryQuestionnaire>
</AcctMgmtRequests>
|
Name |
Type |
Description |
|---|---|---|
|
Execution_Date |
YYYY/MM/DD HH:MM:SS |
Date/Time which the file was processed by IBKR. |
|
Process_File |
FirmName_YYYY-MM-DD_######.xml |
File name of the request file. |
|
Client |
FirmName |
Name of the Counterparty |
|
Client_Master_Acct |
String |
Master account number |
| ProhibitedCountryQuestionnaire | String | Status of the request |
| reference_account_id | String | IBKR account ID of the advisor/broker client account which the request is being submitted for |
| request_status |
PROCESSED ERROR PENDING |
Status of the request |
| message | String | Status of the request. |
| request_id | Non-negative integer | Unique ID which IBKR assigns to the request. The ID can be used to query status request at a later time using //getAmRequestStatus endpoint |
| message | String | Includes details on the status of the request IF status=”PENDING" or "PROCESSED " |
| Pending_Tasks | <Tasks> | Includes pending tasks associated with the info change request IF status=”PENDING" |
| Errors | String | Includes error message if status=”ERROR” |
Sample
<?xml version='1.0' encoding='UTF-8'?>
<Process>
<Execution ECA_XML_Schema_Version="15-Nov-2018">
<Execution_Date>2020/02/20 00:44:38</Execution_Date>
<Process_File>TesterFA_2020-02-20_124438885_761126.xml</Process_File>
<Client>TesterFA</Client>
<Client_Master_Acct>F1234567</Client_Master_Acct>
</Execution>
<ProhibitedCountryQuestionnaire reference_account_id="U2088007" request_status="PROCESSED" message="Status of Request Here" request_id="50813"/>
<Documents>
<Document Form_Number="5709" File_Name="Prohibited Country Questionnaire Primary Holder" Status="completed"/>
<Document Form_Number="5710" File_Name="Prohibited Country Questionnaire Primary Review Task" Status="completed"/>
</Documents>
</ProhibitedCountryQuestionnaire>
</Process>
<?xml version='1.0' encoding='UTF-8'?>
<Process>
<Execution ECA_XML_Schema_Version="15-Nov-2018">
<Execution_Date>2020/02/20 00:44:38</Execution_Date>
<Process_File>TesterFA_2020-02-20_124438885_761126.xml</Process_File>
<Client>TesterFA</Client>
<Client_Master_Acct>F1234567</Client_Master_Acct>
</Execution>
<ProhibitedCountryQuestionnaire reference_account_id="U2088007" request_status="ERROR" request_id="50813">
<Error>Error Message Here</Error>
</UpdateAccountAlias>
</Process>
