---
swagger: "2.0"
info:
  description: This is a swagger definition of the Brexit OBIE Implementation. PCF
    Deployment Reference name -->AUTH-R-Oauth2-TPP-DGL-EA-EM
  version: 1.3.0
  x-ibm-name: Oauth2_Tpp_Digital_Regulatory
  title: Oauth2_Tpp_Digital_Regulatory
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
  /v1/oauth2/tpp/clients/register:
    post:
      summary: This API needs to be used to register client details
      description: This API is used to register client details
      operationId: DynamicClientOauth2TppRegistration
      tags:
      - Regulatory
      parameters:
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - 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: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: DynamicClientOauth2TppRegistrationRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/DynamicClientOauth2TppRegistrationRequest'
      responses:
        200:
          description: Successful operation
          schema:
            $ref: '#/definitions/DynamicClientOauth2TppRegistrationResponse'
        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'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td><tr><td>error</td><td>mfaRequired</td><td>MFA
            is required</td></tr></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</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'
    put:
      summary: This API to be used to update client details
      description: This API to be used to update client details
      operationId: UpdateDynamicClientOauth2TppRegistrations
      tags:
      - Regulatory
      parameters:
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - 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: false
        type: string
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: UpdateDynamicClientOauth2TppRegistrationsRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateDynamicClientOauth2TppRegistrationsRequest'
      responses:
        200:
          description: Successful operation
          schema:
            $ref: '#/definitions/UpdateDynamicClientOauth2TppRegistrationsResponse'
        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'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td><tr><td>error</td><td>mfaRequired</td><td>MFA
            is required</td></tr></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</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'
    delete:
      summary: Delete a client by way of Client ID
      tags:
      - Regulatory
      operationId: DeleteDynamicClientOath2TppRegistration
      parameters:
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - 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: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      responses:
        200:
          description: Successful operation
        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'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr><tr><td>error</td><td>mfaRequired</td><td>MFA
            is required</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</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: Get client Registration details
      tags:
      - Regulatory
      operationId: RetrieveDynamicClientOath2TppRegistration
      parameters:
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - 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: false
        type: string
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: orgId
        in: query
        description: Organisation ID
        type: string
        required: true
      - name: softwareId
        in: query
        description: Software ID
        type: string
        required: true
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveDynamicClientOath2TppRegistrationResponse'
        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'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td><tr><td>error</td><td>mfaRequired</td><td>MFA
            is required</td></tr></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</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'
  /v1/oauth2/tpp/user/accounts:
    get:
      summary: This API gets the account List
      description: This API gets the account List
      operationId: RetrieveOauth2UserAccounts
      tags:
      - Authorize
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - 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: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: accountSelectedFlag
        in: query
        description: The account selection flag
        type: boolean
        required: false
      - name: consentId
        in: query
        description: consent id
        type: boolean
        required: false
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrieveOauth2UserAccountsResponse'
        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'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</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'
    put:
      summary: This API saves the selected account List. Auth to store the selected
        accounts in gemfire for the session ID.
      description: This API saves the selected account List.
      operationId: UpdateOauth2UserAccounts
      tags:
      - Authorize
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - 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: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: UpdateOauth2UserAccountsRequest
        in: body
        description: UpdateOauth2UserAccountsRequest
        required: true
        schema:
          $ref: '#/definitions/UpdateOauth2UserAccountsRequest'
      responses:
        200:
          description: Successful operation.
        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'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</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'
  /v1/oauth2/tpp/clients/register/key:
    get:
      summary: Get TPP public key.
      description: This API will fetch TPP public key
      operationId: RetrieveDynamicClientOauth2TppRegistrationKey
      tags:
      - Regulatory
      parameters:
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - 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: false
        type: string
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: orgId
        in: query
        description: Organisation ID
        type: string
        required: true
      - name: softwareId
        in: query
        description: Software ID
        type: string
        required: true
      responses:
        200:
          description: Successful operation
          schema:
            $ref: '#/definitions/RetrieveDynamicClientOauth2TppRegistrationKeyResponse'
        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'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td><tr><td>error</td><td>mfaRequired</td><td>MFA
            is required</td></tr></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</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'
  /v1/oauth2/tpp/clients/register/openBanking/key:
    get:
      summary: Get Open Banking public key.
      description: This API will fetch OB public key
      operationId: RetrieveDynamicClientOauth2TppRegistrationOpenBankingKey
      tags:
      - Regulatory
      parameters:
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - 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: false
        type: string
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      responses:
        200:
          description: Successful operation
          schema:
            $ref: '#/definitions/RetrieveDynamicClientOauth2TppRegistrationOpenBankingKeyResponse'
        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'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td><tr><td>error</td><td>mfaRequired</td><td>MFA
            is required</td></tr></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</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'
  /oauth2/directorycache/tpp/{globalUniqueReferenceId}:
    get:
      tags:
      - TPP Regulatory Data
      summary: Get the record of a specified TPP by its Global Unique Reference Number
        (GURN).
      operationId: getTpp
      produces:
      - application/json
      parameters:
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        type: string
        required: true
      - name: businessCode
        in: header
        description: The 3 character business code. Use GCB for consumer banking
        type: string
        required: true
      - name: consumerOrgCode
        in: header
        description: consumerOrgCode used to Identify partner by unique code
        type: string
        required: true
      - name: channelId
        in: header
        description: channelId used for of the incoming request
        type: string
        required: false
      - name: globalUniqueReferenceId
        in: path
        description: The Global Unique Reference Number (GURN) for the required TPP
          in the Directory.
        required: true
        type: string
        default: GB-FCA-900008
      responses:
        200:
          description: successful operation
          schema:
            $ref: '#/definitions/Tpp'
        400:
          description: General error when fulfilling the request would cause an invalid
            state (e.g. domain validation errors, missing data, etc.)
        404:
          description: The requested resource could not be found
  /oauth2/directorycache/tpp/{globalUniqueReferenceId}/sourceUrl:
    get:
      tags:
      - TPP Regulatory Data
      summary: Get the redirect URL of a specified TPP by its Global Unique Reference
        Number (GURN).
      operationId: getTppRedirecUrl
      produces:
      - application/json
      parameters:
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        type: string
        required: true
      - name: businessCode
        in: header
        description: The 3 character business code. Use GCB for consumer banking
        type: string
        required: true
      - name: consumerOrgCode
        in: header
        description: consumerOrgCode used to Identify partner by unique code
        type: string
        required: true
      - name: channelId
        in: header
        description: channelId used for of the incoming request
        type: string
        required: false
      - name: globalUniqueReferenceId
        in: path
        description: The Global Unique Reference Number (GURN) for the required TPP
          in the Directory.
        required: true
        type: string
        default: GB-FCA-900008
      responses:
        200:
          description: successful operation
          schema:
            $ref: '#/definitions/SourceUrlResponse'
        400:
          description: General error when fulfilling the request would cause an invalid
            state (e.g. domain validation errors, missing data, etc.)
        404:
          description: The requested resource could not be found
  /oauth2/directorycache/tpp/{globalUniqueReferenceId}/client:
    get:
      tags:
      - TPP client
      summary: Get the client records of a specified TPP by its Global Unique Reference
        Number (GURN).
      operationId: getTppClient
      produces:
      - application/json
      parameters:
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        type: string
        required: true
      - name: businessCode
        in: header
        description: The 3 character business code. Use GCB for consumer banking
        type: string
        required: true
      - name: consumerOrgCode
        in: header
        description: consumerOrgCode used to Identify partner by unique code
        type: string
        required: true
      - name: channelId
        in: header
        description: channelId used for of the incoming request
        type: string
        required: false
      - name: globalUniqueReferenceId
        in: path
        description: The Global Unique Reference Number (GURN) for the required TPP
          in the Directory.
        required: true
        type: string
        default: GB-FCA-900008
      responses:
        200:
          description: successful operation
          schema:
            type: array
            items:
              $ref: '#/definitions/TPPClient'
        400:
          description: General error when fulfilling the request would cause an invalid
            state (e.g. domain validation errors, missing data, etc.)
        404:
          description: The requested resource could not be found
    post:
      tags:
      - TPP client
      summary: Create a TPP client.
      operationId: createClient
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        type: string
        required: true
      - name: businessCode
        in: header
        description: The 3 character business code. Use GCB for consumer banking
        type: string
        required: true
      - name: consumerOrgCode
        in: header
        description: consumerOrgCode used to Identify partner by unique code
        type: string
        required: true
      - name: channelId
        in: header
        description: channelId used for of the incoming request
        type: string
        required: false
      - name: globalUniqueReferenceId
        in: path
        description: The Global Unique Reference Number (GURN) for the required TPP
          in the Directory.
        required: true
        type: string
        default: GB-FCA-900008
      - in: body
        name: client
        description: Creating a tpp client for a TPP
        schema:
          $ref: '#/definitions/TPPClient'
        required: true
      responses:
        200:
          description: successful operation
          schema:
            $ref: '#/definitions/TPPClient'
        400:
          description: General error when fulfilling the request would cause an invalid
            state (e.g. domain validation errors, missing data, etc.)
        404:
          description: The requested resource could not be found
  /oauth2/directorycache/client/{clientId}/qSealCert:
    get:
      tags:
      - TPP client
      summary: Get the Public Key of the Client's Qualified Certificate by Client's
        Client Id.
      operationId: getClientQSealCert
      produces:
      - application/json
      parameters:
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        type: string
        required: true
      - name: businessCode
        in: header
        description: The 3 character business code. Use GCB for consumer banking
        type: string
        required: true
      - name: consumerOrgCode
        in: header
        description: consumerOrgCode used to Identify partner by unique code
        type: string
        required: true
      - name: channelId
        in: header
        description: channelId used for of the incoming request
        type: string
        required: false
      - name: clientId
        in: path
        description: The client Id of a Tpp's Client.
        required: true
        type: string
        default: 06d29b80-5e68-4cb4-8a52-ffd5d626f13c
      responses:
        200:
          description: successful operation
          schema:
            $ref: '#/definitions/QSealCResponse'
        400:
          description: General error when fulfilling the request would cause an invalid
            state (e.g. domain validation errors, missing data, etc.)
        404:
          description: The requested resource could not be found
  /oauth2/directorycache/client/{clientId}/tpp:
    get:
      tags:
      - TPP client
      summary: Get the record of a specified TPP by the Clients Client Id .
      operationId: getClientTpp
      produces:
      - application/json
      parameters:
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        type: string
        required: true
      - name: businessCode
        in: header
        description: The 3 character business code. Use GCB for consumer banking
        type: string
        required: true
      - name: consumerOrgCode
        in: header
        description: consumerOrgCode used to Identify partner by unique code
        type: string
        required: true
      - name: channelId
        in: header
        description: channelId used for of the incoming request
        type: string
        required: false
      - name: clientId
        in: path
        description: The client Id of a Tpp's Client.
        required: true
        type: string
        default: 06d29b80-5e68-4cb4-8a52-ffd5d626f13c
      responses:
        200:
          description: successful operation
          schema:
            $ref: '#/definitions/Tpp'
        400:
          description: General error when fulfilling the request would cause an invalid
            state (e.g. domain validation errors, missing data, etc.)
        404:
          description: The requested resource could not be found
  /authCode/oauth2/consent:
    post:
      tags:
      - Consent
      summary: Create Unique Consent.
      operationId: createConsent
      produces:
      - application/json
      parameters:
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        type: string
        required: true
      - name: businessCode
        in: header
        description: The 3 character business code. Use GCB for consumer banking
        type: string
        required: true
      - name: i-cif
        in: header
        description: Unique number to identify a customer
        type: string
        required: true
      - name: ConsentRequest
        in: body
        description: ConsentRequest
        required: true
        schema:
          $ref: '#/definitions/ConsentRequest'
      responses:
        200:
          description: successful operation
          schema:
            $ref: '#/definitions/ConsentResponse'
        400:
          description: General error when fulfilling the request would cause an invalid
            state (e.g. domain validation errors, missing data, etc.)
        404:
          description: The requested resource could not be found
  /authCode/oauth2/consent/{consentId}:
    get:
      tags:
      - Consent
      summary: Retrieve Data for given consent.
      operationId: RetrieveConsent
      produces:
      - application/json
      parameters:
      - name: consentId
        in: path
        description: ID of a particular Consent.
        required: true
        type: string
        default: 06d29b80-5e68-4cb4-8a52-ffd5d626f13c
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: countryCode
        in: header
        description: Country code in 2 character ISO 3166 format
        type: string
        required: true
      - name: businessCode
        in: header
        description: The 3 character business code. Use GCB for consumer banking
        type: string
        required: true
      responses:
        200:
          description: successful operation
          schema:
            $ref: '#/definitions/GetConsentResponse'
        400:
          description: General error when fulfilling the request would cause an invalid
            state (e.g. domain validation errors, missing data, etc.)
        404:
          description: The requested resource could not be found
  /v1/oauth2/tpp/clients/certificate/validate:
    post:
      summary: Validate certificate
      tags:
      - Certificate Validation
      operationId: ValidateClientOauth2TppCertificate
      parameters:
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - 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: clientDetails
        in: header
        description: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: ValidateClientOauth2TppCertificateRequest
        in: body
        description: ValidateClientOauth2TppCertificateRequest
        required: true
        schema:
          $ref: '#/definitions/ValidateClientOauth2TppCertificateRequest'
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/ValidateClientOauth2TppCertificateResponse'
        400:
          $ref: '#/definitions/400BadRequestResponse'
        401:
          $ref: '#/definitions/401UnauthorizedResponse'
        404:
          $ref: '#/definitions/404NotFoundResponse'
        406:
          $ref: '#/definitions/406NotAcceptableResponse'
        500:
          $ref: '#/definitions/500InternalServerErrorResponse'
        502:
          $ref: '#/definitions/502BadGatewayResponse'
