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

Hopae, Inc. Verifications API

Identity verification sessions

Hopae, Inc. Verifications API is one of 9 APIs that Hopae, Inc. publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 5 paths, and defines 11 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://sandbox.api.hopae.com/connect.

6 operations 5 paths 11 schemas 1 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://sandbox.api.hopae.com/connect
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 5

Hopae, Inc. Verifications API declares 5 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (API Key) (workspaceApiKey). It accepts HTTP bearer tokens (JWT) (consoleJwt). It accepts HTTP bearer tokens (JWT) (workspace-api-key). It accepts HTTP basic authentication (app-basic).

  • basicAuth — Basic authentication using clientId and clientSecret. For direct API calls, format the Authorization header as Authorization: Basic . In the Mintlify playgroun…
  • workspaceApiKey — Workspace API key authentication. Pass your workspace API key as Authorization: Bearer skworkspace....
  • consoleJwt — Console JWT authentication. Issued by Clerk after Console login.

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Verifications 6

Identity verification sessions

POST
/v1/verifications
Create Verification
createVerification body → 201400401
GET
/v1/verifications/{verificationId}
Get Verification Status
getVerification 1 param → 200404
DELETE
/v1/verifications/{verificationId}
Cancel Verification
deleteVerification 1 param → 204400404
GET
/v1/verifications/{verificationId}/evidence
Get evidence for a verification
VerificationController_getVerificationEvidence 1 param → 200400
GET
/v1/verifications/{verificationId}/userinfo
Get userinfo for a verification
VerificationController_getVerificationUserinfo 1 param → 200400
POST
/v1/verifications/dc-request
Create DC request for Digital Credentials flow
VerificationController_createDcRequest body → 200400404

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are GetVerificationUserInfoResponseDto (10 properties), GetVerificationResponse (8 properties), AuthenticationHint (8 properties), CreateVerificationResponse (7 properties). Each schema is shown below with its type and property counts.

GetVerificationUserInfoResponseDto
object
10 properties
GetVerificationResponse
object
8 properties
CreateVerificationResponse
object
7 properties
VerificationUserBlockDto
object
DcRequestResponseDto
object
2 properties 2 required
MatchEnvelopeDto
object
Result envelope for match-capable providers. Present only when verificationmodel is match.
4 properties 3 required
VerificationProvenanceDto
object
2 properties
MatchFieldDetailDto
object
3 properties 1 required
DcRequestDto
object
2 properties 1 required
CreateVerificationRequest
object
4 properties 1 required
AuthenticationHint
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hopae-inc-verifications-api-openapi.yml Raw ↑

Other APIs Hopae, Inc. publishes across the network.

Hopae, Inc. Console - API Keys API
Hopae, Inc. Providers API
Hopae, Inc. Token API
Hopae, Inc. Workspace API - Activation API
Hopae, Inc. Workspace API - Apps API
Hopae, Inc. Workspace API - Production Tests API
Hopae, Inc. Workspace API - Workflows API
Hopae, Inc. Workspace API - Workspace API