The Realtime Document Verification endpoint allows you to run quick, single-purpose document verification workflows via HTTP requests. This is ideal for fast validation of business documents like proof of address, incorporation certificates, and more. For an interactive guide on testing document verification before API integration, see our Realtime Document Verification Playground Quick Start Guide.

Overview

Realtime Document Verification provides:
  • Instant document verification results
  • Configurable validation rules
  • Detailed analysis and extraction
  • Low latency processing

Making a Request

Endpoint

POST https://demo.parcha.ai/api/v1/runFlashCheck

Request Structure

curl -X POST 'https://demo.parcha.ai/api/v1/runFlashCheck' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
    "agent_key": "doc-flash-v1",
    "check_id": "kyb.proof_of_address_verification",
    "check_args": {
        "validity_period": 90,
        "accepted_documents": ["utility_bill", "bank_statement"]
    },
    "kyb_schema": {
        "id": "parcha-latest",
        "self_attested_data": {
            "business_name": "Parcha",
            "registered_business_name": "Parcha Labs Inc",
            "proof_of_address_documents": [
                {
                    "b64_document": "base64_encoded_document_content",
                    "file_name": "utility_bill.pdf",
                    "source_type": "file_url"
                }
            ]
        }
    }
}'

Request Parameters

agent_key
string
required
The specific agent key for the Realtime Document Verification workflow. Currently supported: “doc-flash-v1”
check_id
string
required
The identifier for the specific check to run. Currently supported: “kyb.proof_of_address_verification”
check_args
object
required
Configuration options for the document verification
kyb_schema
object
required
The KYB data schema containing business and document information

Response Structure

{
    "passed": true,
    "answer": "Valid bank statement; use as proof of address.",
    "agent_key": "mercury-poa-v1",
    "command_id": "kyb.proof_of_address_verification",
    "command_name": "Proof of Address Check for Business",
    "status": "complete",
    "payload": {
        "type": "ProofOfAddressFlashCheckResult",
        "company_name": "Parcha Labs, Inc.",
        "document_date": "2025-01-01",
        "document_type": "BANK_STATEMENT",
        "document_address": {
            "type": "Address",
            "street_1": "251 Little Falls Drive",
            "street_2": null,
            "city": "Wilmington",
            "state": "Delaware",
            "country_code": "US",
            "postal_code": "19808"
        }
    },
    "check_args": {
        "validity_period": 90,
        "accepted_documents": [
            "Bank statement",
            "VAT invoice",
            "Utility bill",
            "Signed tenancy or lease agreement",
            "Tax document",
            "Mortgage statement",
            "Credit card statement",
            "Home or renter's insurance policy"
        ]
    },
    "input_data": {
        "type": "ProofOfAddressClassificationToolInput",
        "document": {
            "type": "Document",
            "url": "https://storage.googleapis.com/parcha-ai-public-assets/parcha-labs%2C-inc._statement_2024.12.01-2025.01.01.pdf",
            "file_name": "Parcha_proof_of_address.pdf",
            "source_type": "file_url"
        }
    },
    "command_instance_id": "e3b93e50-0a4a-479e-afb3-4edbb698c190",
    "created_at": "2025-02-04T07:22:13.290674",
    "updated_at": "2025-02-04T07:22:16.492974"
}
passed
boolean
Whether the document passed validation
answer
string
Human-readable explanation of the validation result
agent_key
string
The agent key used for processing
command_id
string
The identifier of the check that was run
command_name
string
Human-readable name of the check
status
string
Status of the check execution. Usually “complete” for Realtime Document Verifications
payload
object
Extracted document information
check_args
object
Arguments used for the check
input_data
object
Information about the input document
command_instance_id
string
Unique identifier for this check execution
created_at
string
Timestamp when the check was initiated
updated_at
string
Timestamp when the check was completed

Use Cases

Realtime Document Verification is ideal for:
  • Business document validation
  • Proof of address verification
  • Document information extraction
  • Real-time document screening