Sign in
Account Links

Retrieve a link token

Exchange a bridge public_token for a link access_token.

post/v1/link-access-tokens/

Request body

public_tokenstring required

Public token for an exchange

Example request

{
  "public_token": "48427a36d43c4d5aa6324bc06c692456"
}

Response

access_tokenstring required

Access token

link_idstring required

Link ID

link_hashstring nullable

Link hash

data_source'payroll' | 'docs' | 'insurance' | 'financial_accounts' | 'tax' | 'scoring_attributes' | 'credit' | 'education'

Source of data: payroll - payroll provider parsing, docs - user uploaded documents, insurance - insurance data, financial_accounts - bank data, tax - tax documents, scoring_attributes - transactions scoring attributes report.

Example response

{
  "access_token": "48427a36d43c4d5aa6324bc06c692456",
  "link_id": "24d7e80942ce4ad58a93f70ce4115f5c",
  "link_hash": "bc917458a3da4b2c8cc8282aa1707aaa",
  "data_source": "payroll"
}

Changes

Changed in 1 of the 11 revisions of this API.2

  • e58688835e252See the full diff
    • ●

      added the new credit enum value to the data_source response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new education enum value to the data_source response property for the response status 201

      response-property-enum-value-added