post https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/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.
Log in to see full request history
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| clientID | yes | string | TransactAPI Client ID |
| developerAPIKey | yes | string | TransactAPI Developer Key |
| id | yes | string | Link ID that is generated by the API once a link is created (createLink) |
Sample Request
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/getLink
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d id=679
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| statusCode | string | API Status Code |
| statusDesc | string | API Status Description |
| linkDetails | string | Array of link includes all information of the matched link (linkId, firstEntryType, firstEntry, relatedEntryType, relatedEntry, linkType, notes) |
Sample Response
{
"statusCode": "101",
"statusDesc": "Ok",
"linkDetails": [
{
"id": "679",
"firstEntryType": "Account",
"firstEntry": "A12452",
"relatedEntry": "A52753",
"relatedEntryType": "Account",
"linkType": "owner",
"notes": "Linked accounts"
}
]
}