/api/identity/v1

Returns information of an Identity.

Request

GET /{tenant}/api/identity/v1/

GET /{tenant}/api/identity/v1/{id}

Authentication

For more information on how to authenticate see How To: Call The Identity Hub API

Request Parameters

Name	Value	Description	Required
id	The identityId of the identity	Instructs The Identity Hub to return the identity information of the identity matching the provided identityId. The caller must be authorized to access the identity.	No (defaults to authenticated identity)

Example Request

GET /{tenant}/api/identity/v1/12487978 
Authorization: Bearer puDWcq-4-xLwoG6y0DwZRA
Host: www.theidentityhub.com

Response

If the method call is successful returns the information about the identity in JSON format.

Name	Value	Description
disabled	`true` or `false`	`true` if the identity is disabled, `false` otherwise
displayName	string	The display name of the identity
emailAddress	email address	The primary email address of the identity
emailAddresses	Array of emailAddress	The email addresses of the identity
emailAddressVerified	`true` or `false`	`true` if the primary email address is verified, `false` otherwise
givenName	string	The primary given name of the identity
givenNames	Array of givenName	The given names of the identity
identityId	string	A unique identifier of the identity
isArchived	`true` or `false`	`true` if the identity is archived, `false` otherwise
largePictures	Array of URLs	Large profile pictures of the identity
lastLogin	date and time	UTC date and time of the last time the identity authenticated
localities	Array of locality	The language codes of the identity.
locality	Two-letter ISO 639-1 code plus country code derived from ISO 3166	The language code of the identity.
mediumPictures	Array of URLs	Medium profile pictures of the identity
mobilePhone	string	The mobile phone number of the identity
mobilePhoneVerified	`true` or `false`	`true` if the mobile phone is verified, `false` otherwise
oldIdentityIds	Array of identity id's	When identities are fused/merged this contains the merged identity id's
privatePersonalIdentifier	string	A unique identifier
properties	Array of key/value pairs	Custom properties of the identity
smallPictures	Array of URLs	Small profile pictures of the identity
surname	string	The primary surname of the identity
surnames	Array of surname	The surnames of the identity
userName	string	The profile user name. See Profile Password
userNamePasswordAccountUserName	string	If the identity has a Username/Password account, this is the username

Example Response

{
    "disabled": false,
    "displayName": "John Doe",
    "emailAddress": "John.Doe@gmail.com",
    "emailAddresses": [
        "John.Doe@gmail.com"
    ],
    "emailAddressVerified": false,
    "givenName": "John",
    "givenNames": [
        "John"
    ],
    "identityId": "24870303422209",
    "isArchived": false,
    "largePictures": [
        "https://graph.facebook.com/v2.12/187956565/picture?type=large"
    ],
    "lastLogin": "2018-03-26T13:48:05.853",
    "localities": [
        "fr-FR"
    ],
    "locality": "fr-FR",
    "mediumPictures": [
        "https://graph.facebook.com/v2.12/187956565/picture?type=normal"
    ],        
    "oldIdentityIds": [],
    "privatePersonalIdentifier": "24870303422209",
    "properties": {},
    "smallPictures": [
        "https://graph.facebook.com/v2.12/187956565/picture?type=small"
    ],
    "surname": "Doe",
    "surnames": [
        "Doe"
    ],
    "userName": "24870303422209"        
}