Veryfi

opencollection: 1.0.0
info:
  name: Veryfi OCR API
  version: v8
request:
  auth:
    type: apikey
    key: CLIENT-ID
    value: '{{CLIENT-ID}}'
    placement: header
items:
- info:
    name: Documents
    type: folder
  items:
  - info:
      name: List All Documents
      type: http
    http:
      method: GET
      url: https://api.veryfi.com/api/v8/partner/documents
      params:
      - name: created_date__gt
        value: ''
        type: query
        description: Filter documents created after this date (format YYYY-MM-DD+HH:MM:SS)
      - name: created_date__lt
        value: ''
        type: query
        description: Filter documents created before this date
      - name: page
        value: ''
        type: query
        description: Page number for pagination
      - name: page_size
        value: ''
        type: query
        description: Number of documents per page
    docs: Retrieve a paginated list of previously processed documents with optional filtering by date range, tags, and other
      criteria.
  - info:
      name: Process a Document
      type: http
    http:
      method: POST
      url: https://api.veryfi.com/api/v8/partner/documents
      body:
        type: json
        data: '{}'
    docs: Submit a document (receipt, invoice, bill, or other financial document) for AI-powered OCR extraction. Returns structured
      JSON with vendor details, line items, taxes, totals, and other captured fields. Supports file uploads, URLs, base64-encoded
      data, and S3 references. Optionally supports asynchronous processing via webhooks.
  - info:
      name: Get a Document
      type: http
    http:
      method: GET
      url: https://api.veryfi.com/api/v8/partner/documents/:documentId
      params:
      - name: documentId
        value: ''
        type: path
        description: Unique document identifier
    docs: Retrieve a previously processed document by its ID.
  - info:
      name: Update a Document
      type: http
    http:
      method: PUT
      url: https://api.veryfi.com/api/v8/partner/documents/:documentId
      params:
      - name: documentId
        value: ''
        type: path
        description: Unique document identifier
      body:
        type: json
        data: '{}'
    docs: Update metadata, tags, or category for a processed document.
  - info:
      name: Delete a Document
      type: http
    http:
      method: DELETE
      url: https://api.veryfi.com/api/v8/partner/documents/:documentId
      params:
      - name: documentId
        value: ''
        type: path
        description: Unique document identifier
    docs: Permanently delete a processed document and its extracted data.
- info:
    name: Bank Statements
    type: folder
  items:
  - info:
      name: List All Bank Statements
      type: http
    http:
      method: GET
      url: https://api.veryfi.com/api/v8/partner/bank-statements
    docs: Retrieve a list of previously processed bank statements.
  - info:
      name: Process a Bank Statement
      type: http
    http:
      method: POST
      url: https://api.veryfi.com/api/v8/partner/bank-statements
      body:
        type: json
        data: '{}'
    docs: Submit a bank statement for AI-powered data extraction. Returns structured transaction data, account information,
      balances, and metadata. Supports PDF, image formats, and multi-page documents.
  - info:
      name: Get a Bank Statement
      type: http
    http:
      method: GET
      url: https://api.veryfi.com/api/v8/partner/bank-statements/:documentId
      params:
      - name: documentId
        value: ''
        type: path
    docs: Retrieve a specific processed bank statement by ID.
  - info:
      name: Delete a Bank Statement
      type: http
    http:
      method: DELETE
      url: https://api.veryfi.com/api/v8/partner/bank-statements/:documentId
      params:
      - name: documentId
        value: ''
        type: path
    docs: Permanently delete a processed bank statement.
- info:
    name: Checks
    type: folder
  items:
  - info:
      name: List All Checks
      type: http
    http:
      method: GET
      url: https://api.veryfi.com/api/v8/partner/checks
    docs: Retrieve a list of previously processed checks.
  - info:
      name: Process a Check
      type: http
    http:
      method: POST
      url: https://api.veryfi.com/api/v8/partner/checks
      body:
        type: json
        data: '{}'
    docs: Submit a check image for OCR extraction including bank routing number, account number, check number, payee, amount,
      and date.
  - info:
      name: Get a Check
      type: http
    http:
      method: GET
      url: https://api.veryfi.com/api/v8/partner/checks/:documentId
      params:
      - name: documentId
        value: ''
        type: path
    docs: Retrieve a specific processed check by ID.
  - info:
      name: Delete a Check
      type: http
    http:
      method: DELETE
      url: https://api.veryfi.com/api/v8/partner/checks/:documentId
      params:
      - name: documentId
        value: ''
        type: path
    docs: Permanently delete a processed check.
