Skip to main content

Create OOB message

PUT 
/:ssiId/ssi/v1/credentialsbbs/wacioob

Generation of Invitation Message for Credential Issuance​

In this section, the process of generating an invitation message, also known as "Out of band," according to the WACI-DIDCOM protocol is described. This invitation message is typically converted into a QR code provided by an Issuer, allowing another individual to scan it with their identity wallet and receive their verifiable credential.

Example Usage​

Let's consider the case of an Issuer representing an educational institution, such as a School. The institution exposes a QR code for a student to obtain their regular student credential.

It is important to note that when someone wishes to generate an invitation QR, it is because they have already entered the user into a business logic process, and therefore already know their identity. In this case, the educational institution recognizes the student because it has validated their information in its system. Once the student has passed these validation processes, this API is requested to generate the invitation message.

Request​

Path Parameters

    ssiId stringrequired

Query Parameters

    apikey stringrequired

Body

required

request body

    did stringrequired

    Issuer DID

    oneTimeUse booleanrequired

    If true, this QR can be scan one time only

    to stringrequired

    Holder DID if you know

    vc objectrequired
    outputDescriptor objectrequired

    Output descriptor for this credential

    inputDescriptors string[]required

    Input descriptor required to generate this credential

    issuer objectrequired

    Issuer metadata

Responses​

Return invitationId and content to render QR Code

Schema
    any
Loading...