---
swagger: "2.0"
info:
  description: TPP Onboarding API
  title: TPP Onboarding
  version: v1
  x-ibm-name: tpp-onboarding
basePath: /v1
tags:
- name: Onboarding-API
  description: Will create and update a provider using the validate API
paths:
  /tpp:
    post:
      tags:
      - Onboarding-API
      summary: Create a new Provider
      description: |
        will create the new provider using the validate API of the TPP Registry to validate the certificate and then the create TPP API.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: requestBody
        description: requestBody
        required: true
        schema:
          $ref: '#/definitions/TPPCreateProviderDTO'
      - in: header
        name: x-client-certificate
        type: string
        required: false
      - in: header
        name: lang
        type: string
        required: false
      - in: header
        name: journeyId
        description: journeyId
        type: string
        required: true
      - in: header
        name: requestId
        description: requestId
        type: string
        required: true
      - in: header
        name: timeStamp
        description: timeStamp
        type: string
        required: true
      responses:
        201:
          description: Created
        400:
          description: Bad Request
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: Forbidden
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: API URL Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        405:
          description: Method not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        406:
          description: Not Acceptable
          schema:
            $ref: '#/definitions/ErrorResponse'
        429:
          description: Too many Requests
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/ErrorResponse'
        503:
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ErrorResponse'
    put:
      tags:
      - Onboarding-API
      summary: Update existing Provider.
      description: "will update an existing provider using the validate API of the
        TPP Registry to validate the certificate and then the update provider API.
        \ \n"
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: requestBody
        description: requestBody
        required: true
        schema:
          $ref: '#/definitions/TPPUpdateProviderDTO'
      - in: header
        name: x-client-certificate
        type: string
        required: false
      - in: header
        name: lang
        type: string
        required: false
      - in: header
        name: journeyId
        description: journeyId
        type: string
        required: true
      - in: header
        name: requestId
        description: requestId
        type: string
        required: true
      - in: header
        name: timeStamp
        description: timeStamp
        type: string
        required: true
      responses:
        200:
          description: Ok
        400:
          description: Bad Request
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: Forbidden
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: API URL Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        405:
          description: Method not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        406:
          description: Not Acceptable
          schema:
            $ref: '#/definitions/ErrorResponse'
        429:
          description: Too many Requests
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/ErrorResponse'
        503:
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ErrorResponse'
    delete:
      tags:
      - Onboarding-API
      summary: Delete an existing Provider
      parameters:
      - in: header
        name: x-client-certificate
        type: string
        required: false
      - in: header
        name: lang
        type: string
        required: false
      - in: header
        name: journeyId
        description: journeyId
        type: string
        required: true
      - in: header
        name: requestId
        description: requestId
        type: string
        required: true
      - in: header
        name: timeStamp
        description: timeStamp
        type: string
        required: true
      responses:
        200:
          description: ok
        400:
          description: Bad Request
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: Forbidden
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: API URL Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        405:
          description: Method not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        406:
          description: Not Acceptable
          schema:
            $ref: '#/definitions/ErrorResponse'
        429:
          description: Too many Requests
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/ErrorResponse'
        503:
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ErrorResponse'
  /tpp/healthCheck:
    get:
      responses:
        200:
          description: 200 OK
      tags:
      - healthCheck
      operationId: healthCheck
definitions:
  AdditionalDetails:
    type: object
    properties:
      errorCode:
        type: string
      severity:
        type: string
      status:
        type: string
      description:
        type: string
  Error:
    type: object
    properties:
      code:
        type: string
      severity:
        type: string
        enum:
        - error
        - warning
        - Info
      description:
        type: string
      additionalDetails:
        type: array
        items:
          $ref: '#/definitions/AdditionalDetails'
  ErrorResponse:
    type: object
    properties:
      fatalError:
        type: boolean
      error:
        $ref: '#/definitions/Error'
  TPPCreateProviderDTO:
    type: object
    required:
    - signingCertificate
    - developer
    - contact
    properties:
      developer:
        $ref: '#/definitions/ContactDetailsDTO'
      contact:
        $ref: '#/definitions/ContactDetailsDTO'
      signingCertificate:
        type: string
  TPPUpdateProviderDTO:
    type: object
    required:
    - contact
    properties:
      contact:
        $ref: '#/definitions/ContactDetailsDTO'
      signingCertificate:
        type: string
  ContactDetailsDTO:
    type: object
    required:
    - firstName
    - lastName
    - email
    - phone
    properties:
      firstName:
        type: string
      lastName:
        type: string
      email:
        type: string
        format: email
      phone:
        type: string
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
schemes:
- https
consumes:
- application/json
produces:
- application/json
x-ibm-endpoints:
- endpointUrl: https://apis.bankofcyprus.com/df-boc-org-prd/prod
  description: APIC Gateway Server
  type:
  - production
...