> ## 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.

# Create or reuse a workspace person.

> Creates a person without a group. An explicit person_id or external_id reuses the named workspace person. A reference-only request keeps submitted details; identity supplied with that reference replaces those details. A shared email or phone never merges people. Suggested matches are returned only with people-read access. The workspace retention setting determines expires_at. An existing person keeps their original expiry. An Idempotency-Key returns the same retained person on retries, without creating another. Changed input with the same key answers 409 idempotency_key_reused. A customer reference that names another person or several people answers 409 person_reference_conflict.



## OpenAPI

````yaml /openapi.json post /v1/people
openapi: 3.1.0
info:
  title: NoResponse API
  version: '1'
  description: >-
    NoResponse is an identity and people risk engine. Create workspace people,
    start investigations, read complete source evidence and retain job history.
    Groups organize people for screening and contextual review. Account
    assessment uses the same engine for account creation, login and purchase
    decisions.


    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: people
    x-displayName: People
    x-group: People
    description: >-
      Retain people in one workspace environment, with submitted identity,
      expiry and source evidence.
  - name: investigations
    x-displayName: Investigations
    x-group: Investigations
    description: >-
      Start person investigations, read job history and record context-specific
      review decisions.
  - 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/people:
    post:
      tags:
        - people
      summary: Create or reuse a workspace person.
      description: >-
        Creates a person without a group. An explicit person_id or external_id
        reuses the named workspace person. A reference-only request keeps
        submitted details; identity supplied with that reference replaces those
        details. A shared email or phone never merges people. Suggested matches
        are returned only with people-read access. The workspace retention
        setting determines expires_at. An existing person keeps their original
        expiry. An Idempotency-Key returns the same retained person on retries,
        without creating another. Changed input with the same key answers 409
        idempotency_key_reused. A customer reference that names another person
        or several people answers 409 person_reference_conflict.
      operationId: createWorkspacePerson
      parameters:
        - $ref: '#/components/parameters/ResourceIdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspacePersonRequest'
      responses:
        '200':
          $ref: '#/components/responses/CreateWorkspacePerson200'
        '201':
          $ref: '#/components/responses/CreateWorkspacePerson201'
        '400':
          $ref: '#/components/responses/InvalidControlRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/WorkspaceForbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/CreateWorkspacePerson409'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - tenantBearer: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |
            curl --request POST \
              --url 'https://api.noresponse.org/v1/people' \
              --header "Authorization: Bearer $NORESPONSE_API_KEY" \
              --header 'Content-Type: application/json' \
              --header 'Idempotency-Key: request-01JA2Z8K6Q4V7W9XBCDEFGHJKM' \
              --data '{
              "external_id": "case-person-1042",
              "name": "Jordan Example",
              "email": "jordan@example.com"
            }'
        - 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.people.create({
                idempotencyKey: "request-01JA2Z8K6Q4V7W9XBCDEFGHJKM",
                body: {
                  externalId: "case-person-1042",
                  name: "Jordan Example",
                  email: "jordan@example.com",
                },
              });

              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.people.create(idempotency_key="request-01JA2Z8K6Q4V7W9XBCDEFGHJKM", external_id="case-person-1042", name="Jordan Example", email="jordan@example.com", phone="+14155550100", company="Example Ltd", city="Melbourne", handles=[
                    {
                        "platform": "bluesky",
                        "handle": "jordan_example",
                    },
                ], person_id="per_01JA2Z8K6Q4V7W9XBCDEFGHJKM")

                # 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/v14\"\n\t\"github.com/noresponsehq/go/v14/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.People.Create(ctx, components.WorkspacePersonRequest{\n        ExternalID: noresponse.Pointer(\"case-person-1042\"),\n        Name: noresponse.Pointer(\"Jordan Example\"),\n        Email: noresponse.Pointer(\"jordan@example.com\"),\n    }, noresponse.Pointer(\"request-01JA2Z8K6Q4V7W9XBCDEFGHJKM\"))\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.CreateWorkspacePersonResponse;

            import org.noresponse.models.shared.WorkspacePersonRequest;


            public class Application {

                public static void main(String[] args) throws Exception {

                    NoResponse sdk = NoResponse.builder()
                            .apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
                        .build();

                    CreateWorkspacePersonResponse res = sdk.people().create()
                            .idempotencyKey("request-01JA2Z8K6Q4V7W9XBCDEFGHJKM")
                            .body(WorkspacePersonRequest.builder()
                                .externalId("case-person-1042")
                                .name("Jordan Example")
                                .email("jordan@example.com")
                                .build())
                            .call();

                    if (res.workspacePersonResult().isPresent()) {
                        System.out.println(res.workspacePersonResult().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.People.CreateAsync(
                body: new WorkspacePersonRequest() {
                    ExternalId = "case-person-1042",
                    Name = "Jordan Example",
                    Email = "jordan@example.com",
                },
                idempotencyKey: "request-01JA2Z8K6Q4V7W9XBCDEFGHJKM"
            );


            // handle response
        - lang: php
          label: PHP
          source: |
            <?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\WorkspacePersonRequest(
                externalId: 'case-person-1042',
                name: 'Jordan Example',
                email: 'jordan@example.com',
            );

            $response = $sdk->people->create(
                body: $body,
                idempotencyKey: 'request-01JA2Z8K6Q4V7W9XBCDEFGHJKM'

            );

            $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.people.create(body:
            Models::Shared::WorkspacePersonRequest.new(
              external_id: 'case-person-1042',
              name: 'Jordan Example',
              email: 'jordan@example.com'
            ), idempotency_key: 'request-01JA2Z8K6Q4V7W9XBCDEFGHJKM')


            unless res.nil?
              # handle response
            end
components:
  parameters:
    ResourceIdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Opaque request key, 16 to 128 characters. Repeating the key and request
        returns the same resource in its current state while it is retained. A
        different request with the same key answers 409. Use a new key for a
        deliberate new operation. Keys are scoped to the environment and
        operation; person searches also scope them to the group and person.
      schema:
        type: string
        minLength: 16
        maxLength: 128
        pattern: ^[A-Za-z0-9._:-]{16,128}$
        not:
          pattern: \n
  schemas:
    WorkspacePersonRequest:
      type: object
      additionalProperties: false
      properties:
        external_id:
          type: string
          minLength: 1
          maxLength: 128
          description: >-
            Your reference for this person within the workspace environment.
            Only an explicit reference or person_id can reuse an existing
            person.
        name:
          type: string
          minLength: 1
          maxLength: 200
          description: The person's full name.
        email:
          type: string
          minLength: 3
          maxLength: 254
          pattern: ^[^@\s]+@[^@\s]+$
          description: The person's email.
        phone:
          type: string
          pattern: ^\+[1-9][0-9]{6,14}$
          description: The person's phone in E.164 form.
        company:
          type: string
          minLength: 1
          maxLength: 200
          description: Where the person works.
        city:
          type: string
          minLength: 1
          maxLength: 100
          description: Where the person lives.
        handles:
          allOf:
            - type: array
              maxItems: 20
              items:
                type: object
                additionalProperties: false
                required:
                  - platform
                  - handle
                properties:
                  platform:
                    type: string
                    pattern: ^[a-z][a-z0-9_]{0,63}$
                    description: >-
                      A platform a screening can cover, such as instagram, x,
                      bluesky, youtube, tiktok or github. A new platform adds an
                      id without changing this contract, so read a platform you
                      do not know in a response as one you have not seen before,
                      not as an error. synthetic is the deterministic
                      connector's own platform, for exercising the product end
                      to end with no network.
                  handle:
                    type: string
                    minLength: 1
                    maxLength: 100
                    description: The account's handle, without a leading @.
                description: An account the person is known to hold.
              description: Accounts the person is known to hold, at most 20.
          minItems: 1
        person_id:
          type: string
          pattern: ^per_[0-7][0-9A-HJKMNP-TV-Z]{25}$
      anyOf:
        - required:
            - name
        - required:
            - email
        - required:
            - phone
        - required:
            - handles
        - required:
            - person_id
        - required:
            - external_id
    WorkspacePersonResult:
      type: object
      additionalProperties: false
      required:
        - person
        - suggested_matches
        - created
      properties:
        person:
          type: object
          additionalProperties: false
          required:
            - id
            - created_at
            - updated_at
            - expires_at
          properties:
            external_id:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Your reference for this person within the workspace environment.
                Only an explicit reference or person_id can reuse an existing
                person.
            name:
              type: string
              maxLength: 200
            email:
              type: string
              minLength: 3
              maxLength: 254
              pattern: ^[^@\s]+@[^@\s]+$
              description: The person's email.
            phone:
              type: string
              pattern: ^\+[1-9][0-9]{6,14}$
              description: The person's phone in E.164 form.
            company:
              type: string
              minLength: 1
              maxLength: 200
              description: Where the person works.
            city:
              type: string
              minLength: 1
              maxLength: 100
              description: Where the person lives.
            handles:
              type: array
              maxItems: 20
              items:
                type: object
                additionalProperties: false
                required:
                  - platform
                  - handle
                properties:
                  platform:
                    type: string
                    pattern: ^[a-z][a-z0-9_]{0,63}$
                    description: >-
                      A platform a screening can cover, such as instagram, x,
                      bluesky, youtube, tiktok or github. A new platform adds an
                      id without changing this contract, so read a platform you
                      do not know in a response as one you have not seen before,
                      not as an error. synthetic is the deterministic
                      connector's own platform, for exercising the product end
                      to end with no network.
                  handle:
                    type: string
                    minLength: 1
                    maxLength: 100
                    description: The account's handle, without a leading @.
                description: An account the person is known to hold.
              description: Accounts the person is known to hold, at most 20.
            id:
              type: string
              pattern: ^per_[0-7][0-9A-HJKMNP-TV-Z]{25}$
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
            expires_at:
              type: string
              format: date-time
              description: >-
                The time the workspace retention policy removes this person,
                their evidence and investigation history. Shortening workspace
                retention can move this time earlier.
        suggested_matches:
          type: array
          maxItems: 20
          items:
            type: object
            additionalProperties: false
            required:
              - person_id
              - matched_on
            properties:
              person_id:
                type: string
                pattern: ^per_[0-7][0-9A-HJKMNP-TV-Z]{25}$
              matched_on:
                type: array
                minItems: 1
                maxItems: 2
                uniqueItems: true
                items:
                  enum:
                    - email
                    - phone
        created:
          type: boolean
    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:
    CreateWorkspacePerson200:
      description: Create or reuse a workspace person.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
        Cache-Control:
          $ref: '#/components/headers/Cache-Control'
        Location:
          $ref: '#/components/headers/Location'
        Idempotent-Replayed:
          $ref: '#/components/headers/Idempotent-Replayed'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WorkspacePersonResult'
    CreateWorkspacePerson201:
      description: Person created.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
        Cache-Control:
          $ref: '#/components/headers/Cache-Control'
        Location:
          $ref: '#/components/headers/Location'
        Idempotent-Replayed:
          $ref: '#/components/headers/Idempotent-Replayed'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WorkspacePersonResult'
    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
    WorkspaceForbidden:
      description: >-
        The API key is valid but may not use this operation: it lacks the
        operation's scope, or its workspace is not entitled or is suspended.
      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
          examples:
            missingScope:
              value:
                type: https://docs.noresponse.org/problems/workspace-forbidden
                title: Forbidden
                status: 403
                detail: The API key does not carry a scope this operation accepts.
                code: workspace_forbidden
                request_id: 0123456789abcdef0123456789abcdef
    NotFound:
      description: >-
        No unexpired assessment with this id for the calling workspace, or a
        malformed assessment_id.
      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
    CreateWorkspacePerson409:
      description: Idempotency input changed or the customer reference is ambiguous.
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - properties:
                  status:
                    const: 409
                  code:
                    enum:
                      - idempotency_key_reused
                      - person_reference_conflict
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
        Cache-Control:
          $ref: '#/components/headers/Cache-Control'
    RateLimited:
      description: >-
        The workspace's rate or concurrency limit is exhausted. Retry-After says
        when to retry; the provider applies its own fallback meanwhile.
      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: 429
                  code:
                    enum:
                      - rate_limited
          examples:
            limited:
              value:
                type: https://docs.noresponse.org/problems/rate-limited
                title: Rate limited
                status: 429
                detail: >-
                  The tenant's assessment rate is exhausted; retry after the
                  Retry-After interval.
                code: rate_limited
                request_id: 0123456789abcdef0123456789abcdef
    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:
    X-Request-ID:
      description: The request correlation id, 32 lowercase hexadecimal characters.
      schema:
        type: string
        pattern: ^[0-9a-f]{32}$
        not:
          pattern: \n
    Cache-Control:
      schema:
        type: string
        const: no-store
    Location:
      description: The polling URI of the assessment, /v1/assessments/{assessment_id}.
      schema:
        type: string
        maxLength: 64
        pattern: ^/v1/assessments/asm_[0-9A-HJKMNP-TV-Z]{26}$
        description: >-
          Server-relative path of the authoritative assessment, GET
          /v1/assessments/{assessment_id}.
        not:
          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]'
    Idempotent-Replayed:
      description: >-
        Present and true when this answer replays an earlier request with the
        same Idempotency-Key and body: the body is the latest assessment of the
        assessment that request created.
      schema:
        type: string
        const: 'true'
  securitySchemes:
    tenantBearer:
      type: http
      scheme: bearer
      description: >-
        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.


        `people` reads people, groups and investigations with full evidence by
        default. `people_write` changes submitted people, groups and
        memberships. `investigations` starts or cancels jobs and screenings.
        `decisions` records reviews. `exports` with people-read access exports
        rosters. `delete` deletes people, groups and memberships. Existing
        `groups` keys retain non-destructive people access. Explicit
        `evidence.read` restrictions withhold collected records, posts, media,
        discovered identifiers and notes.


        `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.