Get user

The method allows you to get user data by his id or clientId

Get user

post

/api-gateway/personal-addresses/get-user

Header parameters

x-api-public-keystring

Public API-key

x-api-signaturestring

Signing the request body with a private API-key

Content-typestring

Request content type

Example: application/json

Body

idstring

User ID in the system. Required, if 'clientId' was not provided

Example: c886f2dd-669a-4657-ba10-9ad7700cc8e5

clientIdstring

User ID in the merchant system. Required, if 'id' was not provided

Example: user12345

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://ocp.onchainpay.io/api-gateway/personal-addresses/get-user' \
  --header 'Content-Type: application/json' \
  --data '{"id":"c886f2dd-669a-4657-ba10-9ad7700cc8e5","clientId":"user12345"}'

200

200

{
  "success": true,
  "response": {
    "id": "c886f2dd-669a-4657-ba10-9ad7700cc8e5",
    "clientId": "user12345",
    "clientEmail": "[e-mail]",
    "clientName": "John Doe",
    "depositWebhookUrl": "https://merchant.domain/webhooks/user12345",
    "createdAt": "2024-12-26T08:21:33.226Z",
    "updatedAt": "2024-12-26T08:21:33.226Z",
    "addresses": {
      "id": "2361c9b9-8c89-40b0-ab90-1ade882cf756",
      "userId": "a4aaa006-0fd1-4413-8433-d0fe45c15f89",
      "currency": "USDT",
      "network": "ethereum",
      "address": "0x515b72ed8a97f42c568d6a143232775018f133c8",
      "balance": "1234.1234",
      "isActive": true,
      "tag": null
    }
  }
}