Verify a Compact Credential
Verify a Compact Credential by providing the encoded payload and specifying verification options.
You can provide a valid Compact Credential as either an encoded string or a QR code in a PDF document or an image file.
Standard checks performed on all verification requests:
- Conformance of the string and encoded data. All string representations of Compact Credentials must be prefixed with
CSC/1
. - Decoded payload structure is a valid Compact Credential.
- Issuer DID can be used to resolve its
did.json
document. - Public key from issuer's
did.json
document validates the proof signature, confirming the credential has not been tampered with.
Optional parameter checks:
- Credential was issued by a trusted issuer.
- Current time is after the beginning of the credential validity period.
- Current time is not after the end of the credential validity period.
- Credential has not been revoked.
Analytic events
- CREDENTIAL_COMPACT_VERIFY_START
- CREDENTIAL_COMPACT_VERIFY_SUCCESS
- CREDENTIAL_COMPACT_VERIFY_FAIL
SecuritybearerAuth
Request
Request Body schema: required
Responses
200
Verification completed
400
Bad Request
413
Payload Too Large
415
Unsupported Media Type
post/v2/credentials/compact/verify
Request samples
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "payload": "CSC:/1/2KCE3IQEJB5DCMSLN5KWKZABE2QFQRVDAF4CIZDJMQ5HOZLCHIYDGOJUFUYTENJNGIZTOLJVGIWTCMJQFZXGO4TPNMXGS33ENZQW2ZLEJJXWQ3QH3BAFB3LISHKGQ2KBJ6Q35NXZFD6LGZ2YIAYHZAKCF7NKTIUZUTZQ3PWDBALAWVRG5XL2H4P4WFK25X3Y5X5RTN7NOZUST67KLCEFS3EPXQU5KM7VUGOPXJLQ6K5U676PMQNWRZCZ",
- "trustedIssuers": [
- "did:web:organization.com"
], - "assertValidFrom": true,
- "assertValidUntil": true,
- "checkRevocation": true
}
Response samples
- 200
- 400
application/json
{- "verified": true,
- "decoded": {
- "iss": "did:web:organization.com",
- "nbf": 1645743759,
- "exp": 1646743759,
- "iat": 1645743759,
- "jti": "6tVMmKodQNaLywW6NGA2aA",
- "type": "CredentialType",
- "property1": "...",
- "property2": "..."
}, - "error": {
- "type": "string",
- "message": "string",
- "details": { }
}
}