Method: be.mdl.canonical.:issuerId.v1.notifyCredentialStatusUpdateAvailable

  • This endpoint, using a POST request, notifies of a new credential status update available via GetCredentialStatus.

  • The request URL follows gRPC Transcoding syntax and is structured as POST https://vgw.googleapis.com/be/mdl/canonical/:issuerId/v1/notifyCredentialStatusUpdateAvailable.

  • The request body requires requestMetadata, a unique deviceReferenceId for each credential on a device, and a credentialId.

  • The response body, upon success, contains responseMetadata acknowledging the availability of a credential status update.

An endpoint to indicate that there is a new status update that can be retrieved using GetCredentialStatus.

HTTP request

POST https://vgw.googleapis.com/be/mdl/canonical/:issuerId/v1/notifyCredentialStatusUpdateAvailable

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "credentialId": string
}
Fields
requestMetadata

object (RequestMetadata)

The metadata about the request, required in all requests.
deviceReferenceId

string

The id that corresponds to the device and the identity key associated with the device. This is NOT a device id, meaning that if the user were to have two separate credentials on the same device, this id would differ between them.

This id is supplied in all requests, and can be used to correlate requests.
credentialId

string

An opaque identifier representing a credential.

Ex: UUID

Response body

An acknowledgement that there is a credential status update available.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "responseMetadata": {
    object (ResponseMetadata)
  }
}
Fields
responseMetadata

object (ResponseMetadata)

The metadata about the response, required in all responses.