Home › API › Reset an identification of user

Reset an identification of user

Updated on 24 Feb 2021

Description

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

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 “View pending reset identification requests”.
  2. External Entity sends a request to Endpoint “Reset an identification of user”.

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

Parameters: 

userId – user identifier

id – Identifier of identification request

Authorization – Authorization token

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

Optional Flow with Web Browser UI

  1. Perform all steps of Use Case “View pending reset identification requests”.
  2. A user sends a request to Endpoint “Reset an identification of user”.

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

Parameters: 

userId – user identifier

id – Identifier of identification request

Authorization – Authorization token

  1. System Operator returns result information to User (See response example below).

Post Conditions

Reset is done.

Response example

{ 

   "request":{ 

      "id":"string",

      "description":"string",

      "organizationId":"string",

      "status":"APPROVED",

      "initiatorUserId":"string",

      "initiatorRole":"string"

   },

   "status":"ok",

   "message":"string"

}