openapi: 3.0.3
info:
  title: Unit Accounts Checks API
  description: Unit is a Banking-as-a-Service (BaaS) platform. This document is an API Evangelist consolidation of Unit's public REST surface, organized into logical groupings (Applications, Customers, Accounts, Cards, Authorizations, Payments, Counterparties, Checks, Transactions, Statements, Tax Forms, Events, Webhooks, Risk/Fraud, Credit/Repayments, Fees, Rewards, and API Tokens). All paths, methods, and the request/ response envelope below were confirmed against Unit's officially published OpenAPI 3.0.2 specification at github.com/unit-finance/openapi-unit-sdk (openapi.json, version 0.4.0); request/response bodies here are condensed and re-typed for readability rather than reproduced schema-for-schema. Unit's API follows the JSON:API specification - every request and response uses the `application/vnd.api+json` media type, wraps the primary resource in a top-level `data` object with `type`/`id`/`attributes`/`relationships`, and authenticates with a Bearer JWT obtained as an org API token or a customer API token.
  version: '1.0'
  contact:
    name: Unit
    url: https://www.unit.co
  license:
    name: Proprietary
    url: https://www.unit.co/legal/
servers:
- url: https://api.s.unit.sh
  description: Sandbox (confirmed - default server in Unit's published OpenAPI spec)
- url: https://api.unit.co
  description: Production (industry-standard Unit convention paired with the sandbox host; not independently re-confirmed against a live docs page in this research pass - verify with your Unit solution engineer)
security:
- bearerAuth: []
tags:
- name: Checks
  description: Check deposits and outbound check payments.
paths:
  /check-deposits:
    get:
      operationId: getCheckDepositsList
      tags:
      - Checks
      summary: Get List Check Deposits
      responses:
        '200':
          $ref: '#/components/responses/ResourceList'
    post:
      operationId: createCheckDeposit
      tags:
      - Checks
      summary: Create Check Deposit
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
      responses:
        '201':
          $ref: '#/components/responses/SingleResource'
  /check-deposits/{checkDepositId}:
    parameters:
    - name: checkDepositId
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: getCheckDeposit
      tags:
      - Checks
      summary: Get Check Deposit by Id
      responses:
        '200':
          $ref: '#/components/responses/SingleResource'
    patch:
      operationId: updateCheckDeposit
      tags:
      - Checks
      summary: Update Check Deposit
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
      responses:
        '200':
          $ref: '#/components/responses/SingleResource'
  /check-deposits/{checkDepositId}/confirm:
    parameters:
    - name: checkDepositId
      in: path
      required: true
      schema:
        type: string
    post:
      operationId: confirmCheckDeposit
      tags:
      - Checks
      summary: Confirm Check Deposit by Id
      responses:
        '200':
          $ref: '#/components/responses/SingleResource'
  /check-deposits/{checkDepositId}/front:
    parameters:
    - name: checkDepositId
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: getFrontCheckDepositImage
      tags:
      - Checks
      summary: Get Front Check Deposit Image by Id
      responses:
        '200':
          description: Front image of the deposited check.
          content:
            image/png: {}
  /check-payments:
    get:
      operationId: getCheckPaymentsList
      tags:
      - Checks
      summary: Get List Check Payments
      responses:
        '200':
          $ref: '#/components/responses/ResourceList'
    post:
      operationId: createCheckPayment
      tags:
      - Checks
      summary: Create Check Payment
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
      responses:
        '201':
          $ref: '#/components/responses/SingleResource'
  /check-payments/{checkPaymentId}:
    parameters:
    - name: checkPaymentId
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: getCheckPayment
      tags:
      - Checks
      summary: Get Check Payment by Id
      responses:
        '200':
          $ref: '#/components/responses/SingleResource'
  /check-payments/{checkPaymentId}/approve:
    parameters:
    - name: checkPaymentId
      in: path
      required: true
      schema:
        type: string
    post:
      operationId: approveCheckPayment
      tags:
      - Checks
      summary: Approve Check Payment by Id
      responses:
        '200':
          $ref: '#/components/responses/SingleResource'
  /check-payments/{checkPaymentId}/cancel:
    parameters:
    - name: checkPaymentId
      in: path
      required: true
      schema:
        type: string
    post:
      operationId: cancelCheckPayment
      tags:
      - Checks
      summary: Cancel Check Payment by Id
      responses:
        '200':
          $ref: '#/components/responses/SingleResource'
  /check-payments/{checkPaymentId}/return:
    parameters:
    - name: checkPaymentId
      in: path
      required: true
      schema:
        type: string
    post:
      operationId: returnCheckPayment
      tags:
      - Checks
      summary: Return Check Payment by Id
      responses:
        '200':
          $ref: '#/components/responses/SingleResource'
components:
  schemas:
    JsonApiSingleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JsonApiResource'
        included:
          type: array
          items:
            $ref: '#/components/schemas/JsonApiResource'
    JsonApiResource:
      type: object
      properties:
        type:
          type: string
          description: The JSON:API resource type, e.g. individualApplication, depositAccount, individualDebitCard, bookPayment, achPayment.
        id:
          type: string
        attributes:
          type: object
          additionalProperties: true
        relationships:
          type: object
          additionalProperties: true
    JsonApiListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/JsonApiResource'
        meta:
          type: object
          properties:
            pagination:
              type: object
              properties:
                total:
                  type: integer
                limit:
                  type: integer
                offset:
                  type: integer
  responses:
    ResourceList:
      description: A page of JSON:API resources.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/JsonApiListResponse'
    SingleResource:
      description: A single JSON:API resource.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/JsonApiSingleResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Bearer JWT issued as an org API token (Dashboard > Developers) or a customer API token. Sent as `Authorization: Bearer ${TOKEN}`. All request and response bodies use the `application/vnd.api+json` JSON:API media type.'