Class IdentityAdminQueryService

Unless need to directly act on an identity specifically, you should be using EntityService instead.

Extends IdentityCache for the bust seam its writer subclass needs, not for a read surface — this search is not cached today. Rooting it here is what lets IdentityAdminService bust the instance it reads through once it is, rather than a detached buster, whose delete cannot reach this instance's entries under a null client.

Hierarchy (View Summary)

IdentityCache
- IdentityAdminQueryService
  - IdentityAdminService

Index

Constructors

constructor

new IdentityAdminQueryService(
    __namedParameters: {
        db: B2bDatabase;
        valkeyClient: ValkeyClient | null;
    },
): IdentityAdminQueryService
Parameters
- __namedParameters: { db: B2bDatabase; valkeyClient: ValkeyClient | null }
Returns IdentityAdminQueryService
Overrides IdentityCache.constructor
- Defined in packages/entity-services/src/identity/IdentityAdminService.ts:239

Properties

`Protected` `Readonly`cache

cache: ServiceCache<
    CachedSearchPage<
        {
            achName: string;
            amlVerification?: { id: string; status: VerificationStatus } & {
                statusDescription: string;
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryCode: string;
            countryOfResidence: string;
            createdAt: Date;
            customerVerification?: { id: string };
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string;
            fullName: string;
            id: string;
            identityDocumentVerification?: { id: string; status: VerificationStatus } & {
                statusDescription: string;
            };
            metadata: Record<string, string>;
            name: { firstName: string; lastName: string; middleName?: string };
            phone: string;
            referenceId?: string;
            requiredInfo: RequiredInfoField[];
            status:
                | "PENDING_VERIFICATION"
                | "ACTION_REQUIRED"
                | "APPROVED"
                | "DISABLED"
                | "DELETED"
                | "REVIEW"
                | "BLOCKED";
            statusDescription: string;
            taxId?: string;
            type: "IDENTITY";
            updatedAt: Date;
            uuid: string;
            verificationProfileId?: string;
            verificationReasonCode?: | "OTHER"
            | "INVALID_TAX_ID"
            | "ADDRESS_MISMATCH"
            | "REGISTRY_NOT_FOUND"
            | "DOCUMENT_ISSUE"
            | "IDENTITY_MISMATCH";
            verificationReasonCodeDescription?: string;
            wireName: string;
        },
    >,
>

`Protected` `Readonly`db

db: B2bDatabase

`Static`instance

instance: (...args: []) => IdentityAdminQueryService = ...

The process default: built from each dependency's own instance().

Methods

get

get(
args: { customerId?: string; id: string; withVerificationReasons: true },
): Promise<{ ok: true; value: AdminIdentity | null }>
Parameters
- args: { customerId?: string; id: string; withVerificationReasons: true }
Returns Promise<{ ok: true; value: AdminIdentity | null }>
- Defined in packages/entity-services/src/identity/IdentityAdminService.ts:250
get(
    args: {
        customerId?: string;
        id: string;
        withVerificationReasons?: false;
    },
): Promise<{ ok: true; value: IdentityWithCustomer | null }>
Parameters
- args: { customerId?: string; id: string; withVerificationReasons?: false }
Returns Promise<{ ok: true; value: IdentityWithCustomer | null }>
- Defined in packages/entity-services/src/identity/IdentityAdminService.ts:255

invalidateCache

invalidateCache(
    __namedParameters: {
        customerIds: readonly string[];
        keys?: readonly CacheKey[];
        records?: readonly string[];
    },
): Promise<void>
Clear each customer's membership tag and each record tag wherever cached, and always this namespace's collection tag. keys are exact deletes in this instance's key space: the only bust a null client honours.
Parameters
- __namedParameters: {
      customerIds: readonly string[];
      keys?: readonly CacheKey[];
      records?: readonly string[];
  }
Returns Promise<void>
Inherited from IdentityCache.invalidateCache
- Defined in packages/db/src/valkey/service-cache.ts:543

`Protected`invalidateWrite

invalidateWrite(
__namedParameters: { customerId: string; id: string },
): Promise<void>
The bust every identity write makes, whatever it changed: its record tag in every namespace copying its columns, its customer's pages on both surfaces, and the folded get key, the one bust a null client honours.
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<void>
Inherited from IdentityCache.invalidateWrite
- Defined in packages/entity-services/src/identity/IdentityCache.ts:109

search

search(
    args: IdentityAdminSearchArgs & { withVerificationReasons: true },
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: AdminIdentity[]; total: number };
    },
