User creation

This method provides functionality of:

• creating user

• updating data of a previously created user when specifying the same clientId. The sent parameter values overwrite the previous data.

When depositing, a webhook, is sent to the user's personal address, to the depositWebhookUrl specified in the request. When withdrawing (the common method of "Make withdrawal" / make-withdrawal) from a personal address, a status of this withdrawal will be in response.

User creation

post

Header parameters

x-api-public-keystringOptional

Public API-key

x-api-signaturestringOptional

Signing the request body with a private API-key

Content-typestringOptional

Request content type

Example: application/json

Body

The body of the user creation request

clientIdstringRequired

User ID in the merchant system

Example: user12345

clientEmailstringOptional

User mail

Example: [e-mail]

clientNamestringOptional

User name

Example: John Doe

depositWebhookUrlstringOptional

URL for notifications of new deposits

Example: https://merchant.domain/webhooks/user12345

createAddressesbooleanOptional

Create all addresses for the user

groupByBlockchainbooleanOptional

Group addresses by blockchain networks (for example, 1 address for bsc, fantom, ethereum networks). This parameter has an effect only when createAddresses: true

checkRisksbooleanOptional

Check risks for every incoming transaction to the user's personal addresses. Information about risks will be sent in the webhook to the specified depositWebhookUrl in the risks field

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /api-gateway/personal-addresses/create-user HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "clientId": "user12345",
  "clientEmail": "[e-mail]",
  "clientName": "John Doe",
  "depositWebhookUrl": "https://merchant.domain/webhooks/user12345",
  "createAddresses": true,
  "groupByBlockchain": true,
  "checkRisks": true
}

200Success

{
  "success": true,
  "response": {
    "id": "43449ae0-e6e1-4a69-aea0-cd08054c7ccf",
    "clientId": "user12345",
    "clientEmail": "[e-mail]",
    "clientName": "John Doe",
    "depositWebhookUrl": "https://merchant.domain/webhooks/user12345",
    "createdAt": "2025-05-14T13:39:50.475Z",
    "updatedAt": "2025-05-14T13:39:50.475Z",
    "addresses": {
      "id": "aab7d331-9a4f-42ce-8c31-4d3a57e220e9",
      "userId": "5bddfd19-2443-410f-a2a9-76ed0b1ef364",
      "currency": "USDT",
      "network": "ethereum",
      "address": "0x515b72ed8a97f42c568d6a143232775018f133c8",
      "tag": null,
      "balance": "1234.1234",
      "isActive": true
    }
  }
}