User self-registration

Updated on 27 Apr 2020

Description

External Entity or User provides e-mail or phone and get registered in the system. 

Actors

  1. External Entity that can interact with System Operator API acting as a registered System Operator User.
  2. System Operator running “SDK.Finance” software and exposing the portfolio of financial APIs.

Basic Flow

By default, this flow assumes that External Entity sends Requests to System Operator Endpoints and System Operator sends back Responses to External Entity.

  1. External Entity sends a request to the User registration endpoint.

API endpoint: https://sdkfinance.app/api/ui/#!/User_registration/createReq

Request body example:

{

  "login": "string",

  "role": "string",

  "referralLink": "string"

}
  1. System Operator sends an email message to the new User with OTP for registration confirmation.
  2. System Operator returns the response to External Entity (see response example below).

Optional Flow with Web Browser UI

  1. A user sends a request to the User registration endpoint.

API endpoint: https://sdkfinance.app/api/ui/#!/User_registration/createReq

Request body example:

{

  "login": "string",

  "role": "string",

  "referralLink": "string"

}
  1. System Operator sends an email message to the new User with OTP for registration confirmation.
  2. System Operator returns the response to User (see response example below)

Post Conditions

User information, e.g. a valid email address, is in the system. Email with OTP for registration confirmation is sent.

Response example

{

  "status": "ok",

  "message": "string",

  "action": "EMAIL_SENT"

}

Email example:

Dear user!

Dear user! To register in the system SDK.finance use shortcode, this is it: 202935

In the case of an erroneous request, please ignore this email

Sincerely, SDK.finance customer support –  support@sdkfinance.app.

 

Confirmation of registration using OTP (one-time-password)

Description

To confirm registration User o External Entity on behalf of User should enter OTP.

Actors

  1. External Entity that can interact with System Operator API acting as a registered System Operator User.
  2. System Operator running “SDK.Finance” software and exposing the portfolio of financial APIs.

Basic Flow

By default, this flow assumes that External Entity sends Requests to System Operator Endpoints and System Operator sends back Responses to External Entity.

  1. External Entity sends a request to Confirmation of registration using the OTP endpoint.

API endpoint: https://sdkfinance.app/api/ui/#!/User_registration/Confirmation_of_registration_using_one_time_password

Request body example:

{

  "login": "string",

  "otp": "string"

}
  1. System Operator returns created User information to External Entity. (See Response example below)
  2. System Operator sends an email message to the new User with all needed information to enter the System.

Optional Flow with Web Browser UI

  1. User sends a request to Confirmation of registration using OTP endpoint.

API endpoint: https://sdkfinance.app/api/ui/#!/User_registration/Confirmation_of_registration_using_one_time_password

Request body example:

{

  "login": "string",

  "otp": "string"

}
  1. System Operator returns created User information to User. (See Response example below)
  2. System Operator sends an email message to the new User with all needed information to enter the System.

Response example:

{

  "status": "ok",

  "message": "string",

  "action": "TOKEN_CREATED",

  "authorizationToken": {

    "token": "string",

    "expiresAt": "2020-04-21T07:51:50.453Z"

  },

  "members": [

    {

      "role": "string",

      "user": {

        "id": "string",

        "name": "string"

      },

      "organization": {

        "id": "string",

        "type": "string",

        "name": "string",

        "identificationStatus": "string",

        "contract_info": {

          "id": "string",

          "personType": "base"

        }

      },

      "permissions": [

        "string"

      ],

      "token": {

        "token": "string",

        "expiresAt": "2020-04-21T07:51:50.453Z"

      }

    }

  ]

}

Email example:

You have successfully registered

Dear user!

Log in to your account, click on the link

https://sdkfinance.app

Username : ghjgghjggjghjg@mailinator.com

Password : RUYQOEYE

In the case of an erroneous request, please ignore this email

Sincerely, SDK.Finance customer support –  support@sdkfinance.app.

Resend one-time password to confirm registration

Description

It can be required to resend OTP to confirm registration to the user .

Actors

  1. External Entity that can interact with System Operator API acting as a registered System Operator User.
  2. System Operator running “SDK.Finance” software and exposing the portfolio of financial APIs.

Basic Flow

By default, this flow assumes that External Entity sends Requests to System Operator Endpoints, and System Operator sends back Responses to External Entity.

  1. External Entity sends a request to Resend one time password to confirm the registration endpoint.

API endpoint: https://sdkfinance.app/api/ui/#!/User_registration/Resend_one_time_password_to_confirm_registration

Request body example:

{

  "login": "string"

}
  1. System Operator sends an email message to the User with OTP for registration confirmation.
  2. System Operator returns the response to External Entity (see response example below)

Optional Flow with Web Browser UI

  1. A User sends a request to Resend one time password to confirm registration endpoint.

API endpoint: https://sdkfinance.app/api/ui/#!/User_registration/Resend_one_time_password_to_confirm_registration

Request body example:

{

  "login": "string"

}
  1. System Operator sends an email message to the User with OTP for registration confirmation.
  2. System Operator returns the response to User (see response example below)

Response example

{

  "status": "ok",

  "message": "string"

}