Identity

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

Attributes

• account string DFend account ID related to this identity.

• identifiers object An object containing a map of pluralized Identifiers.

  • userIds string[] An array of the user's primary keys or unique IDs in connected systems.

  • names string[] An array of names from connected systems.

  • emails string[] An array of email addresses from connected systems.

  • phones string[] An array of phone numbers in E. 164 format from connected systems.

• ips IP[] An array of IPs with Approvable fields.

• devices Device[] An array of Devices with Approvable fields.

• locations Location[] An array of Locations with Approvable fields.

• vpns VPN[] An array of VPNs with Approvable fields.

• carriers Carrier[] An array of Carriers with Approvable fields.

• tor Tor A Tor object with Approvable fields.

• metadata object A custom metadata object that was provided when you created this Identity.

• time number A Unix timestamp (ms) representing the original time of the Signal this Identity was created from, if it was created on the fly.

• optedIn boolean Whether the user has opted into DFend.

• optedOut boolean Whether the user has opted out of DFend.

• contactName string The name the user provided when they opted into DFend.

• contactEmail string The email address the user provided when they opted into DFend.

• contactPhone string The E. 164 format phone number the user provided when they opted into DFend.