4. External User (Customer)

Working with customers you have the following features:

Create customer

Update a customer

List users per counterparty

Show a customer

Create customer

To create an external user (customer) you should use the folowing request:

• Auth a user

Auth customer

post

Auth customer

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Header parameters

X-Auth-TokenstringRequired

auth user token

Body

application/json

counterparty_guidstringOptional

loginstringOptional

Responses

200

OK

application/json

400

json with error msg

application/json

post

/counterparty/{counterparty_guid}/customers/auth

HTTPcURLJavaScriptPython

POST /api/v1/counterparty/{counterparty_guid}/customers/auth HTTP/1.1
Host: dev-dcm-api.armenotech.dev
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "counterparty_guid": "text",
  "login": "text"
}

{
  "access_token": "text",
  "customer_guid": "text",
  "expires_in": 1,
  "refresh_token": "text",
  "token_type": "text",
  "user_guid": "text"
}

• Create a user

Create customer

post

Create dcm customer

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Header parameters

X-Auth-TokenstringRequired

auth user token

Body

application/json

balance_allowednumberOptional

optional default 0

balance_asset_codestringOptional

balance_asset_issuerstringOptional

branch_namestringOptional

optional

counterparty_guidstringOptional

CounterpartyGUID application guid from wallet

guidstringOptional

GUID if guid is zero, generate new random guid if guid exist return error

ibanstringOptional

optional

is_disabledbooleanOptional

optional default false

kyc_levelintegerOptional

optional default 0

loginstringOptional

Login unique user name phone\email\other

user_tokenstringOptional

Responses

200

OK

application/json

400

json with error msg

application/json

post

/counterparty/{counterparty_guid}/customers/create

HTTPcURLJavaScriptPython

POST /api/v1/counterparty/{counterparty_guid}/customers/create HTTP/1.1
Host: dev-dcm-api.armenotech.dev
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 223

{
  "balance_allowed": 1,
  "balance_asset_code": "text",
  "balance_asset_issuer": "text",
  "branch_name": "text",
  "counterparty_guid": "text",
  "guid": "text",
  "iban": "text",
  "is_disabled": true,
  "kyc_level": 1,
  "login": "text",
  "user_token": "text"
}

{
  "access_token": "text",
  "activated": true,
  "assets": [
    {
      "activated": true,
      "balance": 1,
      "code": "text",
      "minor_unit": 1,
      "name": "text",
      "platform": "text"
    }
  ],
  "assets_total": 1,
  "blocked": true,
  "customer_guid": "text",
  "expires_in": 1,
  "guid": "text",
  "name": "text",
  "platform": "text",
  "refresh_token": "text",
  "registered": true,
  "token_type": "text",
  "type": "text",
  "user_guid": "text"
}

Update a customer

Update customer

put

Update dcm customer

Path parameters

counterparty_guidstringRequired

Counterparty GUID

customer_guidstringRequired

Customer GUID

Body

application/json

balance_allowednumberOptional

balance_asset_codestringOptional

balance_asset_issuerstringOptional

branch_namestringOptional

ibanstringOptional

is_disabledbooleanOptional

kyc_levelintegerOptional

Responses

200

OK

application/json

Responseobject

400

json with error msg

application/json

put

/counterparty/{counterparty_guid}/customers/{customer_guid}

HTTPcURLJavaScriptPython

PUT /api/v1/counterparty/{counterparty_guid}/customers/{customer_guid} HTTP/1.1
Host: dev-dcm-api.armenotech.dev
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "balance_allowed": 1,
  "balance_asset_code": "text",
  "balance_asset_issuer": "text",
  "branch_name": "text",
  "iban": "text",
  "is_disabled": true,
  "kyc_level": 1
}

{}

List users per counterparty

Get customers list

get

Get dcm customers list with filter

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Query parameters

wallet_user_guidsstring[]Optional

Customer's GUIDs

counterparty_guidsstring[]Optional

Counterparty's GUIDs

loginsstring[]Optional

Customer's logins

kyc_levelsstring[]Optional

Customer's kyc levels

is_disabledbooleanOptional

Include disabled

min_balance_allowednumberOptional

Customer's allowed balance

max_balance_allowednumberOptional

Customer's allowed balance

balance_asset_codesstring[]Optional

Balance's asset code

balance_asset_issuersstring[]Optional

Balance's asset issuers

branch_namesstring[]Optional

Customer's branch names

ibanstring[]Optional

IBANs

min_created_atstringOptional

Customer's time of creation

max_created_atstringOptional

Customer's time of creation

min_updated_atstringOptional

Customer's time of last update

max_updated_atstringOptional

Customer's time of lat update

offsetintegerOptional

Offset

limitintegerOptional

Limit

orderingstring · enumOptional

Ordering

Possible values:

Responses

200

OK

application/json

400

json with error msg

application/json

get

/counterparty/{counterparty_guid}/customers

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/customers HTTP/1.1
Host: dev-dcm-api.armenotech.dev
Accept: */*

{
  "customers": [
    {
      "balance_allowed": 1,
      "balance_asset_code": "text",
      "balance_asset_issuer": "text",
      "branch_name": "text",
      "counterparty_guid": "text",
      "created_at": "text",
      "iban": "text",
      "is_disabled": true,
      "kyc_level": 1,
      "login": "text",
      "updated_at": "text",
      "wallet_user_guid": "text"
    }
  ],
  "total": 1
}

Show a customer

To show a single user you should do the previuos request and to find the user you need with an appropriate guid.