Read a person

cURL

curl --request GET \
  --url 'https://api.noresponse.org/v1/workspaces/tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM/groups/test/grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM/people/per_01JA2Z8K6Q4V7W9XBCDEFGHJKM' \
  --header "Authorization: Bearer $NORESPONSE_API_KEY"

import { NoResponse } from "@noresponse/node";

const noResponse = new NoResponse({
  apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});

async function run() {
  const result = await noResponse.groups.getPerson({
    workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
    environment: "test",
    groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
    personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
  });

  console.log(result);
}

run();

from noresponse import NoResponse
import os


with NoResponse(
    api_key=os.getenv("NORESPONSE_API_KEY", ""),
) as no_response:

    res = no_response.groups.get_person(workspace_id="tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", environment="test", group_id="grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", person_id="per_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.Groups.GetPerson(ctx, "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.KeyEnvironmentTest, "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
    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.GetPersonResponse;
import org.noresponse.models.shared.KeyEnvironment;

public class Application {

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

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

        GetPersonResponse res = sdk.groups().getPerson()
                .workspaceId("tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
                .environment(KeyEnvironment.TEST)
                .groupId("grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
                .personId("per_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
                .call();

        if (res.personReport().isPresent()) {
            System.out.println(res.personReport().get());
        }
    }
}

using NoResponse;
using NoResponse.Models.Shared;
using System;

var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));

var res = await sdk.Groups.GetPersonAsync(
    workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
    environment: KeyEnvironment.Test,
    groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
    personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM"
);

// 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();



$response = $sdk->groups->getPerson(
    workspaceId: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
    environment: Shared\KeyEnvironment::Test,
    groupId: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
    personId: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM'

);

$result = $response->result;
// handle response

require 'noresponse'

Models = ::NoResponse::Models
s = ::NoResponse::NoResponseClient.new(
  api_key: ENV.fetch('NORESPONSE_API_KEY', '')
)
res = s.groups.get_person(workspace_id: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', environment: Models::Shared::KeyEnvironment::TEST, group_id: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM', person_id: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM')

unless res.nil?
  # handle response
end

{
  "person": {
    "id": "per_01JC8Y2M4N6P8Q0R2S4T6V8W01",
    "group_id": "grp_01JC8Y1K3M5N7P9Q1R3S5T7V9W",
    "external_id": "reg-2048",
    "name": "Jordan Ellis",
    "email": "jordan.ellis@example.com",
    "city": "Leeds",
    "handles": [
      {
        "platform": "x",
        "handle": "jordan_ellis"
      }
    ],
    "match_state": "none_found",
    "highest_band": null,
    "decision": null,
    "coverage": {
      "accounts_found": 0,
      "accounts_accessible": 0,
      "items_read": 0,
      "platforms": [
        {
          "platform": "x",
          "status": "none_found",
          "accounts_found": 0,
          "items_read": 0
        }
      ]
    },
    "spend": {
      "total_minor": 2,
      "by_implementation": [
        {
          "implementation": "lookups",
          "role": "resolver",
          "spend_minor": 2
        }
      ]
    },
    "last_screening_id": "scn_01JC8Y3A5B7C9D1E3F5G7H9J1K",
    "screened_at": "2026-11-14T10:02:11Z",
    "created_at": "2026-11-14T10:00:00Z",
    "updated_at": "2026-11-14T10:02:11Z"
  },
  "profiles": [],
  "findings": [],
  "posts": [],
  "media": [],
  "reviews": [],
  "other_groups": {
    "total": 0,
    "items": []
  },
  "lookup": {
    "checks": [
      {
        "identifier": "email",
        "lane": "accounts",
        "status": "found",
        "sources": 4,
        "answered": 4,
        "found": 2
      },
      {
        "identifier": "email",
        "lane": "breach",
        "status": "found",
        "sources": 1,
        "answered": 1,
        "found": 1
      },
      {
        "identifier": "username",
        "lane": "accounts",
        "status": "found",
        "sources": 6,
        "answered": 6,
        "found": 1
      },
      {
        "identifier": "username",
        "lane": "breach",
        "status": "found",
        "sources": 1,
        "answered": 1,
        "found": 1
      }
    ],
    "records": [
      {
        "id": "rec_5c1e0d7a9b3f4e2d8a6c0b1f9e7d3a52",
        "source": {
          "connector": "github",
          "kind": "platform",
          "site": "github.com"
        },
        "matched": [
          {
            "by": "username",
            "field": "login"
          }
        ],
        "fields": [
          {
            "field": "login",
            "original": "jordan-ellis",
            "kind": "username",
            "role": "handle",
            "value": "jordan-ellis",
            "distinctive": {
              "rating": "distinctive",
              "reason": "34 bits, about one in 17 billion usernames"
            }
          },
          {
            "field": "id",
            "original": "48151623",
            "kind": "account_id",
            "role": "account_id",
            "value": "48151623"
          },
          {
            "field": "name",
            "original": "Jordan  Ellis",
            "kind": "person_name",
            "role": "display_name",
            "value": "Jordan Ellis",
            "distinctive": {
              "rating": "distinctive",
              "reason": "in 3 breach rows"
            }
          },
          {
            "field": "html_url",
            "original": "https://GitHub.com/jordan-ellis",
            "kind": "url",
            "role": "profile_link",
            "value": "https://github.com/jordan-ellis"
          },
          {
            "field": "avatar_url",
            "original": "https://avatars.githubusercontent.com/u/48151623",
            "kind": "image",
            "role": "picture",
            "value": "https://avatars.githubusercontent.com/u/48151623"
          },
          {
            "field": "bio",
            "original": "Security engineer. Climbing on weekends.",
            "kind": "long_text",
            "role": "bio",
            "value": "Security engineer. Climbing on weekends."
          },
          {
            "field": "location",
            "original": "Leeds, UK",
            "kind": "text",
            "role": "location",
            "value": "Leeds, UK"
          },
          {
            "field": "company",
            "original": "Northwind Example",
            "kind": "organisation",
            "role": "organisation",
            "value": "Northwind Example"
          },
          {
            "field": "twitter_username",
            "original": "jordan_ellis",
            "kind": "username",
            "role": "linked_account",
            "value": "jordan_ellis",
            "distinctive": {
              "rating": "distinctive",
              "reason": "33 bits, about one in 8.6 billion usernames"
            }
          },
          {
            "field": "followers",
            "original": "212",
            "kind": "count",
            "role": "followers",
            "value": "212"
          },
          {
            "field": "created_at",
            "original": "2014-03-07T09:30:00Z",
            "kind": "date_time",
            "role": "joined",
            "value": "2014-03-07T09:30:00Z"
          },
          {
            "field": "hireable",
            "original": "true",
            "kind": "flag",
            "value": "true"
          }
        ],
        "observed_at": "2026-11-14T10:01:40Z",
        "likelihood": 0.74,
        "agreed": [
          "name",
          "twitter_username"
        ],
        "clashed": [],
        "joined": true,
        "verdict": "joined"
      },
      {
        "id": "rec_8e2b4f6a1c3d5e7f9a0b2c4d6e8f1a3b",
        "source": {
          "connector": "breach",
          "kind": "site_breach",
          "site": "forum.example.net",
          "table": "FORUM_EXAMPLE_NET_2019",
          "date": "2019-03"
        },
        "matched": [
          {
            "by": "email",
            "field": "email"
          },
          {
            "by": "username",
            "field": "username",
            "search": "srh_01JC8Y5B7C9D1E3F5G7H9J1K3M"
          }
        ],
        "fields": [
          {
            "field": "birthday",
            "original": "07/03/1990",
            "kind": "date",
            "role": "born"
          },
          {
            "field": "email",
            "original": "Jordan.Ellis@Example.com",
            "kind": "email",
            "value": "jordan.ellis@example.com",
            "distinctive": {
              "rating": "unique",
              "reason": "an email address belongs to one person"
            }
          },
          {
            "field": "lastip",
            "original": "3405803781",
            "kind": "ip",
            "role": "last_ip",
            "value": "203.0.113.5",
            "distinctive": {
              "rating": "common",
              "reason": "many people share one IP address"
            }
          },
          {
            "field": "password",
            "original": "Leeds1990!",
            "kind": "password",
            "value": "Leeds1990!",
            "distinctive": {
              "rating": "distinctive",
              "reason": "seen twice in breach data; needs about 10^9 guesses"
            }
          },
          {
            "field": "password_hash",
            "original": "$2y$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy",
            "kind": "hash",
            "value": "$2y$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy",
            "detail": "bcrypt",
            "distinctive": {
              "rating": "distinctive",
              "reason": "in 1 breach row"
            }
          },
          {
            "field": "regdate",
            "original": "1394184600",
            "kind": "date_time",
            "role": "joined",
            "value": "2014-03-07T09:30:00Z"
          },
          {
            "field": "salt",
            "original": "x9Q",
            "kind": "salt",
            "value": "x9Q"
          },
          {
            "field": "usergroupid",
            "original": "2",
            "kind": "label",
            "role": "site_role",
            "value": "2"
          },
          {
            "field": "username",
            "original": "jellis",
            "kind": "username",
            "role": "handle",
            "value": "jellis",
            "distinctive": {
              "rating": "common",
              "reason": "19 bits, about one in 520 thousand usernames"
            }
          }
        ],
        "observed_at": "2026-11-14T10:01:42Z",
        "likelihood": 0.99,
        "agreed": [
          "regdate"
        ],
        "clashed": [],
        "joined": true
      }
    ],
    "remaining": [
      {
        "source": {
          "connector": "breach",
          "kind": "credential_list",
          "table": "COMBOLIST_EXAMPLE_2021",
          "date": "2021"
        },
        "by": "username",
        "search": "srh_01JC8Y5B7C9D1E3F5G7H9J1K3M",
        "rows": 37
      }
    ],
    "looked_at": "2026-11-14T10:01:42Z"
  },
  "searches": [
    {
      "search_id": "srh_01JC8Y5B7C9D1E3F5G7H9J1K3M",
      "record_id": "rec_8e2b4f6a1c3d5e7f9a0b2c4d6e8f1a3b",
      "field": "username",
      "kind": "username",
      "value": "jellis",
      "status": "completed",
      "sources": 3,
      "answered": 3,
      "found": 1,
      "estimated_spend": 2,
      "spent": 2,
      "requested_by": "usr_security_lead",
      "created_at": "2026-11-14T10:05:00Z",
      "finished_at": "2026-11-14T10:05:04Z"
    }
  ]
}

{
  "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": 503,
  "detail": "<string>",
  "code": "service_unavailable",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

GET

workspaces

{workspace_id}

groups

{environment}

{group_id}

people

{person_id}

cURL

curl --request GET \
  --url 'https://api.noresponse.org/v1/workspaces/tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM/groups/test/grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM/people/per_01JA2Z8K6Q4V7W9XBCDEFGHJKM' \
  --header "Authorization: Bearer $NORESPONSE_API_KEY"

import { NoResponse } from "@noresponse/node";

const noResponse = new NoResponse({
  apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});

async function run() {
  const result = await noResponse.groups.getPerson({
    workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
    environment: "test",
    groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
    personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
  });

  console.log(result);
}

run();

from noresponse import NoResponse
import os


with NoResponse(
    api_key=os.getenv("NORESPONSE_API_KEY", ""),
) as no_response:

    res = no_response.groups.get_person(workspace_id="tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", environment="test", group_id="grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", person_id="per_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.Groups.GetPerson(ctx, "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.KeyEnvironmentTest, "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM", "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
    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.GetPersonResponse;
import org.noresponse.models.shared.KeyEnvironment;

public class Application {

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

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

        GetPersonResponse res = sdk.groups().getPerson()
                .workspaceId("tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
                .environment(KeyEnvironment.TEST)
                .groupId("grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
                .personId("per_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
                .call();

        if (res.personReport().isPresent()) {
            System.out.println(res.personReport().get());
        }
    }
}

using NoResponse;
using NoResponse.Models.Shared;
using System;

var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));

var res = await sdk.Groups.GetPersonAsync(
    workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
    environment: KeyEnvironment.Test,
    groupId: "grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
    personId: "per_01JA2Z8K6Q4V7W9XBCDEFGHJKM"
);

// 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();



$response = $sdk->groups->getPerson(
    workspaceId: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
    environment: Shared\KeyEnvironment::Test,
    groupId: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
    personId: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM'

);

$result = $response->result;
// handle response

require 'noresponse'

Models = ::NoResponse::Models
s = ::NoResponse::NoResponseClient.new(
  api_key: ENV.fetch('NORESPONSE_API_KEY', '')
)
res = s.groups.get_person(workspace_id: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', environment: Models::Shared::KeyEnvironment::TEST, group_id: 'grp_01JA2Z8K6Q4V7W9XBCDEFGHJKM', person_id: 'per_01JA2Z8K6Q4V7W9XBCDEFGHJKM')

unless res.nil?
  # handle response
end

{
  "person": {
    "id": "per_01JC8Y2M4N6P8Q0R2S4T6V8W01",
    "group_id": "grp_01JC8Y1K3M5N7P9Q1R3S5T7V9W",
    "external_id": "reg-2048",
    "name": "Jordan Ellis",
    "email": "jordan.ellis@example.com",
    "city": "Leeds",
    "handles": [
      {
        "platform": "x",
        "handle": "jordan_ellis"
      }
    ],
    "match_state": "none_found",
    "highest_band": null,
    "decision": null,
    "coverage": {
      "accounts_found": 0,
      "accounts_accessible": 0,
      "items_read": 0,
      "platforms": [
        {
          "platform": "x",
          "status": "none_found",
          "accounts_found": 0,
          "items_read": 0
        }
      ]
    },
    "spend": {
      "total_minor": 2,
      "by_implementation": [
        {
          "implementation": "lookups",
          "role": "resolver",
          "spend_minor": 2
        }
      ]
    },
    "last_screening_id": "scn_01JC8Y3A5B7C9D1E3F5G7H9J1K",
    "screened_at": "2026-11-14T10:02:11Z",
    "created_at": "2026-11-14T10:00:00Z",
    "updated_at": "2026-11-14T10:02:11Z"
  },
  "profiles": [],
  "findings": [],
  "posts": [],
  "media": [],
  "reviews": [],
  "other_groups": {
    "total": 0,
    "items": []
  },
  "lookup": {
    "checks": [
      {
        "identifier": "email",
        "lane": "accounts",
        "status": "found",
        "sources": 4,
        "answered": 4,
        "found": 2
      },
      {
        "identifier": "email",
        "lane": "breach",
        "status": "found",
        "sources": 1,
        "answered": 1,
        "found": 1
      },
      {
        "identifier": "username",
        "lane": "accounts",
        "status": "found",
        "sources": 6,
        "answered": 6,
        "found": 1
      },
      {
        "identifier": "username",
        "lane": "breach",
        "status": "found",
        "sources": 1,
        "answered": 1,
        "found": 1
      }
    ],
    "records": [
      {
        "id": "rec_5c1e0d7a9b3f4e2d8a6c0b1f9e7d3a52",
        "source": {
          "connector": "github",
          "kind": "platform",
          "site": "github.com"
        },
        "matched": [
          {
            "by": "username",
            "field": "login"
          }
        ],
        "fields": [
          {
            "field": "login",
            "original": "jordan-ellis",
            "kind": "username",
            "role": "handle",
            "value": "jordan-ellis",
            "distinctive": {
              "rating": "distinctive",
              "reason": "34 bits, about one in 17 billion usernames"
            }
          },
          {
            "field": "id",
            "original": "48151623",
            "kind": "account_id",
            "role": "account_id",
            "value": "48151623"
          },
          {
            "field": "name",
            "original": "Jordan  Ellis",
            "kind": "person_name",
            "role": "display_name",
            "value": "Jordan Ellis",
            "distinctive": {
              "rating": "distinctive",
              "reason": "in 3 breach rows"
            }
          },
          {
            "field": "html_url",
            "original": "https://GitHub.com/jordan-ellis",
            "kind": "url",
            "role": "profile_link",
            "value": "https://github.com/jordan-ellis"
          },
          {
            "field": "avatar_url",
            "original": "https://avatars.githubusercontent.com/u/48151623",
            "kind": "image",
            "role": "picture",
            "value": "https://avatars.githubusercontent.com/u/48151623"
          },
          {
            "field": "bio",
            "original": "Security engineer. Climbing on weekends.",
            "kind": "long_text",
            "role": "bio",
            "value": "Security engineer. Climbing on weekends."
          },
          {
            "field": "location",
            "original": "Leeds, UK",
            "kind": "text",
            "role": "location",
            "value": "Leeds, UK"
          },
          {
            "field": "company",
            "original": "Northwind Example",
            "kind": "organisation",
            "role": "organisation",
            "value": "Northwind Example"
          },
          {
            "field": "twitter_username",
            "original": "jordan_ellis",
            "kind": "username",
            "role": "linked_account",
            "value": "jordan_ellis",
            "distinctive": {
              "rating": "distinctive",
              "reason": "33 bits, about one in 8.6 billion usernames"
            }
          },
          {
            "field": "followers",
            "original": "212",
            "kind": "count",
            "role": "followers",
            "value": "212"
          },
          {
            "field": "created_at",
            "original": "2014-03-07T09:30:00Z",
            "kind": "date_time",
            "role": "joined",
            "value": "2014-03-07T09:30:00Z"
          },
          {
            "field": "hireable",
            "original": "true",
            "kind": "flag",
            "value": "true"
          }
        ],
        "observed_at": "2026-11-14T10:01:40Z",
        "likelihood": 0.74,
        "agreed": [
          "name",
          "twitter_username"
        ],
        "clashed": [],
        "joined": true,
        "verdict": "joined"
      },
      {
        "id": "rec_8e2b4f6a1c3d5e7f9a0b2c4d6e8f1a3b",
        "source": {
          "connector": "breach",
          "kind": "site_breach",
          "site": "forum.example.net",
          "table": "FORUM_EXAMPLE_NET_2019",
          "date": "2019-03"
        },
        "matched": [
          {
            "by": "email",
            "field": "email"
          },
          {
            "by": "username",
            "field": "username",
            "search": "srh_01JC8Y5B7C9D1E3F5G7H9J1K3M"
          }
        ],
        "fields": [
          {
            "field": "birthday",
            "original": "07/03/1990",
            "kind": "date",
            "role": "born"
          },
          {
            "field": "email",
            "original": "Jordan.Ellis@Example.com",
            "kind": "email",
            "value": "jordan.ellis@example.com",
            "distinctive": {
              "rating": "unique",
              "reason": "an email address belongs to one person"
            }
          },
          {
            "field": "lastip",
            "original": "3405803781",
            "kind": "ip",
            "role": "last_ip",
            "value": "203.0.113.5",
            "distinctive": {
              "rating": "common",
              "reason": "many people share one IP address"
            }
          },
          {
            "field": "password",
            "original": "Leeds1990!",
            "kind": "password",
            "value": "Leeds1990!",
            "distinctive": {
              "rating": "distinctive",
              "reason": "seen twice in breach data; needs about 10^9 guesses"
            }
          },
          {
            "field": "password_hash",
            "original": "$2y$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy",
            "kind": "hash",
            "value": "$2y$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy",
            "detail": "bcrypt",
            "distinctive": {
              "rating": "distinctive",
              "reason": "in 1 breach row"
            }
          },
          {
            "field": "regdate",
            "original": "1394184600",
            "kind": "date_time",
            "role": "joined",
            "value": "2014-03-07T09:30:00Z"
          },
          {
            "field": "salt",
            "original": "x9Q",
            "kind": "salt",
            "value": "x9Q"
          },
          {
            "field": "usergroupid",
            "original": "2",
            "kind": "label",
            "role": "site_role",
            "value": "2"
          },
          {
            "field": "username",
            "original": "jellis",
            "kind": "username",
            "role": "handle",
            "value": "jellis",
            "distinctive": {
              "rating": "common",
              "reason": "19 bits, about one in 520 thousand usernames"
            }
          }
        ],
        "observed_at": "2026-11-14T10:01:42Z",
        "likelihood": 0.99,
        "agreed": [
          "regdate"
        ],
        "clashed": [],
        "joined": true
      }
    ],
    "remaining": [
      {
        "source": {
          "connector": "breach",
          "kind": "credential_list",
          "table": "COMBOLIST_EXAMPLE_2021",
          "date": "2021"
        },
        "by": "username",
        "search": "srh_01JC8Y5B7C9D1E3F5G7H9J1K3M",
        "rows": 37
      }
    ],
    "looked_at": "2026-11-14T10:01:42Z"
  },
  "searches": [
    {
      "search_id": "srh_01JC8Y5B7C9D1E3F5G7H9J1K3M",
      "record_id": "rec_8e2b4f6a1c3d5e7f9a0b2c4d6e8f1a3b",
      "field": "username",
      "kind": "username",
      "value": "jellis",
      "status": "completed",
      "sources": 3,
      "answered": 3,
      "found": 1,
      "estimated_spend": 2,
      "spent": 2,
      "requested_by": "usr_security_lead",
      "created_at": "2026-11-14T10:05:00Z",
      "finished_at": "2026-11-14T10:05:04Z"
    }
  ]
}

{
  "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": 503,
  "detail": "<string>",
  "code": "service_unavailable",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

workspace_id

string

required

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.

Pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,122}$

environment

enum<string>

required

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.

Available options:

live,

test

group_id

string

required

Pattern: ^grp_[0-7][0-9A-HJKMNP-TV-Z]{25}$

person_id

string

required

Pattern: ^per_[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response

The person, their matched profiles, findings and every recorded decision.

Everything known about one person, and where else in the environment they appear.

person

object

required

A person and where their screening and review stand.

Show child attributes

profiles

object[]

required

The accounts the latest screening matched, with how each was matched.

Maximum array length: 100

Show child attributes

findings

object[]

required

What the latest screening flagged, most severe first, each citing its evidence.

Maximum array length: 500

Show child attributes

posts

object[]

required

The posts the findings cite.

Maximum array length: 5000

Show child attributes

media

object[]

required

The images and videos the findings cite.

Maximum array length: 5000

Show child attributes

reviews

object[]

required

Every recorded decision, oldest first.

Maximum array length: 1000

Show child attributes

other_groups

object

required

The other groups of this environment where a person with the same email or phone appears, newest group first. History only: nothing in it changes this person's screening, band, match state or decision.

Show child attributes

lookup

object

What the latest screening's lookups found, and the records the searches people started found, each match naming its search. Absent until a screening that ran lookups reaches the person.

Show child attributes

searches

object[]

The searches people started on this person's values, newest first: each names the value, and the record and field it came from. Absent when nobody searched.

Maximum array length: 10000

Show child attributes

Overview

Using the API

Endpoints

Errors

Authorizations

Path Parameters

Response