| clientID |
yes |
string |
Transact API Client ID |
| developerAPIKey |
yes |
string |
Transact API Developer Key |
| domicile |
yes |
conditional |
Is the party a U.S. Citizen, U.S. Resident, or non-resident |
| firstName |
yes |
string |
Party's First Name |
| middleInitial |
no |
string |
Party's Middle Initial |
| lastName |
yes |
string |
Party's Last Name |
| socialSecurityNumber |
no |
string |
The Party's Full SSN ( xxx-xx-xxxx ) |
| dob |
yes |
string |
The Party's Date of Birth (MM-DD-YYYY) |
| primCountry |
yes |
string |
The country in which the Party's physical address resides |
| primAddress1 |
yes |
string |
The Party's physical address, line 1 |
| primAddress2 |
no |
string |
The Party's physical address, line 2 |
| primCity |
yes |
string |
The city of the Party's physical address |
| primState |
yes |
string |
Party's residence state ( must be two letter code only ) (It is optional for non-us parties) |
| primZip |
yes |
string |
Zip code |
| emailAddress |
yes |
string |
Party's contact email address |
| emailAddress2 |
no |
string |
Party's contact email address |
| phone |
no |
integer |
Party's contact phone number |
| phone2 |
no |
integer |
Party's contact phone number |
| occupation |
no |
string |
Party's occupation |
| associatedPerson |
no |
conditional |
Yes or No - Is the party associated with a broker dealer? |
| empCountry |
no |
string |
Employer country |
| empAddress1 |
no |
string |
Employer address 1 |
| empAddress2 |
no |
string |
Employer address 2 |
| empCity |
no |
string |
Employer city |
| empState |
no |
string |
Employer state |
| empZip |
no |
string |
Employer zip |
| empName |
no |
string |
Employer Name |
| currentAnnIncome |
no |
integer |
Party's current annual income |
| avgAnnIncome |
no |
integer |
Party's average income over the past 2 years |
| currentHouseholdIncome |
no |
integer |
Party's household income |
| avgHouseholdIncome |
no |
integer |
Party's average household income |
| householdNetworth |
no |
integer |
Household net worth |
| KYCstatus |
no |
conditional |
Know Your Customer(KYC) Status: Pending, Auto Approved, Manually Approved, Disapproved. Default status is "Pending" |
| AMLstatus |
no |
conditional |
Anti-Money Laundering(AML) Status: Pending, Auto Approved, Manually Approved, Disapproved. Default status is "Pending" |
| AMLdate |
no |
string |
Date of Anti-Money Laundering(AML) status update from the default "Pending" status. |
| tags |
no |
string |
Up to 10 tags, comma separated. Generally completed in the Admin interface or with question-based tag generation |
| createdIpAddress |
no |
integer |
IP Address associated with the createParty method call. |
| notes |
no |
string |
Free form text for any notes that need to be added to the party. |
| empStatus |
no |
conditional |
Select any one employee status.(eg: Employed, Not Employed, Retired, Student) |
| field1 |
no |
string |
Additional information relating to the party. Custom Field 1 |
| field2 |
no |
string |
Additional information relating to the party. Custom Field 2 |
| field3 |
no |
string |
Additional information relating to the party. Custom Field 3 |
| invest_to |
no |
conditional |
0 - I will be investing for myself
1 - I will be investing on behalf of another person or entity" |
