Search assessments across this environment

cURL

curl --request POST \
  --url 'https://api.noresponse.org/v1/assessments/search' \
  --header "Authorization: Bearer $NORESPONSE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "from": "2026-10-01T00:00:00Z",
  "to": "2026-10-02T00:00:00Z",
  "limit": 20,
  "identifier_expression": {
    "scope": "assessment",
    "expression": {
      "and": [
        {
          "term": {
            "kind": "phone",
            "value": "+14155552671",
            "match": "canonical"
          }
        },
        {
          "or": [
            {
              "term": {
                "kind": "email",
                "value": "case@example.com",
                "match": "exact"
              }
            },
            {
              "term": {
                "kind": "email",
                "value": "other@example.com",
                "match": "exact"
              }
            }
          ]
        }
      ]
    }
  }
}'

import { NoResponse } from "@noresponse/node";

const noResponse = new NoResponse({
  apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});

async function run() {
  const result = await noResponse.assessments.search({
    from: "2026-10-01T00:00:00Z",
    to: "2026-10-02T00:00:00Z",
    identifierExpression: {
      scope: "assessment",
      expression: {
        and: [
          {
            term: {
              kind: "phone",
              value: "+14155552671",
              match: "canonical",
            },
          },
          {
            or: [
              {
                term: {
                  kind: "email",
                  value: "case@example.com",
                  match: "exact",
                },
              },
              {
                term: {
                  kind: "email",
                  value: "other@example.com",
                  match: "exact",
                },
              },
            ],
          },
        ],
      },
    },
  });

  console.log(result.total);
}

run();

from noresponse import NoResponse
import os


with NoResponse(
    api_key=os.getenv("NORESPONSE_API_KEY", ""),
) as no_response:

    res = no_response.assessments.search(from_="2026-10-01T00:00:00Z", to="2026-10-02T00:00:00Z", identifier_expression={
        "scope": "assessment",
        "expression": {
            "and_": [
                {
                    "term": {
                        "kind": "phone",
                        "value": "+14155552671",
                        "match": "canonical",
                    },
                },
                {
                    "or_": [
                        {
                            "term": {
                                "kind": "email",
                                "value": "case@example.com",
                                "match": "exact",
                            },
                        },
                        {
                            "term": {
                                "kind": "email",
                                "value": "other@example.com",
                                "match": "exact",
                            },
                        },
                    ],
                },
            ],
        },
    }, limit=20)

    # Handle response
    print(res.total)

package main

