Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HyperVerge Matching API

Fuzzy and direct field matching.

HyperVerge Matching API is one of 6 APIs that HyperVerge publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Matching. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 3 base URLs: https://ind-verify.hyperverge.co, https://ind-docs.hyperverge.co/v2.0, https://ind-faceid.hyperverge.co.

1 operations 1 paths 2 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://ind-docs.hyperverge.co/v2.0
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

HyperVerge Matching API declares 1 security scheme for authenticating requests. An API key is passed in the header as appId (appIdKey). By default, every request must be authenticated.

  • appIdKey — HyperVerge issues an appId and appKey pair after enterprise onboarding. Both are sent as request headers: appId and appKey on the ind-docs and ind-verify hosts…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Matching 1

Fuzzy and direct field matching.

POST
/api/matchFields
Match field pairs
matchFields body → 200401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Error (3 properties), ValidationResult (3 properties). Each schema is shown below with its type and property counts.

ValidationResult
object
Representative per-field match response (modeled).
3 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hyperverge-matching-api-openapi.yml Raw ↑

Other APIs HyperVerge publishes across the network.

HyperVerge Liveness Detection
HyperVerge Database Verification API
HyperVerge Face Match API
HyperVerge Input Validation API
HyperVerge KYC OCR API