v13

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-03-243075159.3 KB

Users

List users

Retrieve a list of users with optional filtering parameters. Returns all users that match the specified filters. If no filters are provided, returns all users (paginated).

get/users

Query parameters

platformUserIdstring

Filter by platform-specific user identifier

umaAddressstring

Filter by UMA address

userType'INDIVIDUAL' | 'BUSINESS'

Whether the user is an individual or a business entity

Example:INDIVIDUAL

Filter by user type

createdAfterstring date-time

Filter users created after this timestamp (inclusive)

createdBeforestring date-time

Filter users created before this timestamp (inclusive)

updatedAfterstring date-time

Filter users updated after this timestamp (inclusive)

updatedBeforestring date-time

Filter users updated before this timestamp (inclusive)

limitinteger

Maximum number of results to return (default 20, max 100)

cursorstring

Cursor for pagination (returned from previous request)

isIncludingDeletedboolean

Whether to include deleted users in the results. Default is false.

Response

Successful operation

hasMoreboolean required

Indicates if more results are available beyond this page

nextCursorstring

Cursor to retrieve the next page of results (only present if hasMore is true)

totalCountinteger

Total number of users matching the criteria (excluding pagination)

Example response

{
  "data": [
    {
      "id": "User:019542f5-b3e7-1d02-0000-000000000001",
      "umaAddress": "$john.doe@uma.domain.com",
      "platformUserId": "9f84e0c2a72c4fa",
      "userType": "INDIVIDUAL",
      "createdAt": "2023-07-21T17:32:28Z",
      "updatedAt": "2023-07-21T17:32:28Z",
      "fullName": "John Michael Doe",
      "birthDate": "1990-01-15",
      "nationality": "US",
      "address": {
        "line1": "123 Main Street",
        "line2": "Apt 4B",
        "town": "Hollywood",
        "city": "Los Angeles",
        "state": "CA",
        "postalCode": "94105",
        "country": "US"
      },
      "bankAccountInfo": {
        "clabeNumber": "123456789012345678",
        "bankName": "BBVA Mexico",
        "accountHolderName": "John Doe",
        "platformAccountId": "acc_123456789"
      }
    }
  ]
}