searchEntity

This method is used to search all entity parties for a specific keyword within the party information and will return all matches for that keyword.

Request Parameters

ParameterRequiredTypeDescription
clientIDyesstringTransactAPI Client ID
developerAPIKeyyesstringTransactAPI Developer Key
searchKeywordyesstringKeyword to search within all entity parties

Sample Request

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/searchEntity
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d searchKeyword=E45632

Response Parameters

ParameterTypeDescription
statusCodestringAPI Status Code
statusDescstringAPI Status Description
entityDetailsstringArray of entity includes all information of the matched entities

Sample Response

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "entityDetails": [
    {
      "partyId": "E45632",
      "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": "[email protected]",
      "emailAddress2": "[email protected]",
      "phone": "1234567890",
      "phone2": "2147483647",
      "totalAssets": "3",
      "ownersAI": "no",
      "KYCstatus": "pending",
      "AMLstatus": "pending",
      "AMLdate": "02-15-2016",
      "tags": "Tags",
      "notes": "Notes Added"
    }
  ]
}

Test it Yourself!

Language
Click Try It! to start a request and see the response here!