How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AGNTCY Identity Node API

The identity node that generates and resolves agent IDs, registers issuers and serves their JWKS, and publishes, revokes, searches and verifies Verifiable Credentials. OpenAPI 3.0.3, 9 operations, generated from the protobuf service definitions.

This API exposes 9 operations across 9 paths, organized into 3 resource areas, and defines 29 schemas. It is described by OpenAPI 3.0.3, at version v1alpha1.

Requests are made against a single base URL, http://0.0.0.0:4000.

9 operations 9 paths 29 schemas 2 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1alpha1
Server
http://0.0.0.0:4000
Resource Areas
3

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 2 GET, 7 POST. They span 3 resource areas: IdService, IssuerService, VcService. Each is listed below with its method, path, parameters, and response codes.

IdService 2

IdService is the service that provides ID operations.

POST
/v1alpha1/id/generate
Generate an Id and its corresponding ResolverMetadata for the specified Issuer
IdService_Generate body → 200default
POST
/v1alpha1/id/resolve
Resolve a specified Id to its corresponding ResolverMetadata
IdService_Resolve body → 200default
IssuerService 2

IssuerService is the service that provides ISSUER node operations.

POST
/v1alpha1/issuer/register
Register an issuer by providing the issuer details
IssuerService_Register body → 200default
GET
/v1alpha1/issuer/{commonName}/.well-known/jwks.json
Returns the well-known document content for an issuer in Json Web Key Set (JWKS) format
IssuerService_GetWellKnown 1 param → 200default
VcService 5

VC is the service that provides VC operations.

POST
/v1alpha1/vc/publish
Publish an issued Verifiable Credential
VcService_Publish body → 200default
POST
/v1alpha1/vc/revoke
Revoke a Verifiable Credential. THIS ACTION IS NOT REVERSIBLE.
VcService_Revoke body → 200default
POST
/v1alpha1/vc/search
Search for Verifiable Credentials based on the specified criteria
VcService_Search body → 200default
POST
/v1alpha1/vc/verify
Verify an existing Verifiable Credential
VcService_Verify body → 200default
GET
/v1alpha1/vc/{id}/.well-known/vcs.json
Returns the well-known Verifiable Credentials for the specified Id
VcService_GetWellKnown 1 param → 200default

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Jwk (15 properties), VerifiableCredential (10 properties), Issuer (7 properties), VerificationResult (7 properties). Each schema is shown below with its type and property counts.

CredentialSchema
object
CredentialSchema represents the credentialSchema property of a Verifiable Credential. more information can be found [here] [here]: https://www.w3.org/TR/vc-dat…
2 properties
CredentialStatus
object
CredentialStatus represents the credentialStatus property of a Verifiable Credential. more information can be found [here] [here]: https://www.w3.org/TR/vc-dat…
4 properties
EnvelopedCredential
object
EnvelopedCredential represents a Credential enveloped in a specific format.
2 properties
ErrorInfo
object
Describes the cause of the error with structured details.
2 properties
GenerateRequest
object
Generate an Id and its corresponding ResolverMetadata for the specified Issuer For external IdPs, the Issuer should be provided with a Proof of ownership of th…
2 properties
GenerateResponse
object
Returns the Generated Id and its corresponding ResolverMetadata
1 property
GetIssuerWellKnownResponse
object
Returns the content of the well-known JWKS document
1 property
GetVcWellKnownResponse
object
Returns the well-known VCs for an Id
1 property
GoogleProtobufAny
object
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
1 property
Issuer
object
A Identity Issuer
7 properties
Jwk
object
JWK represents: - a JSON Web Key (JWK) with the respective fields specific to RSA algorithms. - a Quantum JSON Web Key (QJWK) with the respective fields specif…
15 properties
Jwks
object
JWKS represents a set of JSON Web Keys (JWKs).
1 property
Proof
object
A data integrity proof provides information about the proof mechanism, parameters required to verify that proof, and the proof value itself.
3 properties
PublishRequest
object
Request to publish an issued Verifiable Credential
2 properties
RegisterIssuerRequest
object
Request to register an issuer
2 properties
RegisterIssuerResponse
object
Returns a registration response for the issuer
ResolveRequest
object
Resolve a specified Id to its corresponding ResolverMetadata
1 property
ResolveResponse
object
Returns the ResolverMetadata corresponding to the specified Id
1 property
ResolverMetadata
object
ResolverMetadata represents a set of data describing the ID including mechanisms such as: - cryptographic public keys - used to authenticate itself and prove a…
5 properties
RevokeRequest
object
Request to revoke a published Verifiable Credential
2 properties
SearchRequest
object
Request to search for VCs based on the specified criteria
3 properties
SearchResponse
object
Returns the VCs that match the search criteria
1 property
Service
object
Service is used in ResolverMetadata to express ways of communicating with the node that published the document.
1 property
Status
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
Time
object
VerifiableCredential
object
DataModel represents the W3C Verifiable Credential Data Model defined [here] [here]: https://www.w3.org/TR/vc-data-model/
10 properties
VerificationMethod
object
VerificationMethod expresses verification methods, such as cryptographic public keys, which can be used to authenticate or authorize interactions with the enti…
2 properties
VerificationResult
object
The result returned from the verification process defined [here] [here]: https://www.w3.org/TR/vc-data-model-2.0/verification
7 properties
VerifyRequest
object
Request to verify an existing Verifiable Credential
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

agntcy-identity-node-openapi.yaml Raw ↑
Where this information came from

This is an independent, third-party profile of AGNTCY Identity Node API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.