metapro
  • 🤝Welcome!
  • 💻metapro market
    • Set your account
    • Connect wallet + web3 login
    • Side panel
      • Transfer NFT
        • Multiple transfer (Airdrop NFT)
          • Import CSV List
      • Sell NFT
        • Initial NFT Selling (INS)
          • How to setup INS auction
          • How to buy on INS auction
        • Buy Now
          • How to setup Buy Now auction
          • How to buy on Buy Now auction
        • Auction (Bidding)
          • How to setup Auction
          • How to buy on Auction
      • All NFT assets
    • Buy Crypto
    • Top Menu
      • Profile
        • Profile Marketplace
        • My games
        • My assets
          • Royalty
        • Activities
      • Referral Panel
        • Register your downline
        • Downline wallets
        • My referral link
      • Profile Settings
      • Developer Portal
      • Logout
    • Assets
      • Marketplace
        • Auction Card
      • Most favorite
      • Newest assets
        • Asset Card
    • Games
      • Show all games
    • Leaderboard
    • Create asset (minter)
      • Gaming asset specification
      • How to create (mint) asset
        • 1. Setup NFT token
        • 2. Setup metadata
        • 3. Add meta asset
        • 4. Mint meta asset
        • 5. Meta asset created
    • Developers Portal
      • Create team
      • Create game
      • Developers Portal Panel
      • Unity Plugin
      • How to list game on metapro market?
    • Creators
    • Teams
    • Users
    • Wallet App
    • Launcher
    • Market and auction component fees
  • 🚀METAPRO LAUNCHER
    • What is metapro launcher?
    • Download launcher
    • Set your account
      • Login to launcher
    • Home
    • Games
      • Game card on launcher
        • Assets in this game
      • Install game on launcher
      • Update game on launcher
    • My games
      • Installed
      • Not installed
      • Wishlist
    • My assets
      • Collected assets
      • Created assets
      • Wishlist
    • NODEs app
  • 📱metapro one
    • About non-custodial wallet
    • Download & set up
      • Create new metapro wallet
      • Import existing wallet
    • Settings
      • Avatar
      • Multiple wallets
      • Wallet name
      • Private Key
        • Protect Private Key
        • How to find my Private Key
      • Recovery Phrases
        • Protect Recovery Phrases
        • How to find my Recovery Phrases
      • Application version
    • Network switch
    • Deposit (Tokens and Collectibles)
    • Send (Tokens and Collectibles)
      • Send Tokens
      • Send Collectibles (NFT)
    • Buy (Buy and Sell Crypto)
    • Browser
    • My assets
      • Tokens
        • Asset view
        • Adding Tokens
        • Activities
      • Collectibles (NFT)
      • Game assets (NFTma)
    • Explore
      • Apps
      • Collections (NFT)
      • Game assets (NFTma)
    • How to claim Airdrop
    • How to import wallet from MetaMask to metapro
    • Supported devices
  • ⛓️metapro protocol
    • API
      • Users service
      • Teams service
      • Apps service
      • Nft service
      • Nft events service
    • Meta asset
    • Metadata structure
    • Protocole structure
    • Unity Plugin
      • About metapro Unity plugin
      • What's new
      • Guides
        • Installation
        • Requirements
        • Package samples
        • Quick start
          • 1. Editor
            • Access tool
            • Import game key
            • Download resources
            • App data object
            • Change game key
            • Use app data in script
          • 2. Play mode (PC)
            • Enable Web3 in your game
            • Choose provider
            • Connect wallet
            • Login with Web3
            • Display user data
            • Show app tokens
            • Use user and app data from script
          • 3. Play mode (Mobile)
            • Enable Web3 in Your game
            • Choose provider
            • Connect wallet
            • Login with Web3
        • AFP (Additional Features Packages)
          • 1. Safe token transfer
          • 2. Phoenix
        • Troubleshooting
      • Reference
        • MetaproAPPSetup
        • Editor Window
        • Plugin Manager
        • Web3 connection providers
          • metapro
          • Wallet Connect
          • MetaMask
        • WindowController
        • AFP (Additional Features Packages)
          • SafeTransferFrom
          • Phoenix
  • 🛠️WALLET CONNECTOR
    • Introduction
    • Basic informations
      • Next 13 integration
      • React integration
      • Manual installation
  • 👨‍💻Developer Documentation
    • Introduction to Developer Documentation
      • What is a Meta asset?
      • What are the Benefits of Using Tokens as Access Keys for the Game Application
      • Why should I Choose the Meta Assets as the Access Keys for the Game Application?
      • How Does It Work, Exactly?
    • Available Environments
    • Blockchain Communication and information retrieval
      • How can we verify/distinguish a user?
      • How can we track a user's transactions?
      • What information can we obtain?
    • Integration with the Leaderboard service
    • Integration for in-Wallet Apps
    • Integration for Telegram Mini Apps
      • Integration Architecture and Configuration
      • Authorization and Session Management
      • Example Integration and Features
      • Code Examples from the Repository
      • Summary and Appendices
    • Developer documentation for the Construct 3 Plugin
      • Construct 3 - Install plugin
      • Plugin Configuration
      • User onboarding and authorization
      • User Management
      • Score System
      • Leaderboard System
      • Referral System
      • Gameplay
      • Smart Contract Interactions
      • User NFTs
      • Error Handling
      • Additional Getters for Plugin Properties
    • Integration Web3 with Your Game
      • What is Web3
      • Blockchain Basics
      • Differences between chains
      • What is a NFT
      • Advantages of Web3 Gaming
      • Examples of Web3 Games
    • Onboarding the Web3 Player
      • Value for Players
      • Explanation of Cryptocurrency Wallet
      • Rewards for Tournament Participation
      • Reselling Owned Assets
      • Integration of Metapro Wallet Connector
      • Displaying Data for Unlogged Users
      • How to Get Authorization Data
      • User Authorization Benefits
    • Creating Your First Meta Asset
      • The Difference between NFT and Meta Asset
      • Security and Transparency
      • Concept and Value of Meta Assets
      • How and Where to Create Your Meta Asset
        • Step-by-Step Guide on How to Create Your Asset
        • Explanation of URI (Metadata structure)
        • Explanation of the Meta Asset Data taken from our Back End
    • Implementing Meta Assets into Your Game
      • Integrate your Meta Asset to your game using Unity
      • Verify User Tokens Ownership
      • Displaying All User-Owned Tokens
      • Displaying All Assets Assigned to the Game on the Metapro Market
    • Smart Contracts
      • MetaproINS
        • Read Contract
        • Write Contract
      • MetaproBuyNow
        • Read Contract
        • Write Contract
      • MetaproAuction
        • Read Contract
        • Write Contract
      • MetaproMetaAsset
        • Read Contract
        • Write Contract
      • MetaproRoyalty
        • Read Contract
        • Write Contract
      • MetaproReferral
        • Read Contract
        • Write Contract
      • MetaproAirdrop
        • Read Contract
        • Write Contract
    • Universal Links & App Links with WalletConnect
  • 🔎General information
    • Blockchain
    • Blockchain Network Fee
    • Blockchain Native Token
    • Token ERC-1155 vs ERC-721
  • 📄Release Notes
    • Introduction to the Release Notes
    • Marketplace Updates
      • Release 07.03.2024
      • Release 06.03.2024
      • Release 04.03.2024
      • Release 19.02.2024
      • Release 24.01.2024
      • Release 09.01.2024
      • Release 03.01.2024
      • Release 21.12.2023
      • Release 18.12.2023
      • Release 13.12.2023
      • Release 12.12.2023
      • Release 02.12.2023
      • Release 30.11.2023
      • Release 24.11.2023
      • Release 22.11.2023
      • Release 17.11.2023
      • Release 13.11.2023
      • Release 09.11.2023
      • Release 08.11.2023
      • Release 07.11.2023
      • Release 31.10.2023
      • Release 26.10.2023
      • Release 25.10.2023
      • Release 24.10.2023
      • Release 18.10.2023
      • Release 05.10.2023
      • Release 03.10.2023
      • Release 29.09.2023
      • Release 18.09.2023
      • Release 14.09.2023
      • Release 12.09.2023
      • Release 06.09.2023
      • Release 25.08.2023
      • Release 17.08.2023
      • Release 04.08.2023
      • Release 31.07.2023
      • Release 21.07.2023
      • Release 18.07.2023
      • Release 13.07.2023
    • Games Launcher Updates
      • Release 13.03.2024
      • Release 24.01.2024
      • Release 04.01.2024
      • Release 22.11.2023
      • Release 03.10.2023
      • Release 31.07.2023
      • Release 27.07.2023
      • Release 20.07.2023
      • Release 13.07.2023
    • Wallet Updates
      • Release 04.03.2024
      • Release 03.10.2023
      • Release 29.09.2023
      • Release 15.09.2023
      • Release 30.08.2023
      • Release 18.07.2023
