Getting started

The API is available under the following path: BaseURL = /webapi/

Authentication

In order to work with DCM you should log in the sysytem.

For authentication we use Ory Kratos, you can look throught official documentation: https://www.ory.sh/docs/kratos/reference/api.

DCM Processing Center has the following user groups:

• DCM users (operations personelle from DCM)

• internal users (bank employees)

• external ones (bank customers)

The purpose of authentication is to restrict access to crypto-assets and account information only for those who are explicitly allowed to do so.

Now we are using the following url hosts for authentication:

1. for admin user - https://api.admin.dcm.armenotech.dev/

2. for bank and customers - https://api.bank1.dcm.armenotech.dev

What steps should you do for authentication?

Authentication via browser

1. Create registration flow

Error while loading OpenAPI operation — Invalid OpenAPI document

1. Registration via browser

Error while loading OpenAPI operation — Invalid OpenAPI document

To register the user you should fill in the following parameters in the request's body:

{
  "csrf_token": "string",  // token, that you have received in the previous request
  "method": "string",      // method = "password"
  "password": "string",    // password must have at least 8 characters, must contain at least 1 capital letter, 1 block letter, 1 number and q special symbol 
  "traits": {},            // e-mail, last name and first name of the user
}

It is important that body is being sent via x-www-form-urlencoded format.

1. Create log in flow

Error while loading OpenAPI operation — Invalid OpenAPI document

1. Log in via browser

Error while loading OpenAPI operation — Invalid OpenAPI document

In the body of the request you should fill in the user's parameters that you have filled while making a registration.

Authentication via API

1. Create registration flow

Error while loading OpenAPI operation — Invalid OpenAPI document

1. Registration via API

Error while loading OpenAPI operation — Invalid OpenAPI document

To register the user you should fill in the following parameters in the request's body:

{
  "csrf_token": "string",  // token, that you have received in the previous request
  "method": "string",      // method = "password"
  "password": "string",    // password must have at least 8 characters, must contain at least 1 capital letter, 1 block letter, 1 number and q special symbol 
  "traits": {},            // e-mail, last name and first name of the user
}

It is important that body is being sent via x-www-form-urlencoded format.

1. Create Log in Flow

Error while loading OpenAPI operation — Invalid OpenAPI document

1. Log in

Error while loading OpenAPI operation — Invalid OpenAPI document

In the body of the request you should fill in the user's parameters that you have filled while making a registration.

Glossary

	Explanation
Counterparty	A legal entity who has a contract with DCM to process payments. Can be custodial (e.g. bank with a reserve account) or non-custodial (e.g. a mobile operator). Uses an emission account to receive assets after issuing. Possesses a set of processing accounts (e.g. to distribute assets between branches.
Branches	Branch of counterparty, by default branch "HeadOffice" is used.
Emission Account	Account for issuing digital money.
Processing Account	Account fot transferring.
Employee	An employee of a counterparty (internal user): can review requests and documents, and makes decisions about opening accounts and transferring funds (Donor, AIB, DCM, etc).
Customer	A client of counterparty with his own account can manage its funds (Recipient)
Merchant	Merchants (LE or PE who will accept payments from the End User by digital asset)
Payment	A transfer from one account (sending account) to another (beneficiary account).
Account	A stellar address linked to an external user or a counterparty.
Asset	A type of digital token issued on Stellar Network. In case an asset can be issued by multiple issuers: multi-asset. Otherwise – mono-asset.
DCM	(Digital Currency Management) A company that operates the Processing Center.