Messenger Platform

User Profile API

The User Profile API allows you to use a Instagram Scoped ID (IGSID) to retrieve customer profile information. You can use this information to create a personalize experience for people interacting with your business.

User Consent

User consent is required to access user profile. User consent is set only when a person sends a message to a business, or clicks icebreakers or persistent menu. If a person comments on a post or comment but has not sent a message to business, your app will receive an error, User consent is required to access user profile.

Requirements

You will need:

  • The instagram_basic permission
  • The instagram_manage_messages permission
  • The pages_manage_metadata permissions
  • The pages_read_engagement permission
  • The pages_show_list permission
  • A Page access token requested by a person who can perform the MODERATE task on the Page

Limitations

If a customer has blocked your business, you will not be able to view their information.

User Profile Fields

The following profile fields are available for all Graph API versions.

Field Name Description

name

string

The customers's name (can be null if name not set)

profile_pic

url

The URL for the customer's profile picture (can be null if profile pic not set). The URL will expire in a few days.

The following profile fields are available for Graph API v12.0 and later.

Field Name Description

is_verified_user

boolean

Verification status for the customer

follower_count

int

Follower count for the customer

is_user_follow_business

boolean

Indicates whether the customer follows the business or not

is_business_follow_user

boolean

Indicates whether the business follows the customer or not

The following fields are available for Graph API v14.0 and later.

FieldDescription

username

string

The username for the customer's Instagram account

Examples

To get a customer's profile information, send a GET request to the Instagram Scoped ID node for the customer and include the fields you would like to view.

Sample Request

Formatted for readability.
curl -X GET "https://graph.facebook.com/v21.0/instagram-scoped-user-id
  ?fields=name,username,profile_pic,follower_count,is_user_follow_business,is_business_follow_user
  &access_token=page-access-token"

On success, your app will receive the following JSON response:

{
  "name": "Peter Chang",
  "username": "peter_chang_live",
  "profile_pic": "https://fbcdn-profile-...",
  "follower_count": 1234
  "is_user_follow_business": false,
  "is_business_follow_user": true,
}

Developer Support