Search Users (beta)

curl --request POST \
  --url https://api.moonkey.fun/v1/auth/users/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 100,
  "filters": {
    "operator": "OR",
    "fields": [
      {
        "field": "phone_number_match",
        "operator": "eq",
        "value": "2222222"
      }
    ]
  }
}
'

{
  "users": [
    {
      "user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
      "app_id": "app_24ydphdixx2ydhF0E5WUFUKWNqi",
      "first_name": "John",
      "middle_name": "",
      "last_name": "Smith",
      "active": true,
      "updated_at": 1639873806,
      "created_at": 1639873806,
      "emails": [
        {
          "id": "email_24oXBL3PufzHkH1Jzyjc2EXYeo7",
          "verified": false,
          "email": "[email protected]",
          "updated_at": 1639873806,
          "created_at": 1639873806
        }
      ],
      "phone_numbers": [
        {
          "id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy",
          "verified": true,
          "phone_number": "+14152222222",
          "updated_at": 1643004687,
          "created_at": 1639873806
        }
      ],
      "wallets": [
        {
          "id": "wallet_24tdfcVDSJQpK5huDnZaqPP2aiI",
          "app_id": "app_24ydphdixx2ydhF0E5WUFUKWNqi",
          "user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
          "public_address": "0xd3EfC42956c546Cf27B5f18062c63B4BF6d72D7c",
          "wallet_type": "ethereum",
          "is_default": true,
          "updated_at": 1640133104,
          "created_at": 1640133104
        }
      ],
      "totps": [
        {
          "id": "totp_284EPXPYI5zZoh4pp2mpAQ2PnuY",
          "user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
          "verified": false,
          "updated_at": 1650467433,
          "created_at": 1650467433
        }
      ]
    }
  ],
  "total_count": 10,
  "has_more": false
}

POST

auth

users

Search Users (beta)

curl --request POST \
  --url https://api.moonkey.fun/v1/auth/users/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 100,
  "filters": {
    "operator": "OR",
    "fields": [
      {
        "field": "phone_number_match",
        "operator": "eq",
        "value": "2222222"
      }
    ]
  }
}
'

{
  "users": [
    {
      "user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
      "app_id": "app_24ydphdixx2ydhF0E5WUFUKWNqi",
      "first_name": "John",
      "middle_name": "",
      "last_name": "Smith",
      "active": true,
      "updated_at": 1639873806,
      "created_at": 1639873806,
      "emails": [
        {
          "id": "email_24oXBL3PufzHkH1Jzyjc2EXYeo7",
          "verified": false,
          "email": "[email protected]",
          "updated_at": 1639873806,
          "created_at": 1639873806
        }
      ],
      "phone_numbers": [
        {
          "id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy",
          "verified": true,
          "phone_number": "+14152222222",
          "updated_at": 1643004687,
          "created_at": 1639873806
        }
      ],
      "wallets": [
        {
          "id": "wallet_24tdfcVDSJQpK5huDnZaqPP2aiI",
          "app_id": "app_24ydphdixx2ydhF0E5WUFUKWNqi",
          "user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
          "public_address": "0xd3EfC42956c546Cf27B5f18062c63B4BF6d72D7c",
          "wallet_type": "ethereum",
          "is_default": true,
          "updated_at": 1640133104,
          "created_at": 1640133104
        }
      ],
      "totps": [
        {
          "id": "totp_284EPXPYI5zZoh4pp2mpAQ2PnuY",
          "user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
          "verified": false,
          "updated_at": 1650467433,
          "created_at": 1650467433
        }
      ]
    }
  ],
  "total_count": 10,
  "has_more": false
}

Authorizations

Authorization

string

header

required

Auth Platform API includes all the Auth related features. All Users, Phone Numbers, Emails, and OTPs are associated with an App as the container.

Endpoints only accept App's Secret API keys other than certain endpoints that are used client side or via SDK that accept the public_token.

Authentication using App Api Key

Header:

Authorization: Bearer {api_key}

Authenticated Request

curl \
  -X GET https://api.moonkey.fun/v1/auth/users/user_24wFP9pDa9YiMJLun94iKykoZs2 \
  -H "Authorization: Bearer sk_test_pRqweh3wvWmJAAVYv7Z0T5iPLzFM4ql0muoyQcjOxGeN3p1r"

Body

application/json

limit

number

Number of objects to return per response, must be between 10 to 100, defaults to 50.

starting_after

string

A cursor for use in pagination. starting_after is an object ID that defines your place in the search result when there are more results to fit into a single response. For instance, if you make a search request with limit of 100 objects, ending with user_123, your subsequent call can include starting_after: user_123 in order to fetch the next page of the search result.

Minimum string length: 1

filters

object

Filters object to apply to the search.

Show child attributes

filters.operator

string

required

Required if filters property is present Logical operator to apply on the fields. Possible values: AND, OR.

Minimum string length: 1

filters.fields

object[]

Optional List of field filter objects.

Minimum array length: 1

Show child attributes

filters.fields.field

enum<string>

required

Field to filter the search by. Possible values:

