Decline organization’s identification description

Updated on 30 Apr 2020

Description

A User or External Entity on behalf of a User with role permission ORGANIZATION_STATUS_MANAGER will go through all steps of “Get users” Use Case and then send a request to Endpoint “Decline organization’s identification”.

Actors

  1. External Entity that can interact with System Operator API acting as a registered System Operator User with permissions:  ORGANIZATION_STATUS_MANAGER.
  2. System Operator running “SDK.Finance” software and exposing 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 “Get users”.
  2. External Entity sends a request to Endpoint “Decline organization’s identification”.

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

Parameters

Id – Identifier of the user

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 “Get users”.
  2. A user sends a request to Endpoint “Decline organization’s identification”.

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

Parameters

Id – Identifier of the user

Authorization – Authorization token

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

Post Conditions

Identification is declined.

Response example



   "profile":{ 

      "person":{ 

         "namePlain":{ 

            "first":"string",

            "last":"string",

            "middle":"string"

         },

         "nameIntl":{ 

            "first":"string",

            "last":"string",

            "middle":"string"

         },

         "description":"string"

      },

      "contact":{ 

         "id":"string",

         "nickname":"string",

         "firstName":"string",

         "lastName":"string",

         "address":"string",

         "city":"string",

         "country":"string",

         "postCode":"string",

         "email":"string",

         "phoneNumber":"string",

         "photoPath":"string",

         "socialMedias":[ 

            { 

               "id":"string",

               "socialMediaType":"string",

               "socialMediaReference":"string"

            }

         ],

         "accountNumber":"string",

         "swiftBic":"string",

         "ownerId":"string",

         "linkedUserId":"string"

      },

      "type":"base",

      "status":"none",

      "business":{ 

         "companyName":"string",

         "legal":"individual",

         "type":"eshop",

         "vat":"string",

         "administrator":{ 

            "firstName":"string",

            "lastName":"string",

            "email":"string",

            "phone":"string"

         }

      },

      "address":{ 

         "country":"AD",

         "zipCode":"string",

         "city":"string",

         "street":"string",

         "houseNumber":"string"

      },

      "additional":{ 

 

      },

      "security":{ 

         "twoFactorsAuthEnabled":false,

         "transactionNotification":{ 

            "phone":false,

            "email":false

         },

         "authorizationNotification":{ 

            "phone":false,

            "email":false

         }

      }

   },

   "status":"ok",

   "message":"string"

}