User Profile
The User Profile object
{
"id": "AVqvOB58Fg6nZfQ0ZqXt",
"name": "John Doe",
"given_name": "John",
"family_name": "Doe",
"username": "jdoe",
"nickname": "Johnny",
"birthdate": "1983-11-13",
"age": 33,
"custom_identifier": "rollingUser1",
"email": "john.doe@example.com",
"email_verified": true,
"emails": {
"verified": [
"john.doe@example.com"
],
"unverified": [
"other@example.com"
]
},
"password_hash": "$2a$13$A3BmaewEhI/lgxGsXoPATeKhxh1ToRG5r1eES76bVns4P4jAv0f/O",
"gender": "male",
"phone_number": "+33612345678",
"phone_number_verified": false,
"picture": "https://graph.facebook.com/10154500298019865/picture",
"profile": "https://www.facebook.com/app_scoped_user_id/10154500298019865/",
"addresses": [
{
"id": 0,
"default": true,
"address_type": "billing",
"street_address": "10 rue Chaptal",
"address_complement": "4 étage",
"locality": "Paris",
"postal_code": "75009",
"region": "Île-de-France",
"country": "France",
"recipient": "Matthieu Winoc",
"phone_number": "0723538943"
}
],
"likes_count": 67,
"credentials":[
{
"created_at": "2021-04-12T15:18:30.612129Z",
"phone_number": "+33612345678",
"friendly_name": "my MFA phone number",
"type": "sms"
},
{
"created_at": "2022-05-12T12:22:33.162029Z",
"email": "bob@example.com",
"friendly_name": "my MFA email",
"type": "email"
}
],
"identities":[
"updated_at": "2021-05-18T14:28:25.682123Z",
"created_at": "2021-04-12T15:18:30.612129Z",
"provider": "google",
"user_id": "122548588103668578225",
"id": "122548588103668578225",
"username": "cool_gal@example.com"
],
"created_at": "2017-03-08T18:39:35.026123Z",
"updated_at": "2018-08-12T12:54:09.631124Z",
"first_login": "2017-03-08T18:39:35.026121Z",
"last_login": "2018-08-12T12:54:09.631126Z",
"logins_count": 53,
"suspension_status": "permanent",
"suspension_information": {
"reason": "suspiciousUserNoGood"
},
"lockout_end_date": "2022-11-25T12:15:09.536Z",
"origins": [
"website",
"game"
],
"last_login_type": "facebook",
"custom_fields": {
"loyalty_card_number": "19872359235"
},
"consents": {
"newsletter": {
"consent_type": "opt-in",
"granted": true,
"date": "2018-05-25T15:41:09.671321Z",
"consent_version": {
"version_id": 1,
"language": "fr"
}
}
},
"facebook_ids_for_pages": [
{
"user_id": "649145309042062",
"page_id": "931332113682072"
}
],
"external_id": "2977460",
"provider_metadata": { (1)
"kakaotalk": {
"ci": "OUBQAU1Uc5WY…R/dLqvtWeVbL6r2BuT1S33A==",
"ci_authenticated_at": "2022-01-24T08:41:03Z"
}
}
}
1 | Currently, the provider_metadata field is only applicable to Kakao Connect. |
User Profile fields
- Table key
-
-
Import
= importable into ReachFive -
Sort
= sortable (with API via:desc
or:asc
)
-
Name | Scope required | Description | Import | Sort | ||||
---|---|---|---|---|---|---|---|---|
|
ReachFive user ID. |
|||||||
|
Full user name |
|||||||
|
Given name(s) or first name(s) |
|||||||
|
Surname(s) or last name(s) |
|||||||
|
Username |
|||||||
|
Middle name(s) |
|||||||
|
Casual name that may or may not be the same as the |
|||||||
|
URL of one of the user’s profile page (usually a social provider’s page). |
|||||||
|
URL of one of the user’s profile picture. This URL refers to an image file (for example, a PNG, JPEG, or GIF image file). |
|||||||
|
User’s primary email address. |
|||||||
|
Boolean. true if the user’s email address has been verified. |
|||||||
|
Emails object. User’s email addresses. |
|||||||
The user’s encrypted (hashed) password. The hash cannot be retrieved except for very specific cases. If you would like to learn more, please contact your ReachFive representative. |
||||||||
|
User’s primary phone number. At ReachFive, we use a dedicated library to validate a user’s phone number.
|
|||||||
|
Boolean. |
|||||||
|
A string that allows users to authenticate with something other than an Field rules:
|
|||||||
|
User’s gender. Allowed values are |
|||||||
|
User’s birthdate, represented as an ISO 8601 YYYY-MM-DD format. |
|||||||
|
Integer. User’s age computed from birth date. |
|||||||
|
User’s company name. |
|||||||
|
Integer. Number of facebook pages liked by the user. |
|||||||
|
Array of Address objects. User’s postal addresses. |
|||||||
|
Array of Identity objects. List of user’s provider identities. |
|||||||
|
Boolean. true if the user has a password. |
|||||||
|
Date when the user was created. |
|||||||
|
Date when the user was last updated. |
|||||||
|
Date of the user’s first login. |
|||||||
|
Date of the user’s last login. |
|||||||
|
Specifies the date and time when a user lockout ends.
|
|||||||
|
Integer. Number of logins for this user. |
|||||||
|
Name of the authentication type used when user last logged in. e.g. facebook, google, password. |
|||||||
|
Array of strings which provide a list of origins. What is an An You can value this field via the Identity API or our SDKs. However, the field cannot be valued through Imports or the Management API. |
|||||||
|
|
Object. User’s custom fields. |
||||||
|
Users consents. Object containing a series of fields: for each consent key, a Consent object. |
|||||||
|
Array of Friend objects. List of user’s friends also linked to the same ReachFive account. |
|||||||
|
Array of Facebook Page objects. List of page scoped facebook user ids. |
|||||||
|
Boolean. |
|||||||
|
The unique identifier of the profile in your systems or Single Customer View. External IDs can only come from imports, the Management API, or the signup method.
|
|||||||
|
Specifies whether the suspension of the user is temporary or permanent.
|
|||||||
|
Object that provides specific information related to user suspension. |
|||||||
|
Object containing metadata from a specified provider.
|
Emails object
Name | Description | ||
---|---|---|---|
Array of strings. List of verified user’s email addresses.
|
|||
Array of strings. List of unverified email addresses. |
Identities object
- Table key
-
Filter
= Filterable on the API.
Name | Description | Filter |
---|---|---|
The unique ID. This is created from a concatenation of the |
||
Name of the connected provider for this identity, in lowercase letters ( |
||
User’s unique identifier of the provider. |
||
Date when this identity was linked to the profile. |
||
Date when this identity was last updated. |
||
User’s username with the specified provider. |
Consents object
Name | Description | ||||||
---|---|---|---|---|---|---|---|
Consents type: |
|||||||
Boolean. Whether the consent has been granted or not. |
|||||||
Consent date. This reflects the latest date when the
|
|||||||
The consent version. This is an object containing a version ID and language.
|
|||||||
Specifies the reporter who made the modification. For example, this could be an administrator for your site or even an import being executed.
|
MFA credentials object
The MFA credentials
object contains information related to the MFA second factor for the user.
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
array |
An array of objects containing the MFA second factor credentials.
|