---
swagger: "2.0"
info:
  title: ConsumerDataStandards_ClientValidation_Digital_Regulatory
  description: 'This specification define the APIs required to validate Client/TPP
    for EMEA TPPs  </br>Deployment reference : XP_R_ConsumerDataStd_ClientVld_DGL_EA_EM
    </h2>'
  version: 1.2.0
  x-ibm-name: ConsumerDataStandards_ClientValidation_Digital_Regulatory
host: 127.0.0.1
schemes:
- https
consumes:
- application/json
produces:
- application/json
basePath: /api
paths:
  /v1/clients/certificate/validation/{countryCode}:
    post:
      summary: verify a client-TPP by its MTLS cert and validate if TPP is valid and
        allowed to access functional apis
      description: Endpoint will be secured by way of Mutual Authentication over TLS
      tags:
      - Regulatory
      operationId: ExecuteClientCertificateValidation
      parameters:
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: Client ID generated during application registration.
        required: true
        type: string
      - name: cert
        in: header
        description: certificate .
        required: true
        type: string
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: gurn
        in: header
        description: global unique reference ID of TPP .
        required: false
        type: string
      - name: scope
        in: header
        description: scope of functional API, which TPP requested.
        required: false
        type: string
      - name: uuid
        in: header
        description: uuid .
        required: false
        type: string
      - name: referenceId
        in: header
        description: referenceId .
        required: false
        type: string
      - name: countryCode
        type: string
        description: countrycode applicable
        required: true
        in: path
      - name: ExecuteClientCertificateValidationRequest
        in: body
        description: ExecuteClientCertificateValidationRequest
        required: true
        schema:
          $ref: '#/definitions/ExecuteClientCertificateValidationRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/ExecuteClientCertificateValidationResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</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'
        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</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
    get:
      summary: Retrive client-TPP details to validate client by MTLS cert
      description: Endpoint will be secured by way of Mutual Authentication over TLS
      tags:
      - Regulatory
      operationId: RetrieveClientCertificateValidation
      parameters:
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: Client ID generated during application registration.
        required: true
        type: string
      - name: cert
        in: header
        description: certificate .
        required: true
        type: string
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: countryCode
        type: string
        required: true
        in: path
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveClientCertificateValidationResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</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'
        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</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  ExecuteClientCertificateValidationRequest:
    type: string
    format: OBClientRegistration1
    description: JWT format of OBClientRegistration1
  ExecuteClientCertificateValidationResponse:
    description: Client registration
    allOf:
    - $ref: '#/definitions/OBRegistrationProperties1'
  OBRegistrationProperties1:
    properties:
      isValid:
        description: Is client cert valid or not
        type: boolean
      tppIdentifier:
        description: gurn number
        type: string
      software_role:
        description: This refer to the role of the tpp in directory
        type: array
        items:
          type: string
        example:
        - PISP
      scope:
        description: This refer to the scope for the tpp
        type: array
        items:
          type: string
        example:
        - payments
  RetrieveClientCertificateValidationResponse:
    description: Retrieve Client Response
    allOf:
    - $ref: '#/definitions/valideIDAS'
  valideIDAS:
    type: object
    properties:
      eIDAS:
        type: object
        properties:
          validity:
            description: OAuth 2.0 client identifier string
            type: object
            properties:
              validQTSP:
                type: boolean
              validSignature:
                type: boolean
              notRevoked:
                type: boolean
              notExpired:
                type: boolean
          data:
            description: OAuth 2.0 client secret string
            type: object
            properties:
              QTSPCommonName:
                type: string
              authNumber:
                type: string
              pspSubjectName:
                type: string
              QTSPSource:
                type: string
              QTSPJurisdiction:
                type: string
      homeRegister:
        type: object
        properties:
          ncaName:
            type: string
          ncaCountryCode:
            type: string
          registerType:
            type: string
          categoryEntries:
            type: object
            properties:
              categoryName:
                type: string
              pspLegalName:
                type: string
              pspAuthStatus:
                type: string
              pspPaymentServices:
                type: array
                items:
                  type: integer
              passportOut:
                type: object
                properties:
                  countryCode:
                    type: string
                  paymentServices:
                    type: array
                    items:
                      type: integer
      hostRegister:
        type: object
        properties:
          ncaCountryCode:
            type: string
          registerType:
            type: string
          categoryEntries:
            type: string
          warning:
            type: string
  ErrorResponse:
    properties:
      type:
        description: Invalid - Request did not confirm to the specification and was
          unprocessed and rejected. Please fix the value and try again
        enum:
        - error
        - warn
        - invalid
        - fatal
        type: string
      code:
        description: Error code which qualifies the error
        type: string
      details:
        description: Human readable explanation specific to the occurrence of the
          problem
        type: string
      location:
        description: The name of the field that resulted in the error
        type: string
      moreInfo:
        description: URI to human readable documentation of the error
        type: string
    required:
    - type
    - code
securityDefinitions:
  api-key-1:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
security:
- []
x-ibm-endpoints:
- endpointUrl: https://emea.sit.api.citi.com/gcb
  description: Custom Gateway API Endpoint
  type:
  - production
  - development
...