Decline the profile document

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 “View all profile documents” Use Case, and then send a request to Endpoint “Decline the profile document”.

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

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

Parameters

Idprofile document identifier

Authorization – Authorization token

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

Optional Flow with Web Browser UI

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

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

Parameters

Idprofile document identifier

Authorization – Authorization token

Parameter: Security TOKEN

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

Post Conditions

Document status has changed from PENDING to DECLINED

Result example



   "document":{ 

      "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.922Z",

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

         "tag":"string"

      },

      "type":"string",

      "label":"string",

      "status":"PENDING",

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

   },

   "status":"ok",

   "message":"string"

}