| clientID |
yes |
string |
Transact API Client ID |
| developerAPIKey |
yes |
string |
Transact API Developer Key |
| partyId |
yes |
integer |
Party ID that is generated by the API once an entity party is created (createEntity). |
| domicile |
no |
conditional |
U.S. Domicile or non-U.S. |
| entityName |
no |
string |
Name of the Entity |
| entityType |
no |
conditional |
Revocable Trust, Irrevocable Trust, Limited Partnership, LLC, Corporation |
| entityDesc |
no |
string |
Description of the entity. |
| ein |
no |
string |
The entity's Employer Identification number (EIN) or Individual Social Security Number if applicable. |
| primCountry |
no |
string |
The country in which the entity's primary physical address is located. |
| primAddress1 |
no |
string |
The entity's primary physical address, Line 1 |
| primAddress2 |
no |
string |
The entity's primary physical address, Line 2 |
| primCity |
no |
string |
The city in which the entity's primary physical address is located. |
| primState |
no |
string |
The state ( must be two letter code only ) in which the entity's primary physical address is located. (It is optional for non-U.S. entities) |
| primZip |
no |
string |
The ZIP / postal code of the entity's primary physical address. |
| emailAddress |
no |
string |
Entity party's primary email address |
| emailAddress2 |
no |
string |
Entity party's secondary email address |
| phone |
no |
integer |
Entity party's primary phone number |
| phone2 |
no |
integer |
Entity party's secondary phone number |
| totalAssets |
no |
integer |
Total amount of the entity's assets. |
| ownersAI |
no |
string |
Yes or No. Are the owners/members of the entity accredited investors? |
| 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 can be added to an account separated by commas. These are generally completed in the TAPI Admin interface or with question-based tag generation. |
| notes |
no |
string |
Free form text for any notes that need to be added to the entity party. |
| updatedIpAddress |
yes |
integer |
IP Address associated with the updateEntity method call. |
