Error
A valid request URL is required to generate request examples{
"verificationResult": {
"status": "Compliant",
"verifiablePresentation": {
"@context": [
"https://www.w3.org/2018/credentials/v1"
],
"type": [
"VerifiablePresentation"
],
"holder": "did:…",
"verifiableCredential": [
"<issuer-jwt>~<disclosure>~<kb-jwt>"
]
}
}
}{
"code": "INVALID_PARAMETER",
"message": "limit must be between 1 and 100"
}{
"code": "INVALID_PARAMETER",
"message": "<string>"
}{
"code": "FORBIDDEN",
"message": "This endpoint requires an agent JWT"
}{
"code": "CREDENTIAL_STORAGE_UNAVAILABLE",
"message": "Failed to read credential envelope"
}Agent APIs
Verify a credential
Runs a verification program against the holder’s credentials. Requires an
agent JWT with credentials.verify; user JWTs are rejected. Verification
always runs offchain, without a zero-knowledge proof.
status is Compliant, Non-Compliant, or NotFound.
verifiablePresentation is present only when the status is Compliant.
A storage outage returns 502 CREDENTIAL_STORAGE_UNAVAILABLE, not
NotFound.
POST
/
v2
/
credentials
/
verify-by-agent
Error
A valid request URL is required to generate request examples{
"verificationResult": {
"status": "Compliant",
"verifiablePresentation": {
"@context": [
"https://www.w3.org/2018/credentials/v1"
],
"type": [
"VerifiablePresentation"
],
"holder": "did:…",
"verifiableCredential": [
"<issuer-jwt>~<disclosure>~<kb-jwt>"
]
}
}
}{
"code": "INVALID_PARAMETER",
"message": "limit must be between 1 and 100"
}{
"code": "INVALID_PARAMETER",
"message": "<string>"
}{
"code": "FORBIDDEN",
"message": "This endpoint requires an agent JWT"
}{
"code": "CREDENTIAL_STORAGE_UNAVAILABLE",
"message": "Failed to read credential envelope"
}Authorizations
Agent JWT from POST /v2/auth/agent/session.
Body
application/json
Verification program to run.
Omit, "*", or a non-empty list of field names.
- Iden3: omit to return an empty
verifiableCredential(queries still run on the full credential);"*"keeps every subject field exceptid. - SD-JWT: omit to disclose the claims the program queries;
"*"attaches every presentable disclosure.
Available options:
* Example:
"*"
SD-JWT programs only. Verifier challenge bound into the key-binding JWT.
Required when the credential was issued with cnf.jwk.
Response
Verification result
Show child attributes
Show child attributes
Was this page helpful?