📝Step 1 - User Account Creation

In this step, the Client will be able to create an account with a login and verify the ownership of the information (telephone number) he has provided through OTP.

1 - As on any other application, the Client will have to create an account.

POST/v1/user/sign-up

Body

application/json

phoneNumberstring

emailstring

passwordstring

rolesarray of string

Response

200

OK

Body

*/*

successboolean

dataUserAccountView (object)

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

const response = await fetch('/v1/user/sign-up', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "userId": "text",
    "phoneNumber": "text",
    "name": "text",
    "surname": "text",
    "accounts": [
      {
        "accountId": "text",
        "email": "text",
        "subAccountId": "text",
        "subAccountEmail": "text",
        "encryptionKey": "text",
        "creationTs": "2024-07-27T08:06:42.585Z",
        "portfolios": [
          {
            "portfolioId": "text",
            "name": "text",
            "accountId": "text",
            "creationTs": "2024-07-27T08:06:42.585Z",
            "publicStrategy": false,
            "portfolioAccountType": "TRADING"
          }
        ],
        "active": false,
        "tradingPortfolioId": "text"
      }
    ],
    "kycIds": [
      "text"
    ],
    "documentIds": [
      "text"
    ],
    "email": "text",
    "userAccountStatus": "text"
  },
  "errorMessage": "text"
}

OAuth: client_auth

2 - The client will then be able to login using his e-mail and password:

Client can login to the application

POST

Path Parameters

Name	Type	Description
"username":*	"string"	Client ads his username
"password"*	"string"	Client ads the password he chose in the previous step.

200: OK

{
  "success": true,
  "data": {},
  "errorCode": 0,
  "errorMessage": "string"
}

OAuth: client_auth

3 - The client then need to respond to an OTP challenge, i.e he will receive a text message which includes a 4 digit number that he will need to pasted into the Mobile App:

POST/v1/user/otp

Body

application/json

sessionIdstring

usernamestring

challengeTypestring

codestring

Response

200

OK

Body

*/*

successboolean

dataobject

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

const response = await fetch('/v1/user/otp', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "errorMessage": "text"
}

Responding to the OTP challenge correctly, will allow the user to receive an access token to access features (deposit, withdraw, convert).

OAuth: user_auth

If this is not the case, it will be possible to refresh the OPT token using:

POST/v1/user/refresh

Body

application/json

usernamestring

refreshTokenstring

Response

200

OK

Body

*/*

successboolean

dataobject

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

const response = await fetch('/v1/user/refresh', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "errorMessage": "text"
}

4 - If the User loses his password, it is possible to generate a new one using:

PUT/v1/user/change-password

Body

application/json

sessionIdstring

usernamestring

challengeTypestring

passwordstring

passwordConfirmstring

Response

200

OK

Body

*/*

successboolean

dataAuthResponseObject (object)

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

const response = await fetch('/v1/user/change-password', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "data": {},
  "errorMessage": "text"
}

To validate the change of the password, the User will receive a new OTP challenge in the form as describe in point 3 above.

You can add this OTP challenge using:

GET/v1/user/forget-password

Query parameters

Response

200

OK

Body

*/*

successboolean

dataForgotPasswordResult (object)

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

const response = await fetch('/v1/user/forget-password', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "sdkResponseMetadata": {
      "requestId": "text"
    },
    "sdkHttpMetadata": {},
    "codeDeliveryDetails": {
      "destination": "text",
      "deliveryMedium": "text",
      "attributeName": "text"
    }
  },
  "errorMessage": "text"
}

5 - Once the KYC process as been completed and validated for a retail client (as described in step 2 below), the account will be validated and it will be possible to generate a Portfolio Id using:

POST/v1/account/portfolio

Body

application/json

accountIdstring

namestring

portfolioIdstring

portfolioAccountTypeenum

TRADINGSTRATEGYEARNPAYMENTFEES

Response

200

OK

Body

*/*

successboolean

dataAccount (object)

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

const response = await fetch('/v1/account/portfolio', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "accountId": "text",
    "email": "text",
    "subAccountId": "text",
    "subAccountEmail": "text",
    "encryptionKey": "text",
    "creationTs": "2024-07-27T08:06:42.585Z",
    "portfolios": [
      {
        "portfolioId": "text",
        "name": "text",
        "accountId": "text",
        "creationTs": "2024-07-27T08:06:42.585Z",
        "publicStrategy": false,
        "portfolioAccountType": "TRADING"
      }
    ],
    "active": false,
    "tradingPortfolioId": "text"
  },
  "errorMessage": "text"
}

OAuth: client_auth

A portfolio Id is linked to a blockchain public address and several Portfolio Id can be generated for a same Account Id.

6 - Please note that you will also be able to create manually an AccountId using:

POST/v1/account

Body

application/json

userIdstring

accountIdstring

emailstring

Response

200

OK

Body

*/*

successboolean

dataAccount (object)

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

const response = await fetch('/v1/account', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "accountId": "text",
    "email": "text",
    "subAccountId": "text",
    "subAccountEmail": "text",
    "encryptionKey": "text",
    "creationTs": "2024-07-27T08:06:42.585Z",
    "portfolios": [
      {
        "portfolioId": "text",
        "name": "text",
        "accountId": "text",
        "creationTs": "2024-07-27T08:06:42.585Z",
        "publicStrategy": false,
        "portfolioAccountType": "TRADING"
      }
    ],
    "active": false,
    "tradingPortfolioId": "text"
  },
  "errorMessage": "text"
}

OAuth: client_auth

The PortfolioId will only be generated once the User has completed the KYC process (as described in Step 2).