@cfxlabsinc/b2b-services
    Preparing search index...

    Class IdentityAdminQueryService

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    db dbHelper

    Methods

    get search

    Constructors

    Properties

    db: B2bDatabase
    dbHelper: DbHelper

    Methods

    • 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;
          },
      >

    • 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 }
                  )[];
              };
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods