Skip to main content

OfferStatus

offerIduuid

Unique offer identifier.

Example: 550e8400-e29b-41d4-a716-446655440000
statusstring

Current state of the offer.

Possible values: [pending, claimed, accepted, rejected, expired, revoked, suspended]

Example: claimed
credentialConfigurationIdstring

Credential configuration used.

Example: VerifiedPerson_vc+sd-jwt
credentialTypestring

Credential type URN.

Example: VerifiedPerson
externalIdstring

Your correlation ID.

Example: order-12345
holderBindingstring

Holder's DID or key binding, when the wallet supplied one at issuance. May be absent even after the credential is issued.

Example: did:jwk:eyJrdHkiOiJFQyIsImNydiI6IlAtMjU2In0...
createdAtdate-time

Creation timestamp (ISO 8601).

Example: 2025-01-15T10:00:00Z
expiresAtdate-time

Expiry timestamp (ISO 8601).

Example: 2025-01-15T10:05:00Z
claimedAtdate-time

When the credential was issued to the holder's wallet — present once issued.

Example: 2025-01-15T10:01:42Z
respondedAtdate-time

When the wallet accepted or rejected the offer.

Example: 2025-01-15T10:01:50Z
acceptedAtdate-time

When the holder accepted the credential — present once status is accepted.

Example: 2025-01-15T10:01:50Z
rejectedAtdate-time

When the holder declined the offer — present once status is rejected.

revokedAtdate-time

When the offer moved to revoked — after an explicit revocation or a failure.

failedAtdate-time

When the offer failed (status revoked) or expired (status expired).

failureReasonstring

Machine-readable reason, present when the offer failed (status revoked), was rejected by the wallet (wallet_rejected) or expired (offer_expired).

Possible values: [issuance_failed, wallet_rejected, offer_expired, backend_error]

failureDescriptionstring

Human-readable failure detail, present when the offer failed.

updatedAtdate-time

Last time the offer changed.

credentialIdstring

The credential's ID in urn:uuid: form, present once issued. When the credential is registered it is the registry ID — the same value as credentialStatus.credentialId — which Revoke Credential takes.

Example: urn:uuid:7c9e6679-7425-40de-944b-e07fc1f90ae7
credentialStatus object

The credential's W3C Bitstring Status List entry in the Network Credential Registry, present once registered.

credentialIdstring

Registry ID (urn:uuid: form) — the same value as the top-level credentialId.

Example: urn:uuid:7c9e6679-7425-40de-944b-e07fc1f90ae7
statusListIduuid
statusListIndexint64
statusListCredentialuri

URL of the status list credential.

callbackAttemptsinteger

Number of delivery attempts for this offer's issuance webhooks. Revocation notifications are not counted.

Example: 1
callbackDeliveryStatusstring

Your webhook's delivery state for this offer. pending: nothing delivered or given up on yet (also what you see with no callback URL configured). delivered: at least one webhook returned 2xx. exhausted: a notification was given up on — read the state from this response instead of waiting for the webhook. exhausted is permanent. Covers the issuance webhooks only; revocation notifications don't change it.

Possible values: [pending, delivered, exhausted]

Example: delivered
OfferStatus
{
  "offerId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "claimed",
  "credentialConfigurationId": "VerifiedPerson_vc+sd-jwt",
  "credentialType": "VerifiedPerson",
  "externalId": "order-12345",
  "holderBinding": "did:jwk:eyJrdHkiOiJFQyIsImNydiI6IlAtMjU2In0...",
  "createdAt": "2025-01-15T10:00:00Z",
  "expiresAt": "2025-01-15T10:05:00Z",
  "claimedAt": "2025-01-15T10:01:42Z",
  "respondedAt": "2025-01-15T10:01:50Z",
  "acceptedAt": "2025-01-15T10:01:50Z",
  "rejectedAt": "2024-07-29T15:51:28.071Z",
  "revokedAt": "2024-07-29T15:51:28.071Z",
  "failedAt": "2024-07-29T15:51:28.071Z",
  "failureReason": "issuance_failed",
  "failureDescription": "string",
  "updatedAt": "2024-07-29T15:51:28.071Z",
  "credentialId": "urn:uuid:7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "credentialStatus": {
    "credentialId": "urn:uuid:7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "statusListId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "statusListIndex": 0,
    "statusListCredential": "string"
  },
  "callbackAttempts": 1,
  "callbackDeliveryStatus": "delivered"
}