>
Parameters
- args: IdentityAdminSearchArgs & { withVerificationReasons: true }
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: AdminIdentity[]; total: number };
    },
>
- Defined in packages/entity-services/src/identity/IdentityAdminService.ts:301
search(
    args: IdentityAdminSearchArgs & { withVerificationReasons?: false },
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: IdentityWithCustomer[]; total: number };
    },
>
Parameters
- args: IdentityAdminSearchArgs & { withVerificationReasons?: false }
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: IdentityWithCustomer[]; total: number };
    },
>
- Defined in packages/entity-services/src/identity/IdentityAdminService.ts:304

`Protected`searchTags

searchTags(
    __namedParameters: {
        customerIds: readonly string[] | undefined;
        fields?: readonly string[];
        records?: readonly string[];
    },
): string[]
Tags for a page: the scope its query searched (each customer's membership tag, else the collection tag), so an empty page is bustable too, plus the records it projects and the fields that chose or ordered its rows.
Parameters
- __namedParameters: {
      customerIds: readonly string[] | undefined;
      fields?: readonly string[];
      records?: readonly string[];
  }
Returns string[]
Inherited from IdentityCache.searchTags
- Defined in packages/db/src/valkey/service-cache.ts:519

`Static`getCacheKey

getCacheKey(
__namedParameters: { customerId: string; id: string },
): Record<string, unknown>
The exact cache key IdentityQueryService.get reads through.

get folds onto search, so its entry is an ordinary single-row search page — these args must stay identical to the ones get passes ({ customerId, ids: [id], pageSize: 1 }, with search's page default of 1). Every other search filter is undefined there, and serviceCacheKey canonicalizes with JCS, which drops undefined properties — so naming only the four that are set produces the same digest. identityCache.test.ts pins that equivalence.

Writers pass this to SearchCache.invalidateCache's keys so read-after-write holds in memory mode, where tag invalidation no-ops. The cache hashes and surface-prefixes it; this returns the arguments only.
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Record<string, unknown>
Inherited from IdentityCache.getCacheKey
- Defined in packages/entity-services/src/identity/IdentityCache.ts:94

`Static`serializeIdentity

serializeIdentity(
    identity: {
        achName: string;
        amlVerification?: { id: string; status: VerificationStatus } & {
            statusDescription: string;
        };
        capabilities: (
            | "TRANSACT"
            | "MANAGE_PAYMENT_INSTRUMENT"
            | "MANAGE_LEDGER_ACCOUNT"
            | "MANAGE_DEPOSIT_MEMO"
        )[];
        countryCode: string;
        countryOfResidence: string;
        createdAt: Date;
        customerVerification?: { id: string };
        dateOfBirth?: string;
        deletedAt?: Date;
        email: string;
        fullName: string;
        id: string;
        identityDocumentVerification?: { id: string; status: VerificationStatus } & {
            statusDescription: string;
        };
        metadata: Record<string, string>;
        name: { firstName: string; lastName: string; middleName?: string };
        phone: string;
        referenceId?: string;
        requiredInfo: RequiredInfoField[];
        status:
            | "PENDING_VERIFICATION"
            | "ACTION_REQUIRED"
            | "APPROVED"
            | "DISABLED"
            | "DELETED"
            | "REVIEW"
            | "BLOCKED";
        statusDescription: string;
        taxId?: string;
        type: "IDENTITY";
        updatedAt: Date;
        uuid: string;
        verificationProfileId?: string;
        verificationReasonCode?: | "OTHER"
        | "INVALID_TAX_ID"
        | "ADDRESS_MISMATCH"
        | "REGISTRY_NOT_FOUND"
        | "DOCUMENT_ISSUE"
        | "IDENTITY_MISMATCH";
        verificationReasonCodeDescription?: string;
        wireName: string;
    },
): CachedIdentity
Identity → the dashboard wire form. Not the cached shape; needs no cache instance.
Parameters
- identity: {
      achName: string;
      amlVerification?: { id: string; status: VerificationStatus } & {
          statusDescription: string;
      };
      capabilities: (
          | "TRANSACT"
          | "MANAGE_PAYMENT_INSTRUMENT"
          | "MANAGE_LEDGER_ACCOUNT"
          | "MANAGE_DEPOSIT_MEMO"
      )[];
      countryCode: string;
      countryOfResidence: string;
      createdAt: Date;
      customerVerification?: { id: string };
      dateOfBirth?: string;
      deletedAt?: Date;
      email: string;
      fullName: string;
      id: string;
      identityDocumentVerification?: { id: string; status: VerificationStatus } & {
          statusDescription: string;
      };
      metadata: Record<string, string>;
      name: { firstName: string; lastName: string; middleName?: string };
      phone: string;
      referenceId?: string;
      requiredInfo: RequiredInfoField[];
      status:
          | "PENDING_VERIFICATION"
          | "ACTION_REQUIRED"
          | "APPROVED"
          | "DISABLED"
          | "DELETED"
          | "REVIEW"
          | "BLOCKED";
      statusDescription: string;
      taxId?: string;
      type: "IDENTITY";
      updatedAt: Date;
      uuid: string;
      verificationProfileId?: string;
      verificationReasonCode?: | "OTHER"
      | "INVALID_TAX_ID"
      | "ADDRESS_MISMATCH"
      | "REGISTRY_NOT_FOUND"
      | "DOCUMENT_ISSUE"
      | "IDENTITY_MISMATCH";
      verificationReasonCodeDescription?: string;
      wireName: string;
  }
  - achName: string
  - OptionalamlVerification?: { id: string; status: VerificationStatus } & { statusDescription: string }
  - capabilities: (
        | "TRANSACT"
        | "MANAGE_PAYMENT_INSTRUMENT"
        | "MANAGE_LEDGER_ACCOUNT"
        | "MANAGE_DEPOSIT_MEMO"
    )[]
    
    What this identity is capable of executing currently
  - countryCode: string
    
    Country of jurisdiction; alias of countryOfResidence
  - countryOfResidence: string
  - createdAt: Date
  - OptionalcustomerVerification?: { id: string }
    
    Details of customer's own verification of the identity
    
    id: string
    
    Verification unique identifier in the customer's system
  - OptionaldateOfBirth?: string
    
    In ISO format: yyyy-MM-dd
  - OptionaldeletedAt?: Date
  - email: string
  - fullName: string
  - id: string
  - OptionalidentityDocumentVerification?: { id: string; status: VerificationStatus } & { statusDescription: string }
  - metadata: Record<string, string>
  - name: { firstName: string; lastName: string; middleName?: string }
  - phone: string
  - OptionalreferenceId?: string
  - requiredInfo: RequiredInfoField[]
    
    Field paths verification needs and the identity lacks; derived, never stored.
  - status:
        | "PENDING_VERIFICATION"
        | "ACTION_REQUIRED"
        | "APPROVED"
        | "DISABLED"
        | "DELETED"
        | "REVIEW"
        | "BLOCKED"
  - statusDescription: string
    
    The one label status is shown under, computed in SQL beside it.
  - OptionaltaxId?: string
    
    The person's own tax identification number — an SSN or ITIN for a US person, the local equivalent elsewhere. Stored as entered.
    
    Mirrors related_person.data.taxId: the two are the same fact about the same kind of party, and both forward to AiPrise the same way (additional_info: TAX_IDENTIFICATION_NUMBER on the identity-document verification run — AiPrise's user profile has no field for it).
  - type: "IDENTITY"
    
    Discriminator shared with Organization for mixed entity lists
  - updatedAt: Date
  - uuid: string
  - OptionalverificationProfileId?: string
    
    AiPrise user profile ID
    
    Only set if we verify the identity.
  - OptionalverificationReasonCode?:
        | "OTHER"
        | "INVALID_TAX_ID"
        | "ADDRESS_MISMATCH"
        | "REGISTRY_NOT_FOUND"
        | "DOCUMENT_ISSUE"
        | "IDENTITY_MISMATCH"
    
    Customer-safe; set while the verification is declined, in review or needs info.
  - OptionalverificationReasonCodeDescription?: string
  - wireName: string
Returns CachedIdentity
Inherited from IdentityCache.serializeIdentity
- Defined in packages/entity-services/src/identity/IdentityCache.ts:70

Class IdentityAdminQueryService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns IdentityAdminQueryService

Properties

Protected Readonlycache

Protected Readonlydb

Staticinstance

Methods

get

Parameters

Returns Promise<{ ok: true; value: AdminIdentity | null }>

Parameters

Returns Promise<{ ok: true; value: IdentityWithCustomer | null }>

invalidateCache

Parameters

Returns Promise<void>

ProtectedinvalidateWrite

Parameters

Returns Promise<void>

search

Parameters

Returns Promise< { ok: true; value: { hasNext: boolean; items: AdminIdentity[]; total: number }; },>

Parameters

Returns Promise< { ok: true; value: { hasNext: boolean; items: IdentityWithCustomer[]; total: number }; },>

ProtectedsearchTags

Parameters

Returns string[]

StaticgetCacheKey

Parameters

Returns Record<string, unknown>

StaticserializeIdentity

Parameters

achName: string

OptionalamlVerification?: { id: string; status: VerificationStatus } & { statusDescription: string }

capabilities: ( | "TRANSACT" | "MANAGE_PAYMENT_INSTRUMENT" | "MANAGE_LEDGER_ACCOUNT" | "MANAGE_DEPOSIT_MEMO")[]

countryCode: string

countryOfResidence: string

createdAt: Date

OptionalcustomerVerification?: { id: string }

id: string

OptionaldateOfBirth?: string

OptionaldeletedAt?: Date

email: string

fullName: string

id: string

OptionalidentityDocumentVerification?: { id: string; status: VerificationStatus } & { statusDescription: string }

metadata: Record<string, string>

name: { firstName: string; lastName: string; middleName?: string }

phone: string

OptionalreferenceId?: string

requiredInfo: RequiredInfoField[]

status: | "PENDING_VERIFICATION" | "ACTION_REQUIRED" | "APPROVED" | "DISABLED" | "DELETED" | "REVIEW" | "BLOCKED"

statusDescription: string

OptionaltaxId?: string

type: "IDENTITY"

updatedAt: Date

uuid: string

OptionalverificationProfileId?: string

OptionalverificationReasonCode?: | "OTHER" | "INVALID_TAX_ID" | "ADDRESS_MISMATCH" | "REGISTRY_NOT_FOUND" | "DOCUMENT_ISSUE" | "IDENTITY_MISMATCH"

OptionalverificationReasonCodeDescription?: string

wireName: string

Returns CachedIdentity

Settings

On This Page

`Protected` `Readonly`cache

`Protected` `Readonly`db

`Static`instance

`Protected`invalidateWrite

Returns Promise<
{
ok: true;
value: { hasNext: boolean; items: AdminIdentity[]; total: number };
},
>

Returns Promise<
{
ok: true;
value: { hasNext: boolean; items: IdentityWithCustomer[]; total: number };
},
>

`Protected`searchTags

`Static`getCacheKey

`Static`serializeIdentity

`Optional`amlVerification?: { id: string; status: VerificationStatus } & { statusDescription: string }

capabilities: (
| "TRANSACT"
| "MANAGE_PAYMENT_INSTRUMENT"
| "MANAGE_LEDGER_ACCOUNT"
| "MANAGE_DEPOSIT_MEMO"
)[]

`Optional`customerVerification?: { id: string }

`Optional`dateOfBirth?: string

`Optional`deletedAt?: Date

`Optional`identityDocumentVerification?: { id: string; status: VerificationStatus } & { statusDescription: string }

`Optional`referenceId?: string

status:
| "PENDING_VERIFICATION"
| "ACTION_REQUIRED"
| "APPROVED"
| "DISABLED"
| "DELETED"
| "REVIEW"
| "BLOCKED"

`Optional`taxId?: string

`Optional`verificationProfileId?: string

`Optional`verificationReasonCode?:
| "OTHER"
| "INVALID_TAX_ID"
| "ADDRESS_MISMATCH"
| "REGISTRY_NOT_FOUND"
| "DOCUMENT_ISSUE"
| "IDENTITY_MISMATCH"

`Optional`verificationReasonCodeDescription?: string