import(
	"context"
	"os"
	noresponse "github.com/noresponsehq/go/v12"
	"github.com/noresponsehq/go/v12/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := noresponse.New(
        noresponse.WithSecurity(os.Getenv("NORESPONSE_API_KEY")),
    )

    res, err := s.Assessments.Search(ctx, components.AssessmentSearchRequest{
        From: "2026-10-01T00:00:00Z",
        To: "2026-10-02T00:00:00Z",
        IdentifierExpression: &components.IdentifierExpression{
            Scope: components.ScopeEnumAssessment,
            Expression: components.IdentifierExpressionNode{
                And: []components.IdentifierExpressionNodeLevelTwo{
                    components.IdentifierExpressionNodeLevelTwo{
                        Term: &components.IdentifierSearch{
                            Kind: components.IdentifierSearchKindPhone,
                            Value: "+14155552671",
                            Match: components.MatchCanonical.ToPointer(),
                        },
                    },
                    components.IdentifierExpressionNodeLevelTwo{
                        Or: []components.IdentifierExpressionNodeLevelOne{
                            components.IdentifierExpressionNodeLevelOne{
                                Term: &components.IdentifierSearch{
                                    Kind: components.IdentifierSearchKindEmail,
                                    Value: "case@example.com",
                                    Match: components.MatchExact.ToPointer(),
                                },
                            },
                            components.IdentifierExpressionNodeLevelOne{
                                Term: &components.IdentifierSearch{
                                    Kind: components.IdentifierSearchKindEmail,
                                    Value: "other@example.com",
                                    Match: components.MatchExact.ToPointer(),
                                },
                            },
                        },
                    },
                },
            },
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

package hello.world;

import java.lang.Exception;
import java.util.List;
import org.noresponse.NoResponse;
import org.noresponse.models.errors.AuthenticationException;
import org.noresponse.models.errors.BadRequestException;
import org.noresponse.models.errors.ConflictException;
import org.noresponse.models.errors.NotFoundException;
import org.noresponse.models.errors.PermissionDeniedException;
import org.noresponse.models.errors.RateLimitException;
import org.noresponse.models.operations.SearchAssessmentsResponse;
import org.noresponse.models.shared.AssessmentSearchRequest;
import org.noresponse.models.shared.IdentifierExpression;
import org.noresponse.models.shared.IdentifierExpressionNode;
import org.noresponse.models.shared.IdentifierExpressionNodeLevelOne;
import org.noresponse.models.shared.IdentifierExpressionNodeLevelTwo;
import org.noresponse.models.shared.IdentifierSearch;
import org.noresponse.models.shared.IdentifierSearchKind;
import org.noresponse.models.shared.Match;
import org.noresponse.models.shared.ScopeEnum;

public class Application {

    public static void main(String[] args) throws Exception {

        NoResponse sdk = NoResponse.builder()
                .apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
            .build();

        AssessmentSearchRequest req = AssessmentSearchRequest.builder()
                .from("2026-10-01T00:00:00Z")
                .to("2026-10-02T00:00:00Z")
                .identifierExpression(IdentifierExpression.builder()
                    .scope(ScopeEnum.ASSESSMENT)
                    .expression(IdentifierExpressionNode.builder()
                        .and(List.of(
                            IdentifierExpressionNodeLevelTwo.builder()
                                .term(IdentifierSearch.builder()
                                    .kind(IdentifierSearchKind.PHONE)
                                    .value("+14155552671")
                                    .match(Match.CANONICAL)
                                    .build())
                                .build(),
                            IdentifierExpressionNodeLevelTwo.builder()
                                .or(List.of(
                                    IdentifierExpressionNodeLevelOne.builder()
                                        .term(IdentifierSearch.builder()
                                            .kind(IdentifierSearchKind.EMAIL)
                                            .value("case@example.com")
                                            .match(Match.EXACT)
                                            .build())
                                        .build(),
                                    IdentifierExpressionNodeLevelOne.builder()
                                        .term(IdentifierSearch.builder()
                                            .kind(IdentifierSearchKind.EMAIL)
                                            .value("other@example.com")
                                            .match(Match.EXACT)
                                            .build())
                                        .build()))
                                .build()))
                        .build())
                    .build())
                .build();

        SearchAssessmentsResponse res = sdk.assessments().search()
                .request(req)
                .call();

        if (res.assessmentSearchPage().isPresent()) {
            System.out.println(res.assessmentSearchPage().get().total());
        }
    }
}

using NoResponse;
using NoResponse.Models.Shared;
using System;
using System.Collections.Generic;

var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));

AssessmentSearchRequest req = new AssessmentSearchRequest() {
    From = "2026-10-01T00:00:00Z",
    To = "2026-10-02T00:00:00Z",
    IdentifierExpression = new IdentifierExpression() {
        Scope = ScopeEnum.Assessment,
        Expression = new IdentifierExpressionNode() {
            And = new List<IdentifierExpressionNodeLevelTwo>() {
                new IdentifierExpressionNodeLevelTwo() {
                    Term = new IdentifierSearch() {
                        Kind = IdentifierSearchKind.Phone,
                        Value = "+14155552671",
                        Match = Match.Canonical,
                    },
                },
                new IdentifierExpressionNodeLevelTwo() {
                    Or = new List<IdentifierExpressionNodeLevelOne>() {
                        new IdentifierExpressionNodeLevelOne() {
                            Term = new IdentifierSearch() {
                                Kind = IdentifierSearchKind.Email,
                                Value = "case@example.com",
                                Match = Match.Exact,
                            },
                        },
                        new IdentifierExpressionNodeLevelOne() {
                            Term = new IdentifierSearch() {
                                Kind = IdentifierSearchKind.Email,
                                Value = "other@example.com",
                                Match = Match.Exact,
                            },
                        },
                    },
                },
            },
        },
    },
};

var res = await sdk.Assessments.SearchAsync(req);

// handle response

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use NoResponse;
use NoResponse\Models\Shared;

$sdk = NoResponse\NoResponseClient::builder()
    ->setSecurity(
        getenv('NORESPONSE_API_KEY') ?: ''
    )
    ->build();

$request = new Shared\AssessmentSearchRequest(
    from: '2026-10-01T00:00:00Z',
    to: '2026-10-02T00:00:00Z',
    identifierExpression: new Shared\IdentifierExpression(
        scope: Shared\ScopeEnum::Assessment,
        expression: new Shared\IdentifierExpressionNode(
            and: [
                new Shared\IdentifierExpressionNodeLevelTwo(
                    term: new Shared\IdentifierSearch(
                        kind: Shared\IdentifierSearchKind::Phone,
                        value: '+14155552671',
                        match: Shared\MatchT::Canonical,
                    ),
                ),
                new Shared\IdentifierExpressionNodeLevelTwo(
                    or: [
                        new Shared\IdentifierExpressionNodeLevelOne(
                            term: new Shared\IdentifierSearch(
                                kind: Shared\IdentifierSearchKind::Email,
                                value: 'case@example.com',
                                match: Shared\MatchT::Exact,
                            ),
                        ),
                        new Shared\IdentifierExpressionNodeLevelOne(
                            term: new Shared\IdentifierSearch(
                                kind: Shared\IdentifierSearchKind::Email,
                                value: 'other@example.com',
                                match: Shared\MatchT::Exact,
                            ),
                        ),
                    ],
                ),
            ],
        ),
    ),
);

$response = $sdk->assessments->search(
    request: $request
);

$result = $response->result;
// handle response

require 'noresponse'

Models = ::NoResponse::Models
s = ::NoResponse::NoResponseClient.new(
  api_key: ENV.fetch('NORESPONSE_API_KEY', '')
)

req = Models::Shared::AssessmentSearchRequest.new(
  from: '2026-10-01T00:00:00Z',
  to: '2026-10-02T00:00:00Z',
  identifier_expression: Models::Shared::IdentifierExpression.new(
    scope: Models::Shared::ScopeEnum::ASSESSMENT,
    expression: Models::Shared::IdentifierExpressionNode.new(
      and_: [
        Models::Shared::IdentifierExpressionNodeLevelTwo.new(
          term: Models::Shared::IdentifierSearch.new(
            kind: Models::Shared::IdentifierSearchKind::PHONE,
            value: '+14155552671',
            match: Models::Shared::Match::CANONICAL
          )
        ),
        Models::Shared::IdentifierExpressionNodeLevelTwo.new(
          or_: [
            Models::Shared::IdentifierExpressionNodeLevelOne.new(
              term: Models::Shared::IdentifierSearch.new(
                kind: Models::Shared::IdentifierSearchKind::EMAIL,
                value: 'case@example.com',
                match: Models::Shared::Match::EXACT
              )
            ),
            Models::Shared::IdentifierExpressionNodeLevelOne.new(
              term: Models::Shared::IdentifierSearch.new(
                kind: Models::Shared::IdentifierSearchKind::EMAIL,
                value: 'other@example.com',
                match: Models::Shared::Match::EXACT
              )
            ),
          ]
        ),
      ]
    )
  )
)
res = s.assessments.search(request: req)

unless res.nil?
  # handle response
end

{
  "schema_version": "1",
  "items": [
    {
      "schema_version": "1",
      "id": "<string>",
      "status": "complete",
      "flow": "account_creation",
      "depth": "quick",
      "detail": {
        "schema_version": "1",
        "assessment_id": "<string>",
        "account_id": "<string>",
        "status": "complete",
        "confidence": "low",
        "incomplete_sources": [
          {
            "lane": "accounts",
            "reason": "timed_out"
          }
        ],
        "policy_version": "<string>",
        "policy_basis": "heuristic_unvalidated",
        "assessment_version": 500,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z",
        "timing": {
          "deadline_ms": 1525,
          "elapsed_ms": 300000
        },
        "identifiers": {
          "email": "<string>",
          "username": "<string>",
          "phone": "<string>",
          "name": "<string>",
          "ip": "<string>"
        },
        "request_id": "<string>",
        "recommendation": "allow",
        "risk": {
          "score": 50,
          "band": "low",
          "recommendation": "allow",
          "confidence": "low",
          "policy_version": "<string>",
          "policy_basis": "heuristic_unvalidated",
          "reasons": [
            {
              "code": "no_digital_footprint",
              "direction": "raises",
              "impact": "none",
              "identifier": "email",
              "list_entry_id": "<string>"
            }
          ],
          "coverage": {
            "answered": 1,
            "failed": 1,
            "pending": 1
          },
          "block": true,
          "block_threshold": 50,
          "step_up_threshold": 50,
          "review_threshold": 50,
          "summary": {
            "phone": {
              "line_type": "mobile",
              "country": "<string>",
              "report_count": 1,
              "carrier": "<string>"
            },
            "email": {
              "disposable": true,
              "accounts_found": 1,
              "breach": {
                "found": true,
                "breach_count": 1,
                "first_year": 2035,
                "last_year": 2035,
                "exposed": [
                  "email"
                ],
                "in_credential_lists": true,
                "recent_password_exposure": true,
                "truncated": true
              }
            },
            "username": {
              "accounts_found": 1,
              "breach": {
                "found": true,
                "breach_count": 1,
                "first_year": 2035,
                "last_year": 2035,
                "exposed": [
                  "email"
                ],
                "in_credential_lists": true,
                "recent_password_exposure": true,
                "truncated": true
              }
            },
            "ip": {
              "country": "<string>",
              "type": "residential",
              "asn": 2147483648,
              "seen_in_workspace": 1
            },
            "consistency": {
              "name": "match",
              "phone": "match",
              "ip": "match",
              "country": "consistent"
            },
            "footprint": {
              "families": [
                "account_presence"
              ],
              "email": {
                "first_seen_year": 2035,
                "last_seen_year": 2035,
                "span_years": 1,
                "sites": 2,
                "families": [
                  "account_presence"
                ],
                "last_active_year": 2035
              },
              "username": {
                "first_seen_year": 2035,
                "last_seen_year": 2035,
                "span_years": 1,
                "sites": 2,
                "families": [
                  "account_presence"
                ],
                "last_active_year": 2035
              },
              "coherence": {
                "birth_date": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "gender": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "nationality": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "country": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "city": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "zip": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "name": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "company": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "website": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "social": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                }
              }
            }
          },
          "details": {
            "phone_names": [
              {
                "value": "<string>",
                "seen_by": 2
              }
            ],
            "breaches": [
              {
                "name": "<string>",
                "kind": "site_breach",
                "matched_on": "email",
                "domain": "<string>",
                "category": "<string>",
                "year": 2035,
                "month": 6,
                "exposed": [
                  "email"
                ],
                "conduct": [
                  "chargeback"
                ]
              }
            ],
            "breach_names": [
              {
                "value": "<string>",
                "seen_in": 2,
                "sites": [
                  "<string>"
                ],
                "unsited": 2
              }
            ],
            "events": [
              {
                "year": 2035,
                "kind": "created",
                "site": "<string>",
                "category": "<string>",
                "family": "account_presence",
                "identifier": "email",
                "month": 6
              }
            ],
            "accounts": [
              {
                "name": "<string>",
                "domain": "<string>",
                "identifier": "email",
                "outcome": "found",
                "reason": "timed_out",
                "sign_in": [
                  "password"
                ],
                "email_verified": true,
                "blocked": true,
                "account_type": "personal",
                "has_avatar": true,
                "first_name_prefix": "<string>"
              }
            ],
            "attribute_conflicts": [
              {
                "attribute": "birth_date",
                "sites": [
                  "<string>"
                ],
                "unsited": 2
              }
            ]
          }
        },
        "signals": [
          {
            "type": "<string>",
            "identifier": "email",
            "outcome": "found",
            "source_id": "<string>",
            "freshness": "fresh",
            "reason": "timed_out",
            "evidence_ref": "<string>",
            "observed_at": "2023-11-07T05:31:56Z",
            "last_checked_at": "2023-11-07T05:31:56Z",
            "enrichment": {
              "fields": {
                "phone": "<string>",
                "name": "<string>",
                "carrier": "<string>",
                "line_type": "<string>",
                "entity_type": "<string>",
                "country_code": "<string>",
                "country": "<string>",
                "state": "<string>",
                "city": "<string>",
                "location": "<string>",
                "national_format": "<string>",
                "job_title": "<string>",
                "company_name": "<string>",
                "email": "<string>",
                "website": "<string>",
                "first_call_at": "<string>",
                "last_call_at": "<string>",
                "matched_name": "<string>",
                "alternate_names": [
                  "<string>"
                ],
                "name_candidates": [
                  "<string>"
                ],
                "timezones": [
                  "<string>"
                ],
                "emails": [
                  "<string>"
                ],
                "websites": [
                  "<string>"
                ],
                "locations": [
                  "<string>"
                ],
                "social_profiles": [
                  "<string>"
                ],
                "report_count": 1,
                "tag_count": 1,
                "total_calls": 1,
                "calls_60_days": 1,
                "reports_60_days": 1,
                "searches_60_days": 1,
                "comment_count": 1,
                "names_count": 1,
                "spam_report_count": 1
              }
            }
          }
        ],
        "assessment_url": "<string>",
        "auth_context": {
          "provider": "<string>",
          "issuer": "<string>",
          "verified": true,
          "transport": "backend",
          "subject": "<string>",
          "session_id": "<string>",
          "organization_id": "<string>",
          "hook_point": "pre_registration"
        }
      },
      "first_decision": "allow",
      "matched_identifier": {
        "kind": "username",
        "value": "JaneDoe",
        "match_basis": "canonical",
        "namespace": "customer",
        "provenance": "submitted",
        "assessment_id": "asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM"
      },
      "matched_identifiers": [
        {
          "kind": "username",
          "value": "JaneDoe",
          "match_basis": "canonical",
          "namespace": "customer",
          "provenance": "submitted",
          "assessment_id": "asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
          "term_index": 0
        }
      ]
    }
  ],
  "total": 5000,
  "total_capped": true,
  "retention_days": 365,
  "next_cursor": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 400,
  "detail": "<string>",
  "code": "invalid_request",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 401,
  "detail": "<string>",
  "code": "unauthorized",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "https://docs.noresponse.org/problems/workspace-forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The API key does not carry a scope this operation accepts.",
  "code": "workspace_forbidden",
  "request_id": "0123456789abcdef0123456789abcdef"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 404,
  "detail": "<string>",
  "code": "not_found",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 413,
  "detail": "<string>",
  "code": "payload_too_large",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 415,
  "detail": "<string>",
  "code": "unsupported_media_type",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "https://docs.noresponse.org/problems/rate-limited",
  "title": "Rate limited",
  "status": 429,
  "detail": "The tenant's assessment rate is exhausted; retry after the Retry-After interval.",
  "code": "rate_limited",
  "request_id": "0123456789abcdef0123456789abcdef"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 503,
  "detail": "<string>",
  "code": "service_unavailable",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

POST

assessments

cURL

curl --request POST \
  --url 'https://api.noresponse.org/v1/assessments/search' \
  --header "Authorization: Bearer $NORESPONSE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "from": "2026-10-01T00:00:00Z",
  "to": "2026-10-02T00:00:00Z",
  "limit": 20,
  "identifier_expression": {
    "scope": "assessment",
    "expression": {
      "and": [
        {
          "term": {
            "kind": "phone",
            "value": "+14155552671",
            "match": "canonical"
          }
        },
        {
          "or": [
            {
              "term": {
                "kind": "email",
                "value": "case@example.com",
                "match": "exact"
              }
            },
            {
              "term": {
                "kind": "email",
                "value": "other@example.com",
                "match": "exact"
              }
            }
          ]
        }
      ]
    }
  }
}'

