Evaluate a query against the authenticated user's credentials

Evaluate a query against the authenticated user’s credentials. This endpoint allows declarative queries to check user claims.

POST /queries/evaluate

Evaluate a query against the authenticated user's credentials

cURL

curl --request POST \
  --url https://api.sandbox.humanity.org/v2/queries/evaluate \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": {
    "check": {
      "claim": "<string>",
      "operator": "<unknown>",
      "value": "<unknown>"
    }
  }
}
'

200

{
  "type": "<unknown>",
  "passed": true,
  "evaluatedAt": "<string>",
  "evidence": {
    "claimsUsed": [
      {
        "path": "<string>",
        "value": "<unknown>",
        "credentialId": "<string>",
        "source": "<string>"
      }
    ],
    "checkResults": [
      {
        "claim": "<string>",
        "operator": "<string>",
        "expectedValue": "<unknown>",
        "actualValue": "<unknown>",
        "passed": true
      }
    ]
  },
  "expiresAt": "<string>"
}

Body

application/json

The query to evaluate

Request body for query evaluation.

query · object · required

The query to evaluate. Can be a simple check or compound policy.

Option 1

Option 2

Option 3

Show child attributes

Response

200 - application/json

Query evaluation result

Option 1

Option 2

Response from predicate query evaluation.

type · any · required

passed · boolean · required

Whether the query passed.

evaluatedAt · string · required

Timestamp when the query was evaluated.

evidence · object · required

Evidence collected during evaluation.

Show child attributes

expiresAt · string

Earliest credential expiry date (if any).