Home › API › View pending reset identification requests

View pending reset identification requests

Updated on 15 Dec 2020

Description

A User or External Entity on behalf of a User with role permissions RESET_IDENTIFICATION_INITIATOR will go through all steps of “Authentication” Use Case, and then send a request to Endpoint “View pending reset identification request”.

Actors

  1. External Entity that can interact with System Operator API acting as a registered System Operator User with permissions: RESET_IDENTIFICATION_INITIATOR
  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 pending reset identification request”.

API endpoint: https://sdkfinance.app/api/ui/#!/Profile_-_identification/View_pending_reset_identification_requestshttps://sdkfinance.app/api/ui/#!/Profile_-_identification/View_pending_reset_identification_requests

Parameters: 

Authorization – Authorization token

Request body example:

{

 "filter": {

   "status": "APPROVED",

   "organizationId": "string"

 },

 "sort": {

   "organizationId": "asc",

   "status": "asc"

 },

 "pageNumber": 0,

 "pageSize": 0

}
  1. System Operator returns Requested list to External Entity. (See response 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 pending reset identification request”.

API endpoint: https://sdkfinance.app/api/ui/#!/Profile_-_identification/View_pending_reset_identification_requestshttps://sdkfinance.app/api/ui/#!/Profile_-_identification/View_pending_reset_identification_requests

Parameters: 

Authorization – Authorization token

Request body example:

{

 "filter": {

   "status": "APPROVED",

   "organizationId": "string"

 },

 "sort": {

   "organizationId": "asc",

   "status": "asc"

 },

 "pageNumber": 0,

 "pageSize": 0

}
  1. System Operator returns Requested list to User. (See response example below)

Post Conditions

List of requests is available

Response example

{

   "status": "ok",

   "message": "processed successfully",

   "pageNumber": 0,

   "pageSize": 20,

   "totalRecords": 1,

   "totalPages": 1,

   "records": [

       {

           "id": "b7b57423-f62a-4bfe-a983-c488065089bf",

           "description": "Profile reset identification",

           "organizationId": "e4652636-e4c1-400e-abfd-7ef7bcbfc494",

           "status": "PENDING",

           "initiatorUserId": "b70e0ef1-45f9-4c3d-8726-b59d67f0f5ff",

           "initiatorRole": "individual"

       }

   ]

}