Connection invitation parameters

Edit online

You can configure the connection invitation to control the type and operational characteristics of the invitation by adding properties to the JSON body.
POST https://${service_url}/v1.0/diagency/invitations

The following table explains the available parameters:

Property Default Value Description
goal None A human-readable description of the invitation purpose.
goal_code None A machine-readable code of the invitation goal.

For example, issue-vc to issue a credential and request-proof to verify a proof.
manual_accept false
  • If set to true, the inviter must manually accept all connection offers received by using this invitation.
  • If set to false, the agent of the inviter automatically accepts the connection offers.
max_acceptances -1 The maximum number of times the invitation can be accepted. If the value is not set, there is no limit in accepting the invitations.

An invitation can be deleted at any time to prevent future acceptances.

max_connections None The maximum number of connections that can be created from this invitation, which can concurrently exist. If the value is not set, there is no limit in the number of connections.
max_queue_count None Limits the number of messages an edge agent can queue when connecting through this invitation. Any messages received by the mediator that exceeds this limit are discarded by the mediator.
invitation_lifetime_ms None The time in milliseconds to use the invitation before expiry. If the value is not set, the invitations do not expire.
connection_lifetime_ms None The time in milliseconds to use any connection that is created before the invitation expires. If the value is not set, connections that are created from this invitation do not expire.
direct_route true
  • If set to true, messages are sent directly to the inviter.
  • If set to false, messages are proxied through the agency to protect against traffic analysis.
properties {}

The properties that are set on the connection and associated with the inviter.

Properties that are provided by the inviter during manual acceptance of a connection offer are also set on the connection and are associated with the inviter. If a property is in both the invitation and a manual acceptance, the value of the manual acceptance property takes precedence.
attach.cred_offer None The issuer offers a credential to a holder.
attach.cred_proposal None The holder requests for a credential.
attach.verification_request None The verifier requests proof from the holder.
attach.verification_proposal None The holder proposes proof to the verifier.
attach.recipient None Specifies the recipient of the attachment (inviter or invitee).
attach.use_connection None
  • If set to true, it requires a connection first or reuse of an existing connection.
  • If set to false, this initiates a connection-less interaction.
If the attach section is not specified, the invitation is for connection only. If the attach section is specified, both attach.recipient and attach.use_connection must be provided and one of the following fields must be specified:
  • To begin an issuance interaction: attach.cred_offer and attach.cred_proposal
  • To begin a verification interaction: attach.verification_request and attach.verification_proposal