import { NoResponse } from "@noresponse/node";

const noResponse = new NoResponse({
  apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});

async function run() {
  const result = await noResponse.assessments.search({
    from: "2026-10-01T00:00:00Z",
    to: "2026-10-02T00:00:00Z",
    identifierExpression: {
      scope: "assessment",
      expression: {
        and: [
          {
            term: {
              kind: "phone",
              value: "+14155552671",
              match: "canonical",
            },
          },
          {
            or: [
              {
                term: {
                  kind: "email",
                  value: "case@example.com",
                  match: "exact",
                },
              },
              {
                term: {
                  kind: "email",
                  value: "other@example.com",
                  match: "exact",
                },
              },
            ],
          },
        ],
      },
    },
  });

  console.log(result.total);
}

run();

from noresponse import NoResponse
import os


with NoResponse(
    api_key=os.getenv("NORESPONSE_API_KEY", ""),
) as no_response:

    res = no_response.assessments.search(from_="2026-10-01T00:00:00Z", to="2026-10-02T00:00:00Z", identifier_expression={
        "scope": "assessment",
        "expression": {
            "and_": [
                {
                    "term": {
                        "kind": "phone",
                        "value": "+14155552671",
                        "match": "canonical",
                    },
                },
                {
                    "or_": [
                        {
                            "term": {
                                "kind": "email",
                                "value": "case@example.com",
                                "match": "exact",
                            },
                        },
                        {
                            "term": {
                                "kind": "email",
                                "value": "other@example.com",
                                "match": "exact",
                            },
                        },
                    ],
                },
            ],
        },
    }, limit=20)

    # Handle response
    print(res.total)

