---
swagger: "2.0"
info:
  title: chnn-aop-d-dps-agent-entitlements
  description: Validate the faculty for the executive agent checker to set up the
    digital services.
  version: 1.2.0
  x-ibm-name: chnn-aop-d-dps-agent-entitlements
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/channels/account-opening/dps/agents/entitlements/validate:
    post:
      tags:
      - dps-validate-agent-entitlement
      summary: 'LOB: Account Opening; Feature: Agent Digital Package Services; Functionality:
        Validate checker executive credential.'
      description: Validates executive faculty to allow the digital services activation;
        Frontend DPS; Backend Digital Package Services; entry-point; post-login
      operationId: dps-validate-agent-entitlement
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response
        required: true
        type: string
      - name: uuid
        in: header
        description: 128 bit UUID that you generate for every request
        required: true
        type: string
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        required: false
        type: string
      - name: businessCode
        in: header
        description: Business code identified during application registration
        required: true
        type: string
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        required: true
        type: string
      - name: ChannelId
        in: header
        description: Channel where request originated
        required: true
        type: string
      - name: sid
        in: header
        description: SessionId sent by Consumer
        required: true
        type: string
      - name: Content-Type
        in: header
        description: Content-Types that are sent in the request
        required: true
        type: string
      - name: client_id
        in: header
        description: Client ID generated during application registration
        required: true
        type: string
      - name: Authorization
        in: header
        description: The Authorization Token received during login
        required: true
        type: string
      - in: body
        name: dpsValidateAgentEntitlementRequest
        description: The checker agent request
        required: true
        schema:
          $ref: '#/definitions/DpsValidateAgentEntitlementRequest'
      responses:
        204:
          description: Successful Operation
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/channels/account-opening/dps/checker-agents/entitlements:
    post:
      tags:
      - dps-save-agent-checker
      summary: 'LOB: Account Opening; Feature: Agent Digital Package Services; Functionality:
        Save'
      description: This api saves the name and soeid for the checker agent; Frontend
        Digital Package Services; Backend Digital Package Services; entry-point; post-login
      operationId: dps-save-agent-checker
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response
        required: true
        type: string
      - name: uuid
        in: header
        description: 128 bit UUID that you generate for every request
        required: true
        type: string
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        required: false
        type: string
      - name: businessCode
        in: header
        description: Business code identified during application registration
        required: true
        type: string
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        required: true
        type: string
      - name: ChannelId
        in: header
        description: Channel where request originated
        required: true
        type: string
      - name: sid
        in: header
        description: SessionId sent by Consumer
        required: true
        type: string
      - name: Content-Type
        in: header
        description: Content-Types that are sent in the request
        required: true
        type: string
      - name: client_id
        in: header
        description: Client ID generated during application registration
        required: true
        type: string
      - name: Authorization
        in: header
        description: The Authorization Token received during login
        required: true
        type: string
      - in: body
        name: dpsSaveAgentCheckerRequest
        description: The checker agent request
        required: true
        schema:
          $ref: '#/definitions/DpsSaveAgentCheckerRequest'
      responses:
        204:
          description: Successful Operation
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/channels/account-opening/dps/checker-agents/sessions/{serverSessionId}/status:
    get:
      tags:
      - dps-retrieve-status-checker
      summary: 'LOB: Account Opening; Feature: Agent Digital Package Services; Functionality:
        Retrieve checker message.'
      description: This api retrieves the status code of the checker authentication
        that is saved on gemfire transaction; Frontend Digital Package Services; Backend
        Digital Package Services;
      operationId: dps-retrieve-status-checker
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: client_id
        in: header
        description: Client ID generated during application registration
        required: true
        type: string
      - name: Authorization
        in: header
        description: The Authorization Token received during login
        required: true
        type: string
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response
        required: true
        type: string
      - name: uuid
        in: header
        description: 128 bit UUID that you generate for every request
        required: true
        type: string
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response
        required: false
        type: string
      - name: Content-Type
        in: header
        description: Content-Types that are sent in the request
        required: false
        type: string
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        required: true
        type: string
      - name: businessCode
        in: header
        description: Business code identified during application registration
        required: true
        type: string
      - name: ChannelId
        in: header
        description: Channel where request originated
        required: true
        type: string
      - name: sid
        in: header
        description: SessionId sent by Consumer
        required: true
        type: string
      - name: serverSessionId
        in: path
        description: Server Session Id refers to an identifier or code which uniquely
          identifies a specific session across Citi globally.
        required: true
        type: string
      responses:
        200:
          description: Successful Operation
          schema:
            $ref: '#/definitions/DpsRetrieveStatusCheckerResponse'
        400:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The request
            operation is not configured to access this resource</td><td>Channel/Country/Business
            provided in the request is not supported currently</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td><td>More
            Info</td></tr><tr><td>error</td><td>resourceNotFound</td><td>The requested
            resource was not found</td><td>Empty resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationFailed</td><td>Business
            validation error occured on one or more parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error/server unavailability</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  DpsValidateAgentEntitlementRequest:
    description: Operator information to make a login SSO request
    type: object
    properties:
      serverSessionId:
        description: Server Session Id refers to an identifier or code which uniquely
          identifies a specific session across Citi globally.
        type: string
        example: DS20210811000000001065640
        maxLength: 50
      payrollId:
        type: string
        description: Employee  payroll
        example: 00997562
      agentId:
        type: string
        description: Employee SOEID
        example: AP95411
        minLength: 3
        maxLength: 8
      encryptedPasswordText:
        type: string
        description: The security word text
        example: wer786dssdfsdaerwerwsdf87
      userIpAddress:
        type: string
        example: 127.0.0.1
        description: IP Address of the user device
    required:
    - payrollId
    - encryptedPasswordText
  DpsSaveAgentCheckerRequest:
    description: Operator information to save in gemfire and DataBase
    type: object
    properties:
      serverSessionId:
        description: Server Session Id refers to an identifier or code which uniquely
          identifies a specific session across Citi globally.
        type: string
        example: DS20210811000000001065640
        maxLength: 50
      agentId:
        type: string
        description: Employee SOEID
        example: AP95411
        minLength: 3
        maxLength: 8
      agentFullName:
        type: string
        description: Employee name
        example: Alberto Peralta Mora
        minLength: 3
        maxLength: 200
  DpsRetrieveStatusCheckerResponse:
    description: Operator information to retrieve status code of agent checker authentication
      of gemfire
    type: object
    properties:
      processStatusCode:
        description: process status code is the code that identify if the login checker
          was successful
        type: string
        example: "200"
        enum:
        - "200"
        - "201"
        - "203"
        - "204"
  ErrorResponse:
    properties:
      type:
        type: string
        enum:
        - ERROR
        - WARN
        - INVALID
        - FATAL
        description: <br>invalid - Request did not confirm to the specification and
          was unprocessed & rejected. Please fix the value and try again</br><br>warn
          - Request was partially processed.  E.g. some of the fields are missing
          in response to the system issues,  request was accepted successfully but
          will be processed asynchronously</br><br>error - The request was accepted
          but could not be processed successfully</br><br>fatal - There was an internal
          system error while processing the request. These are technical errors and
          will be resolved by Citi, and the consumer should retry after some time.
          Business errors will not be categorized as fatal </br>
      code:
        type: string
        description: Error code which qualifies the error
      details:
        type: string
        description: Human readable explanation specific to the occurrence of the
          problem
      location:
        type: string
        description: The name of the field that resulted in the error
      moreInfo:
        type: string
        description: URI to human readable documentation of the error
    required:
    - type
    - code
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  OAuth2 Application Flow:
    type: oauth2
    description: ""
    flow: application
    scopes:
      /api/v1: ""
    tokenUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
  Client ID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- OAuth2 Application Flow:
  - /api/v1
x-ibm-endpoints:
- endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
  type:
  - production
  - development
...