Search for users

GET

/v1/users

Supports full match search by email and/or phone number. This means you can search for records using either an email address or a phone number, but the search will only return results that exactly match the provided email address or phone number.

Use this endpoint to check if a user with the given email/phone already exists. If you need to get more data about a user, call GET /v2/users/{User-ID} endpoint.

For Partners, using Bitpanda Enterprise “Bring Your Own License” solution, this endpoint is restricted.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

Responses

🟢200

application/json

List users that match the search query parameters

Body

🟠401

🟠422

🔴500

🔴503

🟠429429

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://test.whitelabel.bitpanda.com/v1/users?email=john.doe@domain.com&phone=38712345678&page_size=10&page=1' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "data": [
        {
            "id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
            "appropriateness_tag": {
                "short_name": "appropriateness.not_appropriate"
            },
            "active": true,
            "verified": true,
            "account_level_id": 1
        }
    ],
    "meta": {
        "total_count": 48,
        "page": 3,
        "page_size": 10
    },
    "links": {
        "first": "?page=1&page_size=10",
        "last": "?page=5&page_size=10",
        "prev": "?page=2&page_size=10",
        "next": "?page=4&page_size=10",
        "self": "?page=3&page_size=10"
    }
}

Get user list v2

Get user details v2