Skip to main content
POST
/
api
/
integrations
/
{heron_id}
/
links
Create an integration Link
curl --request POST \
  --url https://app.herondata.io/api/integrations/{heron_id}/links \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "access_token": "access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6",
  "end_user_id": "f70a0fd5-a184-4981-864e-e44c2168d617",
  "item_id": "M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op",
  "asset_report_token": null,
  "end_user_name": "Acme Corp"
}
'
{
  "link": {
    "item_id": "M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op",
    "created": "2020-01-01T00:00:00Z",
    "data_source_heron_id": "<string>",
    "last_successful_sync": "2020-01-01T00:00:00Z",
    "last_updated": "2020-01-01T00:00:00Z",
    "status": "active",
    "status_message": "[ITEM_LOGIN_REQUIRED] the login details of this item have changed (credentials, MFA, or required user action) and a user login is required to update this information. use Link's update mode to restore the item to a good state",
    "type": "plaid_assets_report"
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
heron_id
string
required

Body

application/json
​
access_token
string
required
write-only

The generated token that grants access to the bank (this is encrypted in transit and at-rest with a custom key)

Example:

"access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6"

​
end_user_id
string
required
write-only

A unique identifier for your end user (customer) generated by you

Example:

"f70a0fd5-a184-4981-864e-e44c2168d617"

​
item_id
string
required

Unique identifier for each bank connection made by your end users. In Plaid this is the 'item_id'.

Example:

"M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op"

​
asset_report_token
string | null
write-only

Optional. If you already have a Plaid asset report, pass the token to skip creating a new one.

​
end_user_name
string
write-only

An human readable name for this end user, like the company legal name

Example:

"Acme Corp"

Response

201 - application/json

Created

​
link
object