Get user

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

Get user

POSThttps://ocp.onchainpay.io/api-gateway/personal-addresses/get-user

Header parameters

Body

application/json

idstring

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

Example: "5704a5d7-43ba-445e-9dc4-80a3b8539be5"

clientIdstring

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

Example: "user12345"

Response

200

Body

application/json

success*boolean

Request success indicator

response*PersonalUserResponseSource (object)

Response body of request or user creation

Request

JavaScriptCurlPython

const response = await fetch('https://ocp.onchainpay.io/api-gateway/personal-addresses/get-user', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "id": "5704a5d7-43ba-445e-9dc4-80a3b8539be5",
    "clientId": "user12345",
    "clientEmail": "[e-mail]",
    "clientName": "John Doe",
    "depositWebhookUrl": "https://merchant.domain/webhooks/user12345",
    "createdAt": "2024-12-11T10:54:03.341Z",
    "updatedAt": "2024-12-11T10:54:03.341Z",
    "addresses": {
      "id": "bad5ecb1-5216-4e76-8dd7-83cb03165421",
      "userId": "8d9c015f-ce87-4557-b75c-d133fc62f857",
      "currency": "USDT",
      "network": "ethereum",
      "address": "0x515b72ed8a97f42c568d6a143232775018f133c8",
      "tag": null,
      "balance": "1234.1234",
      "isActive": false
    }
  }
}