Get all document types required for approval

Updated on 30 Apr 2020

Description

A User or External Entity on behalf of a User with role permission PROFILE_DOCUMENTS_OWNER will go through all steps of “Authentication” Use Case, and then send a request to Endpoint “Get all document types required for approval”.

Actors

  1. External Entity that can interact with System Operator API acting as a registered System Operator User with permissions: PROFILE_DOCUMENTS_OWNER.
  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 “Get all document types required for approval”.

API endpoint: https://sdkfinance.app/api/ui/#!/Profile_-_documents_uploading/getDocumentTypes

Parameters

Authorization – Authorization token

  1. System Operator returns List of required types 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 “Get all document types required for approval”.

API endpoint: https://sdkfinance.app/api/ui/#!/Profile_-_documents_uploading/getDocumentTypes

Parameters

Authorization – Authorization token

  1. System Operator returns List of required types to External Entity. (See Result example below)

Post Conditions

A required list of documents is available.

Result example



   "documentTypes":[ 

      { 

         "type":"string",

         "label":"string",

         "optional":false

      }

   ],

   "status":"ok",

   "message":"string"

}