package main

import(
	"context"
	"os"
	noresponse "github.com/noresponsehq/go/v12"
	"github.com/noresponsehq/go/v12/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := noresponse.New(
        noresponse.WithSecurity(os.Getenv("NORESPONSE_API_KEY")),
    )

    res, err := s.Assessments.Search(ctx, components.AssessmentSearchRequest{
        From: "2026-10-01T00:00:00Z",
        To: "2026-10-02T00:00:00Z",
        IdentifierExpression: &components.IdentifierExpression{
            Scope: components.ScopeEnumAssessment,
            Expression: components.IdentifierExpressionNode{
                And: []components.IdentifierExpressionNodeLevelTwo{
                    components.IdentifierExpressionNodeLevelTwo{
                        Term: &components.IdentifierSearch{
                            Kind: components.IdentifierSearchKindPhone,
                            Value: "+14155552671",
                            Match: components.MatchCanonical.ToPointer(),
                        },
                    },
                    components.IdentifierExpressionNodeLevelTwo{
                        Or: []components.IdentifierExpressionNodeLevelOne{
                            components.IdentifierExpressionNodeLevelOne{
                                Term: &components.IdentifierSearch{
                                    Kind: components.IdentifierSearchKindEmail,
                                    Value: "case@example.com",
                                    Match: components.MatchExact.ToPointer(),
                                },
                            },
                            components.IdentifierExpressionNodeLevelOne{
                                Term: &components.IdentifierSearch{
                                    Kind: components.IdentifierSearchKindEmail,
                                    Value: "other@example.com",
                                    Match: components.MatchExact.ToPointer(),
                                },
                            },
                        },
                    },
                },
            },
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

package hello.world;

import java.lang.Exception;
import java.util.List;
import org.noresponse.NoResponse;
import org.noresponse.models.errors.AuthenticationException;
import org.noresponse.models.errors.BadRequestException;
import org.noresponse.models.errors.ConflictException;
import org.noresponse.models.errors.NotFoundException;
import org.noresponse.models.errors.PermissionDeniedException;
import org.noresponse.models.errors.RateLimitException;
import org.noresponse.models.operations.SearchAssessmentsResponse;
import org.noresponse.models.shared.AssessmentSearchRequest;
import org.noresponse.models.shared.IdentifierExpression;
import org.noresponse.models.shared.IdentifierExpressionNode;
import org.noresponse.models.shared.IdentifierExpressionNodeLevelOne;
import org.noresponse.models.shared.IdentifierExpressionNodeLevelTwo;
import org.noresponse.models.shared.IdentifierSearch;
import org.noresponse.models.shared.IdentifierSearchKind;
import org.noresponse.models.shared.Match;
import org.noresponse.models.shared.ScopeEnum;

public class Application {

    public static void main(String[] args) throws Exception {

        NoResponse sdk = NoResponse.builder()
                .apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
            .build();

        AssessmentSearchRequest req = AssessmentSearchRequest.builder()
                .from("2026-10-01T00:00:00Z")
                .to("2026-10-02T00:00:00Z")
                .identifierExpression(IdentifierExpression.builder()
                    .scope(ScopeEnum.ASSESSMENT)
                    .expression(IdentifierExpressionNode.builder()
                        .and(List.of(
                            IdentifierExpressionNodeLevelTwo.builder()
                                .term(IdentifierSearch.builder()
                                    .kind(IdentifierSearchKind.PHONE)
                                    .value("+14155552671")
                                    .match(Match.CANONICAL)
                                    .build())
                                .build(),
                            IdentifierExpressionNodeLevelTwo.builder()
                                .or(List.of(
                                    IdentifierExpressionNodeLevelOne.builder()
                                        .term(IdentifierSearch.builder()
                                            .kind(IdentifierSearchKind.EMAIL)
                                            .value("case@example.com")
                                            .match(Match.EXACT)
                                            .build())
                                        .build(),
                                    IdentifierExpressionNodeLevelOne.builder()
                                        .term(IdentifierSearch.builder()
                                            .kind(IdentifierSearchKind.EMAIL)
                                            .value("other@example.com")
                                            .match(Match.EXACT)
                                            .build())
                                        .build()))
                                .build()))
                        .build())
                    .build())
                .build();

        SearchAssessmentsResponse res = sdk.assessments().search()
                .request(req)
                .call();

        if (res.assessmentSearchPage().isPresent()) {
            System.out.println(res.assessmentSearchPage().get().total());
        }
    }
}

using NoResponse;
using NoResponse.Models.Shared;
using System;
using System.Collections.Generic;

var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));

AssessmentSearchRequest req = new AssessmentSearchRequest() {
    From = "2026-10-01T00:00:00Z",
    To = "2026-10-02T00:00:00Z",
    IdentifierExpression = new IdentifierExpression() {
        Scope = ScopeEnum.Assessment,
        Expression = new IdentifierExpressionNode() {
            And = new List<IdentifierExpressionNodeLevelTwo>() {
                new IdentifierExpressionNodeLevelTwo() {
                    Term = new IdentifierSearch() {
                        Kind = IdentifierSearchKind.Phone,
                        Value = "+14155552671",
                        Match = Match.Canonical,
                    },
                },
                new IdentifierExpressionNodeLevelTwo() {
                    Or = new List<IdentifierExpressionNodeLevelOne>() {
                        new IdentifierExpressionNodeLevelOne() {
                            Term = new IdentifierSearch() {
                                Kind = IdentifierSearchKind.Email,
                                Value = "case@example.com",
                                Match = Match.Exact,
                            },
                        },
                        new IdentifierExpressionNodeLevelOne() {
                            Term = new IdentifierSearch() {
                                Kind = IdentifierSearchKind.Email,
                                Value = "other@example.com",
                                Match = Match.Exact,
                            },
                        },
                    },
                },
            },
        },
    },
};

var res = await sdk.Assessments.SearchAsync(req);

// handle response

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use NoResponse;
use NoResponse\Models\Shared;

$sdk = NoResponse\NoResponseClient::builder()
    ->setSecurity(
        getenv('NORESPONSE_API_KEY') ?: ''
    )
    ->build();

$request = new Shared\AssessmentSearchRequest(
    from: '2026-10-01T00:00:00Z',
    to: '2026-10-02T00:00:00Z',
    identifierExpression: new Shared\IdentifierExpression(
        scope: Shared\ScopeEnum::Assessment,
        expression: new Shared\IdentifierExpressionNode(
            and: [
                new Shared\IdentifierExpressionNodeLevelTwo(
                    term: new Shared\IdentifierSearch(
                        kind: Shared\IdentifierSearchKind::Phone,
                        value: '+14155552671',
                        match: Shared\MatchT::Canonical,
                    ),
                ),
                new Shared\IdentifierExpressionNodeLevelTwo(
                    or: [
                        new Shared\IdentifierExpressionNodeLevelOne(
                            term: new Shared\IdentifierSearch(
                                kind: Shared\IdentifierSearchKind::Email,
                                value: 'case@example.com',
                                match: Shared\MatchT::Exact,
                            ),
                        ),
                        new Shared\IdentifierExpressionNodeLevelOne(
                            term: new Shared\IdentifierSearch(
                                kind: Shared\IdentifierSearchKind::Email,
                                value: 'other@example.com',
                                match: Shared\MatchT::Exact,
                            ),
                        ),
                    ],
                ),
            ],
        ),
    ),
);

$response = $sdk->assessments->search(
    request: $request
);

$result = $response->result;
// handle response

require 'noresponse'

Models = ::NoResponse::Models
s = ::NoResponse::NoResponseClient.new(
  api_key: ENV.fetch('NORESPONSE_API_KEY', '')
)

req = Models::Shared::AssessmentSearchRequest.new(
  from: '2026-10-01T00:00:00Z',
  to: '2026-10-02T00:00:00Z',
  identifier_expression: Models::Shared::IdentifierExpression.new(
    scope: Models::Shared::ScopeEnum::ASSESSMENT,
    expression: Models::Shared::IdentifierExpressionNode.new(
      and_: [
        Models::Shared::IdentifierExpressionNodeLevelTwo.new(
          term: Models::Shared::IdentifierSearch.new(
            kind: Models::Shared::IdentifierSearchKind::PHONE,
            value: '+14155552671',
            match: Models::Shared::Match::CANONICAL
          )
        ),
        Models::Shared::IdentifierExpressionNodeLevelTwo.new(
          or_: [
            Models::Shared::IdentifierExpressionNodeLevelOne.new(
              term: Models::Shared::IdentifierSearch.new(
                kind: Models::Shared::IdentifierSearchKind::EMAIL,
                value: 'case@example.com',
                match: Models::Shared::Match::EXACT
              )
            ),
            Models::Shared::IdentifierExpressionNodeLevelOne.new(
              term: Models::Shared::IdentifierSearch.new(
                kind: Models::Shared::IdentifierSearchKind::EMAIL,
                value: 'other@example.com',
                match: Models::Shared::Match::EXACT
              )
            ),
          ]
        ),
      ]
    )
  )
)
res = s.assessments.search(request: req)

unless res.nil?
  # handle response
end

{
  "schema_version": "1",
  "items": [
    {
      "schema_version": "1",
      "id": "<string>",
      "status": "complete",
      "flow": "account_creation",
      "depth": "quick",
      "detail": {
        "schema_version": "1",
        "assessment_id": "<string>",
        "account_id": "<string>",
        "status": "complete",
        "confidence": "low",
        "incomplete_sources": [
          {
            "lane": "accounts",
            "reason": "timed_out"
          }
        ],
        "policy_version": "<string>",
        "policy_basis": "heuristic_unvalidated",
        "assessment_version": 500,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z",
        "timing": {
          "deadline_ms": 1525,
          "elapsed_ms": 300000
        },
        "identifiers": {
          "email": "<string>",
          "username": "<string>",
          "phone": "<string>",
          "name": "<string>",
          "ip": "<string>"
        },
        "request_id": "<string>",
        "recommendation": "allow",
        "risk": {
          "score": 50,
          "band": "low",
          "recommendation": "allow",
          "confidence": "low",
          "policy_version": "<string>",
          "policy_basis": "heuristic_unvalidated",
          "reasons": [
            {
              "code": "no_digital_footprint",
              "direction": "raises",
              "impact": "none",
              "identifier": "email",
              "list_entry_id": "<string>"
            }
          ],
          "coverage": {
            "answered": 1,
            "failed": 1,
            "pending": 1
          },
          "block": true,
          "block_threshold": 50,
          "step_up_threshold": 50,
          "review_threshold": 50,
          "summary": {
            "phone": {
              "line_type": "mobile",
              "country": "<string>",
              "report_count": 1,
              "carrier": "<string>"
            },
            "email": {
              "disposable": true,
              "accounts_found": 1,
              "breach": {
                "found": true,
                "breach_count": 1,
                "first_year": 2035,
                "last_year": 2035,
                "exposed": [
                  "email"
                ],
                "in_credential_lists": true,
                "recent_password_exposure": true,
                "truncated": true
              }
            },
            "username": {
              "accounts_found": 1,
              "breach": {
                "found": true,
                "breach_count": 1,
                "first_year": 2035,
                "last_year": 2035,
                "exposed": [
                  "email"
                ],
                "in_credential_lists": true,
                "recent_password_exposure": true,
                "truncated": true
              }
            },
            "ip": {
              "country": "<string>",
              "type": "residential",
              "asn": 2147483648,
              "seen_in_workspace": 1
            },
            "consistency": {
              "name": "match",
              "phone": "match",
              "ip": "match",
              "country": "consistent"
            },
            "footprint": {
              "families": [
                "account_presence"
              ],
              "email": {
                "first_seen_year": 2035,
                "last_seen_year": 2035,
                "span_years": 1,
                "sites": 2,
                "families": [
                  "account_presence"
                ],
                "last_active_year": 2035
              },
              "username": {
                "first_seen_year": 2035,
                "last_seen_year": 2035,
                "span_years": 1,
                "sites": 2,
                "families": [
                  "account_presence"
                ],
                "last_active_year": 2035
              },
              "coherence": {
                "birth_date": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "gender": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "nationality": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "country": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "city": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "zip": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "name": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "company": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "website": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                },
                "social": {
                  "agreement": "match",
                  "values": 2,
                  "support": 2
                }
              }
            }
          },
          "details": {
            "phone_names": [
              {
                "value": "<string>",
                "seen_by": 2
              }
            ],
            "breaches": [
              {
                "name": "<string>",
                "kind": "site_breach",
                "matched_on": "email",
                "domain": "<string>",
                "category": "<string>",
                "year": 2035,
                "month": 6,
                "exposed": [
                  "email"
                ],
                "conduct": [
                  "chargeback"
                ]
              }
            ],
            "breach_names": [
              {
                "value": "<string>",
                "seen_in": 2,
                "sites": [
                  "<string>"
                ],
                "unsited": 2
              }
            ],
            "events": [
              {
                "year": 2035,
                "kind": "created",
                "site": "<string>",
                "category": "<string>",
                "family": "account_presence",
                "identifier": "email",
                "month": 6
              }
            ],
            "accounts": [
              {
                "name": "<string>",
                "domain": "<string>",
                "identifier": "email",
                "outcome": "found",
                "reason": "timed_out",
                "sign_in": [
                  "password"
                ],
                "email_verified": true,
                "blocked": true,
                "account_type": "personal",
                "has_avatar": true,
                "first_name_prefix": "<string>"
              }
            ],
            "attribute_conflicts": [
              {
                "attribute": "birth_date",
                "sites": [
                  "<string>"
                ],
                "unsited": 2
              }
            ]
          }
        },
        "signals": [
          {
            "type": "<string>",
            "identifier": "email",
            "outcome": "found",
            "source_id": "<string>",
            "freshness": "fresh",
            "reason": "timed_out",
            "evidence_ref": "<string>",
            "observed_at": "2023-11-07T05:31:56Z",
            "last_checked_at": "2023-11-07T05:31:56Z",
            "enrichment": {
              "fields": {
                "phone": "<string>",
                "name": "<string>",
                "carrier": "<string>",
                "line_type": "<string>",
                "entity_type": "<string>",
                "country_code": "<string>",
                "country": "<string>",
                "state": "<string>",
                "city": "<string>",
                "location": "<string>",
                "national_format": "<string>",
                "job_title": "<string>",
                "company_name": "<string>",
                "email": "<string>",
                "website": "<string>",
                "first_call_at": "<string>",
                "last_call_at": "<string>",
                "matched_name": "<string>",
                "alternate_names": [
                  "<string>"
                ],
                "name_candidates": [
                  "<string>"
                ],
                "timezones": [
                  "<string>"
                ],
                "emails": [
                  "<string>"
                ],
                "websites": [
                  "<string>"
                ],
                "locations": [
                  "<string>"
                ],
                "social_profiles": [
                  "<string>"
                ],
                "report_count": 1,
                "tag_count": 1,
                "total_calls": 1,
                "calls_60_days": 1,
                "reports_60_days": 1,
                "searches_60_days": 1,
                "comment_count": 1,
                "names_count": 1,
                "spam_report_count": 1
              }
            }
          }
        ],
        "assessment_url": "<string>",
        "auth_context": {
          "provider": "<string>",
          "issuer": "<string>",
          "verified": true,
          "transport": "backend",
          "subject": "<string>",
          "session_id": "<string>",
          "organization_id": "<string>",
          "hook_point": "pre_registration"
        }
      },
      "first_decision": "allow",
      "matched_identifier": {
        "kind": "username",
        "value": "JaneDoe",
        "match_basis": "canonical",
        "namespace": "customer",
        "provenance": "submitted",
        "assessment_id": "asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM"
      },
      "matched_identifiers": [
        {
          "kind": "username",
          "value": "JaneDoe",
          "match_basis": "canonical",
          "namespace": "customer",
          "provenance": "submitted",
          "assessment_id": "asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
          "term_index": 0
        }
      ]
    }
  ],
  "total": 5000,
  "total_capped": true,
  "retention_days": 365,
  "next_cursor": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 400,
  "detail": "<string>",
  "code": "invalid_request",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 401,
  "detail": "<string>",
  "code": "unauthorized",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "https://docs.noresponse.org/problems/workspace-forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The API key does not carry a scope this operation accepts.",
  "code": "workspace_forbidden",
  "request_id": "0123456789abcdef0123456789abcdef"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 404,
  "detail": "<string>",
  "code": "not_found",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 413,
  "detail": "<string>",
  "code": "payload_too_large",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 415,
  "detail": "<string>",
  "code": "unsupported_media_type",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "https://docs.noresponse.org/problems/rate-limited",
  "title": "Rate limited",
  "status": 429,
  "detail": "The tenant's assessment rate is exhausted; retry after the Retry-After interval.",
  "code": "rate_limited",
  "request_id": "0123456789abcdef0123456789abcdef"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 503,
  "detail": "<string>",
  "code": "service_unavailable",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Your API key, sent as Authorization: Bearer <key>. A key is nrk_live_ or nrk_test_, a 26-character key id, _ and a 43-character secret. Account, audit and usage data stay within the key's environment. Dedicated team scopes apply across the workspace.

assess creates and reads assessments, records outcomes and reports key usage. investigate reads accounts, assessment history and request diagnostics without export or enforcement access. The legacy history scope also permits account exports, submitted identifiers and enforcement reports. delete permits account and assessment deletion.

evidence or detailed adds detailed merged evidence and submitted identifiers where the operation permits them. Neither grants access to the underlying resource alone. exports permits exports with the underlying account or audit scope. audit reads audit events and usage reads usage. audit_manage manages audit streams and retention, and includes audit-read and export authority.

webhooks manages webhook endpoints. integrations manages hosted auth-provider integrations. management manages keys, settings, lists, reviews and policy evaluations in the key's environment. New keys cannot exceed the issuer's effective permissions.

settings reads configuration, previews policy and list changes, runs evaluations and changes retention. Publishing decision policy or changing lists requires settings and policy_publish together, or the legacy management scope.

groups creates and reads groups, adds people, starts and cancels screenings and records decisions on people, in the key's environment.

members reads the workspace directory. members_manage also administers non-owner members and invitations. These scopes require a live key issued by a current owner with access to both environments. They grant access across the workspace. management does not grant team access. API keys cannot change owners or accept invitations.

A missing, unknown, revoked or expired key answers 401. A valid key without a required scope answers 403.

Body

application/json

Search retained assessments created in [from,to), at most 366 days. identifier matches the submitted value of each returned assessment directly. The legacy email filter keeps its account-wide mailbox semantics and cannot be combined with identifier. Other filters combine using AND and describe assessment decisions, separate from current account decisions. Results use newest-created order with an assessment-ID tie break and are live, not a snapshot across pages. Requires history or investigate authority; identifier, identifier_expression and email filtering also require identifier-read permission. Detailed response mode additionally requires detailed permission. No Idempotency-Key. identifier_expression requires scope assessment and matches the complete expression within each returned submission; account scope returns 400 invalid_request. At most 8 raw terms and 3 group levels. Mutually exclusive with identifier and email.

from

string<date-time>

required

string<date-time>

required

account_id

string

The provider's own opaque identifier for the account being checked, scoped to the calling workspace. It must be provider-opaque and must not contain a direct identifier (email, phone, name, national id): that is a provider obligation the schema can only partly check. '|' is accepted so an Auth0 user id such as 'auth0|64abc' passes unchanged; '@', '+', '$' and whitespace are refused by the pattern, as is an exact-shape JWT; a hex digest such as a SHA-256 is allowed, because hashing an internal id is a common pseudonymous scheme. A value such as '07700900123' or 'jane.doe.gmail.com' cannot be told apart from an opaque id. It travels in bodies, and in a URL only as the path segment of GET /v1/accounts/{account_id}, its /assessments and its /links. An assessment requested by a provider hook at pre_registration, which has no account yet, carries the server-issued account_id pre: followed by its assessment_id.

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:|-]{0,127}$

