curl --request POST \
--url 'https://api.noresponse.org/v1/workspaces/tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM/reviews/live/%3Cid%3E/subjects' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"kind": "account",
"account_id": "acct_7f3a9c",
"assessment_id": "asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
"credential_id": "cred_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
"reason": "Linked during review of the account evidence.",
"expected_version": 691733
}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.reviews.addSubject({
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
environment: "live",
reviewId: "<id>",
body: {
kind: "account",
accountId: "acct_7f3a9c",
assessmentId: "asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
credentialId: "cred_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
reason: "Linked during review of the account evidence.",
expectedVersion: 691733,
},
});
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.reviews.add_subject(workspace_id="tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", environment="live", review_id="<id>", kind="account", account_id="acct_7f3a9c", reason="Linked during review of the account evidence.", expected_version=691733, assessment_id="asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM", credential_id="cred_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
# 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.Reviews.AddSubject(ctx, "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.KeyEnvironmentLive, "<id>", components.ReviewSubjectRequest{
Kind: components.ReviewSubjectKindAccount,
AccountID: "acct_7f3a9c",
AssessmentID: noresponse.Pointer("asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM"),
CredentialID: noresponse.Pointer("cred_01JA2Z8K6Q4V7W9XBCDEFGHJKM"),
Reason: "Linked during review of the account evidence.",
ExpectedVersion: 691733,
})
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.AddReviewSubjectResponse;
import org.noresponse.models.shared.KeyEnvironment;
import org.noresponse.models.shared.ReviewSubjectKind;
import org.noresponse.models.shared.ReviewSubjectRequest;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
AddReviewSubjectResponse res = sdk.reviews().addSubject()
.workspaceId("tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.environment(KeyEnvironment.LIVE)
.reviewId("<id>")
.body(ReviewSubjectRequest.builder()
.kind(ReviewSubjectKind.ACCOUNT)
.accountId("acct_7f3a9c")
.reason("Linked during review of the account evidence.")
.expectedVersion(691733L)
.assessmentId("asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.credentialId("cred_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.build())
.call();
if (res.reviewSubjectChange().isPresent()) {
System.out.println(res.reviewSubjectChange().get());
}
}
}
using NoResponse;
using NoResponse.Models.Shared;
using System;
var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));
var res = await sdk.Reviews.AddSubjectAsync(
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
environment: KeyEnvironment.Live,
reviewId: "<id>",
body: new ReviewSubjectRequest() {
Kind = ReviewSubjectKind.Account,
AccountId = "acct_7f3a9c",
AssessmentId = "asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
CredentialId = "cred_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
Reason = "Linked during review of the account evidence.",
ExpectedVersion = 691733,
}
);
// 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\ReviewSubjectRequest(
kind: Shared\ReviewSubjectKind::Account,
accountId: 'acct_7f3a9c',
assessmentId: 'asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
credentialId: 'cred_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
reason: 'Linked during review of the account evidence.',
expectedVersion: 691733,
);
$response = $sdk->reviews->addSubject(
workspaceId: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
environment: Shared\KeyEnvironment::Live,
reviewId: '<id>',
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.reviews.add_subject(workspace_id: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', environment: Models::Shared::KeyEnvironment::LIVE, review_id: '<id>', body: Models::Shared::ReviewSubjectRequest.new(
kind: Models::Shared::ReviewSubjectKind::ACCOUNT,
account_id: 'acct_7f3a9c',
assessment_id: 'asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
credential_id: 'cred_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
reason: 'Linked during review of the account evidence.',
expected_version: 691_733
))
unless res.nil?
# handle response
end
{
"review_version": 4503599627370496,
"subject": {
"id": "<string>",
"kind": "account",
"account_id": "<string>",
"risk_version": 4503599627370496,
"reason": "<string>",
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"assessment_id": "<string>",
"assessment_version": 4503599627370496,
"credential_id": "<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": "review_version_conflict",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 413,
"detail": "<string>",
"code": "payload_too_large",
"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>"
}
]
}Link evidence to a review
Links a retained account, exact assessment revision or issued-credential association to the review. Explain the link and send the current expected_version.
Every subject must belong to its named account in this environment. A review holds at most 100 links.
A link records investigation context. It does not change account risk, report an outcome or apply enforcement.
Requires the management scope, and acts only in the signing key’s own workspace and environment: another workspace and the other environment answer 404.
curl --request POST \
--url 'https://api.noresponse.org/v1/workspaces/tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM/reviews/live/%3Cid%3E/subjects' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"kind": "account",
"account_id": "acct_7f3a9c",
"assessment_id": "asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
"credential_id": "cred_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
"reason": "Linked during review of the account evidence.",
"expected_version": 691733
}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.reviews.addSubject({
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
environment: "live",
reviewId: "<id>",
body: {
kind: "account",
accountId: "acct_7f3a9c",
assessmentId: "asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
credentialId: "cred_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
reason: "Linked during review of the account evidence.",
expectedVersion: 691733,
},
});
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.reviews.add_subject(workspace_id="tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", environment="live", review_id="<id>", kind="account", account_id="acct_7f3a9c", reason="Linked during review of the account evidence.", expected_version=691733, assessment_id="asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM", credential_id="cred_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
# 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.Reviews.AddSubject(ctx, "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.KeyEnvironmentLive, "<id>", components.ReviewSubjectRequest{
Kind: components.ReviewSubjectKindAccount,
AccountID: "acct_7f3a9c",
AssessmentID: noresponse.Pointer("asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM"),
CredentialID: noresponse.Pointer("cred_01JA2Z8K6Q4V7W9XBCDEFGHJKM"),
Reason: "Linked during review of the account evidence.",
ExpectedVersion: 691733,
})
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.AddReviewSubjectResponse;
import org.noresponse.models.shared.KeyEnvironment;
import org.noresponse.models.shared.ReviewSubjectKind;
import org.noresponse.models.shared.ReviewSubjectRequest;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
AddReviewSubjectResponse res = sdk.reviews().addSubject()
.workspaceId("tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.environment(KeyEnvironment.LIVE)
.reviewId("<id>")
.body(ReviewSubjectRequest.builder()
.kind(ReviewSubjectKind.ACCOUNT)
.accountId("acct_7f3a9c")
.reason("Linked during review of the account evidence.")
.expectedVersion(691733L)
.assessmentId("asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.credentialId("cred_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.build())
.call();
if (res.reviewSubjectChange().isPresent()) {
System.out.println(res.reviewSubjectChange().get());
}
}
}
using NoResponse;
using NoResponse.Models.Shared;
using System;
var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));
var res = await sdk.Reviews.AddSubjectAsync(
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
environment: KeyEnvironment.Live,
reviewId: "<id>",
body: new ReviewSubjectRequest() {
Kind = ReviewSubjectKind.Account,
AccountId = "acct_7f3a9c",
AssessmentId = "asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
CredentialId = "cred_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
Reason = "Linked during review of the account evidence.",
ExpectedVersion = 691733,
}
);
// 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\ReviewSubjectRequest(
kind: Shared\ReviewSubjectKind::Account,
accountId: 'acct_7f3a9c',
assessmentId: 'asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
credentialId: 'cred_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
reason: 'Linked during review of the account evidence.',
expectedVersion: 691733,
);
$response = $sdk->reviews->addSubject(
workspaceId: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
environment: Shared\KeyEnvironment::Live,
reviewId: '<id>',
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.reviews.add_subject(workspace_id: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', environment: Models::Shared::KeyEnvironment::LIVE, review_id: '<id>', body: Models::Shared::ReviewSubjectRequest.new(
kind: Models::Shared::ReviewSubjectKind::ACCOUNT,
account_id: 'acct_7f3a9c',
assessment_id: 'asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
credential_id: 'cred_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
reason: 'Linked during review of the account evidence.',
expected_version: 691_733
))
unless res.nil?
# handle response
end
{
"review_version": 4503599627370496,
"subject": {
"id": "<string>",
"kind": "account",
"account_id": "<string>",
"risk_version": 4503599627370496,
"reason": "<string>",
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"assessment_id": "<string>",
"assessment_version": 4503599627370496,
"credential_id": "<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": "review_version_conflict",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 413,
"detail": "<string>",
"code": "payload_too_large",
"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
An assessment link also requires assessment_id and assessment_version; an issued_credential link also requires credential_id. Every reference must belong to account_id in this environment. Other kinds reject those fields.
Response
The link and resulting review version.