curl --request POST \
--url 'https://api.noresponse.org/v1/workspaces/tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM/groups/test/grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM/people/per_01JA2Z8K6Q4V7W9XBCDEFGHJKM/review' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"decision": "escalated",
"note": "Known to the venue team."
}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.groups.reviewPerson({
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
environment: "test",
groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: {
decision: "escalated",
note: "Known to the venue team.",
},
});
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.review_person(workspace_id="tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", environment="test", group_id="grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", person_id="per_01JA2Z8K6Q4V7W9XBCDEFGHJKM", decision="escalated", note="Known to the venue team.")
# 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.ReviewPerson(ctx, "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.KeyEnvironmentTest, "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.PersonReviewRequest{
Decision: components.PersonDecisionEscalated,
Note: noresponse.Pointer("Known to the venue team."),
})
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.ReviewPersonRequest;
import org.noresponse.models.operations.ReviewPersonResponse;
import org.noresponse.models.shared.KeyEnvironment;
import org.noresponse.models.shared.PersonDecision;
import org.noresponse.models.shared.PersonReviewRequest;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
ReviewPersonRequest req = ReviewPersonRequest.builder()
.workspaceId("tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.environment(KeyEnvironment.TEST)
.groupId("grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.personId("per_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.body(PersonReviewRequest.builder()
.decision(PersonDecision.ESCALATED)
.note("Known to the venue team.")
.build())
.build();
ReviewPersonResponse res = sdk.groups().reviewPerson()
.request(req)
.call();
if (res.person().isPresent()) {
System.out.println(res.person().get());
}
}
}
using NoResponse;
using NoResponse.Models.Shared;
using System;
var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));
var res = await sdk.Groups.ReviewPersonAsync(
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
environment: KeyEnvironment.Test,
groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: new PersonReviewRequest() {
Decision = PersonDecision.Escalated,
Note = "Known to the venue team.",
}
);
// 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\PersonReviewRequest(
decision: Shared\PersonDecision::Escalated,
note: 'Known to the venue team.',
);
$response = $sdk->groups->reviewPerson(
workspaceId: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
environment: Shared\KeyEnvironment::Test,
groupId: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
personId: 'per_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.review_person(workspace_id: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', environment: Models::Shared::KeyEnvironment::TEST, group_id: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM', person_id: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM', body: Models::Shared::PersonReviewRequest.new(
decision: Models::Shared::PersonDecision::ESCALATED,
note: 'Known to the venue team.'
))
unless res.nil?
# handle response
end
{
"id": "<string>",
"group_id": "<string>",
"name": "<string>",
"match_state": "unscreened",
"highest_band": "critical",
"decision": "cleared",
"coverage": {
"accounts_found": 50,
"accounts_accessible": 50,
"items_read": 500000,
"platforms": [
{
"platform": "instagram",
"status": "covered",
"accounts_found": 50,
"items_read": 50000
}
],
"items_not_analysed": 500000,
"not_analysed_by_reason": [
{
"reason": "video",
"items": 500000
}
],
"period_from": "2023-11-07T05:31:56Z",
"period_to": "2023-11-07T05:31:56Z",
"not_searched": [
"instagram"
]
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"spend": {
"total_minor": 50000000000,
"by_implementation": [
{
"implementation": "<string>",
"role": "resolver",
"spend_minor": 50000000000
}
]
},
"external_id": "<string>",
"email": "<string>",
"phone": "<string>",
"company": "<string>",
"city": "<string>",
"handles": [
{
"platform": "instagram",
"handle": "<string>"
}
],
"role": "guest",
"no_profile_to_check": true,
"decision_note": "<string>",
"decided_by": "<string>",
"decided_at": "2023-11-07T05:31:56Z",
"last_screening_id": "<string>",
"screened_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>"
}
]
}Record a decision
Marks the person cleared, watch or escalated with a note. The latest decision is the person’s decision. The next screening screens everyone on watch or escalated again.
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/test/grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM/people/per_01JA2Z8K6Q4V7W9XBCDEFGHJKM/review' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"decision": "escalated",
"note": "Known to the venue team."
}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.groups.reviewPerson({
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
environment: "test",
groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: {
decision: "escalated",
note: "Known to the venue team.",
},
});
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.review_person(workspace_id="tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", environment="test", group_id="grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", person_id="per_01JA2Z8K6Q4V7W9XBCDEFGHJKM", decision="escalated", note="Known to the venue team.")
# 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.ReviewPerson(ctx, "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.KeyEnvironmentTest, "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.PersonReviewRequest{
Decision: components.PersonDecisionEscalated,
Note: noresponse.Pointer("Known to the venue team."),
})
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.ReviewPersonRequest;
import org.noresponse.models.operations.ReviewPersonResponse;
import org.noresponse.models.shared.KeyEnvironment;
import org.noresponse.models.shared.PersonDecision;
import org.noresponse.models.shared.PersonReviewRequest;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
ReviewPersonRequest req = ReviewPersonRequest.builder()
.workspaceId("tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.environment(KeyEnvironment.TEST)
.groupId("grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.personId("per_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.body(PersonReviewRequest.builder()
.decision(PersonDecision.ESCALATED)
.note("Known to the venue team.")
.build())
.build();
ReviewPersonResponse res = sdk.groups().reviewPerson()
.request(req)
.call();
if (res.person().isPresent()) {
System.out.println(res.person().get());
}
}
}
using NoResponse;
using NoResponse.Models.Shared;
using System;
var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));
var res = await sdk.Groups.ReviewPersonAsync(
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
environment: KeyEnvironment.Test,
groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: new PersonReviewRequest() {
Decision = PersonDecision.Escalated,
Note = "Known to the venue team.",
}
);
// 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\PersonReviewRequest(
decision: Shared\PersonDecision::Escalated,
note: 'Known to the venue team.',
);
$response = $sdk->groups->reviewPerson(
workspaceId: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
environment: Shared\KeyEnvironment::Test,
groupId: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
personId: 'per_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.review_person(workspace_id: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', environment: Models::Shared::KeyEnvironment::TEST, group_id: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM', person_id: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM', body: Models::Shared::PersonReviewRequest.new(
decision: Models::Shared::PersonDecision::ESCALATED,
note: 'Known to the venue team.'
))
unless res.nil?
# handle response
end
{
"id": "<string>",
"group_id": "<string>",
"name": "<string>",
"match_state": "unscreened",
"highest_band": "critical",
"decision": "cleared",
"coverage": {
"accounts_found": 50,
"accounts_accessible": 50,
"items_read": 500000,
"platforms": [
{
"platform": "instagram",
"status": "covered",
"accounts_found": 50,
"items_read": 50000
}
],
"items_not_analysed": 500000,
"not_analysed_by_reason": [
{
"reason": "video",
"items": 500000
}
],
"period_from": "2023-11-07T05:31:56Z",
"period_to": "2023-11-07T05:31:56Z",
"not_searched": [
"instagram"
]
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"spend": {
"total_minor": 50000000000,
"by_implementation": [
{
"implementation": "<string>",
"role": "resolver",
"spend_minor": 50000000000
}
]
},
"external_id": "<string>",
"email": "<string>",
"phone": "<string>",
"company": "<string>",
"city": "<string>",
"handles": [
{
"platform": "instagram",
"handle": "<string>"
}
],
"role": "guest",
"no_profile_to_check": true,
"decision_note": "<string>",
"decided_by": "<string>",
"decided_at": "2023-11-07T05:31:56Z",
"last_screening_id": "<string>",
"screened_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.
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.
Path 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
Response
The person with the decision recorded.
A person and where their screening and review stand.
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 The person's role in the group: guest (a ticket holder), crew, vendor or press. Leave it out when you do not know it: a person without one has no role, not guest. A later row naming the same person replaces it, and a change of role alone keeps the person's screening results.
guest, crew, vendor, press true when the latest screening reached the person but the list gave nothing to look up on any requested platform, such as no handle for a platform that reads supplied handles only: nobody looked for a profile. match_state stays unscreened, every platform is in coverage.not_searched, and the person is neither none_found nor failed and does not make the screening partial. Its lookups are on its report. Left out otherwise.