Dizme API version 2.0

Dizme Agent Rest Service API

Dizme API documentation.

Contact:

• URL: 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 existing 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.
• Operation ID: create_verify_request
• Request Body:
  • Description: Request object needed to execute the verify request operation.
  • Content-Type: application/json
  • Schema: VerifyRequest
  • Required: true
• Responses:
  • 200:
    • Description: Successful response
    • Content-Type: application/json
    • Schema: InvitationResponse
  • 401:
    • Description: Not authorized
    • Content-Type: application/json
    • Schema: string
• Security:
  • Auth_token
  • Agent_id
• x-codegen-request-body-name: body

/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.
• Operation ID: create_verify_response
• Request Body:
  • Description: Request object needed to execute the verify response operation.
  • Content-Type: application/json
  • Schema: VerifyResponseRequest
  • Required: true
• Responses:
  • 200:
    • Description: Successful response
    • Content-Type: application/json
    • Schema: DizmeAgentResponse
  • 401:
    • Description: Not authorized
    • Content-Type: application/json
    • Schema: string
• Security:
  • Auth_token
  • Agent_id
• x-codegen-request-body-name: body

/connection/invitation

POST /connection/invitation

• Tags: connection
• Summary: Send a connection_invitation
• Description: The ORG can request a pairwise connection.
• Operation ID: create_connection_invitation
• Request Body:
  • Description: Request object needed to execute the connection invitation operation.
  • Content-Type: application/json
  • Schema: ConnectionInvitationRequest
  • Required: true
• Responses:
  • 200:
    • Description: Successful response
    • Content-Type: application/json
    • Schema: InvitationResponse
  • 401:
    • Description: Not authorized
    • Content-Type: application/json
    • Schema: string
• Security:
  • Auth_token
  • Agent_id
• x-codegen-request-body-name: body

/credential/offer

POST /credential/offer

• Tags: credential
• Summary: Send a credential offer
• Description: The ORG can request a credential offer
• Operation ID: create_credentil_offer
• Request Body:
  • Description: Request object needed to execute the credential offer.
  • Content-Type: application/json
  • Schema: CredentialOfferRequest
  • Required: true
• Responses:
  • 200:
    • Description: Successful response
    • Content-Type: application/json
    • Schema: InvitationResponse
  • 401:
    • Description: Not authorized
    • Content-Type: application/json
    • Schema: string
• Security:
  • Auth_token
  • Agent_id
• x-codegen-request-body-name: body

/transaction/{transaction_id}/status

GET /transaction/{transaction_id}/status

• Tags: transaction
• Parameters:
  • Name: transaction_id
    • In: path
    • Description: The transaction identifier
    • Required: true
    • Schema:
      • Type: string
• Responses:
  • 200:
    • Description: Successful response
    • Content-Type: /
    • 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