> ## Documentation Index > Fetch the complete documentation index at: https://docs.noresponse.org/llms.txt > Use this file to discover all available pages before exploring further. # Search again on a value > Starts a new search on the value of one field of one of the person's records. Name the record with `record_id` and the field with `field`; the value itself is not sent. The field's kind must be `email`, `phone`, `username`, `person_name`, `password`, `hash` or `ip`. Nothing searches again by itself: a search starts only when you ask for it. The search runs the breach search and the account and phone lookups that take the value's kind, and finishes seconds later. A `password` or `hash` search counts first: it stops at `counted`, with `rows` saying how many breach rows hold the value, and runs only when you run it. Name a `table`, as a lookup's `remaining` entry names it, to get up to 100 rows that an earlier search left out. Read the person to follow the search. Each record it finds joins the person's lookup records as a lead, and its `matched` entry names the search in `search`. The person's `searches` list each search with its value and the record and field it came from. Each search counts against the environment's `screening_daily_cap`. Requires the `groups` scope, within the key's own workspace and environment. ## OpenAPI ````yaml /openapi.json post /v1/workspaces/{workspace_id}/groups/{environment}/{group_id}/people/{person_id}/searches openapi: 3.1.0 info: title: NoResponse API version: '1' description: >- The NoResponse API assesses an account creation, login or purchase and answers with the account's one current risk: a 0 to 100 score, a decision for the flow (`allow`, `step_up`, `review` or `block`), the reasons behind it and the decision for each flow. The assessment's own facts, such as its status, confidence and incomplete sources, sit under `detail`. Authenticate every request with your API key as `Authorization: Bearer nrk_...`. Call the API only from your backend. Guides, SDKs and webhook verification are at [docs.noresponse.org](https://docs.noresponse.org/). Every error is an RFC 9457 problem document; see [Errors](https://docs.noresponse.org/reference/errors). servers: - url: https://api.noresponse.org description: Production security: - tenantBearer: [] tags: - name: assess x-displayName: Assessments x-group: Assessments description: Create, read and list assessments, and report outcomes. - name: accounts x-displayName: Accounts x-group: Accounts description: >- Each of your accounts holds one current risk, and its assessments are its history. - name: usage x-displayName: Key usage x-group: Key usage description: >- Report usage of the API keys that your account creation gate issued, so a shared or stolen key raises its account's risk. - name: keys x-displayName: API keys x-group: API keys description: >- Rotate your own API key and, with the `management` scope, create, list and revoke the keys of its environment. - name: settings x-displayName: Settings x-group: Settings description: >- Read and preview environment settings, run evaluations, and publish reviewed policy with separate permissions. - name: lists x-displayName: Lists x-group: Lists description: >- Preview, allow or block accounts that use an email or email domain. Publishing changes requires policy authority. - name: integrations x-displayName: Integrations x-group: Integrations description: >- Hosted endpoints that answer your WorkOS, Auth0 or Supabase sign-up and sign-in hooks. - name: webhooks x-displayName: Webhooks x-group: Webhooks description: Your webhook endpoints, and the signed events NoResponse sends to them. - name: workspaces x-displayName: Workspaces x-group: Workspaces description: >- Manage non-owner team access, read usage and audit events, configure audit streams, and export retained account or audit data. - name: requests x-displayName: Request diagnostics x-group: Request diagnostics description: Search retained request attempts and summarize their status and latency. - name: groups x-displayName: Groups x-group: Groups description: >- Screen a group's people: create the group, upload its list of people, start screenings and record a decision on each person. - name: reviews x-displayName: Reviews x-group: Reviews description: >- Investigate accounts with assignments, comments, linked evidence, saved filters and recorded resolutions. paths: /v1/workspaces/{workspace_id}/groups/{environment}/{group_id}/people/{person_id}/searches: post: tags: - groups summary: Search again on a value description: >- Starts a new search on the value of one field of one of the person's records. Name the record with `record_id` and the field with `field`; the value itself is not sent. The field's kind must be `email`, `phone`, `username`, `person_name`, `password`, `hash` or `ip`. Nothing searches again by itself: a search starts only when you ask for it. The search runs the breach search and the account and phone lookups that take the value's kind, and finishes seconds later. A `password` or `hash` search counts first: it stops at `counted`, with `rows` saying how many breach rows hold the value, and runs only when you run it. Name a `table`, as a lookup's `remaining` entry names it, to get up to 100 rows that an earlier search left out. Read the person to follow the search. Each record it finds joins the person's lookup records as a lead, and its `matched` entry names the search in `search`. The person's `searches` list each search with its value and the record and field it came from. Each search counts against the environment's `screening_daily_cap`. Requires the `groups` scope, within the key's own workspace and environment. operationId: startSearch parameters: - $ref: '#/components/parameters/WorkspaceId' - $ref: '#/components/parameters/Environment' - $ref: '#/components/parameters/GroupId' - $ref: '#/components/parameters/PersonId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchRequest' responses: '202': $ref: '#/components/responses/SearchAccepted' '400': $ref: '#/components/responses/InvalidGroupRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/ControlForbidden' '404': $ref: '#/components/responses/WorkspaceNotFound' '409': $ref: '#/components/responses/GroupConflict' '415': $ref: '#/components/responses/UnsupportedMediaType' '503': $ref: '#/components/responses/ServiceUnavailable' security: - tenantBearer: [] x-codeSamples: - lang: curl label: cURL source: | curl --request POST \ --url 'https://api.noresponse.org/v1/workspaces/tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM/groups/live/grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM/people/per_01JA2Z8K6Q4V7W9XBCDEFGHJKM/searches' \ --header "Authorization: Bearer $NORESPONSE_API_KEY" \ --header 'Content-Type: application/json' \ --data '{ "record_id": "rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7", "field": "username", "table": "FORUM_EXAMPLE_COM_2019" }' - lang: typescript label: TypeScript source: | import { NoResponse } from "@noresponse/node"; const noResponse = new NoResponse({ apiKey: process.env["NORESPONSE_API_KEY"] ?? "", }); async function run() { const result = await noResponse.groups.startSearch({ workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", environment: "live", groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM", body: { recordId: "rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7", field: "username", table: "FORUM_EXAMPLE_COM_2019", }, }); console.log(result); } run(); - lang: python label: Python source: | from noresponse import NoResponse import os with NoResponse( api_key=os.getenv("NORESPONSE_API_KEY", ""), ) as no_response: res = no_response.groups.start_search(workspace_id="tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", environment="live", group_id="grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", person_id="per_01JA2Z8K6Q4V7W9XBCDEFGHJKM", record_id="rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7", field="username", table="FORUM_EXAMPLE_COM_2019") # Handle response print(res) - lang: go label: Go source: "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tnoresponse \"github.com/noresponsehq/go/v12\"\n\t\"github.com/noresponsehq/go/v12/models/components\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := noresponse.New(\n noresponse.WithSecurity(os.Getenv(\"NORESPONSE_API_KEY\")),\n )\n\n res, err := s.Groups.StartSearch(ctx, \"tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM\", components.KeyEnvironmentLive, \"grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM\", \"per_01JA2Z8K6Q4V7W9XBCDEFGHJKM\", components.SearchRequest{\n RecordID: \"rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7\",\n Field: \"username\",\n Table: noresponse.Pointer(\"FORUM_EXAMPLE_COM_2019\"),\n })\n if err != nil {\n log.Fatal(err)\n }\n if res != nil {\n // handle response\n }\n}\n" - lang: java label: Java source: | 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.StartSearchRequest; import org.noresponse.models.operations.StartSearchResponse; import org.noresponse.models.shared.KeyEnvironment; 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(); StartSearchRequest req = StartSearchRequest.builder() .workspaceId("tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM") .environment(KeyEnvironment.LIVE) .groupId("grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM") .personId("per_01JA2Z8K6Q4V7W9XBCDEFGHJKM") .body(SearchRequest.builder() .recordId("rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7") .field("username") .table("FORUM_EXAMPLE_COM_2019") .build()) .build(); StartSearchResponse res = sdk.groups().startSearch() .request(req) .call(); if (res.search().isPresent()) { System.out.println(res.search().get()); } } } - lang: csharp label: C# source: > using NoResponse; using NoResponse.Models.Shared; using System; var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY")); var res = await sdk.Groups.StartSearchAsync( workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", environment: KeyEnvironment.Live, groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM", body: new SearchRequest() { RecordId = "rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7", Field = "username", Table = "FORUM_EXAMPLE_COM_2019", } ); // handle response - lang: php label: PHP source: | setSecurity( getenv('NORESPONSE_API_KEY') ?: '' ) ->build(); $body = new Shared\SearchRequest( recordId: 'rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7', field: 'username', table: 'FORUM_EXAMPLE_COM_2019', ); $response = $sdk->groups->startSearch( workspaceId: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', environment: Shared\KeyEnvironment::Live, groupId: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM', personId: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM', body: $body ); $result = $response->result; // handle response - lang: ruby label: Ruby source: > require 'noresponse' Models = ::NoResponse::Models s = ::NoResponse::NoResponseClient.new( api_key: ENV.fetch('NORESPONSE_API_KEY', '') ) res = s.groups.start_search(workspace_id: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', environment: Models::Shared::KeyEnvironment::LIVE, group_id: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM', person_id: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM', body: Models::Shared::SearchRequest.new( record_id: 'rec_3f9a1c22d4e5b6a73f9a1c22d4e5b6a7', field: 'username', table: 'FORUM_EXAMPLE_COM_2019' )) unless res.nil? # handle response end components: parameters: WorkspaceId: name: workspace_id in: path required: true schema: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,122}$ description: >- The workspace id, which is also its live environment's workspace id; the test environment's is the same id with:test appended. A workspace created through the API is tnt_ and a 26-character ULID. description: >- The workspace id. A workspace the acting user is not an active member of answers 404, as do another workspace than an API key's own, a malformed id and a test environment's id. Environment: name: environment in: path required: true schema: enum: - live - test description: >- The environment the key belongs to. A live key assesses with live sources; a test key answers from the deterministic simulator. description: >- The environment: live or test. Each has its own settings. Any other value answers 400. An API key reads and changes only its own environment's; the other answers 404. GroupId: name: group_id in: path required: true schema: type: string pattern: ^grp_[0-7][0-9A-HJKMNP-TV-Z]{25}$ PersonId: name: person_id in: path required: true schema: type: string pattern: ^per_[0-7][0-9A-HJKMNP-TV-Z]{25}$ schemas: SearchRequest: type: object additionalProperties: false required: - record_id - field properties: record_id: type: string pattern: ^rec_[0-9a-f]{32}$ description: >- One of the person's records: a lookup's, a profile's or one an earlier search found. field: type: string minLength: 1 maxLength: 500 description: >- The name of the record's field whose value to search. Its kind must be email, phone, username, person_name, password, hash or ip. table: type: string minLength: 1 maxLength: 500 description: >- Search only this breach table, as a remaining entry names it, to fetch the rows an earlier search left out. Not for a phone. description: >- The value to search again, named by the record and field that hold it rather than sent again. Search: type: object additionalProperties: false required: - search_id - record_id - field - kind - value - status - sources - answered - found - estimated_spend - spent - requested_by - created_at properties: search_id: type: string pattern: ^srh_[0-7][0-9A-HJKMNP-TV-Z]{25}$ record_id: type: string pattern: ^rec_[0-9a-f]{32}$ description: The record whose value led to the search. field: type: string minLength: 1 maxLength: 500 description: The field of that record that holds the value. table: type: string minLength: 1 maxLength: 500 description: The one breach table searched, when the search was of one table. kind: enum: - email - phone - username - person_name - password - hash - ip description: The kind of the value searched. value: type: string description: >- The value searched: the field's cleaned value, else as the source wrote it. status: enum: - counting - counted - queued - running - completed - partial - failed description: >- 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. rows: type: integer minimum: 0 description: >- How many breach rows hold the password or hash, counted before the search runs. sources: type: integer minimum: 0 description: >- How many sources the search asked: the breach search and the account and phone lookups that take the value's kind. answered: type: integer minimum: 0 description: How many of them gave a definite answer, found or not found. found: type: integer minimum: 0 description: >- How many records the search found. They are among the person report's lookup records, each match naming this search. estimated_spend: type: integer minimum: 0 description: >- What the search may spend, in US cents, held against the environment's daily screening cap while it runs. spent: type: integer minimum: 0 description: What the search spent, in US cents, metered as screening work. error_code: enum: - not_answered - no_source - worker_attempts_exhausted description: >- Why a failed search found nothing: its sources did not answer, none could be asked, or it could not run before its attempts were spent. requested_by: type: string minLength: 1 maxLength: 256 description: Who started the search. created_at: type: string format: date-time finished_at: type: string format: date-time description: >- One search a person started on a value of one of a person's records. Nothing searches again by itself. Problem: title: Problem details error description: >- RFC 9457 problem-details error body returned by every non-2xx API response, extended with a stable machine code and request id. type: object additionalProperties: false required: - type - title - status - detail - code - request_id properties: type: type: string format: uri-reference title: type: string status: type: integer minimum: 400 maximum: 599 detail: type: string instance: type: string format: uri-reference code: type: string request_id: type: string minLength: 1 invalid_params: type: array items: type: object additionalProperties: false required: - field - reason properties: field: type: string minLength: 1 reason: type: string minLength: 1 example: type: string minLength: 1 responses: SearchAccepted: description: >- The search: counting, or queued to run. Read the person after Retry-After to see its status, its count and what it found. headers: Cache-Control: schema: type: string const: no-store required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true Retry-After: description: Whole seconds to wait before reading the person. schema: type: string pattern: ^[1-9][0-9]{0,3}$ required: true content: application/json: schema: $ref: '#/components/schemas/Search' InvalidGroupRequest: description: >- The body or query is invalid, or Idempotency-Key is missing, repeated or malformed. headers: Cache-Control: schema: type: string const: no-store required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: status: const: 400 code: enum: - invalid_request - invalid_idempotency_key Unauthorized: description: No API key, or one that is malformed, unknown, revoked or expired. headers: Cache-Control: schema: type: string const: no-store required: true WWW-Authenticate: schema: type: string const: Bearer realm="noresponse-assessments" required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: status: const: 401 code: enum: - unauthorized ControlForbidden: description: >- workspace_forbidden: an API key without the management scope, or any API key on a route other than the key, settings and list routes. role_forbidden: a console credential's acting user is an active member whose role does not grant the operation. headers: Cache-Control: schema: type: string const: no-store required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: status: const: 403 code: enum: - workspace_forbidden - role_forbidden WorkspaceNotFound: description: >- No such workspace, member, invite, key or environment for the caller. A workspace the acting user is not an active member of answers this too, as do another workspace and the other environment to an API key, so no answer shows which workspaces exist. headers: Cache-Control: schema: type: string const: no-store required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: status: const: 404 code: enum: - not_found GroupConflict: description: >- The group or screening's state does not allow the change, a bound is reached, the Idempotency-Key was used for another body, the environment cannot screen yet, or the screening's estimate exceeds what the daily screening cap has left. headers: Cache-Control: schema: type: string const: no-store required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: status: const: 409 code: enum: - group_conflict - group_limit_reached - idempotency_key_reused - screening_cap_exceeded - screening_unavailable UnsupportedMediaType: description: Content-Type is not application/json. headers: Cache-Control: schema: type: string const: no-store required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: status: const: 415 code: enum: - unsupported_media_type ServiceUnavailable: description: >- The assessment could not be admitted at all (overload, shutdown or a dependency down). An assessment that was admitted answers partial or pending instead of 503. headers: Cache-Control: schema: type: string const: no-store required: true Retry-After: description: >- Whole seconds to wait before polling or retrying. Required on 202, 429 and 503. schema: type: string pattern: >- ^(?:[1-9]|[1-9][0-9]|[1-9][0-9]{2}|[12][0-9]{3}|3[0-5][0-9]{2}|3600)$ description: Whole decimal seconds; wait at least this long. required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: status: const: 503 code: enum: - service_unavailable securitySchemes: tenantBearer: type: http scheme: bearer description: >- Your API key, sent as `Authorization: Bearer `. 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.