curl --request POST \
--url 'https://api.noresponse.org/v1/workspaces/tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM/exports' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"kind": "account",
"environment": "test",
"account_id": "acct_example",
"response_mode": "standard"
}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.exports.create({
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: {
kind: "account",
environment: "test",
accountId: "acct_example",
responseMode: "standard",
},
});
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.exports.create(workspace_id="tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", kind="account", environment="test", account_id="acct_example", response_mode="standard", filter_={
"action": "policy.updated",
"actor": "mem_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
"target_type": "setting",
"target_id": "policy",
"since": "2026-01-01T00:00:00Z",
"until": "2026-01-02T00:00:00Z",
})
# 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.Exports.Create(ctx, "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.CustomerExportRequest{
Kind: components.CustomerExportRequestKindAccount,
Environment: components.EnvironmentTest,
AccountID: noresponse.Pointer("acct_example"),
ResponseMode: components.ResponseModeStandard.ToPointer(),
}, nil)
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.CreateCustomerExportResponse;
import org.noresponse.models.shared.CustomerExportRequest;
import org.noresponse.models.shared.CustomerExportRequestKind;
import org.noresponse.models.shared.Environment;
import org.noresponse.models.shared.ResponseMode;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
CreateCustomerExportResponse res = sdk.exports().create()
.workspaceId("tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.body(CustomerExportRequest.builder()
.kind(CustomerExportRequestKind.ACCOUNT)
.environment(Environment.TEST)
.accountId("acct_example")
.responseMode(ResponseMode.STANDARD)
.build())
.call();
if (res.customerExport().isPresent()) {
System.out.println(res.customerExport().get());
}
}
}
using NoResponse;
using NoResponse.Models.Shared;
using System;
var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));
var res = await sdk.Exports.CreateAsync(
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: new CustomerExportRequest() {
Kind = CustomerExportRequestKind.Account,
Environment = NoResponse.Models.Shared.Environment.Test,
AccountId = "acct_example",
ResponseMode = ResponseMode.Standard,
}
);
// 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\CustomerExportRequest(
kind: Shared\CustomerExportRequestKind::Account,
environment: Shared\Environment::Test,
accountId: 'acct_example',
responseMode: Shared\ResponseMode::Standard,
);
$response = $sdk->exports->create(
workspaceId: 'tnt_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.exports.create(workspace_id: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', body: Models::Shared::CustomerExportRequest.new(
kind: Models::Shared::CustomerExportRequestKind::ACCOUNT,
environment: Models::Shared::Environment::TEST,
account_id: 'acct_example',
response_mode: Models::Shared::ResponseMode::STANDARD
))
unless res.nil?
# handle response
end
{
"id": "<string>",
"kind": "account",
"environment": "live",
"response_mode": "standard",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"records": 1,
"bytes": 33554432,
"chunks": 128,
"attempts": 1,
"generation": 5,
"request_sha256": "<string>",
"snapshot_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": "export_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": 429,
"detail": "<string>",
"code": "export_limit_reached",
"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 an account or audit export
Creates a job for an account export or a filtered audit export. The request fixes the environment, filters and response mode. The job reads one snapshot of retained records and writes encrypted JSON Lines chunks. Download starts only after the whole artifact completes.
An environment can run four exports at once. Each artifact holds at most 64 MiB, in chunks of at most 256 KiB. An oversized artifact fails without truncation. Artifacts expire within 24 hours, or sooner when their source records expire. Job metadata lasts seven days.
Send an Idempotency-Key to replay the same request safely. Reusing it for different criteria returns 409 export_conflict.
Poll the returned job and respect Retry-After. Account exports exclude investigator notes. Use the separate review export for those records.
Account exports hold submitted identifiers. They require legacy history, or exports and investigate with evidence or detailed. Audit exports require exports plus audit, or audit_manage. Detailed account exports always require evidence or detailed. Every operation checks your current scopes and the key’s environment. An export id alone grants no access.
curl --request POST \
--url 'https://api.noresponse.org/v1/workspaces/tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM/exports' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"kind": "account",
"environment": "test",
"account_id": "acct_example",
"response_mode": "standard"
}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.exports.create({
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: {
kind: "account",
environment: "test",
accountId: "acct_example",
responseMode: "standard",
},
});
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.exports.create(workspace_id="tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", kind="account", environment="test", account_id="acct_example", response_mode="standard", filter_={
"action": "policy.updated",
"actor": "mem_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
"target_type": "setting",
"target_id": "policy",
"since": "2026-01-01T00:00:00Z",
"until": "2026-01-02T00:00:00Z",
})
# 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.Exports.Create(ctx, "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.CustomerExportRequest{
Kind: components.CustomerExportRequestKindAccount,
Environment: components.EnvironmentTest,
AccountID: noresponse.Pointer("acct_example"),
ResponseMode: components.ResponseModeStandard.ToPointer(),
}, nil)
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.CreateCustomerExportResponse;
import org.noresponse.models.shared.CustomerExportRequest;
import org.noresponse.models.shared.CustomerExportRequestKind;
import org.noresponse.models.shared.Environment;
import org.noresponse.models.shared.ResponseMode;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
CreateCustomerExportResponse res = sdk.exports().create()
.workspaceId("tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
.body(CustomerExportRequest.builder()
.kind(CustomerExportRequestKind.ACCOUNT)
.environment(Environment.TEST)
.accountId("acct_example")
.responseMode(ResponseMode.STANDARD)
.build())
.call();
if (res.customerExport().isPresent()) {
System.out.println(res.customerExport().get());
}
}
}
using NoResponse;
using NoResponse.Models.Shared;
using System;
var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));
var res = await sdk.Exports.CreateAsync(
workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
body: new CustomerExportRequest() {
Kind = CustomerExportRequestKind.Account,
Environment = NoResponse.Models.Shared.Environment.Test,
AccountId = "acct_example",
ResponseMode = ResponseMode.Standard,
}
);
// 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\CustomerExportRequest(
kind: Shared\CustomerExportRequestKind::Account,
environment: Shared\Environment::Test,
accountId: 'acct_example',
responseMode: Shared\ResponseMode::Standard,
);
$response = $sdk->exports->create(
workspaceId: 'tnt_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.exports.create(workspace_id: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', body: Models::Shared::CustomerExportRequest.new(
kind: Models::Shared::CustomerExportRequestKind::ACCOUNT,
environment: Models::Shared::Environment::TEST,
account_id: 'acct_example',
response_mode: Models::Shared::ResponseMode::STANDARD
))
unless res.nil?
# handle response
end
{
"id": "<string>",
"kind": "account",
"environment": "live",
"response_mode": "standard",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"records": 1,
"bytes": 33554432,
"chunks": 128,
"attempts": 1,
"generation": 5,
"request_sha256": "<string>",
"snapshot_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": "export_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": 429,
"detail": "<string>",
"code": "export_limit_reached",
"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}$Body
The provider's own opaque identifier for the account being checked, scoped to the calling workspace. It must be provider-opaque and must not contain a direct identifier (email, phone, name, national id): that is a provider obligation the schema can only partly check. '|' is accepted so an Auth0 user id such as 'auth0|64abc' passes unchanged; '@', '+', '$' and whitespace are refused by the pattern, as is an exact-shape JWT; a hex digest such as a SHA-256 is allowed, because hashing an internal id is a common pseudonymous scheme. A value such as '07700900123' or 'jane.doe.gmail.com' cannot be told apart from an opaque id. It travels in bodies, and in a URL only as the path segment of GET /v1/accounts/{account_id}, its /assessments and its /links. An assessment requested by a provider hook at pre_registration, which has no account yet, carries the server-issued account_id pre: followed by its assessment_id.
1 - 128^[A-Za-z0-9][A-Za-z0-9._:|-]{0,127}$Response
Request an asynchronous customer export.