Links¶
All requests require clientID and developerAPIKey parameters for authentication.
Base URL: https://api-sandboxdash.norcapsecurities.com
Endpoints¶
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 | Yes | 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". |
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¶
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¶
Example Response¶
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 | string | Array of link includes all information of the matched link (linkId, 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 | string | Array of link includes all information of the matched link (linkId, 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 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. Max value is 500. |
deleted | boolean | false | Include deleted links in response. |
filter | string (JSON) | Filter results by specific fields. | |
sort | string | Sort order specification. |
Filtering and Sorting¶
For more information see Working with List Endpoints.