Fetch User Profile

Search…
Fetch User Profile
Once the user approves the verification on your app with their Truecaller profile ( by clicking the 'Continue' button on the dialog ), we will immediately post the user's accessToken and the requestID to your Callback endpoint. The sample response format would look like below :
1
{"requestId":"RL8YZ41FQMt5Jiak2sc_Ys0OgQA=","accessToken":"a1asX--8_yw-OF--E6Gj_DPyKelJIGUUeYB9U9MJhyeu4hOCbrl","endpoint":"https://profile4-noneu.truecaller.com/v1/default"}
Copied!
Here, the request ID is the same string which you had earlier passed on in the deep link 'requestNonce' parameter. This parameter acts as a request-response correlation identifier and can be used by you to identify the correct source of the request.

Once you receive the user's access token at your backend, you can fetch the respective user profile by making an API call to the endpoint that you receive in the above response in the following format :
Header Authorisation Parameters:
Parameter [Type]
Required
Description
Example
Authorization
yes
Bearer {token}
Bearer WcBaSJYbCr5yla5z0CdAGfyj3Rruk8
Get User Profile
1
curl -X GET -H "Authorization: Bearer a3sAB0KnGANg4VZwIXfhUyFmPbzoONofl4FjIItac0JQSODp6niW8oBr33uOI-u7" -H "Cache-Control: no-cache" "https://profile4-noneu.truecaller.com/v1/default"
Copied!
Sample User Profile Response
1
{
2
  "phoneNumbers": ["919999999999"],
3
  "addresses": [
4
    {
5
       "countryCode": "in",
6
       "city": "city_field_value",
7
       "street": "street_field_value",
8
       "zipcode": "1234567"
9
    }
10
  ], 
11
  "avatarUrl": "https://s3-eu-west-1.amazonaws.com/images1.truecaller.com/myview/1/15a999e9806gh73834c87aaa0498020d/3", 
12
  "aboutMe":"About me",
13
  "jobTitle": "CEO", 
14
  "companyName": "ABC",  
15
  "history": {
16
    "name": 
17
    {
18
      "updateTime": "1508089888000"
19
    }
20
  }, 
21
  "isActive": "True", 
22
  "gender": "Male", 
23
  "createdTime": "1379314068000", 
24
  "onlineIdentities": {
25
    "url": "https://www.truecaller.com", 
26
    "email": "[email protected]",
27
    "facebookId":"105056625245",
28
  }, 
29
  "type": "Personal", 
30
  "id": "655574719", 
31
  "userId":"1319413476",
32
  "badges": ["verified", "premium"], 
33
  "name": {
34
    "last": "Kapoor", 
35
    "first": "Rajat"
36
  }
37
}
Copied!
Response parameter
Type
Optional
Description
id
string
N
​
userId
number
N
​
phoneNumbers
array[number]
N
Phone numbers prefixed with country code
name

name.first
name.last
object
​
string
string
N
​
N
Y
​
badges
array[string]
Y
​
avatarUrl
string
N
​
isActive
boolean
N
​
gender
string
N
Male|Female|NotSet
privacy
string
N
​
type
string
N
User type
history
​
history.<field>

history.<fId>.updateTime
object
​
string

number
N
​
Y
​
Y
Update history record for a field 

(e.g. history.name contains history for name field)
​
Update time for a field fId (e.g. history.name.updateTime contains last update time for name field)
addresses
​
addresses.countryCode
addresses.city
addresses.street
addresses.zipcode
array[object]
​
string
string
string
string
N
​
N
N
N
N
List of addresses
​
Country ISO2 code
city
street/ locality
Zipcode/Postcode/Postal Code
onlineIdentities
​
onlineIdentities.url
onlineIdentities.email
onlineIdentities.facebookId
object
​
string
string
string
Y
​
Y
Y
Y
​
aboutMe
string
N
​
jobTitle
string
N
​
companyName
string
N
​
Please note that the optional attributes in the user profile as defined above, wouldn't exist in the response if not updated by user
Response Codes
200 OK
401 Unauthorised - If your credentials are not valid
5xx Server error - Any other error
Please note, in case users do not wish to share their Truecaller profile ( by dismissing Truecaller profile dialog  ), you'll receive a user reject error response on your callback endpoint. The sample format for the same would look as below :
1
{"requestId":"WZqlS6PqY0ycO3mKlEuI=","status":"user_rejected"}
Copied!
Invoking verification
Completing User Verification
Last modified 1yr ago
Copy link