Powered by GitBook
On this page
  1. metapro protocol
  2. API

Users service

PreviousAPINextTeams service

Last updated 7 months ago

The Users Service API provides various endpoints for managing user-related functionalities, including user authentication, profile management, and account operations. With this API, you can create, authenticate, and update, as well as perform actions such as logging in and adding new addresses to existing account. Additionally, you can retrieve user data, check username availability, and search for users and public profiles. This API empowers you to build user-centric applications and interact with user-related data efficiently.

Swagger docs link :

https://api.metaproprotocol.com/users-service/v2/docs

⛓️

Check if the user has an account in the system and if he has to accept the regulations based on WEB3

get

Possible scenarios:

        1. hasAccount && hasRulesChecked
           - The user has an account in the system.
           - The user has accepted the metaproID regulations and the selected application’s regulations.

        2. hasAccount && !hasRulesChecked
           - The user has an account in the system.
           - The user has not accepted the metaproID regulations or the selected application’s regulations.

        3. !hasAccount && !hasRulesChecked
           - The user does not have an account in the system.
           - The user has not accepted the metaproID regulations or the selected application’s regulations.
Path parameters
walletstringRequired

The wallet address to check

Example: 0x...
Query parameters
projectIdstringRequired

The project ID to check the wallet against

Example: project-id
externalAccountTypestringOptional

