For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterOpenAPI SpecStatus
OverviewInquiriesTransactionsAPI ReferenceChangelog
OverviewInquiriesTransactionsAPI ReferenceChangelog
  • Getting Started
    • Introduction
    • Quickstart Tutorial
  • API Overview
    • API Keys
    • Authentication
    • Protocol
    • Response Body
    • Idempotence
    • Pagination
    • Rate Limiting
    • Downloading Files
    • API Logs
    • Request IDs
  • Versioning
    • API Changelog
    • Versioning
  • Troubleshooting
    • Error Handling
  • API Reference
    • OpenAPI Specification
    • Cases
    • Connect
    • Documents
      • GETRetrieve a Generic Document
      • GETRetrieve a Government Id Document
      • GETRetrieve a Document
    • Inquiries
    • List Items
    • Lists
    • OAuth
    • Reports
    • Transactions
    • Verifications
    • Workflows
  • Webhooks
LogoLogo
Help CenterOpenAPI SpecStatus
API Reference

Documents

A document is a written, printed, or electronic matter provided by an individual, such as a government ID or a utility bill. An inquiry can contain zero or more documents. Each inquiry’s relationships field lists the IDs of all associated documents. For more info about fetching file URLs, see Downloading Files.

Check for the following statuses of a document.

Document StatusDescription
InitiatedWhen the individual is first asked to provide a document, the document is initiated. During this time, a document can be uploaded with files before submitting it for processing.
SubmittedWhen the individual submits their document, the server processes the document.
ProcessedThe server is done processing the document.
ErroredIf the server fails to process the document.
Was this page helpful?
Previous

Retrieve a Generic Document

Next
Built with