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.

Request Parameters

clientIDyesstringTransactAPI Client ID
developerAPIKeyyesstringTransactAPI Developer Key
idyesstringLink ID that is generated by the API once a link is created (createLink)

Sample Request

curl -k -X POST
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d id=679

Response Parameters

statusCodestringAPI Status Code
statusDescstringAPI Status Description
linkDetailsstringArray 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"

Test it Yourself!

Click Try It! to start a request and see the response here!