Get Identity
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.
Note that this endpoint does not trigger a fetch of owner information from the institution; it merely returns
owner information that has already been fetched, either because prefetch
was requested when the link was created,
or because of an on-demand update. 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.
URL
Request
Response
account_ids
: array
An optional list of account IDs to filter the results.
id
: string
required
The unique ID for this link.
example: mk_eqkWN34UEoa2NxyALG8pcV
Responses
200
Successful Response
accounts
: array
A list of accounts associated with the link.
link
: object
The link that these transactions belong to.
403
Forbidden by link owner. The user did not give permission to access this data when linking.
error_code
: string
link_error.forbidden_action
default: "link_error.forbidden_action"
Allowed values:
"link_error.forbidden_action"
error_message
: string
Error message
example: Accounts access not permitted
documentation_url
: string
404
Link not found.
error_code
: string
link_error.not_found
default: "link_error.not_found"
Allowed values:
"link_error.not_found"
error_message
: string
default: "Link not found."
documentation_url
: string
410
Link deleted.
error_code
: string
link_error.deleted
default: "link_error.deleted"
Allowed values:
"link_error.deleted"
error_message
: string
default: "This link was deleted at some earlier time."
documentation_url
: string
422
Link error.
error_code
: string
link_error.bad_state
default: "link_error.bad_state"
Allowed values:
"link_error.bad_state"
error_message
: string
documentation_url
: string
link_error_code
: string
429
Rate limit exceeded.
error_code
: string
api_error.rate_limit_exceeded
default: "api_error.rate_limit_exceeded"
Allowed values:
"api_error.rate_limit_exceeded"
error_message
: string
Error message
default: "Rate limit exceeded"
documentation_url
: string