Process up to 100 documents from URLs in one request.
openapi: 3.1.0
info:
title: Kita Capture Applications Batch API
version: v1
summary: Document intelligence — extract structured, validated, fraud-checked data from bank statements, payslips, IDs, credit reports and 30+ other document types.
description: 'Kita Capture turns scanned or photographed financial and identity documents into clean
JSON — transactions, metadata, metrics, and fraud signals. Upload a file (multipart or
base64), submit a URL, or batch up to 100 documents, then poll for results or receive an
HMAC-signed webhook.
Authentication uses an organization API key prefixed `kita_prod_` sent as
`Authorization: Bearer <key>`. Errors return `{ "error": ..., "message": ... }`.
Rate limiting is per organization; 429 responses carry a `Retry-After` header.
NOTE: Kita does not publish a machine-readable OpenAPI description. This document was
generated by the API Evangelist enrichment pipeline from Kita''s own published API
documentation (shipped verbatim inside the official `kita-docs-mcp` npm package and
served at https://www.kita.ai/documentation). Only operations, parameters, fields and
status codes that Kita documents are represented here.
'
contact:
name: Kita Support
email: support@kita.ai
url: https://www.kita.ai/documentation
x-source:
- https://www.kita.ai/documentation
- https://unpkg.com/kita-docs-mcp@0.4.0/docs/Documentation.md
x-generated-by: api-evangelist-enrichment-pipeline
x-generated: '2026-07-19'
servers:
- url: https://portal.usekita.com
description: Production (default; override with the KITA_API_URL environment variable)
security:
- BearerAuth: []
tags:
- name: Batch
description: Process up to 100 documents from URLs in one request.
paths:
/api/v1/batch:
post:
tags:
- Batch
operationId: createBatch
summary: Process documents from URLs
description: Submit up to 100 documents by URL in a single request. Each entry requires `file_url` and `document_type`; optional `filename` overrides auto-detection. Batch processing requires a paid plan.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- documents
properties:
documents:
type: array
maxItems: 100
items:
type: object
required:
- file_url
- document_type
properties:
file_url:
type: string
format: uri
document_type:
$ref: '#/components/schemas/DocumentType'
filename:
type: string
webhook_url:
type: string
format: uri
description: One-shot delivery URL for this batch.
example:
documents:
- file_url: https://example.com/statement.pdf
document_type: bank_statement
responses:
'200':
description: Batch created.
content:
application/json:
schema:
$ref: '#/components/schemas/Batch'
example:
batch_id: batch_abc123
status: processing
total_documents: 1
status_url: /api/v1/batch/batch_abc123
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/RateLimited'
/api/v1/batch/{batchId}:
parameters:
- $ref: '#/components/parameters/BatchId'
get:
tags:
- Batch
operationId: getBatch
summary: Get batch status
responses:
'200':
description: Batch progress.
content:
application/json:
schema:
$ref: '#/components/schemas/Batch'
example:
batch_id: batch_abc123
status: processing
total_documents: 3
completed: 2
failed: 0
progress_percent: 66.67
documents:
- document_id: 100
filename: stmt1.pdf
status: completed
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
/api/v1/batch/{batchId}/results:
parameters:
- $ref: '#/components/parameters/BatchId'
get:
tags:
- Batch
operationId: getBatchResults
summary: Get results for every document in a batch
responses:
'200':
description: Full extracted data for each document in the batch.
content:
application/json:
schema:
type: object
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
components:
responses:
Forbidden:
description: Upgrade required, or the document type is not enabled for this organization.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: Document or batch ID does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
RateLimited:
description: Rate limited. Wait and retry; check the `Retry-After` header.
headers:
Retry-After:
description: Seconds to wait before retrying.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Invalid or missing API key.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
BadRequest:
description: Bad request — check the request body and parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: Bad Request
message: documents array is required and must not be empty
schemas:
Error:
type: object
properties:
error:
type: string
description: Short error label.
message:
type: string
description: Human-readable description.
JobStatus:
type: string
enum:
- pending
- processing
- completed
- failed
DocumentType:
type: string
description: 'Document type slug. Case-insensitive. Three types run the legacy stage-config pipeline
(`bank_statement`, `audited_financial_statement`, `general_information_sheet`); the rest
run the universal vocabulary-driven pipeline. Slugs without a dedicated vocabulary fall
back to the `other_document` extractor.
'
enum:
- bank_statement
- audited_financial_statement
- general_information_sheet
- bank_certificate
- credit_card_statement
- loan_statement
- mobile_banking_screenshot
- passbook
- payslip
- business_financials
- bill
- receipt
- remittance_slip
- sales_invoice
- government_id
- certificate_of_employment
- barangay_clearance
- credit_report
- slik
- acta_constitutiva
- mx_legal
- indo_legal
- combined_document
- other_document
- bir_2303
- bir_2307
- tin_id
- secretarys_certificate
- business_registration_dti
- business_registration_sec
- certificate_of_incorporation
- business_permit
- mayors_permit
- purchase_order
- bill_of_lading
- proof_of_billing
- land_title
- vehicle_registration
- insurance_policy
- loan_agreement
- income_tax_return
Batch:
type: object
properties:
batch_id:
type: string
status:
type: string
total_documents:
type: integer
completed:
type: integer
failed:
type: integer
progress_percent:
type: number
status_url:
type: string
documents:
type: array
items:
type: object
properties:
document_id:
type: integer
filename:
type: string
status:
$ref: '#/components/schemas/JobStatus'
parameters:
BatchId:
name: batchId
in: path
required: true
schema:
type: string
examples:
- batch_abc123
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: 'Organization API key prefixed `kita_prod_`, issued from the Kita dashboard at
https://portal.usekita.com and sent as `Authorization: Bearer <key>`.
'