string

Assessments of every account that one of its retained admitted assessments sent this mailbox as identifiers.email, matched as lists match an email entry: case-insensitive, a +tag removed and, at gmail.com and googlemail.com, the dots of the local part ignored. Only assessments stored since email list matching began carry the mailbox. An address that is not a valid mailbox is refused with 400.

Required string length: 3 - 254

Pattern: ^[^\s\x00-\x1f\x7f]+$

flow

enum<string>

The event an assessment is made for: account_creation (a user creates an account), login (a user returns to an existing account) or purchase (a payment or a credit grant). The account's risk is reported with the decision for this flow.

Available options:

account_creation,

login,

purchase

status

enum<string>

Processing state, separate from evidence coverage. complete: final; nothing is still running, but unsupported, failed or unanswered lanes remain in incomplete_sources. partial: a recommendation exists and evidence is incomplete; assessment_url identifies continuing work when present. pending: no recommendation yet; poll or wait for the webhook. Finished processing does not mean all sources answered.

Available options:

complete,

partial,

pending

origin

enum<string>

default:api

api (the default) searches the assessments your integration sent. lookup searches the assessments your team ran by hand on the console's Lookup page. The API sets an assessment's origin from the credential that sent it. A lookup is not in any other list, count, webhook event or account.

Available options:

