Go To Top

Consumer Profile API

Create a valid consumer display name from input string
Create a valid consumer display name from input string

POST
Authentication: API Key
https://api.trustpilot.com/v1/consumers/profile/displayname/create
Parameters
No parameters required
Request
{
  "displayName": null
}
Get a list of consumer profiles
Gets a list of consumer profiles

POST
Authentication: API Key
https://api.trustpilot.com/v1/consumers/profile/bulk
Parameters
No parameters required
Request
{
  "consumerIds": [
    null
  ]
}
Response
{
  "consumers": {},
  "notFoundConsumerIds": [
    null
  ]
}
Get the profile of the consumer
Gets the profile information of the consumer. NOTE: birthYear and createdAt result values are obsolete.

GET
Authentication: API Key
https://api.trustpilot.com/v1/consumers/{consumerId}/profile
Parameters
consumerId, Required String

Example: …/v1/consumers/{consumerId}/profile
Response
{
  "city": null,
  "about": null,
  "displayName": null,
  "locale": null,
  "gender": null,
  "country": null,
  "id": null,
  "createdAt": null,
  "hasImage": false,
  "birthYear": 0.0,
  "profileImage": {
    "image24x24": {
      "url": null,
      "width": 0.0,
      "height": 0.0
    },
    "image35x35": {
      "url": null,
      "width": 0.0,
      "height": 0.0
    },
    "image64x64": {
      "url": null,
      "width": 0.0,
      "height": 0.0
    },
    "image73x73": {
      "url": null,
      "width": 0.0,
      "height": 0.0
    }
  }
}
Get the profile of the consumer
Gets the profile information of the consumer. NOTE: birthYear and createdAt result values are obsolete.

GET
Authentication: API Key
https://api.trustpilot.com/v1/consumers/{consumerId}/web-links
Parameters
locale, Optional String
The locale to use when generating web links.
Example: ?locale={locale}
consumerId, Required String

Example: …/v1/consumers/{consumerId}/web-links
Response
{
  "locale": null,
  "profileUrl": null,
  "links": [
    {
      "href": null,
      "method": null,
      "rel": null
    }
  ]
}
Get the profile of the consumer(with #reviews and weblinks)
Gets the profile information of the consumer along with the number of reviews

GET
Authentication: API Key
https://api.trustpilot.com/v1/consumers/{consumerId}
Parameters
consumerId, Required String

Example: …/v1/consumers/{consumerId}
Response
{
  "numberOfReviews": 0.0,
  "links": [
    {
      "href": null,
      "method": null,
      "rel": null
    }
  ],
  "city": null,
  "about": null,
  "displayName": null,
  "locale": null,
  "gender": null,
  "country": null,
  "id": null,
  "createdAt": null,
  "hasImage": false,
  "birthYear": 0.0,
  "profileImage": {
    "image24x24": {
      "url": null,
      "width": 0.0,
      "height": 0.0
    },
    "image35x35": {
      "url": null,
      "width": 0.0,
      "height": 0.0
    },
    "image64x64": {
      "url": null,
      "width": 0.0,
      "height": 0.0
    },
    "image73x73": {
      "url": null,
      "width": 0.0,
      "height": 0.0
    }
  }
}
Validate consumer display name
Validate consumer display name

POST
Authentication: API Key
https://api.trustpilot.com/v1/consumers/profile/displayname/validate
Parameters
No parameters required
Request
{
  "displayName": null
}