• API
  • Connect
  • Guides
  • Get Started
    • Overview
    • Changelog
    • Sandbox Banks
    • Example Projects
    • Client Libraries
  • Foundations
    • Link Session
    • Links
    • Users
    • Institutions
    • Webhooks
    • Access Token
  • Products
    • Accounts
    • Account Numbers
    • Transactions
    • Investments
    • Identity
  • Reference
    • Link Errors
    • Transactions Enrichment
    • Account Types
    • Flow Diagram
    • Rate Limits

Identity

Identity

Verify account ownership and reduce fraud by obtaining users’ names, emails, phone numbers, and addresses.

Endpoints

    GET

    Get Identity

    Returns account owner information from the institution, including names, emails, phone numbers, and addresses, for all permissioned accounts associated with a link. This information will appear in the owners list in the accounts object.

    Some fields may be empty, if not provided by the institution.

    Calling this endpoint repeatedly will not give you new data.. This endpoint does not trigger a fetch of owner information from the institution; it merely returns information that has already been fetched, either when the link was created, or because of an on-demand update.

    You should call this endpoint once after the link is created or after you have made an update refresh. This endpoint returns sensitive information. To force a check for new/updated owner information, you must use the /products endpoint.

    If you have requested prefetch or an on-demand update, you should check the refreshed_at date for this product in the returned response, and compare that against the previous refreshed_at date, which you can get from any previous response for this or any other account or link request. If the refreshed_at date has not increased, then updated data is not yet available.