api,

lookup

recommendation

enum<string>

Advisory only. The provider decides and enforces.

Available options:

allow,

step_up,

review

limit

integer

default:20

Required range: 1 <= x <= 50

cursor

string

Opaque, expiring cursor bound to workspace, environment, operation and all filters, including expression scope, ordered structure and original term values. Keep grouping, operand order, matching modes and values unchanged; an omitted match is equivalent to exact. The page limit may change.

Required string length: 1 - 1024

Pattern: ^[A-Za-z0-9_-]+$

response_mode

enum<string>

default:standard

Available options:

standard,

detailed

decision

enum<string>

The decision of the assessment's latest stored revision, or with revision first its first answer: block when its stored risk.block is true, otherwise its recommendation. This is not the account's current decision or held-admission state. Combined with recommendation using AND.

Available options:

allow,

step_up,

review,

block

revision

enum<string>

required if list_match is set

latest (the default) searches and returns each assessment's latest stored revision; first searches and returns its first answer, the revision POST /v1/assessments/aggregate counts. The filters describe that revision.

Available options:

latest,

first

band

enum<string>

Available options:

low,

medium,

high,

critical

reason

enum<string>

required if impact is set

A reason fired by the selected stored revision.

Available options:

no_digital_footprint,

voip_number,

disposable_email,

