Reference ID
When you generate a Link Token to initialize an Agave Link session, you need to pass in a reference_id
as a parameter.
Agave API uses the reference_id
parameter to determine if the Agave Link is for a new Integration and reference_id
is different since each reference_id
can only belong to one Integration.
In certain situations, you may want to let your Users link multiple accounts within the same Integration (e.g. a
User could belong to multiple companies in a Procore account). For these situations, we recommend that you use different
reference_id
s for each Link Token request (e.g. user-1234:procore
, user-1234:dropbox
, etc). Note, you can format the reference identifier however you want since this is an opaque string.
Note for On-Prem or Hosted Integrations
If you use an on-prem (e.g., QuickBooks Desktop) or hosted (e.g., Vista Hosted or Foundation Hosted) integration, then the Reference ID uniquely identifies your user. If you want to re-authenticate the same user, you must pass the same Reference ID as before. A different Reference ID results in a different Agave Id.