Class IdentityAdminService

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

Hierarchy (View Summary)

IdentityAdminQueryService
- IdentityAdminService

Index

Constructors

constructor

new IdentityAdminService(
    args: {
        aiPriseClient: AiPriseClient;
        customerService: CustomerService;
        defaultAiPriseTemplateIds: { aml: string; identityDocument: string };
        entityEventPublisher: EntityEventPublisher;
        sqlClient: Sql;
    },
): IdentityAdminService
Parameters
- args: {
      aiPriseClient: AiPriseClient;
      customerService: CustomerService;
      defaultAiPriseTemplateIds: { aml: string; identityDocument: string };
      entityEventPublisher: EntityEventPublisher;
      sqlClient: Sql;
  }
Returns IdentityAdminService
Overrides IdentityAdminQueryService.constructor
- Defined in packages/entity-services/src/identity/IdentityAdminService.ts:291

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`dbHelper

dbHelper: DbHelper

Methods

get

get(
    __namedParameters: { customerId?: string; id: string },
): Promise<
    {
        ok: true;
        value: | {
            amlVerification?: {
                id: string;
                status: "PENDING"
                | "REVIEW"
                | "APPROVED"
                | "DECLINED";
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryOfResidence: string;
            createdAt: Date;
            customerVerification?: { id: string };
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string;
            id: string;
            identityDocumentVerification?: {
                id: string;
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
            };
            name?: { firstName: string; lastName: string; middleName?: string };
            phone: string;
            referenceId?: string;
            status:
                | "ACTIVE"
                | "DISABLED"
                | "PENDING_VERIFICATION"
                | "REVIEW"
                | "BLOCKED"
                | "DELETED";
            updatedAt: Date;
            uuid: string;
            verificationProfileId?: string;
        } & { customerId: string }
        | null;
    },
>
Parameters
- __namedParameters: { customerId?: string; id: string }
Returns Promise<
    {
        ok: true;
        value: | {
            amlVerification?: {
                id: string;
                status: "PENDING"
                | "REVIEW"
                | "APPROVED"
                | "DECLINED";
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryOfResidence: string;
            createdAt: Date;
            customerVerification?: { id: string };
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string;
            id: string;
            identityDocumentVerification?: {
                id: string;
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
            };
            name?: { firstName: string; lastName: string; middleName?: string };
            phone: string;
            referenceId?: string;
            status:
                | "ACTIVE"
                | "DISABLED"
                | "PENDING_VERIFICATION"
                | "REVIEW"
                | "BLOCKED"
                | "DELETED";
            updatedAt: Date;
            uuid: string;
            verificationProfileId?: string;
        } & { customerId: string }
        | null;
    },
>
Inherited from IdentityAdminQueryService.get
- Defined in packages/entity-services/src/identity/IdentityAdminService.ts:51

search

search(
    __namedParameters: {
        amlVerificationStatuses?: (
            "PENDING"
            | "REVIEW"
            | "APPROVED"
            | "DECLINED"
        )[];
        countriesOfResidence?: string[];
        createdAt?: DbTimestampCriteria;
        customerIds?: string[];
        emailLike?: string;
        emails?: string[];
        hasCustomerVerification?: boolean;
        identityDocumentVerificationStatuses?: (
            "PENDING"
            | "REVIEW"
            | "APPROVED"
            | "DECLINED"
        )[];
        ids?: string[];
        nameLike?: string;
        orderBy?: DbOrderByCriterion<
            Omit<
                PgTableWithColumns<
                    {
                        columns: {
                            countryOfResidence: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "countryOfResidence";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            createdAt: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgTimestamp";
                                    data: Date;
                                    dataType: "date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "createdAt";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            customerId: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgInteger";
                                    data: number;
                                    dataType: "number";
                                    driverParam: (...)
                                    | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "customerId";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            data: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgJsonb";
                                    data: { dateOfBirth?: ... };
                                    dataType: "json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "data";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                { $type: { dateOfBirth?: ... } },
                            >;
                            deletedAt: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgTimestamp";
                                    data: Date;
                                    dataType: "date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "deletedAt";
                                    notNull: false;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            email: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "email";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            externalId: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: true;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "externalId";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            id: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgInteger";
                                    data: number;
                                    dataType: "number";
                                    driverParam: (...)
                                    | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: "byDefault";
                                    isAutoincrement: false;
                                    isPrimaryKey: true;
                                    name: "id";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            name: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgJsonb";
                                    data: { firstName: ...; lastName: ...; middleName?: ... };
                                    dataType: "json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "name";
                                    notNull: false;
                                    tableName: "identity";
                                },
                                {},
                                { $type: { firstName: ...; lastName: ...; middleName?: ... } },
                            >;
                            phone: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "phone";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            referenceId: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "referenceId";
                                    notNull: false;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            status: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "status";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                { $type: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...) },
                            >;
                            updatedAt: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgTimestamp";
                                    data: Date;
                                    dataType: "date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "updatedAt";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            uuid: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgUUID";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "uuid";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            verification: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgJsonb";
                                    data: {
                                        amlVerification?: ...;
                                        customerVerification?: ...;
                                        identityDocumentVerification?: ...;
                                        verificationProfileId?: ...;
                                    };
                                    dataType: "json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "verification";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {
                                    $type: {
                                        amlVerification?: ...;
                                        customerVerification?: ...;
                                        identityDocumentVerification?: ...;
                                        verificationProfileId?: ...;
                                    };
                                },
                            >;
                        };
                        dialect: "pg";
                        name: "identity";
                        schema: "b2b";
                    },
                >,
                "enableRLS",
            >,
            "createdAt"
            | "updatedAt",
        >[];
        page?: number;
        pageSize?: number;
        phoneLike?: string;
        phones?: string[];
        referenceIdLike?: string;
        referenceIds?: string[];
        statuses?: (
            | "ACTIVE"
            | "DISABLED"
            | "PENDING_VERIFICATION"
            | "REVIEW"
            | "BLOCKED"
            | "DELETED"
        )[];
        updatedAt?: DbTimestampCriteria;
    },
): Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: (
                {
                    amlVerification?: {
                        id: string;
                        status: "PENDING"
                        | "REVIEW"
                        | "APPROVED"
                        | "DECLINED";
                    };
                    capabilities: (
                        | "TRANSACT"
                        | "MANAGE_PAYMENT_INSTRUMENT"
                        | "MANAGE_LEDGER_ACCOUNT"
                        | "MANAGE_DEPOSIT_MEMO"
                    )[];
                    countryOfResidence: string;
                    createdAt: Date;
                    customerVerification?: { id: string };
                    dateOfBirth?: string;
                    deletedAt?: Date;
                    email: string;
                    id: string;
                    identityDocumentVerification?: {
                        id: string;
                        status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                    };
                    name?: { firstName: string; lastName: string; middleName?: string };
                    phone: string;
                    referenceId?: string;
                    status:
                        | "ACTIVE"
                        | "DISABLED"
                        | "PENDING_VERIFICATION"
                        | "REVIEW"
                        | "BLOCKED"
                        | "DELETED";
                    updatedAt: Date;
                    uuid: string;
                    verificationProfileId?: string;
                } & { customerId: string }
            )[];
        };
    },
>
Parameters
- __namedParameters: {
      amlVerificationStatuses?: (
          "PENDING"
          | "REVIEW"
          | "APPROVED"
          | "DECLINED"
      )[];
      countriesOfResidence?: string[];
      createdAt?: DbTimestampCriteria;
      customerIds?: string[];
      emailLike?: string;
      emails?: string[];
      hasCustomerVerification?: boolean;
      identityDocumentVerificationStatuses?: (
          "PENDING"
          | "REVIEW"
          | "APPROVED"
          | "DECLINED"
      )[];
      ids?: string[];
      nameLike?: string;
      orderBy?: DbOrderByCriterion<
          Omit<
              PgTableWithColumns<
                  {
                      columns: {
                          countryOfResidence: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "countryOfResidence";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          createdAt: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgTimestamp";
                                  data: Date;
                                  dataType: "date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "createdAt";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          customerId: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgInteger";
                                  data: number;
                                  dataType: "number";
                                  driverParam: (...)
                                  | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "customerId";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          data: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgJsonb";
                                  data: { dateOfBirth?: ... };
                                  dataType: "json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "data";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              { $type: { dateOfBirth?: ... } },
                          >;
                          deletedAt: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgTimestamp";
                                  data: Date;
                                  dataType: "date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "deletedAt";
                                  notNull: false;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          email: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "email";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          externalId: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: true;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "externalId";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          id: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgInteger";
                                  data: number;
                                  dataType: "number";
                                  driverParam: (...)
                                  | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: "byDefault";
                                  isAutoincrement: false;
                                  isPrimaryKey: true;
                                  name: "id";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          name: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgJsonb";
                                  data: { firstName: ...; lastName: ...; middleName?: ... };
                                  dataType: "json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "name";
                                  notNull: false;
                                  tableName: "identity";
                              },
                              {},
                              { $type: { firstName: ...; lastName: ...; middleName?: ... } },
                          >;
                          phone: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "phone";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          referenceId: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "referenceId";
                                  notNull: false;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          status: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...);
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "status";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              { $type: (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...) },
                          >;
                          updatedAt: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgTimestamp";
                                  data: Date;
                                  dataType: "date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "updatedAt";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          uuid: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgUUID";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "uuid";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          verification: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgJsonb";
                                  data: {
                                      amlVerification?: ...;
                                      customerVerification?: ...;
                                      identityDocumentVerification?: ...;
                                      verificationProfileId?: ...;
                                  };
                                  dataType: "json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "verification";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {
                                  $type: {
                                      amlVerification?: ...;
                                      customerVerification?: ...;
                                      identityDocumentVerification?: ...;
                                      verificationProfileId?: ...;
                                  };
                              },
                          >;
                      };
                      dialect: "pg";
                      name: "identity";
                      schema: "b2b";
                  },
              >,
              "enableRLS",
          >,
          "createdAt"
          | "updatedAt",
      >[];
      page?: number;
      pageSize?: number;
      phoneLike?: string;
      phones?: string[];
      referenceIdLike?: string;
      referenceIds?: string[];
      statuses?: (
          | "ACTIVE"
          | "DISABLED"
          | "PENDING_VERIFICATION"
          | "REVIEW"
          | "BLOCKED"
          | "DELETED"
      )[];
      updatedAt?: DbTimestampCriteria;
  }
  - OptionalamlVerificationStatuses?: ("PENDING" | "REVIEW" | "APPROVED" | "DECLINED")[]
  - OptionalcountriesOfResidence?: string[]
  - OptionalcreatedAt?: DbTimestampCriteria
  - OptionalcustomerIds?: string[]
  - OptionalemailLike?: string
    Partial match on email
  - Optionalemails?: string[]
  - OptionalhasCustomerVerification?: boolean
    Identities that have customer verification or don't. undefined will return either.
  - OptionalidentityDocumentVerificationStatuses?: ("PENDING" | "REVIEW" | "APPROVED" | "DECLINED")[]
  - Optionalids?: string[]
    Fetch multiple ids
  - OptionalnameLike?: string
    Partial match on first, middle, last name or full name
  - OptionalorderBy?: DbOrderByCriterion<
        Omit<
            PgTableWithColumns<
                {
                    columns: {
                        countryOfResidence: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "countryOfResidence";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        createdAt: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgTimestamp";
                                data: Date;
                                dataType: "date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "createdAt";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        customerId: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgInteger";
                                data: number;
                                dataType: "number";
                                driverParam: (...)
                                | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "customerId";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        data: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgJsonb";
                                data: { dateOfBirth?: ... };
                                dataType: "json";
                                driverParam: unknown;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "data";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            { $type: { dateOfBirth?: ... } },
                        >;
                        deletedAt: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgTimestamp";
                                data: Date;
                                dataType: "date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "deletedAt";
                                notNull: false;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        email: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "email";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        externalId: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: true;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "externalId";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        id: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgInteger";
                                data: number;
                                dataType: "number";
                                driverParam: (...)
                                | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: "byDefault";
                                isAutoincrement: false;
                                isPrimaryKey: true;
                                name: "id";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        name: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgJsonb";
                                data: { firstName: ...; lastName: ...; middleName?: ... };
                                dataType: "json";
                                driverParam: unknown;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "name";
                                notNull: false;
                                tableName: "identity";
                            },
                            {},
                            { $type: { firstName: ...; lastName: ...; middleName?: ... } },
                        >;
                        phone: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "phone";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        referenceId: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "referenceId";
                                notNull: false;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        status: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "status";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            { $type: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...) },
                        >;
                        updatedAt: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgTimestamp";
                                data: Date;
                                dataType: "date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "updatedAt";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        uuid: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgUUID";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "uuid";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        verification: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgJsonb";
                                data: {
                                    amlVerification?: ...;
                                    customerVerification?: ...;
                                    identityDocumentVerification?: ...;
                                    verificationProfileId?: ...;
                                };
                                dataType: "json";
                                driverParam: unknown;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "verification";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {
                                $type: {
                                    amlVerification?: ...;
                                    customerVerification?: ...;
                                    identityDocumentVerification?: ...;
                                    verificationProfileId?: ...;
                                };
                            },
                        >;
                    };
                    dialect: "pg";
                    name: "identity";
                    schema: "b2b";
                },
            >,
            "enableRLS",
        >,
        "createdAt"
        | "updatedAt",
    >[]
  - Optionalpage?: number
    Defaults to 1
  - OptionalpageSize?: number
    Defaults to 50
  - OptionalphoneLike?: string
    Partial match on phone
  - Optionalphones?: string[]
  - OptionalreferenceIdLike?: string
    Partial match on reference ID
  - OptionalreferenceIds?: string[]
  - Optionalstatuses?: (
        | "ACTIVE"
        | "DISABLED"
        | "PENDING_VERIFICATION"
        | "REVIEW"
        | "BLOCKED"
        | "DELETED"
    )[]
  - OptionalupdatedAt?: DbTimestampCriteria
Returns Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: (
                {
                    amlVerification?: {
                        id: string;
                        status: "PENDING"
                        | "REVIEW"
                        | "APPROVED"
                        | "DECLINED";
                    };
                    capabilities: (
                        | "TRANSACT"
                        | "MANAGE_PAYMENT_INSTRUMENT"
                        | "MANAGE_LEDGER_ACCOUNT"
                        | "MANAGE_DEPOSIT_MEMO"
                    )[];
                    countryOfResidence: string;
                    createdAt: Date;
                    customerVerification?: { id: string };
                    dateOfBirth?: string;
                    deletedAt?: Date;
                    email: string;
                    id: string;
                    identityDocumentVerification?: {
                        id: string;
                        status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                    };
                    name?: { firstName: string; lastName: string; middleName?: string };
                    phone: string;
                    referenceId?: string;
                    status:
                        | "ACTIVE"
                        | "DISABLED"
                        | "PENDING_VERIFICATION"
                        | "REVIEW"
                        | "BLOCKED"
                        | "DELETED";
                    updatedAt: Date;
                    uuid: string;
                    verificationProfileId?: string;
                } & { customerId: string }
            )[];
        };
    },
>
Inherited from IdentityAdminQueryService.search
- Defined in packages/entity-services/src/identity/IdentityAdminService.ts:79

update

update(
    __namedParameters: {
        customerId?: string;
        data: Partial<
            Pick<
                Identity,
                | "status"
                | "name"
                | "dateOfBirth"
                | "customerVerification"
                | "verificationProfileId"
                | "amlVerification"
                | "identityDocumentVerification",
            >,
        >;
        id: string;
    },
): Promise<
    | { error: ServiceError; ok: false }
    | {
        ok: true;
        value: {
            amlVerification?: {
                id: string;
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryOfResidence: string;
            createdAt: Date;
            customerVerification?: { id: string };
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string;
            id: string;
            identityDocumentVerification?: {
                id: string;
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
            };
            name?: { firstName: string; lastName: string; middleName?: string };
            phone: string;
            referenceId?: string;
            status:
                | "ACTIVE"
                | "DISABLED"
                | "PENDING_VERIFICATION"
                | "REVIEW"
                | "BLOCKED"
                | "DELETED";
            updatedAt: Date;
            uuid: string;
            verificationProfileId?: string;
        } & { customerId: string };
    },
>
Updates do NOT trigger AiPrise verification
Parameters
- __namedParameters: {
      customerId?: string;
      data: Partial<
          Pick<
              Identity,
              | "status"
              | "name"
              | "dateOfBirth"
              | "customerVerification"
              | "verificationProfileId"
              | "amlVerification"
              | "identityDocumentVerification",
          >,
      >;
      id: string;
  }
Returns Promise<
    | { error: ServiceError; ok: false }
    | {
        ok: true;
        value: {
            amlVerification?: {
                id: string;
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryOfResidence: string;
            createdAt: Date;
            customerVerification?: { id: string };
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string;
            id: string;
            identityDocumentVerification?: {
                id: string;
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
            };
            name?: { firstName: string; lastName: string; middleName?: string };
            phone: string;
            referenceId?: string;
            status:
                | "ACTIVE"
                | "DISABLED"
                | "PENDING_VERIFICATION"
                | "REVIEW"
                | "BLOCKED"
                | "DELETED";
            updatedAt: Date;
            uuid: string;
            verificationProfileId?: string;
        } & { customerId: string };
    },
>
- Defined in packages/entity-services/src/identity/IdentityAdminService.ts:311

upliftLegacy

upliftLegacy(
    __namedParameters: { customerId?: string; id: string },
): Promise<
    | {
        ok: true;
        value: {
            amlVerification?: {
                id: string;
                status: "PENDING"
                | "REVIEW"
                | "APPROVED"
                | "DECLINED";
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryOfResidence: string;
            createdAt: Date;
            customerVerification?: { id: string };
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string;
            id: string;
            identityDocumentVerification?: {
                id: string;
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
            };
            name?: { firstName: string; lastName: string; middleName?: string };
            phone: string;
            referenceId?: string;
            status:
                | "ACTIVE"
                | "DISABLED"
                | "PENDING_VERIFICATION"
                | "REVIEW"
                | "BLOCKED"
                | "DELETED";
            updatedAt: Date;
            uuid: string;
            verificationProfileId?: string;
        } & { customerId: string };
    }
    | { error: ServiceError; ok: false },
>
Uplift an identity that was created with Plaid verification before AiPrise was introduced.

It creates the AiPrise profile and configures continuous AML monitoring.
Parameters
- __namedParameters: { customerId?: string; id: string }
Returns Promise<
    | {
        ok: true;
        value: {
            amlVerification?: {
                id: string;
                status: "PENDING"
                | "REVIEW"
                | "APPROVED"
                | "DECLINED";
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryOfResidence: string;
            createdAt: Date;
            customerVerification?: { id: string };
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string;
            id: string;
            identityDocumentVerification?: {
                id: string;
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
            };
            name?: { firstName: string; lastName: string; middleName?: string };
            phone: string;
            referenceId?: string;
            status:
                | "ACTIVE"
                | "DISABLED"
                | "PENDING_VERIFICATION"
                | "REVIEW"
                | "BLOCKED"
                | "DELETED";
            updatedAt: Date;
            uuid: string;
            verificationProfileId?: string;
        } & { customerId: string };
    }
    | { error: ServiceError; ok: false },
>
- Defined in packages/entity-services/src/identity/IdentityAdminService.ts:414

Class IdentityAdminService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns IdentityAdminService

Properties

Protected Readonlydb

Protected ReadonlydbHelper

Methods

get

Parameters

search

Parameters

OptionalamlVerificationStatuses?: ("PENDING" | "REVIEW" | "APPROVED" | "DECLINED")[]

OptionalcountriesOfResidence?: string[]

OptionalcreatedAt?: DbTimestampCriteria

OptionalcustomerIds?: string[]

OptionalemailLike?: string

Optionalemails?: string[]

OptionalhasCustomerVerification?: boolean

OptionalidentityDocumentVerificationStatuses?: ("PENDING" | "REVIEW" | "APPROVED" | "DECLINED")[]

Optionalids?: string[]

OptionalnameLike?: string

Optionalpage?: number

OptionalpageSize?: number

OptionalphoneLike?: string

Optionalphones?: string[]

OptionalreferenceIdLike?: string

OptionalreferenceIds?: string[]

Optionalstatuses?: ( | "ACTIVE" | "DISABLED" | "PENDING_VERIFICATION" | "REVIEW" | "BLOCKED" | "DELETED")[]

OptionalupdatedAt?: DbTimestampCriteria

update

Parameters

upliftLegacy

Parameters

Settings

On This Page

`Protected` `Readonly`db

`Protected` `Readonly`dbHelper

`Optional`amlVerificationStatuses?: ("PENDING" | "REVIEW" | "APPROVED" | "DECLINED")[]

`Optional`countriesOfResidence?: string[]

`Optional`createdAt?: DbTimestampCriteria

`Optional`customerIds?: string[]

`Optional`emailLike?: string

`Optional`emails?: string[]

`Optional`hasCustomerVerification?: boolean

`Optional`identityDocumentVerificationStatuses?: ("PENDING" | "REVIEW" | "APPROVED" | "DECLINED")[]

`Optional`ids?: string[]

`Optional`nameLike?: string

`Optional`page?: number

`Optional`pageSize?: number

`Optional`phoneLike?: string

`Optional`phones?: string[]

`Optional`referenceIdLike?: string

`Optional`referenceIds?: string[]

`Optional`statuses?: (
| "ACTIVE"
| "DISABLED"
| "PENDING_VERIFICATION"
| "REVIEW"
| "BLOCKED"
| "DELETED"
)[]

`Optional`updatedAt?: DbTimestampCriteria