VeraFi OpenAPI Defenition File

The VeraFi Backend API is accompanied by an OpenAPI definition file that describes the complete structure of the platform’s endpoints, request bodies, response formats, security requirements, and data schemas. This definition serves as the authoritative reference for the API and provides a machine-readable specification that can be used by developers, documentation tools, integration systems, and automated client generators. In practice, the OpenAPI file functions as a contract that outlines how the VeraFi platform exposes its functionality and the expectations it places on client applications interacting with it.

The OpenAPI definition encapsulates every endpoint available across the VeraFi ecosystem, including authentication, document processing, verification services, subscription management, configuration retrieval, user operations, tenant administration, OTP workflows, health monitoring, and microservice proxy endpoints. For each operation, the file outlines the accepted HTTP method, the expected request format, validation rules, and the shape of the JSON response returned upon success or failure. This enables developers to understand not only the intent of each endpoint but also the exact structure required for seamless communication with the backend.

Because VeraFi is a tenant-configurable platform, many response structures particularly those associated with document types, verification configurations, and confidence code settings are intentionally flexible. The OpenAPI definition captures this flexibility through schema references and dynamic object definitions, allowing integrators to anticipate variations in structure while still relying on the specification for core expectations such as required fields, data types, and error responses. This allows the OpenAPI file to reflect both the stable aspects of the API and the dynamic layers governed by tenant-level configuration.

The definition file also documents the security model of the VeraFi platform, particularly in relation to token-based authentication. It details how bearer tokens are included within requests, how secure communication is enforced through HTTPS, and the expectations for handling protected endpoints that require valid tokens. This information is essential for client applications to correctly implement authorization flows and to ensure that interactions with the API remain secure and compliant with platform requirements.

Note:

Because certain response structures such as document schemas, configuration objects, or feature mappings are determined at runtime based on the tenant’s setup, the OpenAPI file reflects these elements using generalized schema definitions. Integrators should therefore treat the OpenAPI file as a guide to core structure rather than a guarantee of fixed field layouts, especially where schema flexibility is intentionally supported.

In environments where client SDKs or integration stubs are generated automatically, the OpenAPI definition file plays a critical role. It allows development teams to produce strongly typed API clients, stub servers, testing utilities, and documentation portals that remain synchronized with the platform’s evolving API surface. This ensures that engineering teams can adopt stable integration patterns regardless of the programming language or framework they use.

Attention:

The OpenAPI definition must always be retrieved from the official source. Local or outdated copies may omit new endpoints or recent schema changes, leading to integration mismatches. Because the VeraFi platform expands over time with new verification modules, additional configuration options, or updated subscription models, the latest definition should always be used during integration and testing.

For teams building internal dashboards, automation pipelines, or custom verification workflows, the OpenAPI file provides a structured and dependable starting point. It streamlines onboarding, reduces integration friction, and ensures that all teams interacting with VeraFi have consistent and accurate information about the API. By adhering to the definitions contained within the OpenAPI file, integrators can achieve reliable interoperability with the platform while minimizing the risk of unexpected errors or schema inconsistencies.