Get user
The method allows you to get user data by his id
or clientId
Header parameters
x-api-public-keystringOptional
Public API-key
x-api-signaturestringOptional
Signing the request body with a private API-key
Content-typestringOptionalExample:
Request content type
application/json
Body
User data request body
idstringOptionalExample:
User ID in the system. Required, if 'clientId' was not provided
be4723bf-0bd0-4ff9-a59b-2c8425b08d2d
clientIdstringOptionalExample:
User ID in the merchant system. Required, if 'id' was not provided
user12345
Responses
200Success
application/json
post
POST /api-gateway/personal-addresses/get-user HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 68
{
"id": "be4723bf-0bd0-4ff9-a59b-2c8425b08d2d",
"clientId": "user12345"
}
200Success
{
"success": true,
"response": {
"id": "be4723bf-0bd0-4ff9-a59b-2c8425b08d2d",
"clientId": "user12345",
"clientEmail": "[email protected]",
"clientName": "John Doe",
"depositWebhookUrl": "https://merchant.domain/webhooks/user12345",
"createdAt": "2025-06-09T13:18:11.534Z",
"updatedAt": "2025-06-09T13:18:11.534Z",
"addresses": {
"id": "1b950d20-5c23-4323-b2b9-fb36d104e8f1",
"userId": "4006fd41-0c97-49f7-8808-24c99d536c06",
"currency": "USDT",
"network": "ethereum",
"address": "0x515b72ed8a97f42c568d6a143232775018f133c8",
"tag": null,
"balance": "1234.1234",
"isActive": true
}
}
}
Last updated