user_id - Filter by the unique ID(s) of the user. Compatible with eq and in operators.
status - Filter by the status of the user, accepted values: active, pending. Compatible with eq and in operators.
full_name_match - Filter by the fuzzy match of the user's full name ({first_name} {last_name}). Compatible with eq operator.
phone_number - Filter by associated the phone number(s) of the user. Compatible with eq and in operators.
phone_number_id - Filter by the associated phone number ID(s) of the user. Compatible with eq and in operators.
phone_number_match - Filter by the fuzzy match of the user's phone number(s). Compatible with eq operator.
phone_number_verified - Filter by the verified flag of the user's associated phone number(s). Compatible with eq operator.
email - Filter by the email of the user. Compatible with eq and in operators.
email_id - Filter by the associated email ID(s) of the user. Compatible with eq and in operators.
email_verified - Filter by the verified flag of the user's associated email(s). Compatible with eq operator.
email_match - Filter by the fuzzy match of the user's email(s). Compatible with eq operator.
wallet_public_address - Filter by the wallet public address of the user. Compatible with eq and in operators.
wallet_id - Filter by the associated wallet ID(s) of the user. Compatible with eq and in operators.
totp_id - Filter by the associated totp instance ID(s) of the user. Compatible with eq and in operators.
totp_verified - Filter by the verified flag of the TOTP instance(s). Compatible with eq operator.
idp_provider - Filter by the associated IdP/OAuth provider(s) of the user. Compatible with eq and in operators.

Available options:

user_id,

status,

full_name_match,

phone_number,

phone_number_id,

phone_number_match,

phone_number_verified,

email,

email_id,

email_verified,

email_match,

wallet_public_address,

wallet_id,

totp_id,

totp_verified,

idp_provider

Minimum string length: 1

filters.fields.operator

string

required

Required Filter operator to apply for the field. Possible values: eq (translates to equals or = in SQL), between (translates to >= value AND <= second_value in SQL) , lt (translates to less than or < in SQL), gt (translates to greater than or > in SQL), in (translates to IN (value1, value2, ...) in SQL.)

Minimum string length: 1

filters.fields.value

Optional Value to filter by and to be used with operators eq, between, lt, and gt.

Minimum string length: 1

filters.fields.second_value

Optional Value to filter by and to be used with between operator.

Minimum string length: 1

filters.fields.values

(string | number)[]

Optional Values to filter by and to be used with in operator.

Response

200 - application/json

Search Users (beta) response

users

User · object[]

required

Show child attributes

users.user_id

string

required

Minimum string length: 1

users.first_name

string

required

users.middle_name

string

required

users.last_name

string

required

users.active

boolean

required

users.updated_at

number

required

users.created_at

number

required

users.emails

object[]

required

Show child attributes

users.emails.id

string

required

Minimum string length: 1

users.emails.verified

boolean

required

users.emails.email

string

required

Minimum string length: 1

users.emails.updated_at

number

required

users.emails.created_at

number

required

users.phone_numbers

object[]

required

Minimum array length: 10

Show child attributes

users.phone_numbers.id

string

required

Minimum string length: 1

users.phone_numbers.verified

boolean

required

users.phone_numbers.phone_number

string

required

Minimum string length: 1

users.phone_numbers.updated_at

number

required

users.phone_numbers.created_at

number

required

users.wallets

object[]

required

Show child attributes

users.wallets.id

string

required

Minimum string length: 1

users.wallets.app_id

string

required

Minimum string length: 1

users.wallets.user_id

string

required

Minimum string length: 1

users.wallets.public_address

string

required

Minimum string length: 1

users.wallets.wallet_type

string

required

Minimum string length: 1

users.wallets.is_default

boolean

required

users.wallets.updated_at

number

required

users.wallets.created_at

number

required

users.idp_providers

object[]

Minimum array length: 10

Show child attributes

users.idp_providers.id

string

required

Minimum string length: 1

users.idp_providers.provider

string

required

Minimum string length: 1

users.idp_providers.provider_subject

string

required

Minimum string length: 1

users.idp_providers.idp_type

string

required

Minimum string length: 1

users.idp_providers.method_id

string

required

Minimum string length: 1

users.idp_providers.method_type

string

required

Minimum string length: 1

users.idp_providers.updated_at

number

required

users.idp_providers.created_at

number

required

users.totps

object[]

Show child attributes

users.totps.id

string

required

Minimum string length: 1

users.totps.verified

boolean

required

users.totps.updated_at

number

required

users.totps.created_at

number

required

users.metadata

object

A flexible JSON object for storing custom data about a user. You can store any arbitrary data as key-value pairs.

Update Behavior:

By default, metadata updates are merged at the top level only
Send null values for specific fields to delete those fields (merge mode only)
Send {} (empty object) to clear all metadata
Send null for the metadata field itself will be ignored (as if metadata was not sent)
Deeply nested objects and arrays are NOT merged - they replace the entire top-level key
Set replace_metadata: true to replace all metadata without merging

total_count

number

required

has_more

boolean

required

Create User Get User

⌘I

API Reference

Managed Wallets

Users

OTPs

OAuth

Sessions

TOTP (Time-based one-time passcode)

Wallets Login

Passwords

Transfers

WebAuthn

Magic Links (Deprecated)

Search Users (beta)

HTTP Request

Returns

Authorizations

Authentication using App Api Key

Header:

Authenticated Request

Body

Response