Sail

Get Account Owner Identity (PII)

GET/users/{user_id}/accounts/{account_id}/identity

The legal owner of this specific account (name, emails, phones, addresses) as reported by the owning connection’s administrator. Account-level on purpose: “who owns the account I am about to deposit into” must be answered from that account’s own source, never from aggregated data. Requires the identity key scope, an ephemeral user token carrying the identity token scope, and the identity product on the owning connection. (HSAs are individually owned. Expect exactly one owner.)

Path Parameters

user_idstringrequired

The Sail user id.

account_idstringrequired

The Sail account id.

Response

Identity data.

namesstring[]

Legal names on file with the administrator.

emailsobject[]

Email addresses on file with the administrator.

Show emails properties
emailstring

The email address.

typestring

The email’s label (e.g. home, work).

primaryboolean

Whether this is the primary email on file.

phonesobject[]

Phone numbers on file with the administrator.

Show phones properties
phonestring

The phone number.

typestring

The phone number’s label (e.g. mobile, home).

primaryboolean

Whether this is the primary phone number on file.

addressesobject[]

Mailing addresses on file with the administrator.

Show addresses properties
streetstring

Street address.

citystring

City.

statestring

State or region.

zipstring

Postal code.

countrystring

Country.

primaryboolean

Whether this is the primary address on file.

Standard error envelope covering 400, 401, 403, 404, 429, and 500.

errorobject

The error detail.

Show error properties
codestring

Machine-readable code, e.g. not_found, token_scope_mismatch, product_not_enabled, insufficient_key_scope, insufficient_token_scope, user_token_required, user_token_expired, invalid_user_token, invalid_key_configuration, connection_not_reconnectable, rate_limited.

messagestring

Human-readable error message. May change, so match on error.code instead.

paramstring

The request field that caused the error, when applicable. Null otherwise.

Request
curl -X GET "https://live.savewithsail.com/api/v1/users/<user_id>/accounts/<account_id>/identity" \
  -H "Authorization: Bearer <token>" \
  -H "x-sail-user-token: <x-sail-user-token>"
Response
{
  "names": [
    "string"
  ],
  "emails": [
    {
      "email": "string",
      "type": "string",
      "primary": true
    }
  ],
  "phones": [
    {
      "phone": "string",
      "type": "string",
      "primary": true
    }
  ],
  "addresses": [
    {
      "street": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "string",
      "primary": true
    }
  ]
}