new_email,

no_email_matches,

spam_reports,

fraud_flag,

identity_mismatch,

country_mismatch,

proxy_ip,

seen_before,

shared_ip,

many_recent_accounts,

established_accounts,

aged_identity,

breach_name_match,

breach_cooccurrence,

breach_name_mismatch,

breach_phone_mismatch,

recent_password_exposure,

credential_list_exposure,

abuse_ecosystem_member,

no_breach_history,

automation_fast_submit,

client_clock_skew,

bot_or_automation,

auth_email_verified,

auth_phone_verified,

auth_mfa_recent,

auth_new_session,

auth_new_account,

auth_impersonated,

context_timezone_mismatch,

context_locale_mismatch,

context_line_country_mismatch,

prior_abuse_link,

test_scenario,

shared_api_key,

list_match,

young_email_domain,

email_domain_no_mx,

email_domain_nonexistent,

google_account_missing,

google_empty_account,

google_active_profile,

google_aged_account,

google_name_match,

google_name_mismatch,

google_country_match,

google_country_mismatch,

forum_sanctioned,

prior_payment_abuse,

ip_history_match,

identity_attribute_conflict,

impossible_identity_age,

breach_shared_ip,

nationality_mismatch,

minor_identity,

reported_account_abuse,

breach_city_match,

