Dizme API Version 1.0 (Legacy)

Dizme Agent Rest Service API (Legacy)

Dizme API documentation.

All this API will be referred to the configured default service.Contact:

Version:

1.0

URL:

api/v1

Terms of service

http://swagger.io/terms/

Contact information:
https://dizme.io

Email: team.dizme@etuitus.it

Version: 1.0.0

Servers

• https://{}.dizme.io/api/v1

Tags

• verify: Verify operation can be made through Dizme agent
• connection: Connection operation can be made through Dizme agent
• transaction
• credential: Credential issuing operation can be made through Dizme agent

Paths

/verify/request

POST /verify/request

• Tags: verify
• Summary:

Create a new verify request.

Description:

The verify request can be created for an already exisistingexisting pairwise connection or for a not yet executed pairwise connection. In this last case, a connection will be previously performed automatically.

Multiple read parameter is allowed only for request without connection_id provided

provided.

Responses

Operation ID:create_verify_request

Request

Body:

Description:

Requestobjectneededto

Content-Type:

application/json

Schema:

Content-Type:

application/json

Code	Description
200	Successfullexecute the verify request operation. Content-Type: application/json Schema: VerifyRequest Required: true Responses: 200: Description: Successful response
401	InvitationResponse 401: Description: Not authorized

Schema:

Security

string

Security:

Auth_token

Agent_id

x-codegen-request-body-name:

body

Security Schema	Scopes
Auth_token
Agent_id

/verify/response

POST /verify/response

• Tags: verify
• Summary:

Send a response for a verify request

Description:

The ORG can send a verify proof response for a previously proof verify request executed.

Responses

Operation ID:create_verify_response

Request

Body:

Description:

Requestobjectneededtooperation.

Content-Type:

application/json

Content-Type:

application/json

Code	Description
200	Successfullexecute the verify response
401	Schema: VerifyResponseRequest Required: true Responses: 200: Description: Successful response Content-Type: application/json Schema: DizmeAgentResponse 401: Description: Not authorized

Schema:

Security

string

Security:

Auth_token

Agent_id

x-codegen-request-body-name:

body

Security Schema	Scopes
Auth_token
Agent_id

/connection/invitation

POST /connection/invitation

• Tags: connection
• Summary:

Send a connection_invitation

Description:

The ORG can request a pairwise connection.

Responses

Operation ID:create_connection_invitation

Request

Body:

Description:

Requestobjectneededto

Content-Type:

application/json

Schema:

Content-Type:

application/json

Code	Description
200	Successfullexecute the connection invitation operation. Content-Type: application/json Schema: ConnectionInvitationRequest Required: true Responses: 200: Description: Successful response
401	InvitationResponse 401: Description: Not authorized

Schema:

Security

string

Security:

Auth_token

Agent_id

x-codegen-request-body-name:

body

Security Schema	Scopes
Auth_token
Agent_id

/credetial/credential/offer

POST /credential/offer

• Tags: credential
• Summary:

Send a credential offer

Description:

The ORG can request a credential offer

Responses

Operation ID:create_credentil_offer

Request

Body:

Description:

Requestobjectneededto

Content-Type:

application/json

Schema:

Content-Type:

application/json

Code	Description
200	Successfullexecute the credential offer. Content-Type: application/json Schema: CredentialOfferRequest Required: true Responses: 200: Description: Successful response
401	InvitationResponse 401: Description: Not authorized

Schema:

Security

string

Security:

Auth_token

Agent_id

x-codegen-request-body-name:

body

Security Schema	Scopes
Auth_token
Agent_id

/transaction/{transaction_id}/status

GET /transaction/{transaction_id}/status

Parameters

• Tags:
transaction
• Parameters:
transaction_id
• In:
path
• Description:
• Required:

Name	Located Name: in	Description	Required	Schema
transaction_id	path	The transaction identifier	Yes	true Schema: Type: string

Responses

Responses:

200:

Description:

Content-Type:

/

Code	Description
200	SuccessfullSuccessful response

Schema: TransactionStatusResponse

Components

Schemas

VerifyRequest

• Required:
  • business_code
• Type: object
• Properties:
  • connection_id:
    • Type: string
    • Description: connection_id to which the request will be sent
  • business_code:
    • Type: string
    • Description: Business code of the verify proof
  • allow_multiple_read:
    • Type: boolean
    • Description: Usable only if connection_id is not provided, true if the verify request can be used multiple times, false otherwise
  • request_uid:
    • Type: string
    • Description: The identifier of the request to be used, if not provided it will be automatically generated

InvitationResponse

• Inherits: DizmeAgentResponse

VerifyResponseRequest

• Type: object
• Properties:
  • presentation_id:
    • Type: string
    • Description: presentation_id of the involved verify request
  • result:
    • Type: boolean
    • Description: The result of the verify request performed, True if successful false otherwise
  • descriptions:
    • Type: array
    • Description: The localized description related to the verify response
    • Items:
      • $ref: '#/components/schemas/DizmeDescription'

DizmeAgentResponse

• Required:
  • message
  • message_code
  • status_code
• Type: object
• Properties:
  • status_code:
    • Type: integer
    • Format: int32
  • message_code:
    • Type: integer
    • Format: int32
  • message:
    • Type: string

DizmeDescription

• Required:
  • lang
  • message
• Type: object
• Properties:
  • lang:
    • Type: string
  • message:
    • Type: string

CredentialAttributePreview

• Required:
  • mime_type
  • name
  • value
• Type: object
• Properties:
  • name:
    • Type: string
  • mime_type:
    • Type: string
  • value:
    • Type: string

ConnectionInvitationRequest

• Required:
  • organization_name
• Type: object
• Properties:
  • organization_name:
    • Type: string
    • Description: The name of the organization involved in the request
  • allow_multiple_read:
    • Type: boolean
    • Description: Usable only if connection_id is not provided, true if the verify request can be used multiple times, false otherwise
  • request_uid:
    • Type: string
    • Description: The identifier of the request to be used, if not provided it will be automatically generated

CredentialOfferRequest

• Required:
  • credential_def_id
  • organization_name
• Type: object
• Properties:
  • organization_name:
    • Type: string
    • Description: The name of the organization involved in the request
  • request_uid:
    • Type: string
    • Description: The identifier of the request to be used, if not provided it will be automatically generated
  • connection_id:
    • Type: string
    • Description: connection_id to which the request will be sent
  • credential_def_id:
    • Type: string
    • Description: The credential definition id to offer
  • credential_values:
    • Type: array
    • Description: The list of the credential attributes to offer, Mandatory in case of connection_id provided
    • Items:
      • $ref: '#/components/schemas.CredentialAttributePreview'
  • comment:
    • Type: string
    • Description: A comment description of the operation to present to the user

TransactionStatusResponse

• Inherits: DizmeAgentResponse

Security Schemes

Auth_token

• Type: apiKey
• Name: X-Auth-Token
• In: header

Agent_id

• Type: apiKey
• Name: X-Dizme-Agent-Id
• In: header