api-ninjas-com Sort Code API

openapi: 3.2.0
info:
  title: Ninjas Sort Code API
  description: 'Combined OpenAPI specification for every API Ninjas endpoint. Requests go to https://api.api-ninjas.com with an `X-Api-Key` header; get a free key at https://api-ninjas.com/register. Human-readable docs: https://api-ninjas.com/api. Index for LLMs: https://api-ninjas.com/llms.txt.'
  version: 1.0.0
  contact:
    name: API Ninjas
    url: https://api-ninjas.com
  license:
    name: Proprietary
servers:
- url: https://api.api-ninjas.com
  description: API Ninjas Production
security:
- ApiKeyAuth: []
tags:
- name: Sort Code
  description: The Sort Code API allows you to look up and validate any UK sort code. Free sort code checker and sort code lookup for every UK bank branch.
paths:
  /v1/sortcode:
    get:
      summary: Get UK Bank Branch Information by Sort Code
      description: Looks up and validates a 6-digit UK sort code, returning its bank and branch details. Requires `sort_code`. To search by bank, city or postcode use /sortcodesearch.
      operationId: getSortCodeInfo
      tags:
      - Sort Code
      parameters:
      - name: sort_code
        in: query
        description: The 6-digit UK sort code, with or without hyphens (e.g. 20-00-00 or 200000).
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SortCodeOpenapi_BranchInfo'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '500':
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
  /v1/sortcodesearch:
    get:
      summary: Search for UK Bank Branches and Sort Codes
      description: Finds UK bank branches and their sort codes by bank name, city or postcode. To look up a single sort code that is already known use /sortcode.
      operationId: searchSortCodes
      tags:
      - Sort Code
      parameters:
      - name: bank_name
        in: query
        description: Bank name to search for. At least one of bank_name, city, or postcode is required. Premium only.
        required: false
        schema:
          type: string
      - name: city
        in: query
        description: City name to search for branches. Premium only.
        required: false
        schema:
          type: string
      - name: postcode
        in: query
        description: UK postcode (full or outward only, e.g. E14) to search for branches. Premium only.
        required: false
        schema:
          type: string
      - name: offset
        in: query
        description: Number of results to offset for pagination. Available for annual subscriptions only.
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SortCodeOpenapi_BranchInfo'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '500':
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
components:
  schemas:
    SortCodeOpenapi_BranchInfo:
      type: object
      properties:
        bank_name:
          type:
          - string
          - 'null'
          description: The name of the bank. Premium only.
        sort_code:
          type: string
          description: The 6-digit sort code, hyphenated.
        branch_name:
          type:
          - string
          - 'null'
          description: The name of the branch. Premium only.
        street_address:
          type:
          - string
          - 'null'
          description: The street address of the branch. Premium only.
        city:
          type:
          - string
          - 'null'
          description: The city of the branch.
        postcode:
          type:
          - string
          - 'null'
          description: The UK postcode of the branch.
        country:
          type: string
          description: Always GB.
        phone_number:
          type:
          - string
          - 'null'
          description: The customer service phone number of the bank. Premium only.
        bacs_supported:
          type: boolean
          description: Whether the branch supports Bacs Direct Debit and Direct Credit payments. Premium only.
        chaps_supported:
          type: boolean
          description: Whether the branch supports CHAPS same-day wire transfers. Premium only.
        faster_payments_supported:
          type: boolean
          description: Whether the branch supports Faster Payments. Premium only.
        swift_code:
          type:
          - string
          - 'null'
          description: The SWIFT/BIC code of the bank, useful for international wire transfers. Premium only.
        checksum_valid:
          type: boolean
          description: Whether the sort code passes the modulus check defined by the published Vocalink validation rules.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
externalDocs:
  description: API Ninjas documentation
  url: https://api-ninjas.com/api