Identity

Identity provides you with all of the accounts the end-user granted your application access authorization along with beneficial owner identity information for each of them. Beneficial owner information is attached to each account as it's possible the end-user is not the beneficial owner, e.g. a corporate account, or there is more than one beneficial owner, e.g. a joint account the end-user shares with their partner.

Properties

Name
type
Type
string
Description
person, organization or unknown.
Name
names
Type
array
Description
An array of name objects with the following shape: (can be an empty list)
- Name
  type
  Type
  string
  Description
  name or alias.
- Name
  data
  Type
  string
  Description
  Name of the person or organization.
Name
addresses
Type
array
Description
An array of address objects. Can be an empty list.
- Name
  primary
  Type
  boolean
  Description
  Indicates if this is the owner's primary address (in case multiple addresses are provided).
- Name
  data
  Type
  object
  Description
  Name
  street
  Type
  string
  Description
  The street address.
  Name
  city
  Type
  string
  Description
  The name of the town or city.
  Name
  region
  Type
  string
  Description
  The state or region. For US addresses it's a 2-letter uppercase state code, e.g. "AL".
  Name
  postal_code
  Type
  string
  Description
  The zip or postal code. For US addresses it can be a 5-digit ZIP code or a ZIP+4 code: 5 and 4 digits separated with a hyphen.
  Name
  country
  Type
  string
  Description
  The ISO 3166-1 alpha-2 2-letter country codes, e.g. "US".
Name
phone_numbers
Type
array
Description
An array of phone_number objects with the following shape: (can be an empty list)
- Name
  type
  Type
  string
  Description
  mobile, home, work or unknown.
- Name
  data
  Type
  string
  Description
  The phone number digits only or prefixed with a "+" if in an international (E.164) format.
Name
emails
Type
array
Description
An array of email objects with the following shape: (can be an empty list)
- Name
  data
  Type
  string
  Description
  An email address.

GET/identity

Get Identity

Returns an array of accounts with beneficial owner identity information attached. Each item in the list is an object of the following type:

Properties

Name
account
Type
object
Description
An account object. See the documentation for type information.
Name
owners
Type
array
Description
An array of identity objects of the type defined above.

Request

curl https://api.teller.io/identity \
  -u test_token_ky6igyqi3qxa4:

Response

[
  {
      "account" : {
        "name" : "Essential Savings",
        "last_four" : "3528",
        "type" : "depository",
        "enrollment_id" : "enr_oiin624rqaojse22oe000",
        "id" : "acc_oiin624jqjrg2mp2ea000",
        "status" : "open",
        "links" : {
            "self" : "https://api.teller.io/accounts/acc_oiin624jqjrg2mp2ea000",
            "transactions" : "https://api.teller.io/accounts/acc_oiin624jqjrg2mp2ea000/transactions",
            "balances" : "https://api.teller.io/accounts/acc_oiin624jqjrg2mp2ea000/balances",
            "details" : "https://api.teller.io/accounts/acc_oiin624jqjrg2mp2ea000/details"
        },
        "institution" : {
            "id" : "security_cu",
            "name" : "Security Credit Union"
        },
        "subtype" : "savings",
        "currency" : "USD"
      },
      "owners" : [
        {
            "addresses" : [
              {
                  "primary" : true,
                  "data" : {
                    "postal_code" : "55305",
                    "street" : "4849 SYCAMORE FORK ROAD",
                    "region" : "MINNESOTA",
                    "country" : "US",
                    "city" : "HOPKINS"
                  }
              }
            ],
            "type" : "organization",
            "names" : [
              {
                  "data" : "URBAN GROCERIES INC",
                  "type" : "name"
              }
            ],
            "phone_numbers" : [
              {
                  "data" : "6667778888",
                  "type" : "mobile"
              }
            ],
            "emails" : [
              {
                  "data" : "urban_groceries_inc@example.com"
              }
            ]
        }
      ]
  },
...
]