Get user profile

Updated on 30 Apr 2020

Description

The user or External entity acting as a User with Role Permissions: USER_VIEWER, USER_MANAGER, PROFILE_MANAGER can access the list of Users, pick up a particular User, and request profile details.

Actors

  1. External Entity that can interact with System Operator API acting as a registered System Operator User with the following Role Permissions: USER_VIEWER, USER_MANAGER, PROFILE_MANAGER.
  2. System Operator running “SDK.Finance” software and exposing the portfolio of financial APIs.

Preconditions

  1. The user must have a System Operator profile.

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. Perform all steps of Use Case “Get users”.
  2. External Entity sends a request to Endpoint “Get user profile”.

API endpoint: https://sdkfinance.app/api/ui/#!/Operator_profile_management/Get_user_profile_by_id

Parameters: 

userId

Authorization – Authorization token

  1. System Operator returns requested information to External Entity. (See Result example below)

Optional Flow with Web Browser UI

  1. Perform all steps of Use Case “Get users”.
  2. A user sends a request to Endpoint “Get user profile”.

API endpoint: https://sdkfinance.app/api/ui/#!/Operator_profile_management/Get_user_profile_by_id

Parameters: 

userId

Authorization

  1. System Operator returns requested information to External Entity. (See Result example below)

Post Conditions

User profile details is available to the requestor.

Response example

{

  "status": "ok",

  "message": "string",

  "profile": {

    "person": {

      "namePlain": {

        "first": "string",

        "last": "string",

        "middle": "string"

      },

      "nameIntl": {

        "first": "string",

        "last": "string",

        "middle": "string"

      },

      "description": "string"

    },

    "contact": {

      "phoneNumber": "string",

      "phoneVerified": true,

      "email": "string",

      "emailVerified": true,

      "countryCode": "AD"

    },

    "type": "base",

    "status": "none",

    "business": {

      "companyName": "string",

      "legal": "individual",

      "type": "eshop",

      "vat": "string",

      "administrator": {

        "firstName": "string",

        "lastName": "string",

        "email": "string",

        "phone": "string"

      }

    },

    "address": {

      "country": "AD",

      "zipCode": "string",

      "city": "string",

      "street": "string",

      "houseNumber": "string"

    },

    "additional": {},

    "security": {

      "twoFactorsAuthEnabled": true,

      "transactionNotification": {

        "phone": true,

        "email": true

      },

      "authorizationNotification": {

        "phone": true,

        "email": true

      }

    }

  }

}