Skip to main content

Working with user profiles

A user profile is an aggregate view of all verification transactions associated with a single end user within an organization. It lets you look up a user's complete verification history in one request, instead of searching through individual transactions.

User profiles are created and updated automatically. The platform links each new transaction to a user profile based on the userId field in the consent object. Transactions that share the same userId within the same organization are grouped under one user profile.

Regions

Code examples here use the eu region. Use the appropriate region for your deployment.

List user profiles​

Retrieve a paginated list of user profiles for an organization.

You can find your organization's ID in the URL when browsing the Platform:

https://platform.microblink.com/.../organization/<organization ID>/...

Request​

GET /agent/api/v1/organization/{organizationId}/userprofile

For example:

curl --url "https://api.eu.platform.microblink.com/agent/api/v1/organization/{organizationId}/userprofile" --oauth2-bearer "$ACCESS_TOKEN"

Response​

{
  "data": [
    {
      "id": "66d99fa9edc165df54072f9a",
      "userId": "550e8400-e29b-41d4-a716-446655440000",
      "firstName": "Jane",
      "lastName": "Doe",
      "middleName": "",
      "createdOn": "2025-08-19T08:23:04.431Z",
      "lastActivityOn": "2025-09-14T11:05:22.100Z",
      "transactionCount": 1,
      "transactions": [
        {
          "transactionId": "0168b58c71fa53b5c88c0caedd",
          "createdAt": "2025-09-14T11:05:22.100Z",
          "hasDocuments": true,
          "hasSelfies": true,
          "hasPaymentCards": false,
          "hasTrustScores": true,
          "hasDeviceDetails": false
        }
      ]
    }
  ],
  "total": 1,
  "hasMore": false
}

Get a user profile​

Retrieve a single user profile by its ID. The id can be found in the list IDs endpoint response. Note that id is not the same thing as userId; the first one is the identifier for a user profile, the second one is the information collected in the consent object.

Request​

GET /agent/api/v1/userprofile/{id}

For example:

curl --url "https://api.eu.platform.microblink.com/agent/api/v1/userprofile/{id}" --oauth2-bearer "$ACCESS_TOKEN"

Response​

{
  "id": "66d99fa9edc165df54072f9a",
  "userId": "550e8400-e29b-41d4-a716-446655440000",
  "firstName": "Jane",
  "lastName": "Doe",
  "middleName": "",
  "createdOn": "2025-08-19T08:23:04.431Z",
  "lastActivityOn": "2025-09-14T11:05:22.100Z",
  "transactionCount": 1,
  "transactions": [
    {
      "transactionId": "0168b58c71fa53b5c88c0caedd",
      "createdAt": "2025-09-14T11:05:22.100Z",
      "hasDocuments": true,
      "hasSelfies": true,
      "hasPaymentCards": false,
      "hasTrustScores": true,
      "hasDeviceDetails": false
    }
  ]
}

API reference​

Read the full list of allowed parameters and more in the Agent API reference.

Last updated on