Create Link

This method is used to link an account (createAccount) to a party (either individual or entity) or to another account.

Request Method : PUT

Request Parameters

Parameter Required Type Description
clientID yes string Transact API Client ID
developerAPIKey yes string Transact API Developer Key
firstEntryType yes string The first entry type for createLink is an Account
firstEntry yes conditional Account ID to be linked to an Entity or Individual Party or another Account
relatedEntryType yes string The second entry type for createLink: Account, IndivACParty, or EntityACParty
relatedEntry yes conditional Account ID or individual/entity party ID to be linked to the account(first entry)
linkType yes conditional Link description: owner, manager, member, officer, director, spouse, beneficiary, trustee, custodian, parentco, subsidiary, other, acgroup
notes no string Describe relationship between parties
primary_value yes conditional Yes/No - you should enter either 1 (yes) or 0 (no)

Sample Request

curl -k -X PUT https://api.norcapsecurities.com/tapiv3/index.php/v3/createLink
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d firstEntryType=Account
-d firstEntry=A56465
-d relatedEntryType=IndivACParty
-d relatedEntry=P12345
-d primary_value=0
-d linkType=member
-d notes=Notes

Response Parameters

Parameter Type Description
statusCode string API Status Code
statusDesc string API Status Description
linkId integer Unique identifier code for the Link

Sample Response

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "linkDetails": [
    true,
    [
      {
        "id": "11"
      }
    ]
  ]
}
Click on the "Test it yourself" button to see how it works
Click on the "Error Codes" button to see list of error codes

Custodial Account