ClearBank Secondary Reference Data API

openapi: 3.2.0
info:
  title: ClearBank.CoP.Outbound.Api 1.0 Secondary Reference Data API
  description: ClearBank API for CoP outbound requests
  version: 1.0.COP-Outbound
tags:
- name: SecondaryReferenceData
paths:
  /open-banking/outbound/v1/srd/validate:
    post:
      tags:
      - SecondaryReferenceData
      summary: This endpoint is used to confirm whether a given sort code/account number combination requires Secondary Reference Data (SRD) with Confirmation of Payee (CoP) requests.
      parameters:
      - name: Authorization
        in: header
        description: Your API token, obtained from the ClearBank Portal.
        required: true
        schema:
          type: string
      - name: DigitalSignature
        in: header
        description: Signed hash of the body of the request. The hash is signed by your private key.
        required: true
        schema:
          type: string
      - name: X-Request-Id
        in: header
        description: A unique identifier for the request; valid for 24 hours, max length 83.
        required: true
        schema:
          type: string
      requestBody:
        description: SRD Validation Request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SRDValidationRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/SRDValidationRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SRDValidationRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SRDValidationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/SRDValidationResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/SRDValidationResponse'
        '403':
          description: Forbidden
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SRDValidationRequest:
      required:
      - Identification
      - SchemeName
      type: object
      properties:
        SchemeName:
          minLength: 1
          type: string
          description: Indicates the sort code and account number associated with the payee’s account. The value should always be SortCodeAccountNumber.
        Identification:
          minLength: 1
          type: string
          description: Payee's sort code and account number, used by an Account Servicing Payment Service Provider (ASPSP) to identify the account. In case the account number contains less than 8-digits, it can be padded with preceding zeros to make the length up to 8. The format should always be SortCodeAccountNumber   (e.g., “04040412345678”).
      additionalProperties: false
      description: Secondary reference data validation request
    SRDValidationData:
      type: object
      properties:
        Required:
          type: boolean
          description: Value indicating whether Secondary Reference Data is required on a CoP request.
        BankName:
          type:
          - string
          - 'null'
          description: The name of the bank that the given identification matches with.
        Identification:
          type:
          - string
          - 'null'
          description: The identification given in the original request.
      additionalProperties: false
      description: SRD Validation data.
    ErrorResponse:
      type: object
      properties:
        Error:
          $ref: '#/components/schemas/ErrorBody'
      additionalProperties: false
      description: Error response class.
    SRDValidationResponse:
      type: object
      properties:
        Data:
          $ref: '#/components/schemas/SRDValidationData'
      additionalProperties: false
      description: Response contract.
    ErrorBody:
      type: object
      properties:
        Reason:
          type:
          - string
          - 'null'
          description: The error reason.
        ParticipantName:
          type:
          - string
          - 'null'
          description: Name of the participant.
      additionalProperties: false
      description: Error body with description.