- info:
    name: W-2 Forms
    type: folder
  items:
  - info:
      name: List All W-2 Forms
      type: http
    http:
      method: GET
      url: https://api.veryfi.com/api/v8/partner/w2s
    docs: Retrieve a list of previously processed W-2 forms.
  - info:
      name: Process a W-2 Form
      type: http
    http:
      method: POST
      url: https://api.veryfi.com/api/v8/partner/w2s
      body:
        type: json
        data: '{}'
    docs: Submit a W-2 tax form for OCR extraction including employer details, employee information, wages, tax withholdings,
      and all W-2 box values.
  - info:
      name: Get a W-2 Form
      type: http
    http:
      method: GET
      url: https://api.veryfi.com/api/v8/partner/w2s/:documentId
      params:
      - name: documentId
        value: ''
        type: path
    docs: Retrieve a specific processed W-2 form by ID.
  - info:
      name: Delete a W-2 Form
      type: http
    http:
      method: DELETE
      url: https://api.veryfi.com/api/v8/partner/w2s/:documentId
      params:
      - name: documentId
        value: ''
        type: path
    docs: Permanently delete a processed W-2 form.
- info:
    name: W-9 Forms
    type: folder
  items:
  - info:
      name: List All W-9 Forms
      type: http
    http:
      method: GET
      url: https://api.veryfi.com/api/v8/partner/w9s
    docs: Retrieve a list of previously processed W-9 forms.
  - info:
      name: Process a W-9 Form
      type: http
    http:
      method: POST
      url: https://api.veryfi.com/api/v8/partner/w9s
      body:
        type: json
        data: '{}'
    docs: Submit a W-9 tax form for OCR extraction including taxpayer information, TIN, business name, entity type, and certification
      details.
  - info:
      name: Get a W-9 Form
      type: http
    http:
      method: GET
      url: https://api.veryfi.com/api/v8/partner/w9s/:documentId
      params:
      - name: documentId
        value: ''
        type: path
    docs: Retrieve a specific processed W-9 form by ID.
  - info:
      name: Delete a W-9 Form
      type: http
    http:
      method: DELETE
      url: https://api.veryfi.com/api/v8/partner/w9s/:documentId
      params:
      - name: documentId
        value: ''
        type: path
    docs: Permanently delete a processed W-9 form.
- info:
    name: Any Documents
    type: folder
  items:
  - info:
      name: List Any Documents
      type: http
    http:
      method: GET
      url: https://api.veryfi.com/api/v8/partner/any-documents
      params:
      - name: created_date__gt
        value: ''
        type: query
        description: Filter by creation date greater than
    docs: Retrieve a list of documents processed with custom blueprints.
  - info:
      name: Process Any Document
      type: http
    http:
      method: POST
      url: https://api.veryfi.com/api/v8/partner/any-documents
      body:
        type: json
        data: '{}'
    docs: Submit any document type for custom field extraction using a named blueprint. The ∀Docs API can extract structured
      data from any unstructured document type including contracts, custom forms, and non-standard documents.
  - info:
      name: Get Any Document
      type: http
    http:
      method: GET
      url: https://api.veryfi.com/api/v8/partner/any-documents/:documentId
      params:
      - name: documentId
        value: ''
        type: path
    docs: Retrieve a specific document processed with a custom blueprint.
  - info:
      name: Delete Any Document
      type: http
    http:
      method: DELETE
      url: https://api.veryfi.com/api/v8/partner/any-documents/:documentId
      params:
      - name: documentId
        value: ''
        type: path
    docs: Permanently delete a custom document extraction.
- info:
    name: Classification
    type: folder
  items:
  - info:
      name: Classify a Document
      type: http
    http:
      method: POST
      url: https://api.veryfi.com/api/v8/partner/classify
      body:
        type: json
        data: '{}'
    docs: Submit a document for classification to determine its type before processing. Returns the detected document type
      to route to the appropriate extraction endpoint.
bundled: true