account_holder_token

• uuid
  required
  Globally unique identifier for the account holder.

entity_token

• uuid
  required
  Globally unique identifier for the entity.

200 OK

• object
  Information about an entity associated with an account holder

• account_holder_token

  • uuid
  • required
  • Globally unique identifier for the account holder

• token

  • uuid
  • required
  • Globally unique identifier for the entity

• type

  • string
  • enum
  • required
  • The type of entity

• status

  • string
  • enum
  • required
  • The status of the entity

• first_name

  • string | null
  • required
  • Individual's first name, as it appears on government-issued identity documents

• last_name

  • string | null
  • required
  • Individual's last name, as it appears on government-issued identity documents

• email

  • string | null
  • required
  • Individual's email address

• phone_number

  • string | null
  • required
  • Individual's phone number, entered in E.164 format

• dob

  • string | null
  • required
  • Individual's date of birth, as an RFC 3339 date

• address

  • object
  • required
  • Individual's current address

• address1
  - string - required
  - Valid deliverable address (no PO boxes).

• address2
  - string - Unit or apartment number (if applicable).

• city
  - string - required
  - Name of city.

• country
  - string - required
  - Valid country code. Only USA is currently supported, entered in uppercase ISO 3166-1 alpha-3 three-character format.

• postal_code
  - string - required
  - Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit ZIP or nine-digit ZIP+4.

• state
  - string - required
  - Valid state code. Only USA state codes are currently supported, entered in uppercase ISO 3166-2 two-character format.

``401 | | | | --- | --- | | User has not been authenticated | Invalid or missing API key | | API key is not active | The API key used is no longer active | | Could not find API key | The API key provided is not associated with any user | | Please provide API key in Authorization header | The Authorization header is not in the request | | Please provide API key in the form Authorization: [api-key] | The Authorization header is not formatted properly | | Insufficient privileges. Issuing API key required | Write access requires an Issuing API key. Reach out at lithic.com/contact | | Insufficient privileges to create virtual cards. | Creating virtual cards requires an additional privilege |

``404 The specified resource was not found.

``422 Unprocessable entity.

``429 Client has exceeded the number of allowed requests in a given time period. | | | | --- | --- | | Rate limited, too many requests per second | User has exceeded their per second rate limit | | Rate limited, reached daily limit | User has exceeded their daily rate limit | | Rate limited, too many keys tried | One IP has queried too many different API keys |

Example Request

curl --request DELETE \
     --url https://sandbox.lithic.com/v1/account_holders/account_holder_token/entities/entity_token \
     --header 'accept: application/json'

Example Response

{
  "account_holder_token": "fa68ed76-9d02-4d45-8a3f-782f3b6a8b3f",
  "token": "49c978db-20c4-46d8-9db4-b0ef28c03533",
  "type": "BENEFICIAL_OWNER_INDIVIDUAL",
  "status": "INACTIVE",
  "first_name": "Timmy",
  "last_name": "Turner",
  "email": "tim@left-earth.com",
  "phone_number": "+15555555555",
  "dob": "1991-03-08T08:00:00Z",
  "address": {
    "address1": "300 Normal Forest Way",
    "city": "Portland",
    "country": "USA",
    "postal_code": "90210",
    "state": "OR"
  }
}