> ## Documentation Index > Fetch the complete documentation index at: https://docs.noresponse.org/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /openapi.json post /v1/workspaces/{workspace_id}/exports openapi: 3.1.0 info: title: NoResponse API version: '1' description: >- The NoResponse API assesses an account creation, login or purchase and answers with the account's one current risk: a 0 to 100 score, a decision for the flow (`allow`, `step_up`, `review` or `block`), the reasons behind it and the decision for each flow. The assessment's own facts, such as its status, confidence and incomplete sources, sit under `detail`. Authenticate every request with your API key as `Authorization: Bearer nrk_...`. Call the API only from your backend. Guides, SDKs and webhook verification are at [docs.noresponse.org](https://docs.noresponse.org/). Every error is an RFC 9457 problem document; see [Errors](https://docs.noresponse.org/reference/errors). servers: - url: https://api.noresponse.org description: Production security: - tenantBearer: [] tags: - name: assess x-displayName: Assessments x-group: Assessments description: Create, read and list assessments, and report outcomes. - name: accounts x-displayName: Accounts x-group: Accounts description: >- Each of your accounts holds one current risk, and its assessments are its history. - name: usage x-displayName: Key usage x-group: Key usage description: >- Report usage of the API keys that your account creation gate issued, so a shared or stolen key raises its account's risk. - name: keys x-displayName: API keys x-group: API keys description: >- Rotate your own API key and, with the `management` scope, create, list and revoke the keys of its environment. - name: settings x-displayName: Settings x-group: Settings description: >- Read and preview environment settings, run evaluations, and publish reviewed policy with separate permissions. - name: lists x-displayName: Lists x-group: Lists description: >- Preview, allow or block accounts that use an email or email domain. Publishing changes requires policy authority. - name: integrations x-displayName: Integrations x-group: Integrations description: >- Hosted endpoints that answer your WorkOS, Auth0 or Supabase sign-up and sign-in hooks. - name: webhooks x-displayName: Webhooks x-group: Webhooks description: Your webhook endpoints, and the signed events NoResponse sends to them. - name: workspaces x-displayName: Workspaces x-group: Workspaces description: >- Manage non-owner team access, read usage and audit events, configure audit streams, and export retained account or audit data. - name: requests x-displayName: Request diagnostics x-group: Request diagnostics description: Search retained request attempts and summarize their status and latency. - name: groups x-displayName: Groups x-group: Groups description: >- Screen a group's people: create the group, upload its list of people, start screenings and record a decision on each person. - name: reviews x-displayName: Reviews x-group: Reviews description: >- Investigate accounts with assignments, comments, linked evidence, saved filters and recorded resolutions. paths: /v1/workspaces/{workspace_id}/exports: post: tags: - workspaces summary: Start an account or audit export description: >- 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. operationId: createCustomerExport parameters: - $ref: '#/components/parameters/WorkspaceId' - name: Idempotency-Key in: header required: false schema: type: string minLength: 1 maxLength: 128 pattern: ^[!-~]+$ requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomerExportRequest' example: kind: account environment: test account_id: acct_example response_mode: standard responses: '202': $ref: '#/components/responses/createCustomerExportResult' '400': $ref: '#/components/responses/InvalidControlRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/ControlForbidden' '404': $ref: '#/components/responses/WorkspaceNotFound' '409': $ref: '#/components/responses/CustomerExportConflict' '413': $ref: '#/components/responses/PayloadTooLarge' '415': $ref: '#/components/responses/UnsupportedMediaType' '429': $ref: '#/components/responses/CustomerExportLimit' '503': $ref: '#/components/responses/ServiceUnavailable' security: - tenantBearer: [] x-codeSamples: - lang: curl label: cURL source: | 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" }' - lang: typescript label: TypeScript source: | 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(); - lang: python label: Python source: | 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) - lang: go label: Go source: "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tnoresponse \"github.com/noresponsehq/go/v12\"\n\t\"github.com/noresponsehq/go/v12/models/components\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := noresponse.New(\n noresponse.WithSecurity(os.Getenv(\"NORESPONSE_API_KEY\")),\n )\n\n res, err := s.Exports.Create(ctx, \"tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM\", components.CustomerExportRequest{\n Kind: components.CustomerExportRequestKindAccount,\n Environment: components.EnvironmentTest,\n AccountID: noresponse.Pointer(\"acct_example\"),\n ResponseMode: components.ResponseModeStandard.ToPointer(),\n }, nil)\n if err != nil {\n log.Fatal(err)\n }\n if res != nil {\n // handle response\n }\n}\n" - lang: java label: Java source: > 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()); } } } - lang: csharp label: C# source: > 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 - lang: php label: PHP source: | 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 - lang: ruby label: Ruby source: > 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 components: parameters: WorkspaceId: name: workspace_id in: path required: true schema: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,122}$ description: >- 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. description: >- 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. schemas: CustomerExportRequest: title: Create a customer export type: object additionalProperties: false required: - kind - environment properties: kind: enum: - account - audit environment: enum: - live - test - workspace account_id: type: string minLength: 1 maxLength: 128 pattern: ^[A-Za-z0-9][A-Za-z0-9._:|-]{0,127}$ description: >- 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. not: description: refused_text plus secret_encoded, for account_id. anyOf: - description: >- A NUL or line feed anywhere, refused with not beside anchored patterns. The parser refuses NUL in every request string. This guard also closes engines where $ accepts a final line feed. pattern: '[\x00\n]' - description: >- Exact shapes only: a complete modular-crypt password hash (bcrypt $2a$/$2b$/$2x$/$2y$ with a two-digit cost and 53 characters; $argon2i/d/id with its m, t, p parameters, salt and hash; md5-crypt $1$, sha256-crypt $5$ or sha512-crypt $6$ with a 22, 43 or 86 character hash; passlib $scrypt$ with ln, r, p, salt and hash) or a three-segment JWT whose header is base64url JSON opening with an "alg", "typ", "kid" or "cty" member (eyJhbGciOi, eyJ0eXAiOi, eyJraWQiOi or eyJjdHkiOi). A value that merely starts with '$2' or 'eyJ', such as eyJohnathan.doe.x, is not refused. Best effort, not a guarantee; see the provider obligation in the README. anyOf: - pattern: ^\$2[abxy]?\$[0-9]{2}\$[./A-Za-z0-9]{53}$ - pattern: >- ^\$argon2(?:id|i|d)\$(?:v=[0-9]{1,4}\$)?m=[0-9]{1,10},t=[0-9]{1,10},p=[0-9]{1,3}\$[A-Za-z0-9+/]{8,}\$[A-Za-z0-9+/]{16,}$ - pattern: >- ^\$[156]\$(?:rounds=[0-9]{1,9}\$)?[./A-Za-z0-9]{1,16}\$(?:[./A-Za-z0-9]{22}|[./A-Za-z0-9]{43}|[./A-Za-z0-9]{86})$ - pattern: >- ^\$scrypt\$ln=[0-9]{1,2},r=[0-9]{1,3},p=[0-9]{1,3}\$[A-Za-z0-9+/.]{8,}\$[A-Za-z0-9+/.]{16,}$ - pattern: >- ^eyJ(?:hbGciOi|0eXAiOi|raWQiOi|jdHkiOi)[A-Za-z0-9_-]*\.[A-Za-z0-9_-]{2,}\.[A-Za-z0-9_-]*$ response_mode: enum: - standard - detailed default: standard filter: type: object additionalProperties: false properties: action: type: string minLength: 1 maxLength: 64 pattern: ^[!-~]+$ actor: type: string minLength: 1 maxLength: 256 pattern: ^[!-~]+$ target_type: type: string minLength: 1 maxLength: 256 pattern: ^[!-~]+$ target_id: type: string minLength: 1 maxLength: 128 pattern: ^[!-~]+$ environment: enum: - live - test - workspace outcome: enum: - succeeded - denied since: type: string format: date-time until: type: string format: date-time allOf: - if: properties: kind: const: account then: required: - account_id properties: environment: enum: - live - test filter: not: minProperties: 1 else: not: required: - account_id properties: response_mode: const: standard CustomerExport: title: Customer export job type: object additionalProperties: false required: - id - kind - environment - response_mode - status - created_at - expires_at - records - bytes - chunks - attempts - generation - request_sha256 properties: id: type: string pattern: ^exp_[0-7][0-9A-HJKMNP-TV-Z]{25}$ kind: enum: - account - audit environment: enum: - live - test - workspace response_mode: enum: - standard - detailed status: enum: - queued - running - completed - failed - cancelled - expired created_at: type: string format: date-time snapshot_at: type: string format: date-time expires_at: type: string format: date-time finished_at: type: string format: date-time records: type: integer minimum: 0 bytes: type: integer minimum: 0 maximum: 67108864 chunks: type: integer minimum: 0 maximum: 257 attempts: type: integer minimum: 0 generation: type: integer minimum: 1 maximum: 10 error_code: type: string pattern: ^[a-z_]+$ request_sha256: type: string pattern: ^[a-f0-9]{64}$ Problem: title: Problem details error description: >- RFC 9457 problem-details error body returned by every non-2xx API response, extended with a stable machine code and request id. type: object additionalProperties: false required: - type - title - status - detail - code - request_id properties: type: type: string format: uri-reference title: type: string status: type: integer minimum: 400 maximum: 599 detail: type: string instance: type: string format: uri-reference code: type: string request_id: type: string minLength: 1 invalid_params: type: array items: type: object additionalProperties: false required: - field - reason properties: field: type: string minLength: 1 reason: type: string minLength: 1 example: type: string minLength: 1 responses: createCustomerExportResult: description: Request an asynchronous customer export. content: application/json: schema: $ref: '#/components/schemas/CustomerExport' headers: Cache-Control: schema: type: string const: no-store required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true Retry-After: description: >- Whole seconds to wait before polling or retrying. Required on 202, 429 and 503. schema: type: string pattern: >- ^(?:[1-9]|[1-9][0-9]|[1-9][0-9]{2}|[12][0-9]{3}|3[0-5][0-9]{2}|3600)$ description: Whole decimal seconds; wait at least this long. InvalidControlRequest: description: >- The body breaks its schema, or a console credential named no valid NR-Acting-User. headers: Cache-Control: schema: type: string const: no-store required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: status: const: 400 code: enum: - invalid_request Unauthorized: description: No API key, or one that is malformed, unknown, revoked or expired. headers: Cache-Control: schema: type: string const: no-store required: true WWW-Authenticate: schema: type: string const: Bearer realm="noresponse-assessments" required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: status: const: 401 code: enum: - unauthorized ControlForbidden: description: >- workspace_forbidden: an API key without the management scope, or any API key on a route other than the key, settings and list routes. role_forbidden: a console credential's acting user is an active member whose role does not grant the operation. headers: Cache-Control: schema: type: string const: no-store required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: status: const: 403 code: enum: - workspace_forbidden - role_forbidden WorkspaceNotFound: description: >- No such workspace, member, invite, key or environment for the caller. A workspace the acting user is not an active member of answers this too, as do another workspace and the other environment to an API key, so no answer shows which workspaces exist. headers: Cache-Control: schema: type: string const: no-store required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: status: const: 404 code: enum: - not_found CustomerExportConflict: description: >- State or idempotency conflict, expired artifact, or an unverified stream endpoint. Fetch current state before retrying. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: status: const: 409 code: const: export_conflict headers: Cache-Control: schema: type: string const: no-store required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true PayloadTooLarge: description: The body exceeds 32768 bytes. Refused before parsing. headers: Cache-Control: schema: type: string const: no-store required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: status: const: 413 code: enum: - payload_too_large UnsupportedMediaType: description: Content-Type is not application/json. headers: Cache-Control: schema: type: string const: no-store required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: status: const: 415 code: enum: - unsupported_media_type CustomerExportLimit: description: >- Too many active export jobs, or the calling key exceeded its request rate. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: status: const: 429 code: enum: - export_limit_reached - rate_limited headers: Cache-Control: schema: type: string const: no-store required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true Retry-After: $ref: '#/components/headers/Retry-After' ServiceUnavailable: description: >- The assessment could not be admitted at all (overload, shutdown or a dependency down). An assessment that was admitted answers partial or pending instead of 503. headers: Cache-Control: schema: type: string const: no-store required: true Retry-After: description: >- Whole seconds to wait before polling or retrying. Required on 202, 429 and 503. schema: type: string pattern: >- ^(?:[1-9]|[1-9][0-9]|[1-9][0-9]{2}|[12][0-9]{3}|3[0-5][0-9]{2}|3600)$ description: Whole decimal seconds; wait at least this long. required: true X-Request-ID: description: The request correlation id, 32 lowercase hexadecimal characters. schema: type: string pattern: ^[0-9a-f]{32}$ not: pattern: \n required: true content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - properties: status: const: 503 code: enum: - service_unavailable headers: Retry-After: description: >- Whole seconds to wait before polling or retrying. Required on 202, 429 and 503. schema: type: string pattern: ^(?:[1-9]|[1-9][0-9]|[1-9][0-9]{2}|[12][0-9]{3}|3[0-5][0-9]{2}|3600)$ description: Whole decimal seconds; wait at least this long. securitySchemes: tenantBearer: type: http scheme: bearer description: >- Your API key, sent as `Authorization: Bearer `. 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.