> For the complete documentation index, see [llms.txt](https://dfend.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dfend.gitbook.io/documentation/developer-api/types/identity.md).

# Identity

An **Identity** is our internal representation of one of your users, unique by primary key or user ID.

## Attributes

* `account`  <mark style="color:blue;">string</mark>  DFend account ID related to this identity.
* `identifiers`  <mark style="color:blue;">object</mark>  An object containing a map of pluralized [Identifiers](/documentation/developer-api/types/identifiers.md).
  * `userIds`  <mark style="color:blue;">string\[]</mark>  An array of the user's primary keys or unique IDs in connected systems.
  * `names`  <mark style="color:blue;">string\[]</mark>  An array of names from connected systems.
  * `emails`  <mark style="color:blue;">string\[]</mark>  An array of email addresses from connected systems.
  * `phones`  <mark style="color:blue;">string\[]</mark>  An array of phone numbers in [E. 164 format](https://www.twilio.com/docs/glossary/what-e164) from connected systems.
* `ips`  <mark style="color:blue;">IP\[]</mark>  An array of [IPs](/documentation/developer-api/types/ip.md) with [Approvable](/documentation/developer-api/types/approvable.md) fields.
* `devices`  <mark style="color:blue;">Device\[]</mark>  An array of [Devices](/documentation/developer-api/types/device.md) with [Approvable](/documentation/developer-api/types/approvable.md) fields.
* `locations`  <mark style="color:blue;">Location\[]</mark>  An array of [Locations](/documentation/developer-api/types/location.md) with [Approvable](/documentation/developer-api/types/approvable.md) fields.
* `vpns`  <mark style="color:blue;">VPN\[]</mark>  An array of [VPNs](/documentation/developer-api/types/vpn.md) with [Approvable](/documentation/developer-api/types/approvable.md) fields.
* `carriers`  <mark style="color:blue;">Carrier\[]</mark>  An array of [Carriers](/documentation/developer-api/types/carrier.md) with [Approvable](/documentation/developer-api/types/approvable.md) fields.
* `tor`  <mark style="color:blue;">Tor</mark>  A [Tor](/documentation/developer-api/types/tor.md) object with [Approvable](/documentation/developer-api/types/approvable.md) fields.
* `metadata`  <mark style="color:blue;">object</mark>  A custom metadata object that was provided when you created this Identity.
* `time`  <mark style="color:blue;">number</mark>  A Unix timestamp (ms) representing the original time of the [Signal](/documentation/developer-api/types/signal.md) this Identity was created from, if it was created on the fly.
* `optedIn`  <mark style="color:blue;">boolean</mark>  Whether the user has opted into DFend.
* `optedOut`  <mark style="color:blue;">boolean</mark>  Whether the user has opted out of DFend.
* `contactName`  <mark style="color:blue;">string</mark>  The name the user provided when they opted into DFend.
* `contactEmail`  <mark style="color:blue;">string</mark>  The email address the user provided when they opted into DFend.
* `contactPhone`  <mark style="color:blue;">string</mark>  The [E. 164 format](https://www.twilio.com/docs/glossary/what-e164) phone number the user provided when they opted into DFend.