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

zkMe zkKYC API

Customer identity verification results and proofs

zkMe zkKYC API is one of 5 APIs that zkMe publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include zkKYC. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and rate-limit docs.

This API exposes 3 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://agw.zk.me, https://nest-api.zk.me.

3 operations 3 paths 4 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://agw.zk.me
Resource Areas
1

Paths & Operations 3

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

zkKYC 3

Customer identity verification results and proofs

POST
/zkseradmin/openapi/kyc/getUsersList
List users who have interacted with a program
getUsersList body → 200
POST
/zkseradmin/openapi/queryKycInfoByAddress
Get a user's zkKYC result overview
queryKycInfoByAddress body → 200
POST
/zkseradmin/openapi/queryPoAInfoByAddress
Get a user's proof-of-address result overview
queryPoAInfoByAddress body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are KycUser (6 properties), KycInfo (5 properties), Envelope (4 properties), ApiKeyAuth (2 properties). Each schema is shown below with its type and property counts.

KycUser
object
6 properties
ApiKeyAuth
object
2 properties 2 required
KycInfo
object
5 properties
Envelope
object
Standard zkMe response envelope
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zkme-zkkyc-api-openapi.yml Raw ↑

Other APIs zkMe publishes across the network.

zkMe Auth API
zkMe KYT API
zkMe zkKYB API
zkMe zkOBS API