Get Entity

This method is used to get information about an Entity Party. The entity Party ID is required as a request parameter to get the Entity Party information.

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 once an entity Party is created(createEntity)

Sample Request

curl -k -X POST
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d partyId=P12679

Response Parameters

Parameter Type Description
statusCode string API Status Code
statusDesc string API Status Description
entityDetails string Array of entity includes all information of the matched entity

Sample Response

  "statusCode": "101",
  "statusDesc": "Ok",
  "entityDetails": [
      "partyId": "P12679",
      "domicile": "U.S. citizen",
      "entityName": "Entity Name",
      "entityType": "revocable trust",
      "entityDesc": "Entity Description",
      "ein": "152152",
      "primCountry": "USA",
      "primAddress1": "PEACHTREE PLACE",
      "primAddress2": "PEACHTREE PLACE",
      "primCity": "Atlanta",
      "primState": "GA",
      "primZip": "30318",
      "emailAddress": "",
      "emailAddress2": "",
      "phone": "1234567890",
      "phone2": "2147483647",
      "totalAssets": "3",
      "ownersAI": "no",
      "KYCstatus": "pending",
      "AMLstatus": "pending",
      "AMLdate": "02-15-2016",
      "tags": "Tags",
      "notes": "Notes Added"
Click on the "Test it yourself" button to see how it works
Click on the "Error Codes" button to see list of error codes

ACH Distributions