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": "8adccb95-17cd-461f-b68f-360e765b8df8",
"end_user_name": "Acme Corp",
"item_id": "M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op"
}'
{
"link": {
"created": "2020-01-01T00:00:00Z",
"data_source_heron_id": "<string>",
"item_id": "M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op",
"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"
}
}
Create a Link for an active Integration every time a customer connects their bank. In Plaid, this is a Plaid Link every time a customer connects their bank. For Plaid, call this after exchanging a public token for an Item access_token.
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": "8adccb95-17cd-461f-b68f-360e765b8df8",
"end_user_name": "Acme Corp",
"item_id": "M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op"
}'
{
"link": {
"created": "2020-01-01T00:00:00Z",
"data_source_heron_id": "<string>",
"item_id": "M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op",
"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"
}
}
Created
The response is of type object
.
Was this page helpful?