breach_city_mismatch

impact

enum<string>

The selected reason's served impact band. Requires reason.

Available options:

none,

low,

medium,

high

lane

enum<string>

An incomplete lane in the selected stored revision.

Available options:

accounts,

phone,

breach,

domain,

ip

country

string

Pattern: ^[A-Z]{2}$

asn

integer

Required range: 1 <= x <= 4294967295

score_min

integer

Inclusive lower score bound. Pending answers without a score do not match.

Required range: 0 <= x <= 100

score_max

integer

Inclusive upper score bound, at least score_min when both are supplied.

Required range: 0 <= x <= 100

list_match

enum<string>

The list action captured at the first answer. Requires revision first. Older answers without captured list state do not match, including none.

Available options:

allow,

block,

none

changed

boolean

true returns only assessments whose latest stored revision's decision differs from their first answer's decision (see decision); false only the others. An assessment whose first answer or latest revision has no decision yet is not changed. Cannot be combined with revision first.

identifier

Identifier search · object

Match a retained assessment's submitted identifier directly. Mutually exclusive with identifier_expression and legacy email. All other supported filters combine using AND.

Show child attributes

Example:

{
  "kind": "username",
  "value": "janedoe",
  "match": "canonical",
  "namespace": "customer"
}

identifier_expression

Submitted identifier expression · object

Explicit bounded AND/OR combinations. Mutually exclusive with identifier and legacy email. Other supported filters combine using AND.

Show child attributes

Example:

{
  "scope": "assessment",
  "expression": {
    "and": [
      {
        "term": {
          "kind": "phone",
          "value": "+14155552671",
          "match": "canonical"
        }
      },
      {
        "or": [
          {
            "term": {
              "kind": "email",
              "value": "case@example.com",
              "match": "exact"
            }
          },
          {
            "term": {
              "kind": "email",
              "value": "other@example.com",
              "match": "exact"
            }
          }
        ]
      }
    ]
  }
}

Response

Search assessments across this environment. A repeat returns the original receipt.

A bounded page of latest assessment revisions, newest creation first, with how many assessments match the filters. Each item is the revision found and its first answer's decision; no current account risk is attached.

schema_version

any

required

Version of the body shape.

items

Assessment search item · object[]

required

Maximum array length: 50

Show child attributes

total

integer

required

How many assessments match the filters over every page, counted when this page was read: exact up to 10000. At 10000 or more it is 10000 and total_capped is true. The cursor does not change it; a later page can count differently, as results are live.

Required range: 0 <= x <= 10000

total_capped

boolean

required

True when at least 10000 assessments match, so total is 10000 and not the exact count.

retention_days

integer

default:365

required

The calling workspace's configured retention period in days. Default 365 (12 months), which is also the maximum: a workspace may only shorten it, to at least 1 day. Each record expires from its own created_at; see assessment expires_at.

Required range: 1 <= x <= 365

next_cursor

string

Opaque, expiring cursor bound to this environment, operation and every filter. Keep the filters unchanged.

Required string length: 1 - 1024

Pattern: ^[A-Za-z0-9_-]+$

Overview

Using the API

Endpoints

Errors

Search assessments across this environment

Authorizations

Body

Response