cURL
curl --request POST \
--url 'https://api.noresponse.org/v1/accounts/search' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"needs_action": false,
"limit": 25,
"identifier_expression": {
"scope": "account",
"expression": {
"and": [
{
"term": {
"kind": "phone",
"value": "+14155552671",
"match": "canonical"
}
},
{
"or": [
{
"term": {
"kind": "email",
"value": "case@example.com",
"match": "exact"
}
},
{
"term": {
"kind": "email",
"value": "other@example.com",
"match": "exact"
}
}
]
}
]
}
}
}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.accounts.search({
identifierExpression: {
scope: "account",
expression: {
and: [
{
term: {
kind: "phone",
value: "+14155552671",
match: "canonical",
},
},
{
or: [
{
term: {
kind: "email",
value: "case@example.com",
match: "exact",
},
},
{
term: {
kind: "email",
value: "other@example.com",
match: "exact",
},
},
],
},
],
},
},
});
console.log(result.total);
}
run();
from noresponse import NoResponse
import os
with NoResponse(
api_key=os.getenv("NORESPONSE_API_KEY", ""),
) as no_response:
res = no_response.accounts.search(identifier_expression={
"scope": "account",
"expression": {
"and_": [
{
"term": {
"kind": "phone",
"value": "+14155552671",
"match": "canonical",
},
},
{
"or_": [
{
"term": {
"kind": "email",
"value": "case@example.com",
"match": "exact",
},
},
{
"term": {
"kind": "email",
"value": "other@example.com",
"match": "exact",
},
},
],
},
],
},
}, limit=25)
# Handle response
if res.result is not None:
print(res.result.total)
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.Accounts.Search(ctx, components.AccountDirectorySearchRequest{
IdentifierExpression: &components.IdentifierExpression{
Scope: components.ScopeEnumAccount,
Expression: components.IdentifierExpressionNode{
And: []components.IdentifierExpressionNodeLevelTwo{
components.IdentifierExpressionNodeLevelTwo{
Term: &components.IdentifierSearch{
Kind: components.IdentifierSearchKindPhone,
Value: "+14155552671",
Match: components.MatchCanonical.ToPointer(),
},
},
components.IdentifierExpressionNodeLevelTwo{
Or: []components.IdentifierExpressionNodeLevelOne{
components.IdentifierExpressionNodeLevelOne{
Term: &components.IdentifierSearch{
Kind: components.IdentifierSearchKindEmail,
Value: "case@example.com",
Match: components.MatchExact.ToPointer(),
},
},
components.IdentifierExpressionNodeLevelOne{
Term: &components.IdentifierSearch{
Kind: components.IdentifierSearchKindEmail,
Value: "other@example.com",
Match: components.MatchExact.ToPointer(),
},
},
},
},
},
},
},
})
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
package hello.world;
import java.lang.Exception;
import java.util.List;
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.SearchAccountsResponse;
import org.noresponse.models.shared.AccountDirectorySearchRequest;
import org.noresponse.models.shared.IdentifierExpression;
import org.noresponse.models.shared.IdentifierExpressionNode;
import org.noresponse.models.shared.IdentifierExpressionNodeLevelOne;
import org.noresponse.models.shared.IdentifierExpressionNodeLevelTwo;
import org.noresponse.models.shared.IdentifierSearch;
import org.noresponse.models.shared.IdentifierSearchKind;
import org.noresponse.models.shared.Match;
import org.noresponse.models.shared.ScopeEnum;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
AccountDirectorySearchRequest req = AccountDirectorySearchRequest.builder()
.identifierExpression(IdentifierExpression.builder()
.scope(ScopeEnum.ACCOUNT)
.expression(IdentifierExpressionNode.builder()
.and(List.of(
IdentifierExpressionNodeLevelTwo.builder()
.term(IdentifierSearch.builder()
.kind(IdentifierSearchKind.PHONE)
.value("+14155552671")
.match(Match.CANONICAL)
.build())
.build(),
IdentifierExpressionNodeLevelTwo.builder()
.or(List.of(
IdentifierExpressionNodeLevelOne.builder()
.term(IdentifierSearch.builder()
.kind(IdentifierSearchKind.EMAIL)
.value("case@example.com")
.match(Match.EXACT)
.build())
.build(),
IdentifierExpressionNodeLevelOne.builder()
.term(IdentifierSearch.builder()
.kind(IdentifierSearchKind.EMAIL)
.value("other@example.com")
.match(Match.EXACT)
.build())
.build()))
.build()))
.build())
.build())
.build();
SearchAccountsResponse res = sdk.accounts().search()
.request(req)
.call();
if (res.accountDirectoryPage().isPresent()) {
System.out.println(res.accountDirectoryPage().get().total());
}
}
}
using NoResponse;
using NoResponse.Models.Shared;
using System;
using System.Collections.Generic;
var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));
AccountDirectorySearchRequest req = new AccountDirectorySearchRequest() {
IdentifierExpression = new IdentifierExpression() {
Scope = ScopeEnum.Account,
Expression = new IdentifierExpressionNode() {
And = new List<IdentifierExpressionNodeLevelTwo>() {
new IdentifierExpressionNodeLevelTwo() {
Term = new IdentifierSearch() {
Kind = IdentifierSearchKind.Phone,
Value = "+14155552671",
Match = Match.Canonical,
},
},
new IdentifierExpressionNodeLevelTwo() {
Or = new List<IdentifierExpressionNodeLevelOne>() {
new IdentifierExpressionNodeLevelOne() {
Term = new IdentifierSearch() {
Kind = IdentifierSearchKind.Email,
Value = "case@example.com",
Match = Match.Exact,
},
},
new IdentifierExpressionNodeLevelOne() {
Term = new IdentifierSearch() {
Kind = IdentifierSearchKind.Email,
Value = "other@example.com",
Match = Match.Exact,
},
},
},
},
},
},
},
};
var res = await sdk.Accounts.SearchAsync(req);
// 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();
$request = new Shared\AccountDirectorySearchRequest(
identifierExpression: new Shared\IdentifierExpression(
scope: Shared\ScopeEnum::Account,
expression: new Shared\IdentifierExpressionNode(
and: [
new Shared\IdentifierExpressionNodeLevelTwo(
term: new Shared\IdentifierSearch(
kind: Shared\IdentifierSearchKind::Phone,
value: '+14155552671',
match: Shared\MatchT::Canonical,
),
),
new Shared\IdentifierExpressionNodeLevelTwo(
or: [
new Shared\IdentifierExpressionNodeLevelOne(
term: new Shared\IdentifierSearch(
kind: Shared\IdentifierSearchKind::Email,
value: 'case@example.com',
match: Shared\MatchT::Exact,
),
),
new Shared\IdentifierExpressionNodeLevelOne(
term: new Shared\IdentifierSearch(
kind: Shared\IdentifierSearchKind::Email,
value: 'other@example.com',
match: Shared\MatchT::Exact,
),
),
],
),
],
),
),
);
$response = $sdk->accounts->search(
request: $request
);
$result = $response->result;
// handle response
require 'noresponse'
Models = ::NoResponse::Models
s = ::NoResponse::NoResponseClient.new(
api_key: ENV.fetch('NORESPONSE_API_KEY', '')
)
req = Models::Shared::AccountDirectorySearchRequest.new(
identifier_expression: Models::Shared::IdentifierExpression.new(
scope: Models::Shared::ScopeEnum::ACCOUNT,
expression: Models::Shared::IdentifierExpressionNode.new(
and_: [
Models::Shared::IdentifierExpressionNodeLevelTwo.new(
term: Models::Shared::IdentifierSearch.new(
kind: Models::Shared::IdentifierSearchKind::PHONE,
value: '+14155552671',
match: Models::Shared::Match::CANONICAL
)
),
Models::Shared::IdentifierExpressionNodeLevelTwo.new(
or_: [
Models::Shared::IdentifierExpressionNodeLevelOne.new(
term: Models::Shared::IdentifierSearch.new(
kind: Models::Shared::IdentifierSearchKind::EMAIL,
value: 'case@example.com',
match: Models::Shared::Match::EXACT
)
),
Models::Shared::IdentifierExpressionNodeLevelOne.new(
term: Models::Shared::IdentifierSearch.new(
kind: Models::Shared::IdentifierSearchKind::EMAIL,
value: 'other@example.com',
match: Models::Shared::Match::EXACT
)
),
]
),
]
)
)
)
res = s.accounts.search(request: req)
unless res.nil?
# handle response
end
{
"schema_version": "1",
"items": [
{
"account_id": "<string>",
"latest": {
"schema_version": "1",
"id": "<string>",
"status": "complete",
"flow": "account_creation",
"depth": "quick",
"detail": {
"schema_version": "1",
"assessment_id": "<string>",
"account_id": "<string>",
"status": "complete",
"confidence": "low",
"incomplete_sources": [
{
"lane": "accounts",
"reason": "timed_out"
}
],
"policy_version": "<string>",
"policy_basis": "heuristic_unvalidated",
"assessment_version": 500,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"timing": {
"deadline_ms": 1525,
"elapsed_ms": 300000
},
"identifiers": {
"email": "<string>",
"username": "<string>",
"phone": "<string>",
"name": "<string>",
"ip": "<string>"
},
"request_id": "<string>",
"recommendation": "allow",
"risk": {
"score": 50,
"band": "low",
"recommendation": "allow",
"confidence": "low",
"policy_version": "<string>",
"policy_basis": "heuristic_unvalidated",
"reasons": [
{
"code": "no_digital_footprint",
"direction": "raises",
"impact": "none",
"identifier": "email",
"list_entry_id": "<string>"
}
],
"coverage": {
"answered": 1,
"failed": 1,
"pending": 1
},
"block": true,
"block_threshold": 50,
"step_up_threshold": 50,
"review_threshold": 50,
"summary": {
"phone": {
"line_type": "mobile",
"country": "<string>",
"report_count": 1,
"carrier": "<string>"
},
"email": {
"disposable": true,
"accounts_found": 1,
"breach": {
"found": true,
"breach_count": 1,
"first_year": 2035,
"last_year": 2035,
"exposed": [
"email"
],
"in_credential_lists": true,
"recent_password_exposure": true,
"truncated": true
}
},
"username": {
"accounts_found": 1,
"breach": {
"found": true,
"breach_count": 1,
"first_year": 2035,
"last_year": 2035,
"exposed": [
"email"
],
"in_credential_lists": true,
"recent_password_exposure": true,
"truncated": true
}
},
"ip": {
"country": "<string>",
"type": "residential",
"asn": 2147483648,
"seen_in_workspace": 1
},
"consistency": {
"name": "match",
"phone": "match",
"ip": "match",
"country": "consistent"
},
"footprint": {
"families": [
"account_presence"
],
"email": {
"first_seen_year": 2035,
"last_seen_year": 2035,
"span_years": 1,
"sites": 2,
"families": [
"account_presence"
],
"last_active_year": 2035
},
"username": {
"first_seen_year": 2035,
"last_seen_year": 2035,
"span_years": 1,
"sites": 2,
"families": [
"account_presence"
],
"last_active_year": 2035
},
"coherence": {
"birth_date": {
"agreement": "match",
"values": 2,
"support": 2
},
"gender": {
"agreement": "match",
"values": 2,
"support": 2
},
"nationality": {
"agreement": "match",
"values": 2,
"support": 2
},
"country": {
"agreement": "match",
"values": 2,
"support": 2
},
"city": {
"agreement": "match",
"values": 2,
"support": 2
},
"zip": {
"agreement": "match",
"values": 2,
"support": 2
},
"name": {
"agreement": "match",
"values": 2,
"support": 2
},
"company": {
"agreement": "match",
"values": 2,
"support": 2
},
"website": {
"agreement": "match",
"values": 2,
"support": 2
},
"social": {
"agreement": "match",
"values": 2,
"support": 2
}
}
}
},
"details": {
"phone_names": [
{
"value": "<string>",
"seen_by": 2
}
],
"breaches": [
{
"name": "<string>",
"kind": "site_breach",
"matched_on": "email",
"domain": "<string>",
"category": "<string>",
"year": 2035,
"month": 6,
"exposed": [
"email"
],
"conduct": [
"chargeback"
]
}
],
"breach_names": [
{
"value": "<string>",
"seen_in": 2,
"sites": [
"<string>"
],
"unsited": 2
}
],
"events": [
{
"year": 2035,
"kind": "created",
"site": "<string>",
"category": "<string>",
"family": "account_presence",
"identifier": "email",
"month": 6
}
],
"accounts": [
{
"name": "<string>",
"domain": "<string>",
"identifier": "email",
"outcome": "found",
"reason": "timed_out",
"sign_in": [
"password"
],
"email_verified": true,
"blocked": true,
"account_type": "personal",
"has_avatar": true,
"first_name_prefix": "<string>"
}
],
"attribute_conflicts": [
{
"attribute": "birth_date",
"sites": [
"<string>"
],
"unsited": 2
}
]
}
},
"signals": [
{
"type": "<string>",
"identifier": "email",
"outcome": "found",
"source_id": "<string>",
"freshness": "fresh",
"reason": "timed_out",
"evidence_ref": "<string>",
"observed_at": "2023-11-07T05:31:56Z",
"last_checked_at": "2023-11-07T05:31:56Z",
"enrichment": {
"fields": {
"phone": "<string>",
"name": "<string>",
"carrier": "<string>",
"line_type": "<string>",
"entity_type": "<string>",
"country_code": "<string>",
"country": "<string>",
"state": "<string>",
"city": "<string>",
"location": "<string>",
"national_format": "<string>",
"job_title": "<string>",
"company_name": "<string>",
"email": "<string>",
"website": "<string>",
"first_call_at": "<string>",
"last_call_at": "<string>",
"matched_name": "<string>",
"alternate_names": [
"<string>"
],
"name_candidates": [
"<string>"
],
"timezones": [
"<string>"
],
"emails": [
"<string>"
],
"websites": [
"<string>"
],
"locations": [
"<string>"
],
"social_profiles": [
"<string>"
],
"report_count": 1,
"tag_count": 1,
"total_calls": 1,
"calls_60_days": 1,
"reports_60_days": 1,
"searches_60_days": 1,
"comment_count": 1,
"names_count": 1,
"spam_report_count": 1
}
}
}
],
"assessment_url": "<string>",
"auth_context": {
"provider": "<string>",
"issuer": "<string>",
"verified": true,
"transport": "backend",
"subject": "<string>",
"session_id": "<string>",
"organization_id": "<string>",
"hook_point": "pre_registration"
}
}
},
"assessments": 2,
"waiting_for": [
"outcome"
],
"current": {
"schema_version": "1",
"id": "<string>",
"risk": {
"score": 50,
"decision": "allow",
"reasons": [
{
"code": "no_digital_footprint",
"direction": "raises",
"impact": "none",
"identifier": "email",
"list_entry_id": "<string>"
}
]
},
"decisions_by_flow": {
"account_creation": "allow",
"login": "allow",
"purchase": "allow"
},
"assessment_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"risk_version": 2
},
"matched_identifier": {
"kind": "username",
"value": "JaneDoe",
"match_basis": "canonical",
"namespace": "customer",
"provenance": "submitted",
"assessment_id": "asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM"
},
"matched_identifiers": [
{
"kind": "username",
"value": "JaneDoe",
"match_basis": "canonical",
"namespace": "customer",
"provenance": "submitted",
"assessment_id": "asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
"term_index": 0
}
]
}
],
"total": 5000,
"total_capped": true,
"next_cursor": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 400,
"detail": "<string>",
"code": "invalid_request",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 401,
"detail": "<string>",
"code": "unauthorized",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "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"
}{
"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": 413,
"detail": "<string>",
"code": "payload_too_large",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 415,
"detail": "<string>",
"code": "unsupported_media_type",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "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"
}{
"type": "<string>",
"title": "<string>",
"status": 503,
"detail": "<string>",
"code": "service_unavailable",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}Accounts
Search distinct observed accounts by email or account ID
Search accounts observed in retained assessments in the authenticated workspace and environment. Each account appears once, with its latest retained assessment, current decision when available, and the number of retained assessments. This is not a complete directory of your application’s users.
Send an exact account ID or email, or neither to list all observed accounts. Email matching follows the same canonical mailbox rules as assessment search and matches any retained assessment belonging to the account. Email filtering requires permission to read submitted identifiers.
The server counts distinct accounts before paginating. Send next_cursor back with unchanged filters to continue. Totals are exact below 10000 and capped at 10000 otherwise. Pages are live and may change between requests, not a single snapshot spanning all pages.
Read-only and safe to retry. Requires history access. Cross-environment, expired or modified cursors are refused. No Idempotency-Key.
POST
/
v1
/
accounts
/
search
cURL
curl --request POST \
--url 'https://api.noresponse.org/v1/accounts/search' \
--header "Authorization: Bearer $NORESPONSE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"needs_action": false,
"limit": 25,
"identifier_expression": {
"scope": "account",
"expression": {
"and": [
{
"term": {
"kind": "phone",
"value": "+14155552671",
"match": "canonical"
}
},
{
"or": [
{
"term": {
"kind": "email",
"value": "case@example.com",
"match": "exact"
}
},
{
"term": {
"kind": "email",
"value": "other@example.com",
"match": "exact"
}
}
]
}
]
}
}
}'
import { NoResponse } from "@noresponse/node";
const noResponse = new NoResponse({
apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});
async function run() {
const result = await noResponse.accounts.search({
identifierExpression: {
scope: "account",
expression: {
and: [
{
term: {
kind: "phone",
value: "+14155552671",
match: "canonical",
},
},
{
or: [
{
term: {
kind: "email",
value: "case@example.com",
match: "exact",
},
},
{
term: {
kind: "email",
value: "other@example.com",
match: "exact",
},
},
],
},
],
},
},
});
console.log(result.total);
}
run();
from noresponse import NoResponse
import os
with NoResponse(
api_key=os.getenv("NORESPONSE_API_KEY", ""),
) as no_response:
res = no_response.accounts.search(identifier_expression={
"scope": "account",
"expression": {
"and_": [
{
"term": {
"kind": "phone",
"value": "+14155552671",
"match": "canonical",
},
},
{
"or_": [
{
"term": {
"kind": "email",
"value": "case@example.com",
"match": "exact",
},
},
{
"term": {
"kind": "email",
"value": "other@example.com",
"match": "exact",
},
},
],
},
],
},
}, limit=25)
# Handle response
if res.result is not None:
print(res.result.total)
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.Accounts.Search(ctx, components.AccountDirectorySearchRequest{
IdentifierExpression: &components.IdentifierExpression{
Scope: components.ScopeEnumAccount,
Expression: components.IdentifierExpressionNode{
And: []components.IdentifierExpressionNodeLevelTwo{
components.IdentifierExpressionNodeLevelTwo{
Term: &components.IdentifierSearch{
Kind: components.IdentifierSearchKindPhone,
Value: "+14155552671",
Match: components.MatchCanonical.ToPointer(),
},
},
components.IdentifierExpressionNodeLevelTwo{
Or: []components.IdentifierExpressionNodeLevelOne{
components.IdentifierExpressionNodeLevelOne{
Term: &components.IdentifierSearch{
Kind: components.IdentifierSearchKindEmail,
Value: "case@example.com",
Match: components.MatchExact.ToPointer(),
},
},
components.IdentifierExpressionNodeLevelOne{
Term: &components.IdentifierSearch{
Kind: components.IdentifierSearchKindEmail,
Value: "other@example.com",
Match: components.MatchExact.ToPointer(),
},
},
},
},
},
},
},
})
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
package hello.world;
import java.lang.Exception;
import java.util.List;
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.SearchAccountsResponse;
import org.noresponse.models.shared.AccountDirectorySearchRequest;
import org.noresponse.models.shared.IdentifierExpression;
import org.noresponse.models.shared.IdentifierExpressionNode;
import org.noresponse.models.shared.IdentifierExpressionNodeLevelOne;
import org.noresponse.models.shared.IdentifierExpressionNodeLevelTwo;
import org.noresponse.models.shared.IdentifierSearch;
import org.noresponse.models.shared.IdentifierSearchKind;
import org.noresponse.models.shared.Match;
import org.noresponse.models.shared.ScopeEnum;
public class Application {
public static void main(String[] args) throws Exception {
NoResponse sdk = NoResponse.builder()
.apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
.build();
AccountDirectorySearchRequest req = AccountDirectorySearchRequest.builder()
.identifierExpression(IdentifierExpression.builder()
.scope(ScopeEnum.ACCOUNT)
.expression(IdentifierExpressionNode.builder()
.and(List.of(
IdentifierExpressionNodeLevelTwo.builder()
.term(IdentifierSearch.builder()
.kind(IdentifierSearchKind.PHONE)
.value("+14155552671")
.match(Match.CANONICAL)
.build())
.build(),
IdentifierExpressionNodeLevelTwo.builder()
.or(List.of(
IdentifierExpressionNodeLevelOne.builder()
.term(IdentifierSearch.builder()
.kind(IdentifierSearchKind.EMAIL)
.value("case@example.com")
.match(Match.EXACT)
.build())
.build(),
IdentifierExpressionNodeLevelOne.builder()
.term(IdentifierSearch.builder()
.kind(IdentifierSearchKind.EMAIL)
.value("other@example.com")
.match(Match.EXACT)
.build())
.build()))
.build()))
.build())
.build())
.build();
SearchAccountsResponse res = sdk.accounts().search()
.request(req)
.call();
if (res.accountDirectoryPage().isPresent()) {
System.out.println(res.accountDirectoryPage().get().total());
}
}
}
using NoResponse;
using NoResponse.Models.Shared;
using System;
using System.Collections.Generic;
var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));
AccountDirectorySearchRequest req = new AccountDirectorySearchRequest() {
IdentifierExpression = new IdentifierExpression() {
Scope = ScopeEnum.Account,
Expression = new IdentifierExpressionNode() {
And = new List<IdentifierExpressionNodeLevelTwo>() {
new IdentifierExpressionNodeLevelTwo() {
Term = new IdentifierSearch() {
Kind = IdentifierSearchKind.Phone,
Value = "+14155552671",
Match = Match.Canonical,
},
},
new IdentifierExpressionNodeLevelTwo() {
Or = new List<IdentifierExpressionNodeLevelOne>() {
new IdentifierExpressionNodeLevelOne() {
Term = new IdentifierSearch() {
Kind = IdentifierSearchKind.Email,
Value = "case@example.com",
Match = Match.Exact,
},
},
new IdentifierExpressionNodeLevelOne() {
Term = new IdentifierSearch() {
Kind = IdentifierSearchKind.Email,
Value = "other@example.com",
Match = Match.Exact,
},
},
},
},
},
},
},
};
var res = await sdk.Accounts.SearchAsync(req);
// 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();
$request = new Shared\AccountDirectorySearchRequest(
identifierExpression: new Shared\IdentifierExpression(
scope: Shared\ScopeEnum::Account,
expression: new Shared\IdentifierExpressionNode(
and: [
new Shared\IdentifierExpressionNodeLevelTwo(
term: new Shared\IdentifierSearch(
kind: Shared\IdentifierSearchKind::Phone,
value: '+14155552671',
match: Shared\MatchT::Canonical,
),
),
new Shared\IdentifierExpressionNodeLevelTwo(
or: [
new Shared\IdentifierExpressionNodeLevelOne(
term: new Shared\IdentifierSearch(
kind: Shared\IdentifierSearchKind::Email,
value: 'case@example.com',
match: Shared\MatchT::Exact,
),
),
new Shared\IdentifierExpressionNodeLevelOne(
term: new Shared\IdentifierSearch(
kind: Shared\IdentifierSearchKind::Email,
value: 'other@example.com',
match: Shared\MatchT::Exact,
),
),
],
),
],
),
),
);
$response = $sdk->accounts->search(
request: $request
);
$result = $response->result;
// handle response
require 'noresponse'
Models = ::NoResponse::Models
s = ::NoResponse::NoResponseClient.new(
api_key: ENV.fetch('NORESPONSE_API_KEY', '')
)
req = Models::Shared::AccountDirectorySearchRequest.new(
identifier_expression: Models::Shared::IdentifierExpression.new(
scope: Models::Shared::ScopeEnum::ACCOUNT,
expression: Models::Shared::IdentifierExpressionNode.new(
and_: [
Models::Shared::IdentifierExpressionNodeLevelTwo.new(
term: Models::Shared::IdentifierSearch.new(
kind: Models::Shared::IdentifierSearchKind::PHONE,
value: '+14155552671',
match: Models::Shared::Match::CANONICAL
)
),
Models::Shared::IdentifierExpressionNodeLevelTwo.new(
or_: [
Models::Shared::IdentifierExpressionNodeLevelOne.new(
term: Models::Shared::IdentifierSearch.new(
kind: Models::Shared::IdentifierSearchKind::EMAIL,
value: 'case@example.com',
match: Models::Shared::Match::EXACT
)
),
Models::Shared::IdentifierExpressionNodeLevelOne.new(
term: Models::Shared::IdentifierSearch.new(
kind: Models::Shared::IdentifierSearchKind::EMAIL,
value: 'other@example.com',
match: Models::Shared::Match::EXACT
)
),
]
),
]
)
)
)
res = s.accounts.search(request: req)
unless res.nil?
# handle response
end
{
"schema_version": "1",
"items": [
{
"account_id": "<string>",
"latest": {
"schema_version": "1",
"id": "<string>",
"status": "complete",
"flow": "account_creation",
"depth": "quick",
"detail": {
"schema_version": "1",
"assessment_id": "<string>",
"account_id": "<string>",
"status": "complete",
"confidence": "low",
"incomplete_sources": [
{
"lane": "accounts",
"reason": "timed_out"
}
],
"policy_version": "<string>",
"policy_basis": "heuristic_unvalidated",
"assessment_version": 500,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"timing": {
"deadline_ms": 1525,
"elapsed_ms": 300000
},
"identifiers": {
"email": "<string>",
"username": "<string>",
"phone": "<string>",
"name": "<string>",
"ip": "<string>"
},
"request_id": "<string>",
"recommendation": "allow",
"risk": {
"score": 50,
"band": "low",
"recommendation": "allow",
"confidence": "low",
"policy_version": "<string>",
"policy_basis": "heuristic_unvalidated",
"reasons": [
{
"code": "no_digital_footprint",
"direction": "raises",
"impact": "none",
"identifier": "email",
"list_entry_id": "<string>"
}
],
"coverage": {
"answered": 1,
"failed": 1,
"pending": 1
},
"block": true,
"block_threshold": 50,
"step_up_threshold": 50,
"review_threshold": 50,
"summary": {
"phone": {
"line_type": "mobile",
"country": "<string>",
"report_count": 1,
"carrier": "<string>"
},
"email": {
"disposable": true,
"accounts_found": 1,
"breach": {
"found": true,
"breach_count": 1,
"first_year": 2035,
"last_year": 2035,
"exposed": [
"email"
],
"in_credential_lists": true,
"recent_password_exposure": true,
"truncated": true
}
},
"username": {
"accounts_found": 1,
"breach": {
"found": true,
"breach_count": 1,
"first_year": 2035,
"last_year": 2035,
"exposed": [
"email"
],
"in_credential_lists": true,
"recent_password_exposure": true,
"truncated": true
}
},
"ip": {
"country": "<string>",
"type": "residential",
"asn": 2147483648,
"seen_in_workspace": 1
},
"consistency": {
"name": "match",
"phone": "match",
"ip": "match",
"country": "consistent"
},
"footprint": {
"families": [
"account_presence"
],
"email": {
"first_seen_year": 2035,
"last_seen_year": 2035,
"span_years": 1,
"sites": 2,
"families": [
"account_presence"
],
"last_active_year": 2035
},
"username": {
"first_seen_year": 2035,
"last_seen_year": 2035,
"span_years": 1,
"sites": 2,
"families": [
"account_presence"
],
"last_active_year": 2035
},
"coherence": {
"birth_date": {
"agreement": "match",
"values": 2,
"support": 2
},
"gender": {
"agreement": "match",
"values": 2,
"support": 2
},
"nationality": {
"agreement": "match",
"values": 2,
"support": 2
},
"country": {
"agreement": "match",
"values": 2,
"support": 2
},
"city": {
"agreement": "match",
"values": 2,
"support": 2
},
"zip": {
"agreement": "match",
"values": 2,
"support": 2
},
"name": {
"agreement": "match",
"values": 2,
"support": 2
},
"company": {
"agreement": "match",
"values": 2,
"support": 2
},
"website": {
"agreement": "match",
"values": 2,
"support": 2
},
"social": {
"agreement": "match",
"values": 2,
"support": 2
}
}
}
},
"details": {
"phone_names": [
{
"value": "<string>",
"seen_by": 2
}
],
"breaches": [
{
"name": "<string>",
"kind": "site_breach",
"matched_on": "email",
"domain": "<string>",
"category": "<string>",
"year": 2035,
"month": 6,
"exposed": [
"email"
],
"conduct": [
"chargeback"
]
}
],
"breach_names": [
{
"value": "<string>",
"seen_in": 2,
"sites": [
"<string>"
],
"unsited": 2
}
],
"events": [
{
"year": 2035,
"kind": "created",
"site": "<string>",
"category": "<string>",
"family": "account_presence",
"identifier": "email",
"month": 6
}
],
"accounts": [
{
"name": "<string>",
"domain": "<string>",
"identifier": "email",
"outcome": "found",
"reason": "timed_out",
"sign_in": [
"password"
],
"email_verified": true,
"blocked": true,
"account_type": "personal",
"has_avatar": true,
"first_name_prefix": "<string>"
}
],
"attribute_conflicts": [
{
"attribute": "birth_date",
"sites": [
"<string>"
],
"unsited": 2
}
]
}
},
"signals": [
{
"type": "<string>",
"identifier": "email",
"outcome": "found",
"source_id": "<string>",
"freshness": "fresh",
"reason": "timed_out",
"evidence_ref": "<string>",
"observed_at": "2023-11-07T05:31:56Z",
"last_checked_at": "2023-11-07T05:31:56Z",
"enrichment": {
"fields": {
"phone": "<string>",
"name": "<string>",
"carrier": "<string>",
"line_type": "<string>",
"entity_type": "<string>",
"country_code": "<string>",
"country": "<string>",
"state": "<string>",
"city": "<string>",
"location": "<string>",
"national_format": "<string>",
"job_title": "<string>",
"company_name": "<string>",
"email": "<string>",
"website": "<string>",
"first_call_at": "<string>",
"last_call_at": "<string>",
"matched_name": "<string>",
"alternate_names": [
"<string>"
],
"name_candidates": [
"<string>"
],
"timezones": [
"<string>"
],
"emails": [
"<string>"
],
"websites": [
"<string>"
],
"locations": [
"<string>"
],
"social_profiles": [
"<string>"
],
"report_count": 1,
"tag_count": 1,
"total_calls": 1,
"calls_60_days": 1,
"reports_60_days": 1,
"searches_60_days": 1,
"comment_count": 1,
"names_count": 1,
"spam_report_count": 1
}
}
}
],
"assessment_url": "<string>",
"auth_context": {
"provider": "<string>",
"issuer": "<string>",
"verified": true,
"transport": "backend",
"subject": "<string>",
"session_id": "<string>",
"organization_id": "<string>",
"hook_point": "pre_registration"
}
}
},
"assessments": 2,
"waiting_for": [
"outcome"
],
"current": {
"schema_version": "1",
"id": "<string>",
"risk": {
"score": 50,
"decision": "allow",
"reasons": [
{
"code": "no_digital_footprint",
"direction": "raises",
"impact": "none",
"identifier": "email",
"list_entry_id": "<string>"
}
]
},
"decisions_by_flow": {
"account_creation": "allow",
"login": "allow",
"purchase": "allow"
},
"assessment_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"risk_version": 2
},
"matched_identifier": {
"kind": "username",
"value": "JaneDoe",
"match_basis": "canonical",
"namespace": "customer",
"provenance": "submitted",
"assessment_id": "asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM"
},
"matched_identifiers": [
{
"kind": "username",
"value": "JaneDoe",
"match_basis": "canonical",
"namespace": "customer",
"provenance": "submitted",
"assessment_id": "asm_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
"term_index": 0
}
]
}
],
"total": 5000,
"total_capped": true,
"next_cursor": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 400,
"detail": "<string>",
"code": "invalid_request",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 401,
"detail": "<string>",
"code": "unauthorized",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "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"
}{
"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": 413,
"detail": "<string>",
"code": "payload_too_large",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 415,
"detail": "<string>",
"code": "unsupported_media_type",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}{
"type": "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"
}{
"type": "<string>",
"title": "<string>",
"status": 503,
"detail": "<string>",
"code": "service_unavailable",
"request_id": "<string>",
"instance": "<string>",
"invalid_params": [
{
"field": "<string>",
"reason": "<string>",
"example": "<string>"
}
]
}Authorizations
Your API key, sent as Authorization: Bearer <key>. A key is nrk_live_ or nrk_test_, a 26-character key id, _ and a 43-character secret. Account, audit and usage data stay within the key's environment. Dedicated team scopes apply across the workspace.
assess creates and reads assessments, records outcomes and reports key usage. investigate reads accounts, assessment history and request diagnostics without export or enforcement access. The legacy history scope also permits account exports, submitted identifiers and enforcement reports. delete permits account and assessment deletion.
evidence or detailed adds detailed merged evidence and submitted identifiers where the operation permits them. Neither grants access to the underlying resource alone. exports permits exports with the underlying account or audit scope. audit reads audit events and usage reads usage. audit_manage manages audit streams and retention, and includes audit-read and export authority.
webhooks manages webhook endpoints. integrations manages hosted auth-provider integrations. management manages keys, settings, lists, reviews and policy evaluations in the key's environment. New keys cannot exceed the issuer's effective permissions.
settings reads configuration, previews policy and list changes, runs evaluations and changes retention. Publishing decision policy or changing lists requires settings and policy_publish together, or the legacy management scope.
groups creates and reads groups, adds people, starts and cancels screenings and records decisions on people, in the key's environment.
members reads the workspace directory. members_manage also administers non-owner members and invitations. These scopes require a live key issued by a current owner with access to both environments. They grant access across the workspace. management does not grant team access. API keys cannot change owners or accept invitations.
A missing, unknown, revoked or expired key answers 401. A valid key without a required scope answers 403.
Body
application/json
Bounded distinct-account search for one authenticated workspace/environment. identifier matches any retained admitted assessment of an account, including historical submitted values. email preserves the legacy canonical-mailbox filter. identifier and email cannot be combined. All other filters combine using AND. Typed identifier search uses stable opaque account order; ordinary and legacy email searches retain newest-seen ordering. Pages are live, not a cross-page snapshot. Requires history or investigate authority and identifier-read permission for identifier, identifier_expression or email filtering. identifier_expression explicitly chooses scope assessment (one whole matching submission) or account (terms may match different retained submissions of one account). At most 8 raw terms and 3 group levels. Mutually exclusive with identifier and email. Expression search uses the same stable opaque account order as typed identifier search.
Select accounts with a retained open or in-progress review, or a current review/block account decision with no retained effective account outcome. The server applies this filter before counting and pagination. Requires reviews.read as well as history.read for console members; API keys additionally require management.
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.
Required string length:
1 - 128Pattern:
^[A-Za-z0-9][A-Za-z0-9._:|-]{0,127}$Assessments of every account that one of its retained admitted assessments sent this mailbox as identifiers.email, matched as lists match an email entry: case-insensitive, a +tag removed and, at gmail.com and googlemail.com, the dots of the local part ignored. Only assessments stored since email list matching began carry the mailbox. An address that is not a valid mailbox is refused with 400.
Required string length:
3 - 254Pattern:
^[^\s\x00-\x1f\x7f]+$Every account that one of its retained admitted assessments sent an email of this domain or its subdomains, matched as lists match an email_domain entry and with the same identifier-read permission as email. A value that is not a registrable domain is refused with 400. Mutually exclusive with email, identifier and identifier_expression.
Required string length:
3 - 253Pattern:
^[^\s\x00-\x1f\x7f@]+$Opaque, expiring cursor bound to workspace, environment, operation and all filters, including expression scope, ordered structure and original term values. Keep grouping, operand order, matching modes and values unchanged; an omitted match is equivalent to exact. The page limit may change.
Required string length:
1 - 1024Pattern:
^[A-Za-z0-9_-]+$Match a retained assessment's submitted identifier directly. Mutually exclusive with identifier_expression and legacy email. All other supported filters combine using AND.
Show child attributes
Show child attributes
Example:
{ "kind": "username", "value": "janedoe", "match": "canonical", "namespace": "customer" }
Explicit bounded AND/OR combinations. Mutually exclusive with identifier and legacy email. Other supported filters combine using AND.
Show child attributes
Show child attributes
Example:
{ "scope": "assessment", "expression": { "and": [ { "term": { "kind": "phone", "value": "+14155552671", "match": "canonical" } }, { "or": [ { "term": { "kind": "email", "value": "case@example.com", "match": "exact" } }, { "term": { "kind": "email", "value": "other@example.com", "match": "exact" } } ] } ] } }
Response
Account-level paginated search results
Distinct observed accounts with retained assessments. Typed identifier searches use stable opaque account order, independent of newly submitted assessments; ordinary and legacy email searches use newest-seen order. One repeatable-read database snapshot supplies each page's rows and totals. Pages do not share a snapshot: new matching accounts may appear on a later page or before the cursor and be missed until a fresh search; retention, erasure and changed membership can remove results. Current account decisions are read separately and may advance during a page. Cursors bind the workspace/environment, operation and filters, expire, and cannot cross scopes. Erasure and retention always take precedence over pagination.