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.
curl -i -X GET \
'http://localhost:8080/links/{id}/identity?account_ids=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'moneykit-version: 2023-02-18'
{
"accounts": [
{
"account_id": "a3ba443a-257c-490e-8242-03a84789d39f",
"account_type": "checking",
"name": "Premier Checking",
"account_mask": "3748",
"balances": {
"currency": "USD",
"available": 340.12,
"current": 445.89,
"limit": 500
},
"owners": [
{
"names": [
"string"
],
"addresses": [
{
"city": "string",
"country": "string",
"postal_code": "string",
"region": "string",
"street": "string",
"primary": false
}
],
"phone_numbers": [
{
"number": "+16175551212",
"primary": false,
"type": "home"
}
],
"emails": [
{
"address": "example@example.com",
"primary": false
}
]
}
]
}
],
"link": {
"link_id": "mk_eqkWN34UEoa2NxyALG8pcV",
"institution_id": "chase",
"institution_name": "Chase",
"provider": "mx",
"state": "connected",
"last_synced_at": "2023-02-16T09:14:11",
"tags": [
"user_type:admin"
],
"products": {
"accounts": {
"refreshed_at": "2023-02-16T09:14:11",
"last_attempted_at": "2023-02-16T09:14:11"
},
"identity": {
"refreshed_at": "2023-02-16T09:14:11",
"last_attempted_at": "2023-02-16T09:14:11",
"settings": {
"required": true,
"prefetch": false
}
}
}
}
}