curl --request POST \
--url 'https://api.noresponse.org/v1/groups/grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM/people/per_01JA2Z8K6Q4V7W9XBCDEFGHJKM/searches' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: request-01JA2Z8K6Q4V7W9XBCDEFGHJKM' \
--data '{
"record_id": "rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7",
"field": "username",
"table": "FORUM_EXAMPLE_COM_2019"
}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.groups.startSearch({
groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
idempotencyKey: "request-01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: {
recordId: "rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7",
field: "username",
table: "FORUM_EXAMPLE_COM_2019",
},
});
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.start_search(group_id="grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", person_id="per_01JA2Z8K6Q4V7W9XBCDEFGHJKM", record_id="rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7", field="username", idempotency_key="request-01JA2Z8K6Q4V7W9XBCDEFGHJKM", table="FORUM_EXAMPLE_COM_2019")
# 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.StartSearch(ctx, "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.SearchRequest{
RecordID: "rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7",
Field: "username",
Table: noresponse.Pointer("FORUM_EXAMPLE_COM_2019"),
}, noresponse.Pointer("request-01JA2Z8K6Q4V7W9XBCDEFGHJKM"))
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.StartSearchResponse;
import org.noresponse.models.shared.SearchRequest;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
StartSearchResponse res = sdk.groups().startSearch()
.groupId("grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.personId("per_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.idempotencyKey("request-01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.body(SearchRequest.builder()
.recordId("rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7")
.field("username")
.table("FORUM_EXAMPLE_COM_2019")
.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.StartSearchAsync(
groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: new SearchRequest() {
RecordId = "rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7",
Field = "username",
Table = "FORUM_EXAMPLE_COM_2019",
},
idempotencyKey: "request-01JA2Z8K6Q4V7W9XBCDEFGHJKM"
);
// 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\SearchRequest(
recordId: 'rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7',
field: 'username',
table: 'FORUM_EXAMPLE_COM_2019',
);
$response = $sdk->groups->startSearch(
groupId: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
personId: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
body: $body,
idempotencyKey: 'request-01JA2Z8K6Q4V7W9XBCDEFGHJKM'
);
$result = $response->result;
// handle response
require 'noresponse'
Models = ::NoResponse::Models
s = ::NoResponse::NoResponseClient.new(
api_key: ENV.fetch('NORESPONSE_API_KEY', '')
)
res = s.groups.start_search(group_id: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM', person_id: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM', body: Models::Shared::SearchRequest.new(
record_id: 'rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7',
field: 'username',
table: 'FORUM_EXAMPLE_COM_2019'
), idempotency_key: 'request-01JA2Z8K6Q4V7W9XBCDEFGHJKM')
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>"
}
]
}Search again on a value of one of a person's records.
Starts a new search on the value of one field of one of the person’s records: a lookup’s, a profile’s or one an earlier search found. Name the record and the field; the value itself is not sent. The field’s kind must be email, phone, username, person_name, password, hash, ip or domain. A domain search finds the breach rows of every email address at the domain, which must be a registrable domain or a host under one; any other domain answers 400. Nothing ever searches again by itself: a search starts only when a person asks. The search runs the breach search and the account and phone lookups that take the value’s kind, under the environment’s source controls, and finishes seconds later. A password or hash search counts first: it stops at counted with rows, how many breach rows hold the value, and runs only when a person runs it. Name a table, as a lookup remaining entry names it, to fetch the rows an earlier search left out, up to 100. What the search finds joins the person’s lookup records as leads, each match naming the search; the person report lists the searches, each with the value and the record and field it came from, and its records are scored like the rest. Without an Idempotency-Key, starting the same open search returns it. Its estimate counts against the environment’s screening_daily_cap, and one the cap cannot hold answers 409 screening_cap_exceeded. A record or field the person does not hold answers 404. Each search is audited as person.search_started. Send an Idempotency-Key to retry safely: the same key and request return the same resource in its current state while it is retained, even after work completes. Reusing the key with different input answers 409 idempotency_key_reused. Use a new key for a deliberate new operation. 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' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: request-01JA2Z8K6Q4V7W9XBCDEFGHJKM' \
--data '{
"record_id": "rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7",
"field": "username",
"table": "FORUM_EXAMPLE_COM_2019"
}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.groups.startSearch({
groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
idempotencyKey: "request-01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: {
recordId: "rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7",
field: "username",
table: "FORUM_EXAMPLE_COM_2019",
},
});
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.start_search(group_id="grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", person_id="per_01JA2Z8K6Q4V7W9XBCDEFGHJKM", record_id="rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7", field="username", idempotency_key="request-01JA2Z8K6Q4V7W9XBCDEFGHJKM", table="FORUM_EXAMPLE_COM_2019")
# 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.StartSearch(ctx, "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.SearchRequest{
RecordID: "rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7",
Field: "username",
Table: noresponse.Pointer("FORUM_EXAMPLE_COM_2019"),
}, noresponse.Pointer("request-01JA2Z8K6Q4V7W9XBCDEFGHJKM"))
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.StartSearchResponse;
import org.noresponse.models.shared.SearchRequest;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
StartSearchResponse res = sdk.groups().startSearch()
.groupId("grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.personId("per_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.idempotencyKey("request-01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.body(SearchRequest.builder()
.recordId("rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7")
.field("username")
.table("FORUM_EXAMPLE_COM_2019")
.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.StartSearchAsync(
groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: new SearchRequest() {
RecordId = "rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7",
Field = "username",
Table = "FORUM_EXAMPLE_COM_2019",
},
idempotencyKey: "request-01JA2Z8K6Q4V7W9XBCDEFGHJKM"
);
// 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\SearchRequest(
recordId: 'rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7',
field: 'username',
table: 'FORUM_EXAMPLE_COM_2019',
);
$response = $sdk->groups->startSearch(
groupId: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
personId: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
body: $body,
idempotencyKey: 'request-01JA2Z8K6Q4V7W9XBCDEFGHJKM'
);
$result = $response->result;
// handle response
require 'noresponse'
Models = ::NoResponse::Models
s = ::NoResponse::NoResponseClient.new(
api_key: ENV.fetch('NORESPONSE_API_KEY', '')
)
res = s.groups.start_search(group_id: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM', person_id: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM', body: Models::Shared::SearchRequest.new(
record_id: 'rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7',
field: 'username',
table: 'FORUM_EXAMPLE_COM_2019'
), idempotency_key: 'request-01JA2Z8K6Q4V7W9XBCDEFGHJKM')
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.
Headers
Opaque request key, 16 to 128 characters. Repeating the key and request returns the same resource in its current state while it is retained. A different request with the same key answers 409. Use a new key for a deliberate new operation. Keys are scoped to the environment and operation; person searches also scope them to the group and person.
16 - 128^[A-Za-z0-9._:-]{16,128}$Path Parameters
Body
The value to search again, named by the record and field that hold it rather than sent again.
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