Digital entity

There are 3 types of entities that we use in the processing center:

1. identification entity - for creating digital identificators

2. processing entity - for distribution of identificators between branches and customers

3. customer's entity - each external user has their own Stellar entity

Note: a digital entity has one identificator assigned.

Entity has status attributes:

• activated

• registered

• blocked

The attributes are not used currently.

Create an additional processing entity

Entities are created in 4 ways:

1. a counterparty is already created with 2 digital entities: an identification and a processing.

2. an employee can create an additional processing entity for their Counterparty (e.g., to separate identificator flow between branches) - see below.

3. an employee can create an digital entity for a customer (each customer has their own Stellar entity) - see #create-additional-customer-account.

4. a customer can create an entity for themselves (not yet implemented).

Create account

post

Create account

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Body

account_kindall ofOptional

type of account: processing or emission (for branch accounts only processing type is possible)

Possible values:

string · enumOptionalPossible values:

ibanstringOptional

key_keeper_loginstringOptional

Responses

200

OK

application/json

400

json with error msg

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/counterparty/{counterparty_guid}/accounts HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "account_kind": "processing",
  "iban": "text",
  "key_keeper_login": "text"
}

{
  "guid": "text"
}

The attribute branch_guid is optional.

Get entity list

Get the list of accounts that are visible to the user.

Get accounts list

get

Get accounts list

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Query parameters

wallet_account_guidsstring[]Optional

wallet account guid (uuid)

wallet_user_guidsstring[]Optional

wallet user guid (uuid)

account_kindsstring[]Optional

account kinds (string)

ibanstringOptional

iban

search_stringstringOptional

Parameter to search by guid, iban, login or external_id

offsetintegerOptional

offset (int)

orderstring · enumOptional

list order (string)

Possible values:

Responses

200

OK

application/json

400

json with error msg

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/accounts HTTP/1.1
Host: your_host
Accept: */*

[
  {
    "accounts": [
      {
        "account_kind": "processing",
        "counterparty_guid": "text",
        "created_at": "text",
        "iban": "text",
        "stellar_address": "text",
        "updated_at": "text",
        "wallet_account_guid": "text",
        "wallet_user_external_id": "text",
        "wallet_user_guid": "text"
      }
    ],
    "total": 1
  }
]

The filter search_string accepts the following values:

1. customer_guid - the unique identifier of the customer. More you can find here
2. account_guid - the unique identifier of the digital entity

3. account_iban - IBAN of an account without spaces

4. customer.login - customer's login, which was assigned upon customer registration

5. customer.external_id - customer's external identifier, can be the same as login

Get digital entity

Get the accounts for the counterparty.

Get account

get

Get account

Path parameters

counterparty_guidstringRequired

Counterparty GUID

account_guidstringRequired

wallet account guid (uuid)

Query parameters

ibanstringOptional

iban (string)

Responses

200

OK

application/json

400

json with error msg

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/accounts/{account_guid} HTTP/1.1
Host: your_host
Accept: */*

{
  "activated": true,
  "assets": [
    {
      "activated": true,
      "balance": 1,
      "code": "text",
      "minor_unit": 1,
      "name": "text",
      "platform": "text",
      "stellar_code": "text",
      "stellar_issuer": "text"
    }
  ],
  "assets_total": 1,
  "blocked": true,
  "guid": "text",
  "iban": "text",
  "name": "text",
  "platform": "text",
  "registered": true,
  "type": "text"
}

Admin user can get all available digital entities.

Bank employee can get all digital entities except the distributor entity.