The type of external account to check

Example: steam
Responses
200Success
201Success
application/json
400
Incorrect data requested
application/json
403Error
application/json
get
GET /auth/web3/check/{wallet}?projectId=text HTTP/1.1
Host: v2
Accept: */*

No content

Returns login hash

get

This endpoint is used to get a hash for the login process. It is required to log in with a wallet address.

Header parameters
x-account-walletstringRequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

Responses
200Success
application/json
get
GET /auth/web3/signature/hash HTTP/1.1
Host: v2
x-account-wallet: text
Accept: */*
200Success
{
  "hash": "text"
}

Remove a wallet from user account

delete

This endpoint doesn't delete account, just remove a wallet (different than currently logged in)

Authorizations
Path parameters
walletstring · min: 34 · max: 135RequiredExample: 0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62
Header parameters
AuthorizationstringRequired

asduf823hf-sa98ehf938rh

x-account-useridstringRequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Responses
200Success
application/json
400
Incorrect data requested
application/json
401Error
application/json
403Error
application/json
delete
DELETE /auth/web3/remove/{wallet} HTTP/1.1
Host: v2
Authorization: text
x-account-userid: text
Accept: */*
{
  "id": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "isMetaproAdmin": false,
  "elympicsUserId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "role": null,
  "addresses": [
    {
      "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
    }
  ],
  "socialMedia": [
    {
      "name": "steam",
      "value": "https://steam.com/my-account",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "externalAccounts": [
    {
      "name": "steam",
      "data": {},
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "rulesCheckbox": {
    "checked": true,
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "personalDetails": {
    "email": "email@test.com",
    "username": "johny_bravo",
    "country": "PL",
    "firstName": "Adam",
    "lastName": "Kowalski",
    "birthDate": "2022-05-25T16:17:01.797Z",
    "bio": "Some text about me",
    "avatar": "qwer-qwer-qwer-qwer.png",
    "banner": "fda-fda-fdsa-fdas.jpg",
    "shortBio": "Short text about me",
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "engagementPoints": 1,
  "isMerged": true,
  "verificationKYC": true,
  "visitedAt": "2022-05-25T16:17:01.797Z",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "expiresAt": "2022-05-25T16:17:01.797Z"
}

Returns user data

get

Only for logged in

Authorizations
Header parameters
AuthorizationstringRequired

asduf823hf-sa98ehf938rh

x-account-useridstringRequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Responses
200Success
application/json
400
Incorrect data requested
application/json
401Error
application/json
403Error
application/json
get
GET / HTTP/1.1
Host: me
Authorization: text
x-account-userid: text
Accept: */*
{
  "id": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "isMetaproAdmin": false,
  "elympicsUserId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "role": null,
  "addresses": [
    {
      "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
    }
  ],
  "socialMedia": [
    {
      "name": "steam",
      "value": "https://steam.com/my-account",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "externalAccounts": [
    {
      "name": "steam",
      "data": {},
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "rulesCheckbox": {
    "checked": true,
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "personalDetails": {
    "email": "email@test.com",
    "username": "johny_bravo",
    "country": "PL",
    "firstName": "Adam",
    "lastName": "Kowalski",
    "birthDate": "2022-05-25T16:17:01.797Z",
    "bio": "Some text about me",
    "avatar": "qwer-qwer-qwer-qwer.png",
    "banner": "fda-fda-fdsa-fdas.jpg",
    "shortBio": "Short text about me",
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "engagementPoints": 1,
  "isMerged": true,
  "verificationKYC": true,
  "visitedAt": "2022-05-25T16:17:01.797Z",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "expiresAt": "2022-05-25T16:17:01.797Z",
  "project": {
    "projectId": "c409b3ae-3f5e-4b75-9c1a-5e12f92d7717",
    "userId": "c409b3ae-3f5e-4b75-9c1a-5e12f92d7717",
    "isSourceProject": false,
    "rulesChecked": true,
    "rulesCheckedDate": "2022-05-25T16:17:01.797Z",
    "roles": [
      "user"
    ],
    "permissions": [
      "platform_add"
    ],
    "visitedAt": "2022-05-25T16:17:01.797Z",
    "createdAt": "2022-08-12T14:21:28.449Z",
    "updatedAt": "2022-08-12T14:21:28.449Z"
  }
}

Checks username availability

get

Only for logged in

Authorizations
Path parameters
usernamestringRequired
Header parameters
AuthorizationstringRequired

asduf823hf-sa98ehf938rh

x-account-useridstringRequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Responses
200Success
application/json
400
Incorrect data requested
application/json
401Error
application/json
409Error
application/json
500Error
application/json
get
GET /{username} HTTP/1.1
Host: availability
Authorization: text
x-account-userid: text
Accept: */*
{
  "isAvailable": true
}

Returns public user data

get
Path parameters
userstring · min: 2 · max: 100Required

Wallet address or username or userId

Example: 0x1234567890123456789012345678901234567890
Responses
200Success
application/json
400
Incorrect data requested
application/json
401Error
application/json
get
GET /{user} HTTP/1.1
Host: profile
Accept: */*
{
  "id": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "isMetaproAdmin": false,
  "elympicsUserId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "role": null,
  "addresses": [
    {
      "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
    }
  ],
  "socialMedia": [
    {
      "name": "steam",
      "value": "https://steam.com/my-account",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "externalAccounts": [
    {
      "name": "steam",
      "data": {},
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "rulesCheckbox": {
    "checked": true,
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "personalDetails": {
    "email": "email@test.com",
    "username": "johny_bravo",
    "country": "PL",
    "firstName": "Adam",
    "lastName": "Kowalski",
    "birthDate": "2022-05-25T16:17:01.797Z",
    "bio": "Some text about me",
    "avatar": "qwer-qwer-qwer-qwer.png",
    "banner": "fda-fda-fdsa-fdas.jpg",
    "shortBio": "Short text about me",
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "engagementPoints": 1,
  "isMerged": true,
  "verificationKYC": true,
  "visitedAt": "2022-05-25T16:17:01.797Z",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "expiresAt": "2022-05-25T16:17:01.797Z"
}

Returns list of users

get
Query parameters
skipnumberOptionalExample: 2
limitnumber · min: 1OptionalExample: 2
walletsstring[]OptionalExample: ["0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62","0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C63"]
elympicsUserIdsstring[] · min: 1 · max: 135OptionalExample: ["9aef833a-6714-4079-a95d-fd0079375a34","9aef833a-6714-4079-a95d-fd0079375a34"]
userIdsstring[] · min: 1 · max: 135OptionalExample: ["934fdc4d46-289f-e6469f-19c08504118f","934fdc4d46-289f-e6469f-19c08504118f"]
rolesstring[]Optional
projectIdstringOptional

Project ID

Responses
200Success
application/json
400
Incorrect data requested
application/json
401Error
application/json
get
GET / HTTP/1.1
Host: profiles
Accept: */*
{
  "results": [
    {
      "id": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
      "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
      "isMetaproAdmin": false,
      "elympicsUserId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
      "role": null,
      "addresses": [
        {
          "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
        }
      ],
      "socialMedia": [
        {
          "name": "steam",
          "value": "https://steam.com/my-account",
          "createdAt": "2022-05-25T16:17:01.797Z",
          "updatedAt": "2022-05-25T16:17:01.797Z"
        }
      ],
      "externalAccounts": [
        {
          "name": "steam",
          "data": {},
          "createdAt": "2022-05-25T16:17:01.797Z",
          "updatedAt": "2022-05-25T16:17:01.797Z"
        }
      ],
      "rulesCheckbox": {
        "checked": true,
        "updatedAt": "2022-05-25T16:17:01.797Z"
      },
      "personalDetails": {
        "email": "email@test.com",
        "username": "johny_bravo",
        "country": "PL",
        "firstName": "Adam",
        "lastName": "Kowalski",
        "birthDate": "2022-05-25T16:17:01.797Z",
        "bio": "Some text about me",
        "avatar": "qwer-qwer-qwer-qwer.png",
        "banner": "fda-fda-fdsa-fdas.jpg",
        "shortBio": "Short text about me",
        "updatedAt": "2022-05-25T16:17:01.797Z"
      },
      "engagementPoints": 1,
      "isMerged": true,
      "verificationKYC": true,
      "visitedAt": "2022-05-25T16:17:01.797Z",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z",
      "expiresAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "count": 1
}

Returns a list of requested Users

get
Path parameters
searchTextstringRequired
Query parameters
skipnumberOptionalExample: 2
limitnumber · min: 1OptionalExample: 2
projectIdstringOptional

Project ID

Responses
200Success
application/json
400
Incorrect data requested
application/json
404
Entity not found
application/json
get
GET /{searchText} HTTP/1.1
Host: users-search
Accept: */*
{
  "results": [
    {
      "id": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
      "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
      "isMetaproAdmin": false,
      "elympicsUserId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
      "role": null,
      "addresses": [
        {
          "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
        }
      ],
      "socialMedia": [
        {
          "name": "steam",
          "value": "https://steam.com/my-account",
          "createdAt": "2022-05-25T16:17:01.797Z",
          "updatedAt": "2022-05-25T16:17:01.797Z"
        }
      ],
      "externalAccounts": [
        {
          "name": "steam",
          "data": {},
          "createdAt": "2022-05-25T16:17:01.797Z",
          "updatedAt": "2022-05-25T16:17:01.797Z"
        }
      ],
      "rulesCheckbox": {
        "checked": true,
        "updatedAt": "2022-05-25T16:17:01.797Z"
      },
      "personalDetails": {
        "email": "email@test.com",
        "username": "johny_bravo",
        "country": "PL",
        "firstName": "Adam",
        "lastName": "Kowalski",
        "birthDate": "2022-05-25T16:17:01.797Z",
        "bio": "Some text about me",
        "avatar": "qwer-qwer-qwer-qwer.png",
        "banner": "fda-fda-fdsa-fdas.jpg",
        "shortBio": "Short text about me",
        "updatedAt": "2022-05-25T16:17:01.797Z"
      },
      "engagementPoints": 1,
      "isMerged": true,
      "verificationKYC": true,
      "visitedAt": "2022-05-25T16:17:01.797Z",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z",
      "expiresAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "count": 1
}
  • Swagger docs link :
  • POSTReturns user data
  • POSTLogin user if he exists in the database or create new account
  • GETCheck if the user has an account in the system and if he has to accept the regulations based on WEB3
  • POSTAdd a new address to an existing account
  • GETReturns login hash
  • DELETERemove a wallet from user account
  • GETReturns user data
  • GETChecks username availability
  • GETReturns public user data
  • GETReturns list of users
  • GETReturns a list of requested Users
  • PATCHUpdate user data
  • POSTUpdate wallet name

Returns user data

post

Only for logged in

Authorizations
Header parameters
AuthorizationstringRequired

asduf823hf-sa98ehf938rh

x-account-walletstringRequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringRequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Body
Responses
200Success
application/json
201Success
application/json
400
Incorrect data requested
application/json
401Error
application/json
403Error
application/json
post
POST /users HTTP/1.1
Host: internal
Authorization: text
x-account-wallet: text
x-account-userid: text
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "addresses": [
    {
      "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
    }
  ]
}
[
  {
    "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
    "addresses": [
      {
        "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
      }
    ]
  }
]

Login user if he exists in the database or create new account

post
Header parameters
x-account-login-hashstringRequired

FjWEtwGDoWmD7NAk5b6niTZFAG1Di-r6BgtzmLqWWBFGlKbPiM

x-account-walletstringRequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

Body
walletstring · min: 34 · max: 135RequiredExample: 0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62
signaturestring · min: 4 · max: 1500Required

Alphanumeric values

Example: 0xb91467e570a6466aa9e9876cbcd013baba02900b8979d43fe208a4a4f339f5fd6007e74cd82e037b800186422fc2da167c747ef045e5d18a5f5d4300f8e1a0291c
personalDetailsall ofOptional

Personal details

mergebooleanOptional

Merge account

projectIdstringRequired

Project ID

platformIdstringOptional

Platform ID

rulesCheckedbooleanOptional

Rules checkbox used in the registration process or in the rules acceptance process with an existing account

referralSettingsIdstringOptional

Referral settings ID

referralCodestringOptional

Referral code

externalLoginDataall ofOptional

External login data

Responses
201Success
application/json
400
Incorrect data requested
application/json
401Error
application/json
403Error
application/json
30001
Account has active deletion process.
application/json
post
POST /auth/web3/login HTTP/1.1
Host: v2
x-account-login-hash: text
x-account-wallet: text
Content-Type: application/json
Accept: */*
Content-Length: 879

{
  "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62",
  "signature": "0xb91467e570a6466aa9e9876cbcd013baba02900b8979d43fe208a4a4f339f5fd6007e74cd82e037b800186422fc2da167c747ef045e5d18a5f5d4300f8e1a0291c",
  "personalDetails": {
    "username": "text",
    "email": "email@test.com",
    "country": "PL",
    "firstName": "Adam",
    "lastName": "Kowalski",
    "birthDate": "2022-05-25T16:17:01.797Z",
    "bio": "Some text about me",
    "avatar": "qwer-qwer-qwer-qwer.png",
    "banner": "fda-fda-fdsa-fdas.jpg",
    "shortBio": "Short text about me"
  },
  "merge": true,
  "projectId": "text",
  "platformId": "text",
  "rulesChecked": true,
  "referralSettingsId": "text",
  "referralCode": "text",
  "externalLoginData": {
    "steamId": "text",
    "googleAccessToken": "text",
    "googleUserId": "text",
    "appleToken": "text",
    "discordAccessToken": "text",
    "discordUserId": "text",
    "telegramString": "text",
    "telegramUserId": "text",
    "querySteam": {
      "openid.ns": "http://specs.openid.net/auth/2.0"
    }
  }
}
{
  "token": {
    "accessToken": "text",
    "tokenType": "text",
    "exp": 1
  },
  "account": {
    "id": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
    "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
    "isMetaproAdmin": false,
    "elympicsUserId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
    "role": null,
    "addresses": [
      {
        "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
      }
    ],
    "socialMedia": [
      {
        "name": "steam",
        "value": "https://steam.com/my-account",
        "createdAt": "2022-05-25T16:17:01.797Z",
        "updatedAt": "2022-05-25T16:17:01.797Z"
      }
    ],
    "externalAccounts": [
      {
        "name": "steam",
        "data": {},
        "createdAt": "2022-05-25T16:17:01.797Z",
        "updatedAt": "2022-05-25T16:17:01.797Z"
      }
    ],
    "rulesCheckbox": {
      "checked": true,
      "updatedAt": "2022-05-25T16:17:01.797Z"
    },
    "personalDetails": {
      "email": "email@test.com",
      "username": "johny_bravo",
      "country": "PL",
      "firstName": "Adam",
      "lastName": "Kowalski",
      "birthDate": "2022-05-25T16:17:01.797Z",
      "bio": "Some text about me",
      "avatar": "qwer-qwer-qwer-qwer.png",
      "banner": "fda-fda-fdsa-fdas.jpg",
      "shortBio": "Short text about me",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    },
    "engagementPoints": 1,
    "isMerged": true,
    "verificationKYC": true,
    "visitedAt": "2022-05-25T16:17:01.797Z",
    "createdAt": "2022-05-25T16:17:01.797Z",
    "updatedAt": "2022-05-25T16:17:01.797Z",
    "expiresAt": "2022-05-25T16:17:01.797Z"
  }
}

Add a new address to an existing account

post

This endpoint allows to add a new wallet address to an existing account. If the wallet is already linked to another account then it is possible to merge them if the existing account does not have linked external accounts.

Authorizations
Header parameters
x-account-login-hashstringRequired

FjWEtwGDoWmD7NAk5b6niTZFAG1Di-r6BgtzmLqWWBFGlKbPiM

AuthorizationstringRequired

asduf823hf-sa98ehf938rh

x-account-useridstringRequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

x-account-walletstringRequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

Body
walletstring · min: 34 · max: 135RequiredExample: 0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62
signaturestring · min: 4 · max: 1500Required

Alphanumeric values

Example: 0xb91467e570a6466aa9e9876cbcd013baba02900b8979d43fe208a4a4f339f5fd6007e74cd82e037b800186422fc2da167c747ef045e5d18a5f5d4300f8e1a0291c
namestringOptional

Name of the wallet

typestringOptional

Type of the wallet

mergebooleanOptional

Confirmation of merge wallet with existing wallet

Default: false
Responses
201Success
application/json
400
Incorrect data requested
application/json
401Error
application/json
403Error
application/json
40002
Wallet already linked with different user. Merge required. The wallet address provided is already associated with another user account. To proceed, use the merge option to link this wallet with your current account.
application/json
40003
Wallet already linked with this user. The wallet address is already associated with your account. No further action is needed as the wallet is already linked.
application/json
post
POST /auth/web3/new-address HTTP/1.1
Host: v2
Authorization: text
x-account-login-hash: text
x-account-userid: text
x-account-wallet: text
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62",
  "signature": "0xb91467e570a6466aa9e9876cbcd013baba02900b8979d43fe208a4a4f339f5fd6007e74cd82e037b800186422fc2da167c747ef045e5d18a5f5d4300f8e1a0291c",
  "name": "text",
  "type": "text",
  "merge": false
}
{
  "id": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "isMetaproAdmin": false,
  "elympicsUserId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "role": null,
  "addresses": [
    {
      "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
    }
  ],
  "socialMedia": [
    {
      "name": "steam",
      "value": "https://steam.com/my-account",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "externalAccounts": [
    {
      "name": "steam",
      "data": {},
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "rulesCheckbox": {
    "checked": true,
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "personalDetails": {
    "email": "email@test.com",
    "username": "johny_bravo",
    "country": "PL",
    "firstName": "Adam",
    "lastName": "Kowalski",
    "birthDate": "2022-05-25T16:17:01.797Z",
    "bio": "Some text about me",
    "avatar": "qwer-qwer-qwer-qwer.png",
    "banner": "fda-fda-fdsa-fdas.jpg",
    "shortBio": "Short text about me",
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "engagementPoints": 1,
  "isMerged": true,
  "verificationKYC": true,
  "visitedAt": "2022-05-25T16:17:01.797Z",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "expiresAt": "2022-05-25T16:17:01.797Z"
}

Update user data

patch
Authorizations
Header parameters
AuthorizationstringRequired

asduf823hf-sa98ehf938rh

x-account-useridstringRequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Body
elympicsUserIdstringRequired
verificationKYCbooleanRequired
Responses
200Success
application/json
400
Incorrect data requested
application/json
401Error
application/json
403Error
application/json
409Error
application/json
patch
PATCH / HTTP/1.1
Host: update
Authorization: text
x-account-userid: text
Content-Type: application/json
Accept: */*
Content-Length: 478

{
  "socialMedia": [
    {
      "name": "steam",
      "value": "https://steam.com/my-account"
    }
  ],
  "personalDetails": {
    "username": "text",
    "email": "email@test.com",
    "country": "PL",
    "firstName": "Adam",
    "lastName": "Kowalski",
    "birthDate": "2022-05-25T16:17:01.797Z",
    "bio": "Some text about me",
    "avatar": "qwer-qwer-qwer-qwer.png",
    "banner": "fda-fda-fdsa-fdas.jpg",
    "shortBio": "Short text about me"
  },
  "elympicsUserId": "text",
  "rulesCheckbox": {
    "checked": true,
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "verificationKYC": true
}
{
  "id": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "isMetaproAdmin": false,
  "elympicsUserId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "role": null,
  "addresses": [
    {
      "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
    }
  ],
  "socialMedia": [
    {
      "name": "steam",
      "value": "https://steam.com/my-account",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "externalAccounts": [
    {
      "name": "steam",
      "data": {},
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "rulesCheckbox": {
    "checked": true,
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "personalDetails": {
    "email": "email@test.com",
    "username": "johny_bravo",
    "country": "PL",
    "firstName": "Adam",
    "lastName": "Kowalski",
    "birthDate": "2022-05-25T16:17:01.797Z",
    "bio": "Some text about me",
    "avatar": "qwer-qwer-qwer-qwer.png",
    "banner": "fda-fda-fdsa-fdas.jpg",
    "shortBio": "Short text about me",
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "engagementPoints": 1,
  "isMerged": true,
  "verificationKYC": true,
  "visitedAt": "2022-05-25T16:17:01.797Z",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "expiresAt": "2022-05-25T16:17:01.797Z"
}

Update wallet name

post
Authorizations
Path parameters
walletstringRequired

The wallet address

Example: 0x1234567890abcdef
Header parameters
AuthorizationstringRequired

asduf823hf-sa98ehf938rh

x-account-useridstringRequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Body
namestringRequired

The name of the wallet

Example: My Wallet
Responses
200Success
201Success
400
Incorrect data requested
application/json
401Error
application/json
403Error
application/json
post
POST /wallet/{wallet} HTTP/1.1
Host: update
Authorization: text
x-account-userid: text
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "name": "My Wallet"
}

No content