curl --request POST \
--url 'https://api.noresponse.org/v1/workspaces/tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM/groups/live/grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM/screenings' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: account-acct_7f3a9c' \
--data '{
"depth": "standard",
"platforms": []
}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.groups.startScreening({
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
environment: "live",
groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
idempotencyKey: "account-acct_7f3a9c",
body: {
depth: "standard",
platforms: [],
},
});
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_screening(workspace_id="tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", environment="live", group_id="grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", idempotency_key="account-acct_7f3a9c", depth="standard", platforms=[])
# Handle response
print(res)
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.Groups.StartScreening(ctx, "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.KeyEnvironmentLive, "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", "account-acct_7f3a9c", components.ScreeningRequest{
Depth: components.ScreeningDepthStandard,
Platforms: []components.HandlePlatform{},
})
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.StartScreeningRequest;
import org.noresponse.models.operations.StartScreeningResponse;
import org.noresponse.models.shared.KeyEnvironment;
import org.noresponse.models.shared.ScreeningDepth;
import org.noresponse.models.shared.ScreeningRequest;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
StartScreeningRequest req = StartScreeningRequest.builder()
.workspaceId("tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.environment(KeyEnvironment.LIVE)
.groupId("grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.idempotencyKey("account-acct_7f3a9c")
.body(ScreeningRequest.builder()
.depth(ScreeningDepth.STANDARD)
.platforms(List.of())
.build())
.build();
StartScreeningResponse res = sdk.groups().startScreening()
.request(req)
.call();
if (res.screening().isPresent()) {
System.out.println(res.screening().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.Groups.StartScreeningAsync(
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
environment: KeyEnvironment.Live,
groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: new ScreeningRequest() {
Depth = ScreeningDepth.Standard,
Platforms = new List<HandlePlatform>() {},
},
idempotencyKey: "account-acct_7f3a9c"
);
// 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\ScreeningRequest(
depth: Shared\ScreeningDepth::Standard,
platforms: [],
);
$response = $sdk->groups->startScreening(
workspaceId: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
environment: Shared\KeyEnvironment::Live,
groupId: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
body: $body,
idempotencyKey: 'account-acct_7f3a9c'
);
$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_screening(workspace_id: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', environment: Models::Shared::KeyEnvironment::LIVE, group_id: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM', body: Models::Shared::ScreeningRequest.new(
depth: Models::Shared::ScreeningDepth::STANDARD,
platforms: []
), idempotency_key: 'account-acct_7f3a9c')
unless res.nil?
# handle response
end
{
"id": "<string>",
"group_id": "<string>",
"environment": "live",
"status": "queued",
"depth": "standard",
"platforms": [
"instagram"
],
"requested_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"people_total": 10000,
"people_done": 10000,
"people_flagged": 10000,
"people_failed": 10000,
"people_partial": 10000,
"estimated_spend": 1,
"spent": 1,
"spend": {
"total_minor": 50000000000,
"by_implementation": [
{
"implementation": "<string>",
"role": "resolver",
"spend_minor": 50000000000
}
]
},
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"error_code": "<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": "<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>"
}
]
}Start a screening
Screens the people that no screening has reached, and everyone on watch or escalated. One screening of a group runs at a time.
A screening finishes minutes to hours later as completed, partial (some people not covered, counted in people_failed) or failed. A screening that runs for 24 hours fails with error_code expired. Poll it and respect Retry-After.
Send an Idempotency-Key. It binds the body for the life of the screening.
The answer gives the cost estimate in estimated_spend, in US cents. A screening whose estimate is more than the environment’s screening_daily_cap has left for the day answers 409 screening_cap_exceeded and queues nothing.
The test environment screens with deterministic stand-ins that find no accounts. A live screening answers 409 screening_unavailable until live screening opens.
Requires the groups scope, within the key’s own workspace and environment.
curl --request POST \
--url 'https://api.noresponse.org/v1/workspaces/tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM/groups/live/grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM/screenings' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: account-acct_7f3a9c' \
--data '{
"depth": "standard",
"platforms": []
}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.groups.startScreening({
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
environment: "live",
groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
idempotencyKey: "account-acct_7f3a9c",
body: {
depth: "standard",
platforms: [],
},
});
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_screening(workspace_id="tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", environment="live", group_id="grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", idempotency_key="account-acct_7f3a9c", depth="standard", platforms=[])
# Handle response
print(res)
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.Groups.StartScreening(ctx, "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.KeyEnvironmentLive, "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", "account-acct_7f3a9c", components.ScreeningRequest{
Depth: components.ScreeningDepthStandard,
Platforms: []components.HandlePlatform{},
})
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.StartScreeningRequest;
import org.noresponse.models.operations.StartScreeningResponse;
import org.noresponse.models.shared.KeyEnvironment;
import org.noresponse.models.shared.ScreeningDepth;
import org.noresponse.models.shared.ScreeningRequest;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
StartScreeningRequest req = StartScreeningRequest.builder()
.workspaceId("tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.environment(KeyEnvironment.LIVE)
.groupId("grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.idempotencyKey("account-acct_7f3a9c")
.body(ScreeningRequest.builder()
.depth(ScreeningDepth.STANDARD)
.platforms(List.of())
.build())
.build();
StartScreeningResponse res = sdk.groups().startScreening()
.request(req)
.call();
if (res.screening().isPresent()) {
System.out.println(res.screening().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.Groups.StartScreeningAsync(
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
environment: KeyEnvironment.Live,
groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: new ScreeningRequest() {
Depth = ScreeningDepth.Standard,
Platforms = new List<HandlePlatform>() {},
},
idempotencyKey: "account-acct_7f3a9c"
);
// 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\ScreeningRequest(
depth: Shared\ScreeningDepth::Standard,
platforms: [],
);
$response = $sdk->groups->startScreening(
workspaceId: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
environment: Shared\KeyEnvironment::Live,
groupId: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
body: $body,
idempotencyKey: 'account-acct_7f3a9c'
);
$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_screening(workspace_id: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', environment: Models::Shared::KeyEnvironment::LIVE, group_id: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM', body: Models::Shared::ScreeningRequest.new(
depth: Models::Shared::ScreeningDepth::STANDARD,
platforms: []
), idempotency_key: 'account-acct_7f3a9c')
unless res.nil?
# handle response
end
{
"id": "<string>",
"group_id": "<string>",
"environment": "live",
"status": "queued",
"depth": "standard",
"platforms": [
"instagram"
],
"requested_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"people_total": 10000,
"people_done": 10000,
"people_flagged": 10000,
"people_failed": 10000,
"people_partial": 10000,
"estimated_spend": 1,
"spent": 1,
"spend": {
"total_minor": 50000000000,
"by_implementation": [
{
"implementation": "<string>",
"role": "resolver",
"spend_minor": 50000000000
}
]
},
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"error_code": "<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": "<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.
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.
Headers
The acting user's address as the console verified it at sign-in, where a screening's mail goes when it finishes. It counts only with a console credential and only when its member id (email: and the SHA-256 of the lower-cased address, hex) is NR-Acting-User; otherwise it is ignored. It is kept only until the screening's mail is queued.
3 - 254Path Parameters
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. 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.
^[A-Za-z0-9][A-Za-z0-9_.-]{0,122}$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. The environment the key belongs to. A live key assesses with live sources; a test key answers from the deterministic simulator.
live, test Body
Screens the group's people no screening has reached and everyone on watch or escalated.
1 - 11 elementsA platform a screening can cover. github and scratch through flickr are each one read of the public profile a handle names, with no posts. synthetic is the deterministic connector's own platform, for exercising the product end to end with no network.
instagram, x, bluesky, youtube, tiktok, facebook, threads, reddit, telegram, linkedin, github, scratch, dailymotion, substack, duolingo, dockerhub, wikipedia, internetarchive, spotify, patreon, wordpress, okru, flickr, synthetic Response
The screening is queued. Poll Location after Retry-After; it finishes minutes to hours later.
A screening and its progress.
1 - 11 elementsA platform a screening can cover. github and scratch through flickr are each one read of the public profile a handle names, with no posts. synthetic is the deterministic connector's own platform, for exercising the product end to end with no network.
instagram, x, bluesky, youtube, tiktok, facebook, threads, reddit, telegram, linkedin, github, scratch, dailymotion, substack, duolingo, dockerhub, wikipedia, internetarchive, spotify, patreon, wordpress, okru, flickr, synthetic