openapi: 3.0.0
info:
title: Privado ID - Issuer Agent Internal API
description: "The Issuer Node Core API is ideal for users who need multiple identities and for integrator profiles, who want to \ncreate solutions based on Privado ID functionalities and might be interested in having access to low level \ninformation such as Merkle Trees.\nThe Issuer Node API provide the following functionalities:\n* Create and retrieve Identities\n* Create a Verifiable Credential (VC)\n* Retrieve a Verifiable Credential or a list of Verifiable Credentials\n* Generate JSON to create a QR Code and use that to accept credentials in a wallet\n* Revoke a Verifiable Credential\n* Check revocation status of a Verifiable Credential\n* Retrieve the Revocation Status of a Verifiable Credential\n* Call Agent Endpoint using the Wallet App\n* Handle connections.\n"
version: '1'
tags:
- name: Internal
description: Internal endpoints
paths:
/:
get:
summary: Get the documentation
operationId: GetDocumentation
x-internal: true
tags:
- Internal
responses:
200:
description: success and returns the documentation in HTML format
/health:
get:
summary: Health Check
operationId: Health
tags:
- Internal
responses:
'200':
description: All services are running
content:
application/json:
schema:
$ref: '#/components/schemas/Health'
'500':
$ref: '#/components/responses/500'
/callback:
post:
summary: Callback
operationId: Callback
tags:
- Internal
parameters:
- $ref: '#/components/parameters/sessionID'
requestBody:
required: true
content:
text/plain:
schema:
type: string
example: jwz-token
description: JWZ token
responses:
'200':
description: Callback
content:
application/json:
schema:
$ref: '#/components/schemas/CallbackResponse'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
components:
schemas:
GenericErrorMessage:
type: object
required:
- message
properties:
message:
type: string
example: Something happen
Health:
type: object
x-omitempty: false
example:
healthy: true
CallbackResponse:
type: object
parameters:
sessionID:
name: sessionID
in: query
required: true
description: 'ID e.g: 89d298fa-15a6-4a1d-ab13-d1069467eedd
'
schema:
type: string
x-go-type: uuid.UUID
x-go-type-import:
name: uuid
path: github.com/google/uuid
responses:
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/GenericErrorMessage'
'500':
description: Internal Server error
content:
application/json:
schema:
$ref: '#/components/schemas/GenericErrorMessage'
securitySchemes:
basicAuth:
type: http
scheme: basic