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

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

Header parameters

Body

application/json

clientId*string

User ID in the merchant system

clientEmailstring

User mail

clientNamestring

User name

depositWebhookUrlstring

URL for notifications of new deposits

createAddressesboolean

Create all addresses for the user

groupByBlockchainboolean

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

checkRisksboolean

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

Response

200

Body

application/json

success*boolean

Request success indicator

response*PersonalUserResponseSource (object)

Response body of request or user creation

Request

JavaScriptCurl

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

Response

{
  "success": false,
  "response": {
    "id": "48963640-75f5-42b9-81d6-885a35990c79",
    "clientId": "user12345",
    "clientEmail": "[e-mail]",
    "clientName": "John Doe",
    "depositWebhookUrl": "https://merchant.domain/webhooks/user12345",
    "createdAt": "2024-05-07T11:27:25.622Z",
    "updatedAt": "2024-05-07T11:27:25.622Z",
    "addresses": {
      "id": "de309f5c-bc8b-465a-b948-0dfb11b379b7",
      "userId": "11ef759b-ab4e-4aae-a3aa-e89e933005b4",
      "currency": "USDT",
      "network": "ethereum",
      "address": "0x515b72ed8a97f42c568d6a143232775018f133c8",
      "balance": "1234.1234",
      "isActive": false
    }
  }
}