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>"
    }
  }
}
'

import requests

url = "https://api.sandbox.humanity.org/v2/queries/evaluate"

payload = { "query": { "check": {
            "claim": "<string>",
            "operator": "<unknown>",
            "value": "<unknown>"
        } } }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({query: {check: {claim: '<string>', operator: '<unknown>', value: '<unknown>'}}})
};

fetch('https://api.sandbox.humanity.org/v2/queries/evaluate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.humanity.org/v2/queries/evaluate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => [
        'check' => [
                'claim' => '<string>',
                'operator' => '<unknown>',
                'value' => '<unknown>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.humanity.org/v2/queries/evaluate"

	payload := strings.NewReader("{\n  \"query\": {\n    \"check\": {\n      \"claim\": \"<string>\",\n      \"operator\": \"<unknown>\",\n      \"value\": \"<unknown>\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.humanity.org/v2/queries/evaluate")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": {\n    \"check\": {\n      \"claim\": \"<string>\",\n      \"operator\": \"<unknown>\",\n      \"value\": \"<unknown>\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.humanity.org/v2/queries/evaluate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": {\n    \"check\": {\n      \"claim\": \"<string>\",\n      \"operator\": \"<unknown>\",\n      \"value\": \"<unknown>\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

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).