Request Parameters

Parameter	Required	Type	Description
clientID	yes	string	Client ID associated with this request
developerAPIKey	yes	string	API key used to validate this request
firstEntryType	yes	enum	The first entry type for createLink is an account. `Account` is the only valid value for this parameter. (String enumeration)
firstEntry	yes	string	Account ID to be linked to an entity, individual party, or account
relatedEntryType	yes	enum	The type of the resource to be linked to the account. Valid enumerated string values are: `"Account"`, `"IndivACParty"`, or `"EntityACParty"`
relatedEntry	yes	string	Resource ID of the related entry, to be linked to the first entry
linkType	yes	enum	Describes the relationship between the target account and the linked resource. Note: if you want the party/entity to be sent documents through Docusign as the secondary party, you must use the value 'secondary'. Valid enumerated string values are: `"owner"`, `"secondary"`, `"manager"`, `"member"`, `"officer"`, `"director"`, `"spouse"`, `"beneficiary"`, `"trustee"`, `"custodian"`, `"parentco"`, `"subsidiary"`, `"other"`, `"acgroup"`, `"advisor"`, `"attorney"`, `"proxy"`
notes	no	string	Additional user defined information related to this link
primary_value	yes	int	Indicates that the party linked to this account will be the one who is the signatory authority on the account and the one to receive subscription documents. 1 = primary, 0 = not primary. There may only be one primary party per account (`firstEntry`). The `relatedEntry` must be an `"IndivACParty"`.

Sample Request

curl -k -X PUT https://api-sandboxdash.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
linkDetails	string[]	The first value should be ignored. The second value is an array with one element, the new <object> created by this request. See details below

linkDetails Parameters	Type	Description
id	string	Unique identifier of the link

Sample Response

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "linkDetails": [
    true,
    [
      {
        "id": "11"
      }
    ]
  ]
}

Errors

HTTP response code	TAPI error code	Condition
404	103	Invalid authorization parameters
404	110	Not permitted to access the resource
404	111	Not authorized to invoke method
404	206	A primary party already exists for this account
400	1400	Cannot create a link to self (account to account)
400	1400	Link already exists
400	1400	Missing request parameter
404	1404	First entry does not exist
404	1404	Second entry does not exist
422	1422	Invalid first entry type
422	1422	Invalid related entry type
422	1422	Invalid link type
422	1422	Invalid primary party link definition

Test it Yourself!