View all profile documents

Updated on 30 Apr 2020

Description

A User or External Entity on behalf of a User with role permission PROFILE_DOCUMENTS_MANAGER will go through all steps of “Authentication” Use Case, and then send a request to Endpoint “View all profile documents”.

Actors

  1. External Entity that can interact with System Operator API acting as a registered System Operator User with permissions: PROFILE_DOCUMENTS_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 with sufficient access privileges.

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 “Authentication”.
  2. External Entity sends a request to Endpoint “View all profile documents”.

API endpoint: https://sdkfinance.app/api/ui/#!/Profile_-_documents_approving/View_profile_documents

Parameters: 

Authorization – Authorization token

Request body example:

{ 

   "filter":{ 

      "orgIds":[ 

         "string"

      ],

      "statuses":[ 

         "PENDING"

      ],

      "types":[ 

         "string"

      ]

   },

   "sort":{ 

      "status":"asc"

   },

   "pageNumber":0,

   "pageSize":0

}
  1. System Operator returns response to External Entity. (See Result example below)

Optional Flow with Web Browser UI

  1. Perform all steps of Use Case “Authentication”.
  2. A user sends a request to Endpoint “View all profile documents”.

API endpoint: https://sdkfinance.app/api/ui/#!/Profile_-_documents_approving/View_profile_documents

Parameters: 

Authorization – Authorization token

Request body example:

{ 

   "filter":{ 

      "orgIds":[ 

         "string"

      ],

      "statuses":[ 

         "PENDING"

      ],

      "types":[ 

         "string"

      ]

   },

   "sort":{ 

      "status":"asc"

   },

   "pageNumber":0,

   "pageSize":0

}

 

  1. System Operator returns a response to User (See Result example below).

Post Conditions

All profile documents are available

Result example

{ 

   "records":[ 

      { 

         "id":"string",

         "file":{ 

            "id":"string",

            "ownerId":"string",

            "mediaType":"string",

            "name":"string",

            "url":"string",

            "md5":"string",

            "sha1":"string",

            "size":0,

            "used":false,

            "createdAt":"2018-07-25T12:12:33.912Z",

            "expiresAt":"2018-07-25T12:12:33.912Z",

            "tag":"string"

         },

         "type":"string",

         "label":"string",

         "status":"PENDING",

         "updatedAt":"2018-07-25T12:12:33.912Z"

      }

   ],

   "status":"ok",

   "message":"string"

}