Class CredentialDeferredIssueRequest

  • All Implemented Interfaces:
    Serializable

    public class CredentialDeferredIssueRequest
    extends Object
    implements Serializable
    A request to Authlete's /vci/deferred/issue API.

    The Authlete API is supposed to be called by the implementation of the deferred credential endpoint. The endpoint is defined in the "OpenID for Verifiable Credential Issuance" (OID4VCI) specification.

    The implementation of the deferred credential endpoint is expected to call the following Authlete APIs in the order.

    1. /auth/introspection
    2. /vci/deferred/parse
    3. /vci/deferred/issue

    The role of the /vci/deferred/issue API is to issue a credential.

    If the credential for the transaction ID is not ready, the implementation of the deferred credential endpoint should prepare an error response with "error":"issuance_pending" manually and return it to the request sender, without calling the /vci/deferred/issue API.

     HTTP/1.1 400 Bad Request
     Content-Type: application/json
     Cache-Control: no-store
    
     {
       "error": "issuance_pending"
     }
     
    Since:
    3.70, Authlete 3.0
    See Also:
    OpenID for Verifiable Credential Issuance, Serialized Form
    • Constructor Detail

      • CredentialDeferredIssueRequest

        public CredentialDeferredIssueRequest()
    • Method Detail

      • getOrder

        public CredentialIssuanceOrder getOrder()
        Get the credential order that provides an instruction for issuing a credential.
        Returns:
        The instruction for credential issuance.