Links¶

All requests require clientID and developerAPIKey parameters for authentication.

Base URL: https://api-sandboxdash.norcapsecurities.com

Endpoints¶

PUT /v3/createLink
POST /v3/deleteLink
POST /v3/getAllLinks
POST /v3/getLink
GET /v3/links

`PUT /v3/createLink`¶

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

Parameters¶

Parameter	Type	Required	Description
`firstEntryType`	enum	Yes	The first entry type for createLink is an account. `Account` is the only valid value for this parameter. (String enumeration)
`firstEntry`	string	Yes	Account ID to be linked to an entity, individual party, or account
`relatedEntryType`	enum	Yes	The type of the resource to be linked to the account. Valid enumerated string values are: `"Account"`, `"IndivACParty"`, or `"EntityACParty"`
`relatedEntry`	string	Yes	Resource ID of the related entry, to be linked to the first entry
`linkType`	enum	Yes	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`	string	No	Additional user defined information related to this link
`primary_value`	int	No	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. Defaults to 0 (not primary) when omitted or empty. When set to 1, there may only be one primary party per account (`firstEntry`) and the `relatedEntry` must be an `"IndivACParty"`.

Example Request¶

curl -k -X PUT https://api-sandboxdash.norcapsecurities.com/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¶

Field	Type	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

Field	Type	Description
`id`	string	Unique identifier of the link

Example Response¶

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

Error Responses¶

In addition to standard validation errors (missing parameters, invalid enumeration values), the request is rejected when:

HTTP Status	Condition
400	`firstEntry` and `relatedEntry` are the same resource (cannot link a resource to itself).
400	A link between `firstEntry` and `relatedEntry` already exists.
422	`primary_value` is 1 and `relatedEntryType` is not `IndivACParty`.
422	`primary_value` is 1 and the account (`firstEntry`) already has a primary party.

`POST /v3/deleteLink`¶

This method is used to delete a particular link between an account and a party or other account. The Link ID is required as a request parameter to delete a link.

Parameters¶

Parameter	Type	Required	Description
`id`	integer	Yes	Link ID that is generated by the API once a link is created (createLink)

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/deleteLink
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d id=3212679

Response¶

Returns the standard {statusCode, statusDesc} status envelope; no resource fields are returned.

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Link has been deleted successfully!"
}

`POST /v3/getAllLinks`¶

Deprecated

This endpoint is deprecated and may be removed in a future version.

This endpoint has been deprecated, it is superseded by /v3/links

Parameters¶

Parameter	Type	Required	Description
`accountId`	string	Yes	Link account ID that is generated by the API once a link is created(createLink)

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/getAllLinks
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d accountId=A12345

Response¶

Field	Type	Description
`linkDetails`	object[]	Array of link objects; each includes all information of the matched link (id, firstEntryType, firstEntry, relatedEntryType, relatedEntry, linkType, notes)

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "linkDetails": [
    {
      "id": "330",
      "firstEntryType": "Account",
      "firstEntry": "A51242",
      "relatedEntry": "P99324",
      "relatedEntryType": "IndivACParty",
      "linkType": "owner",
      "notes": ""
    },
    {
      "id": "345",
      "firstEntryType": "Account",
      "firstEntry": "A51242",
      "relatedEntry": "E67648",
      "relatedEntryType": "EntityACParty",
      "linkType": "owner",
      "notes": ""
    }
  ]
}

`POST /v3/getLink`¶

This method is used to get information about a Link between an account and a party or other account. The Link ID is required as a request parameter to get the Link information.

Parameters¶

Parameter	Type	Required	Description
`id`	string	Yes	Link ID that is generated by the API once a link is created (createLink)

Example Request¶

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/v3/getLink
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d id=679

Response¶

Field	Type	Description
`linkDetails`	object[]	Array of link objects; each includes all information of the matched link (id, firstEntryType, firstEntry, relatedEntryType, relatedEntry, linkType, notes)

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "linkDetails": [
    {
      "id": "679",
      "firstEntryType": "Account",
      "firstEntry": "A12452",
      "relatedEntry": "A52753",
      "relatedEntryType": "Account",
      "linkType": "owner",
      "notes": "Linked accounts"
    }
  ]
}

`GET /v3/links`¶

Fetch a paginated list of link resources associated with this client. Links are ordered by created date with the most recently created link at index zero.

Permissions¶

This method requires the scope link.read to be granted to the calling API key.

This scope can be assigned by system admins through the API or Transact Portal.

Authorization¶

Header: Authorization: Bearer clientId:apiKey

Query Parameters¶

Parameter	Type	Default	Description
`offset`	integer	0	The row index at which to begin the query. Zero represents the first link in the list.
`limit`	integer	10	The maximum number of links to return. Must be between 1 and the maximum page size (500 by default; may vary by deployment).
`deleted`	boolean	false	When `true`, include deleted links (`virtualStatus` = `DELETED`) in the response.
`filter`	string (JSON)		Filter results by specific fields. See Working with List Endpoints.
`sort`	string		Sort order specification. See Working with List Endpoints.

Filtering and Sorting¶

For more information see Working with List Endpoints.

Response Fields¶

The response envelope contains a links array of link objects and a pagination object.

Field	Type	Description
`statusCode`	string	Status code of the response. `101` indicates success.
`statusDesc`	string	Human-readable status description.
`links`	object[]	Array of link objects matching the query. Each object contains the fields described below.
`pagination`	object	Pagination metadata for the result set.

Each object in the links array contains:

Field	Type	Description
`id`	string	Unique identifier of the link.
`firstEntryType`	string	Type of the first entry in the link. Always `Account`.
`firstEntry`	string	Account ID of the first entry.
`relatedEntry`	string	Resource ID of the related entry linked to the first entry.
`relatedEntryType`	string	Type of the related entry. One of `Account`, `IndivACParty`, or `EntityACParty`.
`linkType`	string	Relationship between the first entry and the related entry. One of `owner`, `secondary`, `manager`, `member`, `officer`, `director`, `spouse`, `beneficiary`, `trustee`, `custodian`, `parentco`, `subsidiary`, `other`, `acgroup`, `advisor`, `attorney`, `proxy`.
`notes`	string	Additional user-defined information related to the link.

The pagination object contains:

Field	Type	Description
`totalRecords`	integer	Total number of links matching the query, ignoring pagination.
`startIndex`	integer	Zero-based index of the first returned record (equal to the requested `offset`).
`endIndex`	integer	Zero-based index of the last returned record (`offset` + number of returned records − 1). Note that an `offset` greater than or equal to `totalRecords` is rejected with a 422 error, so a successful response always contains at least one record.

Example Response¶

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "links": [
    {
      "id": "345",
      "firstEntryType": "Account",
      "firstEntry": "A51242",
      "relatedEntry": "E67648",
      "relatedEntryType": "EntityACParty",
      "linkType": "owner",
      "notes": ""
    },
    {
      "id": "330",
      "firstEntryType": "Account",
      "firstEntry": "A51242",
      "relatedEntry": "P99324",
      "relatedEntryType": "IndivACParty",
      "linkType": "owner",
      "notes": ""
    }
  ],
  "pagination": {
    "totalRecords": 2,
    "startIndex": 0,
    "endIndex": 1
  }
}

Links¶

Endpoints¶

PUT /v3/createLink¶

Parameters¶

Example Request¶

Response¶

Example Response¶

Error Responses¶

POST /v3/deleteLink¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getAllLinks¶

Parameters¶

Example Request¶

Response¶

Example Response¶

POST /v3/getLink¶

Parameters¶

Example Request¶

Response¶

Example Response¶

GET /v3/links¶

Permissions¶

Authorization¶

Query Parameters¶

Filtering and Sorting¶

Response Fields¶

Example Response¶

`PUT /v3/createLink`¶

`POST /v3/deleteLink`¶

`POST /v3/getAllLinks`¶

`POST /v3/getLink`¶

`GET /v3/links`¶