curl --request POST \
--url 'https://api.noresponse.org/v1/groups/grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM/people/per_01JA2Z8K6Q4V7W9XBCDEFGHJKM/searches/srh_01JA2Z8K6Q4V7W9XBCDEFGHJKM/run' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.groups.runSearch({
groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
searchId: "srh_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: {},
});
console.log(result);
}
run();
from noresponse import NoResponse
import os
with NoResponse(
api_key=os.getenv("NORESPONSE_API_KEY", ""),
) as no_response:
res = no_response.groups.run_search(group_id="grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", person_id="per_01JA2Z8K6Q4V7W9XBCDEFGHJKM", search_id="srh_01JA2Z8K6Q4V7W9XBCDEFGHJKM", body={})
# Handle response
print(res)
package main
import(
"context"
"os"
noresponse "github.com/noresponsehq/go/v14"
"github.com/noresponsehq/go/v14/models/components"
"log"
)
func main() {
ctx := context.Background()
s := noresponse.New(
noresponse.WithSecurity(os.Getenv("NORESPONSE_API_KEY")),
)
res, err := s.Groups.RunSearch(ctx, "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM", "srh_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.ScreeningCancelRequest{})
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
package hello.world;
import java.lang.Exception;
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.RunSearchResponse;
import org.noresponse.models.shared.ScreeningCancelRequest;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
RunSearchResponse res = sdk.groups().runSearch()
.groupId("grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.personId("per_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.searchId("srh_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.body(ScreeningCancelRequest.builder()
.build())
.call();
if (res.search().isPresent()) {
System.out.println(res.search().get());
}
}
}
using NoResponse;
using NoResponse.Models.Shared;
using System;
var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));
var res = await sdk.Groups.RunSearchAsync(
groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
searchId: "srh_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: new ScreeningCancelRequest() {}
);
// 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();
$body = new Shared\ScreeningCancelRequest();
$response = $sdk->groups->runSearch(
groupId: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
personId: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
searchId: 'srh_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
body: $body
);
$result = $response->result;
// handle response
require 'noresponse'
Models = ::NoResponse::Models
s = ::NoResponse::NoResponseClient.new(
api_key: ENV.fetch('NORESPONSE_API_KEY', '')
)
res = s.groups.run_search(group_id: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM', person_id: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM', search_id: 'srh_01JA2Z8K6Q4V7W9XBCDEFGHJKM', body: Models::Shared::ScreeningCancelRequest.new)
unless res.nil?
# handle response
end
{
"search_id": "<string>",
"record_id": "<string>",
"field": "<string>",
"kind": "email",
"value": "<string>",
"status": "counting",
"sources": 1,
"answered": 1,
"found": 1,
"estimated_spend": 1,
"spent": 1,
"requested_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"table": "<string>",
"rows": 1,
"error_code": "not_answered",
"finished_at": "2023-11-07T05:31:56Z"
}{
"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": "<string>",
"title": "<string>",
"status": 403,
"detail": "<string>",
"code": "workspace_forbidden",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"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": 409,
"detail": "<string>",
"code": "group_conflict",
"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": "<string>",
"title": "<string>",
"status": 503,
"detail": "<string>",
"code": "service_unavailable",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}Run a counted password or hash search.
Runs a password or hash search once a person has seen its count. A search still counting answers 409 group_conflict; one already queued, running or finished answers as it is. The body is an empty object. Its estimate counts against the environment’s screening_daily_cap. Each run is audited as person.search_run. The investigations scope grants this operation. Explicit evidence.read restrictions override default evidence access. The groups scope is also accepted for existing integrations. The API key selects the workspace and environment.
curl --request POST \
--url 'https://api.noresponse.org/v1/groups/grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM/people/per_01JA2Z8K6Q4V7W9XBCDEFGHJKM/searches/srh_01JA2Z8K6Q4V7W9XBCDEFGHJKM/run' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.groups.runSearch({
groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
searchId: "srh_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: {},
});
console.log(result);
}
run();
from noresponse import NoResponse
import os
with NoResponse(
api_key=os.getenv("NORESPONSE_API_KEY", ""),
) as no_response:
res = no_response.groups.run_search(group_id="grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", person_id="per_01JA2Z8K6Q4V7W9XBCDEFGHJKM", search_id="srh_01JA2Z8K6Q4V7W9XBCDEFGHJKM", body={})
# Handle response
print(res)
package main
import(
"context"
"os"
noresponse "github.com/noresponsehq/go/v14"
"github.com/noresponsehq/go/v14/models/components"
"log"
)
func main() {
ctx := context.Background()
s := noresponse.New(
noresponse.WithSecurity(os.Getenv("NORESPONSE_API_KEY")),
)
res, err := s.Groups.RunSearch(ctx, "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM", "srh_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.ScreeningCancelRequest{})
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
package hello.world;
import java.lang.Exception;
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.RunSearchResponse;
import org.noresponse.models.shared.ScreeningCancelRequest;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
RunSearchResponse res = sdk.groups().runSearch()
.groupId("grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.personId("per_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.searchId("srh_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.body(ScreeningCancelRequest.builder()
.build())
.call();
if (res.search().isPresent()) {
System.out.println(res.search().get());
}
}
}
using NoResponse;
using NoResponse.Models.Shared;
using System;
var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));
var res = await sdk.Groups.RunSearchAsync(
groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
searchId: "srh_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: new ScreeningCancelRequest() {}
);
// 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();
$body = new Shared\ScreeningCancelRequest();
$response = $sdk->groups->runSearch(
groupId: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
personId: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
searchId: 'srh_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
body: $body
);
$result = $response->result;
// handle response
require 'noresponse'
Models = ::NoResponse::Models
s = ::NoResponse::NoResponseClient.new(
api_key: ENV.fetch('NORESPONSE_API_KEY', '')
)
res = s.groups.run_search(group_id: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM', person_id: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM', search_id: 'srh_01JA2Z8K6Q4V7W9XBCDEFGHJKM', body: Models::Shared::ScreeningCancelRequest.new)
unless res.nil?
# handle response
end
{
"search_id": "<string>",
"record_id": "<string>",
"field": "<string>",
"kind": "email",
"value": "<string>",
"status": "counting",
"sources": 1,
"answered": 1,
"found": 1,
"estimated_spend": 1,
"spent": 1,
"requested_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"table": "<string>",
"rows": 1,
"error_code": "not_answered",
"finished_at": "2023-11-07T05:31:56Z"
}{
"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": "<string>",
"title": "<string>",
"status": 403,
"detail": "<string>",
"code": "workspace_forbidden",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"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": 409,
"detail": "<string>",
"code": "group_conflict",
"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": "<string>",
"title": "<string>",
"status": 503,
"detail": "<string>",
"code": "service_unavailable",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}Authorizations
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.
people reads people, groups and investigations with full evidence by default. people_write changes submitted people, groups and memberships. investigations starts or cancels jobs and screenings. decisions records reviews. exports with people-read access exports rosters. delete deletes people, groups and memberships. Existing groups keys retain non-destructive people access. Explicit evidence.read restrictions withhold collected records, posts, media, discovered identifiers and notes.
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.
Path Parameters
Body
An empty object.
Response
The search: counting, or queued to run. Read the person after Retry-After to see its status, its count and what it found.
One search a person started on a value of one of a person's records. Nothing searches again by itself.
A password or hash search is counting, then counted: rows says how many breach rows hold the value, and nothing runs until a person runs it (POST.../searches/{search_id}/run). Any other search is queued, then running. completed: every source it asked answered. partial: some did not. failed: none answered or none could be asked, which says nothing about whether the value is held anywhere.
counting, counted, queued, running, completed, partial, failed