definitions:
  RetrieveOauth2UserAccountsResponse:
    properties:
      accounts:
        type: array
        items:
          $ref: '#/definitions/Accounts'
      scopes:
        description: scopes
        type: array
        items:
          properties:
            scopes:
              description: scopes
              type: string
      sharingDuration:
        description: sharingDuration
        type: string
  Accounts:
    properties:
      accountNumber:
        description: This is last 4 digits of the account number
        type: string
      accountType:
        description: This is the account type available with customer
        type: string
      accountId:
        description: This is the account ID. From host we get plain account number,
          auth to use logic to hash the account number to generate the accountID
        type: string
      accountSelectedFlag:
        description: This flag indicates the account selected by the customer in that
          session
        type: boolean
      existingConsentFlag:
        description: This flag is to indicate the account is associated with existing
          consent
        type: boolean
      statusIndicator:
        description: This indicator indicates the status whether the account selected
          is active or inactive
        type: string
      productName:
        description: This is product name
        type: string
      accountClosureDate:
        type: string
        example: 11-Nov-2000
    required:
    - accountId
  UpdateOauth2UserAccountsRequest:
    properties:
      account:
        type: array
        items:
          $ref: '#/definitions/Account'
  Account:
    properties:
      accountId:
        description: This is the account ID. From host we get plain account number,
          auth to use logic to hash the account number to generate the accountID
        type: string
      accountSelectedFlag:
        description: This flag indicates the account selected by the customer in that
          session
        type: boolean
      statusIndicator:
        description: This indicator indicates the status whether the account selected
          is active or inactive
        type: string
      accountClosureDate:
        type: string
        example: 11-Nov-2000
    required:
    - accountId
  ValidateClientOauth2TppCertificateRequest:
    properties:
      payloadDefinitionCertificate:
        description: Certificate Validation Payload
        type: array
        items:
          type: string
  UniqueRequestIdSchema:
    type: string
    description: Unique Request Id. Give it to the Support Desk if you eve need help
      with a request that does not work the way you expected.
  ValidateClientOauth2TppCertificateResponse:
    description: OK
    type: object
    properties:
      data:
        type: object
        properties:
          certificate:
            type: object
            properties:
              type:
                type: string
              eidas_profile:
                type: string
              qtsp_name:
                type: string
              qtsp_uri:
                type: string
              roles:
                type: array
                items:
                  type: string
              valid_eidas_certificate:
                type: boolean
              valid_obietf_certificate:
                type: boolean
              expired:
                type: boolean
              revoked:
                type: boolean
          organisation:
            type: object
            properties:
              onboarded_to_open_banking:
                type: boolean
              org_name:
                type: string
              passports:
                type: object
                properties:
                  nca_name:
                    type: object
                    properties:
                      permission_country:
                        type: array
                        items:
                          type: object
                          properties:
                            permission_type:
                              type: string
                            permissions:
                              type: array
                              items:
                                type: object
                                properties:
                                  code:
                                    type: string
                                  permission:
                                    type: string
                            roles:
                              type: array
                              items:
                                type: string
                      roles:
                        type: array
                        items:
                          type: string
              competent_authority_claims:
                type: array
                items:
                  type: object
                  properties:
                    authorization_domain:
                      type: string
                    authority_id:
                      type: string
                    registration_id:
                      type: string
                    status:
                      type: string
                    authorizations:
                      type: array
                      items:
                        type: object
                        properties:
                          member_state:
                            type: string
                          roles:
                            type: array
                            items:
                              type: string
              software_statements:
                type: array
                items:
                  type: object
                  properties:
                    software_id:
                      type: string
  400BadRequestResponse:
    description: Bad Request
    properties:
      type:
        $ref: '#/definitions/UniqueRequestIdSchema'
  401UnauthorizedResponse:
    description: Unauthorized
    properties:
      type:
        $ref: '#/definitions/UniqueRequestIdSchema'
  404NotFoundResponse:
    description: Not found
    properties:
      type:
        $ref: '#/definitions/UniqueRequestIdSchema'
  406NotAcceptableResponse:
    description: Not Acceptable
    properties:
      type:
        $ref: '#/definitions/UniqueRequestIdSchema'
  500InternalServerErrorResponse:
    description: Internal Server Error
    properties:
      type:
        $ref: '#/definitions/UniqueRequestIdSchema'
  502BadGatewayResponse:
    description: Bad Gateway
    properties:
      type:
        $ref: '#/definitions/UniqueRequestIdSchema'
  DynamicClientOauth2TppRegistrationRequest:
    type: object
    required:
    - client_id
    - client_id_issued_at
    - client_name
    - software_id
    - software_client_id
    - software_client_name
    - software_client_description
    - software_version
    - software_client_uri
    - software_redirect_uris
    - software_roles
    - software_logo_uri
    - org_status
    - org_id
    - org_name
    - org_jwks_endpoint
    - org_jwks_revoked_endpoint
    - software_jwks_endpoint
    - software_jwks_revoked_endpoint
    - software_policy_uri
    - software_tos_uri
    - software_on_behalf_of_org
    - ob_registry_tos
    properties:
      client_id:
        description: Data Holder issued client identifier string
        type: string
        example: 35a5a70b-5b8d-41f4-9cbd-96cfbc15c58a
      client_id_issued_at:
        description: Time at which the client identifier was issued expressed as seconds
          since 1970-01-01T00:00:00Z as measured in UTC
        type: integer
        format: int32
        example: 1571808167
      client_name:
        description: Human-readable string name of the software product to be presented
          to the end-user during authorization
        type: string
        example: Mock Software
      software_id:
        description: String representing a unique identifier assigned by the OBIE
          and used by registration endpoints to identify the software product to be
          dynamically registered. </br></br>The "software_id" will remain the same
          for the lifetime of the product, across multiple updates and versions
        type: string
        example: 740C368F-ECF9-4D29-A2EA-0514A66B0CDE
      software_client_id:
        description: 'String representing a unique Client identifier assigned by the
          OBIE '
        type: string
        example: 740C368F-ECF9-4D29
      software_client_name:
        description: Human-readable string name of the TPP
        type: string
        example: Amazon Prime Movies
      software_client_description:
        description: Detailed Description of Human-readable string name of the TPP
        type: string
        example: Amazon Prime Movies is a moving streaming service
      software_version:
        description: Versioning of the software
        type: string
        example: "2.2"
      software_client_uri:
        description: URL string that points to a human-readable document for the Software
          Product
        type: string
        example: https://prime.amazon.com
      software_redirect_uris:
        description: Array of redirection URI strings for use in redirect-based flows
        type: array
        items:
          type: string
          format: uri
        example:
        - https://prime.amazon.com/cb
        - https://prime.amazon.co.uk/cb
      software_roles:
        description: Array of Software Roles
        type: array
        items:
          type: string
          format: uri
        example:
        - PISP
        - AISP
      software_logo_uri:
        description: URL string that points to a Logo document for the Software Product
        type: string
        example: https://prime.amazon.com/logo.png
      org_status:
        description: string Representing Org status
        type: string
        example: Active
      org_id:
        description: A unique identifier string assigned by the OBIE that identifies
          the TPP
        type: string
        example: 3B0B0A7B-3E7B-4A2C-9497-E357A71D07C8
      org_name:
        description: Human-readable string name of the TPP to be presented to the
          end user during authorization
        example: Mock Company Inc.
        type: string
      org_jwks_endpoint:
        description: URL string referencing the client JSON Web Key (JWK) Set [RFC7517]
          document, which contains the client public keys
        type: string
        example: https://jwks.openbanking.org.uk/org_id/org_id.jkws
      org_jwks_revoked_endpoint:
        description: URL string referencing the Revoked client JSON Web Key (JWK)
          Set [RFC7517] document, which contains the client public keys
        type: string
        example: https://jwks.openbanking.org.uk/org_id/revoked/org_id.jkws
      software_jwks_endpoint:
        description: URL string referencing the Software JSON Web Key (JWK) Set [RFC7517]
          document, which contains the client public keys
        type: string
        example: https://jwks.openbanking.org.uk/org_id/software_id.jkws
      software_jwks_revoked_endpoint:
        description: URL string referencing the revoked Software JSON Web Key (JWK)
          Set [RFC7517] document, which contains the client public keys
        type: string
        example: https://jwks.openbanking.org.uk/org_id/revoked/software_id.jkws
      redirect_uris:
        description: Array of redirection URI strings for use in redirect-based flows
        type: array
        items:
          type: string
          format: uri
        example:
        - https://www.mockcompany.com.au/redirects/redirect1
        - https://www.mockcompany.com.au/redirects/redirect2
      logo_uri:
        description: URL string that references a logo for the client. If present,
          the server SHOULD display this image to the end-user during approval
        type: string
        example: https://www.mockcompany.com.au/logos/logo1.png
      software_tos_uri:
        description: URL string that points to a human-readable terms of service document
          for the Software Product
        type: string
        example: https://tpp.com/tos.html
      software_policy_uri:
        description: URL string that points to a human-readable policy document for
          the Software Product
        type: string
        example: https://tpp.com/policy.html
      software_on_behalf_of_org:
        description: URL string that references a proxy Org which has requested for
          the Software.
        type: string
        example: https://api.openbanking.org.uk/scim2/OBTrustedPaymentParty/1234567789
      ob_registry_tos:
        description: ob_registry_tos
        type: string
        example: https://registry.openbanking.org.uk/tos.html
  DynamicClientOauth2TppRegistrationResponse:
    type: object
    required:
    - client_id
    - client_id_issued_at
    - client_name
    - software_id
    - software_client_id
    - software_client_name
    - software_client_description
    - software_version
    - software_client_uri
    - software_redirect_uris
    - software_roles
    - software_logo_uri
    - org_status
    - org_id
    - org_name
    - org_jwks_endpoint
    - org_jwks_revoked_endpoint
    - software_jwks_endpoint
    - software_jwks_revoked_endpoint
    - software_policy_uri
    - software_tos_uri
    - software_on_behalf_of_org
    - ob_registry_tos
    - createdDate
    - status
    properties:
      client_id:
        description: Data Holder issued client identifier string
        type: string
        example: 35a5a70b-5b8d-41f4-9cbd-96cfbc15c58a
      client_id_issued_at:
        description: Time at which the client identifier was issued expressed as seconds
          since 1970-01-01T00:00:00Z as measured in UTC
        type: integer
        format: int32
        example: 1571808167
      client_name:
        description: Human-readable string name of the software product to be presented
          to the end-user during authorization
        type: string
        example: Mock Software
      software_id:
        description: String representing a unique identifier assigned by the OBIE
          and used by registration endpoints to identify the software product to be
          dynamically registered. </br></br>The "software_id" will remain the same
          for the lifetime of the product, across multiple updates and versions
        type: string
        example: 740C368F-ECF9-4D29-A2EA-0514A66B0CDE
      software_client_id:
        description: 'String representing a unique Client identifier assigned by the
          OBIE '
        type: string
        example: 740C368F-ECF9-4D29
      software_client_name:
        description: Human-readable string name of the TPP
        type: string
        example: Amazon Prime Movies
      software_client_description:
        description: Detailed Description of Human-readable string name of the TPP
        type: string
        example: Amazon Prime Movies is a moving streaming service
      software_version:
        description: Versioning of the software
        type: string
        example: "2.2"
      software_client_uri:
        description: URL string that points to a human-readable document for the Software
          Product
        type: string
        example: https://prime.amazon.com
      software_redirect_uris:
        description: Array of redirection URI strings for use in redirect-based flows
        type: array
        items:
          type: string
          format: uri
        example:
        - https://prime.amazon.com/cb
        - https://prime.amazon.co.uk/cb
      software_roles:
        description: Array of Software Roles
        type: array
        items:
          type: string
          format: uri
        example:
        - PISP
        - AISP
      software_logo_uri:
        description: URL string that points to a Logo document for the Software Product
        type: string
        example: https://prime.amazon.com/logo.png
      org_status:
        description: string Representing Org status
        type: string
        example: Active
      org_id:
        description: A unique identifier string assigned by the OBIE that identifies
          the TPP
        type: string
        example: 3B0B0A7B-3E7B-4A2C-9497-E357A71D07C8
      org_name:
        description: Human-readable string name of the TPP to be presented to the
          end user during authorization
        example: Mock Company Inc.
        type: string
      org_jwks_endpoint:
        description: URL string referencing the client JSON Web Key (JWK) Set [RFC7517]
          document, which contains the client public keys
        type: string
        example: https://jwks.openbanking.org.uk/org_id/org_id.jkws
      org_jwks_revoked_endpoint:
        description: URL string referencing the Revoked client JSON Web Key (JWK)
          Set [RFC7517] document, which contains the client public keys
        type: string
        example: https://jwks.openbanking.org.uk/org_id/revoked/org_id.jkws
      software_jwks_endpoint:
        description: URL string referencing the Software JSON Web Key (JWK) Set [RFC7517]
          document, which contains the client public keys
        type: string
        example: https://jwks.openbanking.org.uk/org_id/software_id.jkws
      software_jwks_revoked_endpoint:
        description: URL string referencing the revoked Software JSON Web Key (JWK)
          Set [RFC7517] document, which contains the client public keys
        type: string
        example: https://jwks.openbanking.org.uk/org_id/revoked/software_id.jkws
      redirect_uris:
        description: Array of redirection URI strings for use in redirect-based flows
        type: array
        items:
          type: string
          format: uri
        example:
        - https://www.mockcompany.com.au/redirects/redirect1
        - https://www.mockcompany.com.au/redirects/redirect2
      logo_uri:
        description: URL string that references a logo for the client. If present,
          the server SHOULD display this image to the end-user during approval
        type: string
        example: https://www.mockcompany.com.au/logos/logo1.png
      software_tos_uri:
        description: URL string that points to a human-readable terms of service document
          for the Software Product
        type: string
        example: https://tpp.com/tos.html
      software_policy_uri:
        description: URL string that points to a human-readable policy document for
          the Software Product
        type: string
        example: https://tpp.com/policy.html
      software_on_behalf_of_org:
        description: URL string that references a proxy Org which has requested for
          the Software.
        type: string
        example: https://api.openbanking.org.uk/scim2/OBTrustedPaymentParty/1234567789
      ob_registry_tos:
        description: ob_registry_tos
        type: string
        example: https://registry.openbanking.org.uk/tos.html
  UpdateDynamicClientOauth2TppRegistrationsRequest:
    type: object
    required:
    - client_id
    - client_id_issued_at
    - client_name
    - software_id
    - software_client_id
    - software_client_name
    - software_client_description
    - software_version
    - software_client_uri
    - software_redirect_uris
    - software_roles
    - software_logo_uri
    - org_status
    - org_id
    - org_name
    - org_jwks_endpoint
    - org_jwks_revoked_endpoint
    - software_jwks_endpoint
    - software_jwks_revoked_endpoint
    - software_policy_uri
    - software_tos_uri
    - software_on_behalf_of_org
    - ob_registry_tos
    properties:
      client_id:
        description: Data Holder issued client identifier string
        type: string
        example: 35a5a70b-5b8d-41f4-9cbd-96cfbc15c58a
      client_id_issued_at:
        description: Time at which the client identifier was issued expressed as seconds
          since 1970-01-01T00:00:00Z as measured in UTC
        type: integer
        format: int32
        example: 1571808167
      client_name:
        description: Human-readable string name of the software product to be presented
          to the end-user during authorization
        type: string
        example: Mock Software
      software_id:
        description: String representing a unique identifier assigned by the OBIE
          and used by registration endpoints to identify the software product to be
          dynamically registered. </br></br>The "software_id" will remain the same
          for the lifetime of the product, across multiple updates and versions
        type: string
        example: 740C368F-ECF9-4D29-A2EA-0514A66B0CDE
      software_client_id:
        description: 'String representing a unique Client identifier assigned by the
          OBIE '
        type: string
        example: 740C368F-ECF9-4D29
      software_client_name:
        description: Human-readable string name of the TPP
        type: string
        example: Amazon Prime Movies
      software_client_description:
        description: Detailed Description of Human-readable string name of the TPP
        type: string
        example: Amazon Prime Movies is a moving streaming service
      software_version:
        description: Versioning of the software
        type: string
        example: "2.2"
      software_client_uri:
        description: URL string that points to a human-readable document for the Software
          Product
        type: string
        example: https://prime.amazon.com
      software_redirect_uris:
        description: Array of redirection URI strings for use in redirect-based flows
        type: array
        items:
          type: string
          format: uri
        example:
        - https://prime.amazon.com/cb
        - https://prime.amazon.co.uk/cb
      software_roles:
        description: Array of Software Roles
        type: array
        items:
          type: string
          format: uri
        example:
        - PISP
        - AISP
      software_logo_uri:
        description: URL string that points to a Logo document for the Software Product
        type: string
        example: https://prime.amazon.com/logo.png
      org_status:
        description: string Representing Org status
        type: string
        example: Active
      org_id:
        description: A unique identifier string assigned by the OBIE that identifies
          the TPP
        type: string
        example: 3B0B0A7B-3E7B-4A2C-9497-E357A71D07C8
      org_name:
        description: Human-readable string name of the TPP to be presented to the
          end user during authorization
        example: Mock Company Inc.
        type: string
      org_jwks_endpoint:
        description: URL string referencing the client JSON Web Key (JWK) Set [RFC7517]
          document, which contains the client public keys
        type: string
        example: https://jwks.openbanking.org.uk/org_id/org_id.jkws
      org_jwks_revoked_endpoint:
        description: URL string referencing the Revoked client JSON Web Key (JWK)
          Set [RFC7517] document, which contains the client public keys
        type: string
        example: https://jwks.openbanking.org.uk/org_id/revoked/org_id.jkws
      software_jwks_endpoint:
        description: URL string referencing the Software JSON Web Key (JWK) Set [RFC7517]
          document, which contains the client public keys
        type: string
        example: https://jwks.openbanking.org.uk/org_id/software_id.jkws
      software_jwks_revoked_endpoint:
        description: URL string referencing the revoked Software JSON Web Key (JWK)
          Set [RFC7517] document, which contains the client public keys
        type: string
        example: https://jwks.openbanking.org.uk/org_id/revoked/software_id.jkws
      redirect_uris:
        description: Array of redirection URI strings for use in redirect-based flows
        type: array
        items:
          type: string
          format: uri
        example:
        - https://www.mockcompany.com.au/redirects/redirect1
        - https://www.mockcompany.com.au/redirects/redirect2
      logo_uri:
        description: URL string that references a logo for the client. If present,
          the server SHOULD display this image to the end-user during approval
        type: string
        example: https://www.mockcompany.com.au/logos/logo1.png
      software_tos_uri:
        description: URL string that points to a human-readable terms of service document
          for the Software Product
        type: string
        example: https://tpp.com/tos.html
      software_policy_uri:
        description: URL string that points to a human-readable policy document for
          the Software Product
        type: string
        example: https://tpp.com/policy.html
      software_on_behalf_of_org:
        description: URL string that references a proxy Org which has requested for
          the Software.
        type: string
        example: https://api.openbanking.org.uk/scim2/OBTrustedPaymentParty/1234567789
      ob_registry_tos:
        description: ob_registry_tos
        type: string
        example: https://registry.openbanking.org.uk/tos.html
  UpdateDynamicClientOauth2TppRegistrationsResponse:
    type: object
    required:
    - client_id
    - client_id_issued_at
    - client_name
    - software_id
    - software_client_id
    - software_client_name
    - software_client_description
    - software_version
    - software_client_uri
    - software_redirect_uris
    - software_roles
    - software_logo_uri
    - org_status
    - org_id
    - org_name
    - org_jwks_endpoint
    - org_jwks_revoked_endpoint
    - software_jwks_endpoint
    - software_jwks_revoked_endpoint
    - software_policy_uri
    - software_tos_uri
    - software_on_behalf_of_org
    - ob_registry_tos
    - createdDate
    - status
    properties:
      client_id:
        description: Data Holder issued client identifier string
        type: string
        example: 35a5a70b-5b8d-41f4-9cbd-96cfbc15c58a
      client_id_issued_at:
        description: Time at which the client identifier was issued expressed as seconds
          since 1970-01-01T00:00:00Z as measured in UTC
        type: integer
        format: int32
        example: 1571808167
      client_name:
        description: Human-readable string name of the software product to be presented
          to the end-user during authorization
        type: string
        example: Mock Software
      software_id:
        description: String representing a unique identifier assigned by the OBIE
          and used by registration endpoints to identify the software product to be
          dynamically registered. </br></br>The "software_id" will remain the same
          for the lifetime of the product, across multiple updates and versions
        type: string
        example: 740C368F-ECF9-4D29-A2EA-0514A66B0CDE
      software_client_id:
        description: 'String representing a unique Client identifier assigned by the
          OBIE '
        type: string
        example: 740C368F-ECF9-4D29
      software_client_name:
        description: Human-readable string name of the TPP
        type: string
        example: Amazon Prime Movies
      software_client_description:
        description: Detailed Description of Human-readable string name of the TPP
        type: string
        example: Amazon Prime Movies is a moving streaming service
      software_version:
        description: Versioning of the software
        type: string
        example: "2.2"
      software_client_uri:
        description: URL string that points to a human-readable document for the Software
          Product
        type: string
        example: https://prime.amazon.com
      software_redirect_uris:
        description: Array of redirection URI strings for use in redirect-based flows
        type: array
        items:
          type: string
          format: uri
        example:
        - https://prime.amazon.com/cb
        - https://prime.amazon.co.uk/cb
      software_roles:
        description: Array of Software Roles
        type: array
        items:
          type: string
          format: uri
        example:
        - PISP
        - AISP
      software_logo_uri:
        description: URL string that points to a Logo document for the Software Product
        type: string
        example: https://prime.amazon.com/logo.png
      org_status:
        description: string Representing Org status
        type: string
        example: Active
      org_id:
        description: A unique identifier string assigned by the OBIE that identifies
          the TPP
        type: string
        example: 3B0B0A7B-3E7B-4A2C-9497-E357A71D07C8
      org_name:
        description: Human-readable string name of the TPP to be presented to the
          end user during authorization
        example: Mock Company Inc.
        type: string
      org_jwks_endpoint:
        description: URL string referencing the client JSON Web Key (JWK) Set [RFC7517]
          document, which contains the client public keys
        type: string
        example: https://jwks.openbanking.org.uk/org_id/org_id.jkws
      org_jwks_revoked_endpoint:
        description: URL string referencing the Revoked client JSON Web Key (JWK)
          Set [RFC7517] document, which contains the client public keys
        type: string
        example: https://jwks.openbanking.org.uk/org_id/revoked/org_id.jkws
      software_jwks_endpoint:
        description: URL string referencing the Software JSON Web Key (JWK) Set [RFC7517]
          document, which contains the client public keys
        type: string
        example: https://jwks.openbanking.org.uk/org_id/software_id.jkws
      software_jwks_revoked_endpoint:
        description: URL string referencing the revoked Software JSON Web Key (JWK)
          Set [RFC7517] document, which contains the client public keys
        type: string
        example: https://jwks.openbanking.org.uk/org_id/revoked/software_id.jkws
      redirect_uris:
        description: Array of redirection URI strings for use in redirect-based flows
        type: array
        items:
          type: string
          format: uri
        example:
        - https://www.mockcompany.com.au/redirects/redirect1
        - https://www.mockcompany.com.au/redirects/redirect2
      logo_uri:
        description: URL string that references a logo for the client. If present,
          the server SHOULD display this image to the end-user during approval
        type: string
        example: https://www.mockcompany.com.au/logos/logo1.png
      software_tos_uri:
        description: URL string that points to a human-readable terms of service document
          for the Software Product
        type: string
        example: https://tpp.com/tos.html
      software_policy_uri:
        description: URL string that points to a human-readable policy document for
          the Software Product
        type: string
        example: https://tpp.com/policy.html
      software_on_behalf_of_org:
        description: URL string that references a proxy Org which has requested for
          the Software.
        type: string
        example: https://api.openbanking.org.uk/scim2/OBTrustedPaymentParty/1234567789
      ob_registry_tos:
        description: ob_registry_tos
        type: string
        example: https://registry.openbanking.org.uk/tos.html
  RetrieveDynamicClientOath2TppRegistrationResponse:
    properties:
      status:
        enum:
        - REGISTRED
        - NOT_REGISTERED
        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: object
    required:
    - type
    - code
  RetrieveDynamicClientOauth2TppRegistrationOpenBankingKeyResponse:
    required:
    - keys
    type: object
    properties:
      keys:
        description: Response data for the query
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/keys'
  RetrieveDynamicClientOauth2TppRegistrationKeyResponse:
    required:
    - keys
    type: object
    properties:
      keys:
        description: Response data for the query
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/keys'
  keys:
    required:
    - kid
    - kty
    - "n"
    - e
    - x5c
    - x5t
    - x5t#256
    - x5U
    - use
    type: object
    properties:
      e:
        example: AQAB
        type: string
      kid:
        example: j8HWY00aIBmKA1OW7YntvtKUM2runx7oAgbKhIDMH3I=
        type: string
      kty:
        example: RSA
        type: string
      "n":
        example: qCLGXeBBTYk6sOQxLRJtm3Je1zfOEz-bvRF9J_WUaRckZ1zmi9w5vsYNquhCT7EkNUEc4YpwNNpFAmTHvcdoF5cEkwBEx6y1lnUQo0xAFlrZY5-fBYXb9by3kZxhH_PLOgtHlxr4mUzFB-WxcBnMvb8zpc-emFFIhtRxiF_BJyiYcTgDE33RwJqmDjih7SNM3kXYsYPyrXO8WvpVHpwmUvaH4fLsdmB0udiiD_NrT7XSTaHIUh_Q-pd8bU_KtnIBreEwTyUxnFMzVuruGlKKOMM78xfu-ltrAVBGrafZD9oYoij79qoFVAuAA5Tcwr-rhv17kwu2RkMOYg9Rc_6OlQ
        type: string
      x5c:
        type: array
        items:
          type: string
          format: uri
        example:
        - MIIFIjCCBAqgAwIBAgIEWcYQMzANBgkqhkiG9w0BAQsFADBTMQswCQYDVQQGEwJHQjEUMBIGA1UEChMLT3BlbkJhbmtpbmcxLjAsBgNVBAMTJU9wZW5CYW5raW5nIFByZS1Qcm9kdWN0aW9uIElzc3VpbmcgQ0EwHhcNMjEwMTIwMTQ1NzE1WhcNMjIwMjIwMTUyNzE1WjBWMQswCQYDVQQGEwJHQjEUMBIGA1UEChMLT3BlbkJhbmtpbmcxHzAdBgNVBAsTFk9wZW4gQmFua2luZyBEaXJlY3RvcnkxEDAOBgNVBAMTB3NpZ25pbmcwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCoIsZd4EFNiTqw5DEtEm2bcl7XN84TP5u9EX0n9ZRpFyRnXOaL3Dm+xg2q6EJPsSQ1QRzhinA02kUCZMe9x2gXlwSTAETHrLWWdRCjTEAWWtljn58Fhdv1vLeRnGEf88s6C0eXGviZTMUH5bFwGcy9vzOlz56YUUiG1HGIX8EnKJhxOAMTfdHAmqYOOKHtI0zeRdixg/Ktc7xa+lUenCZS9ofh8ux2YHS52KIP82tPtdJNochSH9D6l3xtT8q2cgGt4TBPJTGcUzNW6u4aUoo4wzvzF+76W2sBUEatp9kP2hiiKPv2qgVUC4ADlNzCv6uG/XuTC7ZGQw5iD1Fz/o6VAgMBAAGjggH5MIIB9TAOBgNVHQ8BAf8EBAMCBsAwFQYDVR0lBA4wDAYKKwYBBAGCNwoDDDCB4AYDVR0gBIHYMIHVMIHSBgsrBgEEAah1gQYBZDCBwjAqBggrBgEFBQcCARYeaHR0cDovL29iLnRydXN0aXMuY29tL3BvbGljaWVzMIGTBggrBgEFBQcCAjCBhgyBg1VzZSBvZiB0aGlzIENlcnRpZmljYXRlIGNvbnN0aXR1dGVzIGFjY2VwdGFuY2Ugb2YgdGhlIE9wZW5CYW5raW5nIFJvb3QgQ0EgQ2VydGlmaWNhdGlvbiBQb2xpY2llcyBhbmQgQ2VydGlmaWNhdGUgUHJhY3RpY2UgU3RhdGVtZW50MG0GCCsGAQUFBwEBBGEwXzAmBggrBgEFBQcwAYYaaHR0cDovL29iLnRydXN0aXMuY29tL29jc3AwNQYIKwYBBQUHMAKGKWh0dHA6Ly9vYi50cnVzdGlzLmNvbS9vYl9wcF9pc3N1aW5nY2EuY3J0MDoGA1UdHwQzMDEwL6AtoCuGKWh0dHA6Ly9vYi50cnVzdGlzLmNvbS9vYl9wcF9pc3N1aW5nY2EuY3JsMB8GA1UdIwQYMBaAFFBzkcYhctN39P4AEgaBXHl5bj9QMB0GA1UdDgQWBBTnLDN3hdnQOnyF4Fq+XM1QQ/pYljANBgkqhkiG9w0BAQsFAAOCAQEAPaOxEVeFiHdlqFeGszrpq4iBvAyjq1WmnmndXnhUD9dYqVaRDFI3F4fDlt/eJAcDTFPguFu7WZyu+I0JpQ3RR2dq32sXBnNv/gksUwo9DVXmLO6tLxVZwKSN1DQ3QmYHxfnCHb4N870xdz8OGFTpMtTALd6gBcniBTKtgwuUuojCz7VV/v1stXWy0NBNwxf8affp9qE2BepWW88xMfbEb0UB3JtBL7dqRS4vupHGb+WX0XGq1DqZ2ulOd1D18sLYXr3WVOP8JX1Av1w5FCXsQqZ44qx31UXnCxy7y4xtJKTgct9m9nQ5ISdvRi1TeLrEMdzgtWWf7RimEqS/+LVtKw==
        - MIIGEzCCA/ugAwIBAgIEWcT9RzANBgkqhkiG9w0BAQsFADBQMQswCQYDVQQGEwJHQjEUMBIGA1UEChMLT3BlbkJhbmtpbmcxKzApBgNVBAMTIk9wZW5CYW5raW5nIFByZS1Qcm9kdWN0aW9uIFJvb3QgQ0EwHhcNMTcwOTIyMTI0NjU3WhcNMjcwOTIyMTMxNjU3WjBTMQswCQYDVQQGEwJHQjEUMBIGA1UEChMLT3BlbkJhbmtpbmcxLjAsBgNVBAMTJU9wZW5CYW5raW5nIFByZS1Qcm9kdWN0aW9uIElzc3VpbmcgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCyyrRg2jF01jXhX3IR44p338ZBozn8WkZaCN8MB+AlBfuXHD6mC/0v+N/Z4XI6E5pzArmTho8D6a6JDpAHmmefqGSqOXVbclYv1tHFjmC1FtKqkFHTTMyhl41nEMo0dnvWA45bMsGm0yMi/tEM5Vb5dSY4Zr/2LWgUTDFUisgUbyIIHT+L6qxPUPCpNuEd+AWVc9K0SlmhaC+UIfVO83gE1+9ar2dONSFaK/a445Us6MnqgKvfkvKdaR06Ok/EhGgiAZORcyZ61EYFVVzJewy5NrFSF3mwiPYvMxoT5bxcwAEvxqBXpTDv8njQfR+cgZDeloeK1UqmW/DpR+jj3KNHAgMBAAGjggHwMIIB7DAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIBADCB4AYDVR0gBIHYMIHVMIHSBgsrBgEEAah1gQYBZDCBwjAqBggrBgEFBQcCARYeaHR0cDovL29iLnRydXN0aXMuY29tL3BvbGljaWVzMIGTBggrBgEFBQcCAjCBhgyBg1VzZSBvZiB0aGlzIENlcnRpZmljYXRlIGNvbnN0aXR1dGVzIGFjY2VwdGFuY2Ugb2YgdGhlIE9wZW5CYW5raW5nIFJvb3QgQ0EgQ2VydGlmaWNhdGlvbiBQb2xpY2llcyBhbmQgQ2VydGlmaWNhdGUgUHJhY3RpY2UgU3RhdGVtZW50MGoGCCsGAQUFBwEBBF4wXDAyBggrBgEFBQcwAoYmaHR0cDovL29iLnRydXN0aXMuY29tL29idGVzdHJvb3RjYS5jcnQwJgYIKwYBBQUHMAGGGmh0dHA6Ly9vYi50cnVzdGlzLmNvbS9vY3NwMDcGA1UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9vYi50cnVzdGlzLmNvbS9vYl9wcF9yb290Y2EuY3JsMB8GA1UdIwQYMBaAFOw4jgva8/k3PpDefV9q5mDNeUKDMB0GA1UdDgQWBBRQc5HGIXLTd/T+ABIGgVx5eW4/UDANBgkqhkiG9w0BAQsFAAOCAgEAdRg2H9uLwzlGqvHGjIz0ydM1tElujEcWJp5MeiorikK0rMOlxVU6ZFBlXPfO1APu0cZXxfHwWs91zoNCpGXebC6tiDFQ3+mI4qywtippjBqb6Sft37NlkXDzQETomsY7wETuUJ31xFA0FccI8WlAUzUOBE8OAGo5kAZ4FTa/nkd8c2wmuwSp+9/s+gQe0K9BkxywoP1WAEdUAaKW3RE9yuTbHA/ZF/zz4/Rpw/FB/hYhOxvDV6qInl5B7ErSH4r4v4D2jiE6apAcn5LT+e0aBa/EgGAxgyAgrYpw1s+TCUJot+227xRvXxeeZzXa2igsd+C845BGiSlthzr0mqYDYEWJMfApZ+BlMtxa7K9T3D2l6XMv12RoNnEWe6H5xazTvBLiTibW3c5ij8WWKJNtQbgmooRPaKJIl+0rm54MFH0FDxJ+P4mAR6qa8JS911nS26iCsE9FQVK51djuct349FYBOVM595/GkkTz9k1vXw1BdD71lNjI00Yjf73AAtvL/X4CpRz92NagshS2Ia5a3qjjFrjx7z4h7QtMJGjuUsjTI/c+yjIYwAZ5gelF5gz7l2dn3g6B40pu7y1EewlfIQh/HVMF0ZpF29XL6+7siYQCGhP5cNJ04fotzqDPaT2XlOhE3yNkjp82uzCWvhLUJgE3D9V9PL0XD/ykNEP0Fio=
        - MIIFYDCCA0igAwIBAgIEWcT89jANBgkqhkiG9w0BAQsFADBQMQswCQYDVQQGEwJHQjEUMBIGA1UEChMLT3BlbkJhbmtpbmcxKzApBgNVBAMTIk9wZW5CYW5raW5nIFByZS1Qcm9kdWN0aW9uIFJvb3QgQ0EwHhcNMTcwOTIyMTEzOTQyWhcNMzcwOTIyMTIwOTQyWjBQMQswCQYDVQQGEwJHQjEUMBIGA1UEChMLT3BlbkJhbmtpbmcxKzApBgNVBAMTIk9wZW5CYW5raW5nIFByZS1Qcm9kdWN0aW9uIFJvb3QgQ0EwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCYuk3s8HqlNQL6ahJuHybswCgIWkDv6U7O3WbNWNeIR3PdAEd23EppcT2r6z96+TrLqGCgdf6z2YouLOt62A2JqJ4iJaVFjt0e9j5bQqPhNEVieSqNB8xhUlpGFEXdj7GPw03qvSeqGITSfjsV9Vi8NZgUqtYKdZPVa1FL3vR1YVN052nO/tFewoFn5AdEC/SrpIPyXk50SvXzbx9vBJnA6MLJ8CoI9yNyI7j6QyL35OeUf6c7fDTkLB2Vf29RjL/YhJy70GXt0sUbL5N9Rezr8JlhwGEPRpr0D+rKyYLoGWLUtoSvYwPC85ePMWmdlUwOaC59NLUihiy4uszE2qP2CJslHdOhgWkCQ86K+yga+lCh6GX7qPZKNnS3YsjZ+23o1+ZNzbKcOGsbCdP/hXzTa/D8fyo/0MTMqXsEbOqqocD1CfGNv1Bfn2rbe41oKAv2fiEYf4Qrq9f16jrTK4f3bUA1V7xiu2YRDFdSJ7CZvtrpLwPXP/WeYZaeO+SJQq2+Ag67aEi+9A+Zy+QjWwjCoqgNJGRZiEjQhU7gX6Nz9GeRNV3RGHUKUqRtFrMxvG0M1FjODC7kosEscZtI4FkBTLtAoV4XqOsLtfm2kxrTA58zf+dnlIb51Mne63f5GUd4+Cyb3SUcvqFj4FQtzIO44FvArraFkCvC/vi5IYANvQIDAQABo0IwQDAOBgNVHQ8BAf8EBAMCAQYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQU7DiOC9rz+Tc+kN59X2rmYM15QoMwDQYJKoZIhvcNAQELBQADggIBABidG6pXhNLmLOzHl7lP3j/SEE4Mq9DQLkirfM3JeXmcOB0xKwqvpzJSjeKx9+hYlQRKorIc5QD1hLKqjG7CqUNcCgPGXU96iofcUPthFI+fgkJL6yMOtlLiidlFlchYmIHk2SjhMUP/TQzwHe2Ca0ssCRgyJ1DEkaxkurEb2H8jZVpEVlHJrc3itxzYm4Un11Zh+brNvrZfc2Phy4fu3HckphxCsJ76ZbpyiuZ7lWnDT6hONH+zEHITsEmYsje1xRiDR3MJSty7xf06qe7UEKtsFgwGuzS/4IQIRKKfgk1RUZH6WxK+ZsB9HsYVP/sSVEZWNUT3z9N4hveIrP/So0A8toAID0nNOqC5o9yBdQTKN9IX5Neh801PTX183/t/OC2JEFAPvo6IxXtMpfI2aTxrpBWKIBX5xgFs5lJH7nJ8CKkWIdGo6hhrx8IflpAKuq+YXLhWFWuyyP6R8VfRXWRv3ZiZVXrgsDx2RA4Q2r4AE2BjGxyYW/vxF73B3Yf0yi1IBOQ9d+VqT8hSO76zYWY+1r5+qWzsqT4tIIWG6ZA8ckcnpjnxgM/XnDwtJICq3DR8C2rSeyed3x9CCtAbgKpvc2bGWZtISZti93Smy5aotMm+4aKpm7EZRfSsD2knnIn31bnaW3SDokLiG7OnFFU2lMkcrlFFsTeWq5Sn/XUD
      x5t:
        example: SJvQicc88ds08xL7No3KdnVfjrc=
        type: string
      x5t#256:
        example: j8HWY00aIBmKA1OW7YntvtKUM2runx7oAgbKhIDMH3I=
        type: string
      x5u:
        example: https://keystore.openbankingtest.org.uk/keystore/openbanking.pem
        type: string
      use:
        example: sig
        type: string
  Tpp:
    type: object
    properties:
      globalUrn:
        type: string
        description: Global Unique Reference Number
        example: GB-FCA-100008
      directoryStatus:
        type: string
        description: Status of the TPP in the Directory
        example: Active
        enum:
        - Active
        - Inactive
        - Deleted
      dateStopped:
        type: string
        format: date-time
        description: Date and time the TPP was created in the Directory in ISO8601
          format
        example: "2017-10-23"
      recordDate:
        type: string
        format: date-time
        description: Date and time the TPP was updated in the Directory in ISO8601
          format
        example: "2017-11-12T23:34:45Z"
      recordVersion:
        type: integer
        description: Recorded version
        example: 3
      competentAuthoritySourceUrl:
        description: Authority Source URL
        type: string
        example: https://www.fca.org.uk/Company=123
      competentAuthorityUrn:
        type: string
        description: Competent Authority Unique Reference Number
        example: "100008"
      competentAuthorityCode:
        type: string
        description: ID of the Competent Authority Register within the Directory
        example: FCA
      competentAuthorityCountry:
        type: string
        description: 2 Digit ISO Country Code of the Competent Authority. Note ISO
          standard is used in place of EU publications - GR = Greece, GB = United
          Kingdom
        example: GB
      name:
        type: string
        description: Name of the TPP as specified in the Competent Authority Register
        example: Royal Bank Of Scotland
      competentAuthorityStartedDate:
        type: string
        format: date-time
        description: Authority Started Date
        example: "2011-05-19"
      competentAuthorityStatus:
        type: string
        description: Authority Status
        example: Authorised
      pspCategory:
        type: string
        description: PSG Category name .
        example: Credit Institution
      legalEntityIdentifier:
        type: string
        description: Legal Entity Identifier  .
        example: "12345676"
      withdrawalDate:
        type: string
        format: date-time
        description: Date and time the Withdrawal in the Directory in Date format
        example: "2017-03-04"
      commercialNames:
        type: string
        description: Commercial Name .
        example: Google Payments, Google Pay
      addressLine1:
        type: string
        description: Address Lines 1 .
        example: 5 New Street Square
      addressLine2:
        type: string
        description: Address Lines 2 .
        example: ""
      postalTown:
        type: string
        description: Postal Town .
        example: London
      postcode:
        type: string
        description: Postal Code .
        example: EC4A 3TW
      country:
        type: string
        description: Country Code.
        example: United Kingdom
      phone:
        type: string
        description: phone .
        example: "+44"
      fax:
        type: string
        description: Fax .
        example: "+44"
      email:
        type: string
        description: email .
        example: gpl-compliance@google.com
      website:
        type: string
        description: website .
        example: http://www.google.com/compliance
      deleted:
        type: string
        description: deleted .
        example: false
      pspServicePassports:
        type: array
        description: List of PSP Service Passports
        items:
          $ref: '#/definitions/pspServicePassports'
      pspRolePassports:
        type: array
        description: List of PSP Role Passports
        items:
          $ref: '#/definitions/pspRolePassports'
  TPPClient:
    type: object
    properties:
      apiClientId:
        type: string
        description: The client Id of a TPP Client
        example: 16d29c91-5e69-4ab4-8a52-ffd5d626f13d
      active:
        type: boolean
        description: indicates if the client is active
      qSealCert:
        type: string
        description: QSeal Certificate  of a TPP Client
        example: |-
          MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmnTx3lWNQoj9UHXT/6nayrGlrmsZc3Q5q5G5keYlAhNz
          Q3OJndCzvxndqAcbn4MEWWV/+IOo3Fiaiaia+F/p1dhFARYQmyiaJ4JHthAqr0/5BwZOoR6QyJ8zgvPV0HqPq+HwJRcR0XVXO
          F4GPInxcOzx8vKZRT+wve7y4FTHbyEbDE12FAYwyfraH4OieylSOTIjz8jCZQd/G7Mx1zE9WZZim8Ie/tbJX0Gx9qoiRiOGMq
          0yrnNc8W0Jfzd+/2Bi7UtPlTL8G3OtxpHnAfkkwJQbEbxLTsUkcfkBwTePxIr4etRJlNW6B+FSiN93VAAaJgC/mOO27Qu6c8lyQA7BAREJNQIDAQAB
  QSealCResponse:
    type: object
    properties:
      qSealCert:
        type: string
        description: The Public Key of the TPP's Qualified Certificate.
        example: |-
          MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmnTx3lWNQoj9UHXT/6nayrGlrmsZc3Q5q5G5keYlAhNz
          Q3OJndCzvxndqAcbn4MEWWV/+IOo3Fiaiaia+F/p1dhFARYQmyiaJ4JHthAqr0/5BwZOoR6QyJ8zgvPV0HqPq+HwJRcR0XVXO
          F4GPInxcOzx8vKZRT+wve7y4FTHbyEbDE12FAYwyfraH4OieylSOTIjz8jCZQd/G7Mx1zE9WZZim8Ie/tbJX0Gx9qoiRiOGMq
          0yrnNc8W0Jfzd+/2Bi7UtPlTL8G3OtxpHnAfkkwJQbEbxLTsUkcfkBwTePxIr4etRJlNW6B+FSiN93VAAaJgC/mOO27Qu6c8lyQA7BAREJNQIDAQAB
  SourceUrlResponse:
    type: object
    properties:
      sourceUrl:
        type: string
        example: https://www.fca.org.uk/Company=123
  ConsentRequest:
    properties:
      clientId:
        description: Client ID generated during application registration.
        type: string
        example: 44125873852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d
      grantType:
        description: Authentication grant type. Valid value is refresh_token
        type: string
        example: card_authorization
      role:
        description: Transaction taking place for which Role
        type: string
        example: Partner
      scope:
        description: Under which category the scope is.
        type: string
        example: play with Point
      customerNumber:
        description: Customer Number.
        type: string
        example: 73852316
    required:
    - clientId
    - grantType
    - role
    - customerNumber
    - scope
  ConsentResponse:
    type: object
    properties:
      consentID:
        description: Unique ID for Consent
        type: string
        example: 73852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a416537
  GetConsentResponse:
    properties:
      consentID:
        description: Unique ID for Consent
        type: string
        example: 73852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a416537
      clientId:
        description: Client ID generated during application registration.
        type: string
        example: 44125873852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d
      grantType:
        description: Authentication grant type. Valid value is refresh_token
        type: string
        example: card_authorization
      role:
        description: Transaction taking place for which Role
        type: string
        example: Partner
      i-cif:
        description: Unique number to identify a customer
        type: string
        example: 123455
      scope:
        description: Under which category the scope is.
        type: string
        example: play with Point
  pspServicePassports:
    type: object
    properties:
      service:
        type: string
        description: Servoce
        example: 4a
      countries:
        type: array
        items:
          type: string
          example: FR
  pspRolePassports:
    type: object
    properties:
      role:
        type: string
        description: Servoce
        example: PIS
      countries:
        type: array
        items:
          type: string
          example: GB
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  client_id:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- client_id: []
x-ibm-endpoints:
- endpointUrl: https://emea.sit.api.citi.com/gcb
  description: Custom Gateway API Endpoint
  type:
  - production
  - development
...