curl --request POST \
--url 'https://api.noresponse.org/v1/investigations' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: investigation-case-1042-first' \
--data '{
"depth": "standard",
"platforms": [
"x"
],
"person_id": "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM"
}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.investigations.create({
idempotencyKey: "investigation-case-1042-first",
body: {
depth: "standard",
platforms: [
"x",
],
personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
},
});
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.investigations.create(idempotency_key="investigation-case-1042-first", depth="standard", platforms=[
"x",
], person_id="per_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
# 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.Investigations.Create(ctx, "investigation-case-1042-first", components.InvestigationRequest{
Depth: components.ScreeningDepthStandard,
Platforms: []string{
"x",
},
PersonID: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
})
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.CreateInvestigationResponse;
import org.noresponse.models.shared.InvestigationRequest;
import org.noresponse.models.shared.ScreeningDepth;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
CreateInvestigationResponse res = sdk.investigations().create()
.idempotencyKey("investigation-case-1042-first")
.body(InvestigationRequest.builder()
.depth(ScreeningDepth.STANDARD)
.platforms(List.of(
"x"))
.personId("per_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.build())
.call();
if (res.investigation().isPresent()) {
System.out.println(res.investigation().get());
}
}
}
using NoResponse;
using NoResponse.Models.Shared;
using System;
using System.Collections.Generic;
var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));
var res = await sdk.Investigations.CreateAsync(
body: new InvestigationRequest() {
Depth = ScreeningDepth.Standard,
Platforms = new List<string>() {
"x",
},
PersonId = "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
},
idempotencyKey: "investigation-case-1042-first"
);
// 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\InvestigationRequest(
depth: Shared\ScreeningDepth::Standard,
platforms: [
'x',
],
personId: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
);
$response = $sdk->investigations->create(
body: $body,
idempotencyKey: 'investigation-case-1042-first'
);
$result = $response->result;
// handle response
require 'noresponse'
Models = ::NoResponse::Models
s = ::NoResponse::NoResponseClient.new(
api_key: ENV.fetch('NORESPONSE_API_KEY', '')
)
res = s.investigations.create(body: Models::Shared::InvestigationRequest.new(
depth: Models::Shared::ScreeningDepth::STANDARD,
platforms: [
'x',
],
person_id: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM'
), idempotency_key: 'investigation-case-1042-first')
unless res.nil?
# handle response
end
{
"highest_band": "critical",
"coverage": {
"accounts_found": 50,
"accounts_accessible": 50,
"items_read": 500000,
"platforms": [
{
"platform": "<string>",
"status": "covered",
"accounts_found": 50,
"items_read": 50000
}
],
"items_not_analysed": 500000,
"not_analysed_by_reason": [
{
"reason": "video",
"items": 500000
}
],
"items_frame_only": 500000,
"period_from": "2023-11-07T05:31:56Z",
"period_to": "2023-11-07T05:31:56Z",
"not_searched": [
"<string>"
]
},
"spend": {
"total_minor": 50000000000,
"by_implementation": [
{
"implementation": "<string>",
"role": "resolver",
"spend_minor": 50000000000
}
]
},
"decision": "cleared",
"id": "<string>",
"person_id": "<string>",
"group_id": "<string>",
"status": "queued",
"depth": "standard",
"platforms": [
"<string>"
],
"match_state": "unscreened",
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"deadline_at": "2023-11-07T05:31:56Z",
"decision_note": "<string>",
"decided_by": "<string>",
"decided_at": "2023-11-07T05:31:56Z",
"error_code": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"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": "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": 409,
"detail": "<string>",
"code": "group_conflict",
"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>"
}
]
}Start an investigation for a person.
Starts an investigation against a retained workspace person, independently of group membership. Idempotency-Key is required: the same key and input return the same retained job in its current state without repeating billable work. Different input with that key answers 409 idempotency_key_reused; a deliberate new investigation uses a new key. The response includes Location and Retry-After. The person’s retention expiry limits both execution and retained history. The API key selects the workspace and environment.
curl --request POST \
--url 'https://api.noresponse.org/v1/investigations' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: investigation-case-1042-first' \
--data '{
"depth": "standard",
"platforms": [
"x"
],
"person_id": "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM"
}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.investigations.create({
idempotencyKey: "investigation-case-1042-first",
body: {
depth: "standard",
platforms: [
"x",
],
personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
},
});
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.investigations.create(idempotency_key="investigation-case-1042-first", depth="standard", platforms=[
"x",
], person_id="per_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
# 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.Investigations.Create(ctx, "investigation-case-1042-first", components.InvestigationRequest{
Depth: components.ScreeningDepthStandard,
Platforms: []string{
"x",
},
PersonID: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
})
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.CreateInvestigationResponse;
import org.noresponse.models.shared.InvestigationRequest;
import org.noresponse.models.shared.ScreeningDepth;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
CreateInvestigationResponse res = sdk.investigations().create()
.idempotencyKey("investigation-case-1042-first")
.body(InvestigationRequest.builder()
.depth(ScreeningDepth.STANDARD)
.platforms(List.of(
"x"))
.personId("per_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.build())
.call();
if (res.investigation().isPresent()) {
System.out.println(res.investigation().get());
}
}
}
using NoResponse;
using NoResponse.Models.Shared;
using System;
using System.Collections.Generic;
var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));
var res = await sdk.Investigations.CreateAsync(
body: new InvestigationRequest() {
Depth = ScreeningDepth.Standard,
Platforms = new List<string>() {
"x",
},
PersonId = "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
},
idempotencyKey: "investigation-case-1042-first"
);
// 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\InvestigationRequest(
depth: Shared\ScreeningDepth::Standard,
platforms: [
'x',
],
personId: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
);
$response = $sdk->investigations->create(
body: $body,
idempotencyKey: 'investigation-case-1042-first'
);
$result = $response->result;
// handle response
require 'noresponse'
Models = ::NoResponse::Models
s = ::NoResponse::NoResponseClient.new(
api_key: ENV.fetch('NORESPONSE_API_KEY', '')
)
res = s.investigations.create(body: Models::Shared::InvestigationRequest.new(
depth: Models::Shared::ScreeningDepth::STANDARD,
platforms: [
'x',
],
person_id: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM'
), idempotency_key: 'investigation-case-1042-first')
unless res.nil?
# handle response
end
{
"highest_band": "critical",
"coverage": {
"accounts_found": 50,
"accounts_accessible": 50,
"items_read": 500000,
"platforms": [
{
"platform": "<string>",
"status": "covered",
"accounts_found": 50,
"items_read": 50000
}
],
"items_not_analysed": 500000,
"not_analysed_by_reason": [
{
"reason": "video",
"items": 500000
}
],
"items_frame_only": 500000,
"period_from": "2023-11-07T05:31:56Z",
"period_to": "2023-11-07T05:31:56Z",
"not_searched": [
"<string>"
]
},
"spend": {
"total_minor": 50000000000,
"by_implementation": [
{
"implementation": "<string>",
"role": "resolver",
"spend_minor": 50000000000
}
]
},
"decision": "cleared",
"id": "<string>",
"person_id": "<string>",
"group_id": "<string>",
"status": "queued",
"depth": "standard",
"platforms": [
"<string>"
],
"match_state": "unscreened",
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"deadline_at": "2023-11-07T05:31:56Z",
"decision_note": "<string>",
"decided_by": "<string>",
"decided_at": "2023-11-07T05:31:56Z",
"error_code": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"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": "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": 409,
"detail": "<string>",
"code": "group_conflict",
"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
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}$Body
Runs a new investigation against one retained workspace person.
1 - 11 elementsA platform a screening can cover, such as instagram, x, bluesky, youtube, tiktok or github. A new platform adds an id without changing this contract, so read a platform you do not know in a response as one you have not seen before, not as an error. synthetic is the deterministic connector's own platform, for exercising the product end to end with no network.
^[a-z][a-z0-9_]{0,63}$Response
Start an investigation for a person.
1 - 11 elementsA platform a screening can cover, such as instagram, x, bluesky, youtube, tiktok or github. A new platform adds an id without changing this contract, so read a platform you do not know in a response as one you have not seen before, not as an error. synthetic is the deterministic connector's own platform, for exercising the product end to end with no network.
^[a-z][a-z0-9_]{0,63}$How sure the latest screening is that it found the person's accounts. unscreened until a screening reaches the person, and after one that had no profile to check (no_profile_to_check).
unscreened, confirmed, probable, possible, none_found, inaccessible