Home
Home
  1. API reference
  • Getting started
  • Authentication
  • Webhooks
  • Embeddable widgets
    • Overview
    • Document upload widget
      • Designing an upload flow
  • Guides
    • Verifying a new business
    • Verifying bank accounts
    • Uploading documents
    • Country-specific fields
    • Supported document types
  • API reference
    • Submissions
      • Reports
        • List available report templates
        • Download a report
      • Create new submission
      • Get submission
      • Update submission
      • Update submission status
      • Run a submission pre-flight check
      • Run business verification
      • Get submission checks
      • Delete submission
      • List submissions
    • Documents
      • Public documents API
        • List documents (public)
        • Upload document (public)
        • Get document (public)
        • Delete document (public)
        • Download document file (public)
        • Rerun validations (public)
      • List documents
      • Upload document
      • Get document
      • Delete document
      • Download document file
      • Rerun validations
    • RPC search
      • RPC search
      • Get company with ID
      • Look up company by RFC
      • Search companies by name
      • Download RPC document
    • Utilities
      • Matcher
        • Run name matching
  1. API reference

Documents

Documents are the evidence Niva extracts and verifies business information from.

Overview#

Documents belong to a submission.
Identify a document with country_code, document_type (a category such as formation), and document_subtype (such as acta_constitutiva or contrato_social). For photo identification and proof of address, you can omit the subtype and let Niva detect it. The country must match the submission's market, except that Mexican submissions accept photo identification from other issuing countries.
Niva validates a document when it is uploaded and extracts data from it according to its type.
Each document has a validation_status: valid when instant checks pass, warning for non-blocking issues, fail for blocking issues, or incomplete when an ID needs its other side. validating means checks are still pending; a blocking result can appear before all checks finish. validation_errors lists the problems and messages you can show to the applicant.

Endpoints#

1.
Upload document
2.
List documents
3.
Get document, including the extracted data
4.
Download document file
5.
Rerun validations
6.
Delete document
The Public Documents API offers the same operations for browser integrations.
INFO
To create a submission and start verification, see the Submissions section.

Supported document types#

The document types, subtypes, extracted data and checks of each market are listed under Supported document types.

Schema#

Document

Previous
List submissions
Next
Public documents API