Update Party

This method is used to update fields related to a particular individual party record in Transact API. The Party ID must be specified as a request parameter to update the record.

Request Method : POST

Request Parameters

Parameter Required Type Description
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 when an individual party is created(createParty)
domicile no conditional Is the party a U.S. Citizen, U.S. Resident, or non-Resident
firstName no string Party's First Name
middleInitial no string Party's Middle Initial
lastName no string Party's Last Name
socialSecurityNumber no string The Party's Full SSN ( xxx-xx-xxxx )
dob no string The Party's Date of Birth (MM-DD-YYYY)
primCountry no string The country in which the Party's physical address resides
primAddress1 no string The Party's physical address, line 1
primAddress2 no string The Party's physical address, line 2
primCity no string The city of the Party's physical address
primState no string Party's state of residence (It is optional for non-U.S. parties)
primZip no string Party's Zip/Postal Code
emailAddress no string Party's primary email address
emailAddress2 no string Party's secondary email address
phone no integer Party's primary phone number
phone2 no integer Party's secondary 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 line 1
empAddress2 no string Employer address line 2
empCity no string Employer city
empState no string Employer state
empZip no string Employer zip
empName no string Employer Name
invest_to no conditional 0 - I will be investing for myself 1 - I will be investing on behalf of another person or entity"
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 can be added to an account separated by commas. These are generally completed in the TAPI Admin interface or with question-based tag generation.
updatedIpAddress no integer IP Address associated with the updateParty 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

Sample Request

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/updateParty
 -d developerAPIKey=somedeveloperkey
 -d clientID=someclientid
 -d partyId=P98542
 -d domicile=U.S. citizen
 -d firstName=John
 -d middleInitial=D
 -d lastName=Smith
 -d socialSecurityNumber=112-22-3333
 -d dob=28-02-1975
 -d primCountry=USA
 -d primAddress1=PEACHTREE PLACE
 -d primAddress2=TREE PLACE
 -d primCity=Atlanta
 -d primState=GA
 -d primZip=30318
 -d emailAddress=john@gmail.com
 -d emailAddress2=PEACHTREE PLACE
 -d phone=11223364585
 -d phone2=9876543210
 -d occupation=Developer
 -d associatedPerson=Yes
 -d invest_to=0
 -d empStatus=Employed
 -d empName=Name
 -d empCountry=USA
 -d empAddress1=PEACHTREE PLACE
 -d empAddress2=PEACHTREE PLACE
 -d empCity=Atlanta
 -d empState=GA
 -d empZip=30318
 -d currentAnnIncome=200000
 -d avgAnnIncome=200000
 -d currentHouseholdIncome=200000
 -d avgHouseholdIncome=200000
 -d householdNetworth=200000
 -d KYCstatus=pending
 -d AMLstatus=pending
 -d AMLdate=02-15-2016
 -d tags=tags
 -d updatedIpAddress=10.0.0.111
 -d field1=some text
 -d field2=some text
 -d field3=some text
 -d notes=Notes Added

Response Parameters

Parameter Type Description
statusCode string API Status Code
statusDesc string API Status Description
partyId integer Unique identifier code for the party

Sample Response

{
	"statusCode": "101",
	"statusDesc": "Ok",
	"partyDetails": [true, [{
		"partyId": "P39944",
		"KYCstatus": "Pending",
		"AMLstatus": "Pending"
	}]]
}
Click on the "Test it yourself" button to see how it works
Click on the "Error Codes" button to see list of error codes

Marketplace-as-a-Service