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

/api-gateway/personal-addresses/create-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

clientIdstringrequired

User ID in the merchant system

Example: user12345

clientEmailstring

User mail

Example: [e-mail]

clientNamestring

User name

Example: John Doe

depositWebhookUrlstring

URL for notifications of new deposits

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

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.apollopayment.io/api-gateway/personal-addresses/create-user' \
  --header 'Content-Type: application/json' \
  --data '{
    "clientId": "user12345",
    "clientEmail": "[e-mail]",
    "clientName": "John Doe",
    "depositWebhookUrl": "https://merchant.domain/webhooks/user12345",
    "createAddresses": true,
    "groupByBlockchain": true,
    "checkRisks": true
  }'

200

200

{
  "success": true,
  "response": {
    "id": "aa3f81ac-d3eb-482f-8db0-1c7171e75730",
    "clientId": "user12345",
    "clientEmail": "[e-mail]",
    "clientName": "John Doe",
    "depositWebhookUrl": "https://merchant.domain/webhooks/user12345",
    "createdAt": "2024-12-26T08:21:53.372Z",
    "updatedAt": "2024-12-26T08:21:53.372Z",
    "addresses": {
      "id": "217150d6-a66b-46b6-920d-b839a935504f",
      "userId": "679536e9-ac28-4997-b045-1188b289ebc8",
      "currency": "USDT",
      "network": "ethereum",
      "address": "0x515b72ed8a97f42c568d6a143232775018f133c8",
      "balance": "1234.1234",
      "isActive": true,
      "tag": null
    }
  }
}