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

    Class IdentityQueryService

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    db

    Methods

    get search

    Constructors

    Properties

    db: B2bDatabase

    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"
                  )[];
                  countryCode: string;
                  countryOfResidence: string;
                  createdAt: Date;
                  customerVerification?: { id: string };
                  dateOfBirth?: string;
                  deletedAt?: Date;
                  displayName: string;
                  email: string;
                  fullName?: 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"
                      | "DELETED"
                      | "PENDING_VERIFICATION"
                      | "REVIEW"
                      | "BLOCKED";
                  type: "IDENTITY";
                  updatedAt: Date;
                  uuid: string;
                  verificationProfileId?: string;
              }
              | null;
          },
      >

    • Parameters

      • __namedParameters: {
            amlVerificationStatuses?: (
                "PENDING"
                | "REVIEW"
                | "APPROVED"
                | "DECLINED"
            )[];
            countriesOfResidence?: string[];
            createdAt?: DbTimestampCriteria;
            customerId: string;
            emailLike?: string;
            emails?: string[];
            hasCustomerVerification?: boolean;
            identityDocumentVerificationStatuses?: (
                "PENDING"
                | "REVIEW"
                | "APPROVED"
                | "DECLINED"
            )[];
            ids?: string[];
            includeDeleted?: boolean;
            nameLike?: string;
            orderBy?: DbOrderByCriterion<
                Omit<
                    PgTableWithColumns<
                        {
                            columns: {
                                countryOfResidence: PgBuildColumn<
                                    "identity",
                                    SetNotNull<PgTextBuilder<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "identity";
                                    },
                                >;
                                createdAt: PgBuildColumn<
                                    "identity",
                                    SetHasDefault<SetNotNull<(...)>>,
                                    {
                                        data: Date;
                                        dataType: "object date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "identity";
                                    },
                                >;
                                customerId: PgBuildColumn<
                                    "identity",
                                    SetNotNull<PgIntegerBuilder>,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...) | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "identity";
                                    },
                                >;
                                data: PgBuildColumn<
                                    "identity",
                                    Set$Type<SetHasDefault<(...)>, { dateOfBirth?: ... }>,
                                    {
                                        data: { dateOfBirth?: ... };
                                        dataType: "object json";
                                        driverParam: unknown;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "identity";
                                    },
                                >;
                                deletedAt: PgBuildColumn<
                                    "identity",
                                    PgTimestampBuilder,
                                    {
                                        data: Date;
                                        dataType: "object date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "identity";
                                    },
                                >;
                                email: PgBuildColumn<
                                    "identity",
                                    SetNotNull<PgTextBuilder<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "identity";
                                    },
                                >;
                                externalId: PgBuildColumn<
                                    "identity",
                                    SetHasRuntimeDefault<SetNotNull<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "identity";
                                    },
                                >;
                                id: PgBuildColumn<
                                    "identity",
                                    HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...) | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: "byDefault";
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "identity";
                                    },
                                >;
                                name: PgBuildColumn<
                                    "identity",
                                    Set$Type<
                                        PgJsonbBuilder,
                                        { firstName: ...; lastName: ...; middleName?: ... },
                                    >,
                                    {
                                        data: { firstName: ...; lastName: ...; middleName?: ... };
                                        dataType: "object json";
                                        driverParam: unknown;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "identity";
                                    },
                                >;
                                phone: PgBuildColumn<
                                    "identity",
                                    SetNotNull<PgTextBuilder<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "identity";
                                    },
                                >;
                                referenceId: PgBuildColumn<
                                    "identity",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "identity";
                                    },
                                >;
                                status: PgBuildColumn<
                                    "identity",
                                    Set$Type<
                                        SetNotNull<(...)>,
                                        (...) | (...) | (...) | (...) | (...) | (...),
                                    >,
                                    {
                                        data: (...) | (...) | (...) | (...) | (...) | (...);
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "identity";
                                    },
                                >;
                                updatedAt: PgBuildColumn<
                                    "identity",
                                    SetHasDefault<SetHasDefault<(...)>>,
                                    {
                                        data: Date;
                                        dataType: "object date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "identity";
                                    },
                                >;
                                uuid: PgBuildColumn<
                                    "identity",
                                    SetHasDefault<SetNotNull<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string uuid";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "identity";
                                    },
                                >;
                                verification: PgBuildColumn<
                                    "identity",
                                    Set$Type<
                                        SetHasDefault<(...)>,
                                        {
                                            amlVerification?: ...;
                                            customerVerification?: ...;
                                            identityDocumentVerification?: ...;
                                            verificationProfileId?: ...;
                                        },
                                    >,
                                    {
                                        data: {
                                            amlVerification?: ...;
                                            customerVerification?: ...;
                                            identityDocumentVerification?: ...;
                                            verificationProfileId?: ...;
                                        };
                                        dataType: "object json";
                                        driverParam: unknown;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "identity";
                                    },
                                >;
                            };
                            dialect: "pg";
                            name: "identity";
                            schema: "b2b";
                        },
                    >,
                    "enableRLS",
                >,
                "createdAt"
                | "updatedAt",
            >[];
            page?: number;
            pageSize?: number;
            partialText?: string;
            phoneLike?: string;
            phones?: string[];
            referenceIdLike?: string;
            referenceIds?: string[];
            statuses?: (
                | "ACTIVE"
                | "DISABLED"
                | "DELETED"
                | "PENDING_VERIFICATION"
                | "REVIEW"
                | "BLOCKED"
            )[];
            updatedAt?: DbTimestampCriteria;
        }
        • OptionalamlVerificationStatuses?: ("PENDING" | "REVIEW" | "APPROVED" | "DECLINED")[]
        • OptionalcountriesOfResidence?: string[]
        • OptionalcreatedAt?: DbTimestampCriteria
        • customerId: 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

        • OptionalincludeDeleted?: boolean
        • OptionalnameLike?: string

          Partial match on first, middle, last name or full name

        • OptionalorderBy?: DbOrderByCriterion<
              Omit<
                  PgTableWithColumns<
                      {
                          columns: {
                              countryOfResidence: PgBuildColumn<
                                  "identity",
                                  SetNotNull<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "identity";
                                  },
                              >;
                              createdAt: PgBuildColumn<
                                  "identity",
                                  SetHasDefault<SetNotNull<(...)>>,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "identity";
                                  },
                              >;
                              customerId: PgBuildColumn<
                                  "identity",
                                  SetNotNull<PgIntegerBuilder>,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "identity";
                                  },
                              >;
                              data: PgBuildColumn<
                                  "identity",
                                  Set$Type<SetHasDefault<(...)>, { dateOfBirth?: ... }>,
                                  {
                                      data: { dateOfBirth?: ... };
                                      dataType: "object json";
                                      driverParam: unknown;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "identity";
                                  },
                              >;
                              deletedAt: PgBuildColumn<
                                  "identity",
                                  PgTimestampBuilder,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "identity";
                                  },
                              >;
                              email: PgBuildColumn<
                                  "identity",
                                  SetNotNull<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "identity";
                                  },
                              >;
                              externalId: PgBuildColumn<
                                  "identity",
                                  SetHasRuntimeDefault<SetNotNull<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "identity";
                                  },
                              >;
                              id: PgBuildColumn<
                                  "identity",
                                  HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: "byDefault";
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "identity";
                                  },
                              >;
                              name: PgBuildColumn<
                                  "identity",
                                  Set$Type<
                                      PgJsonbBuilder,
                                      { firstName: ...; lastName: ...; middleName?: ... },
                                  >,
                                  {
                                      data: { firstName: ...; lastName: ...; middleName?: ... };
                                      dataType: "object json";
                                      driverParam: unknown;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "identity";
                                  },
                              >;
                              phone: PgBuildColumn<
                                  "identity",
                                  SetNotNull<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "identity";
                                  },
                              >;
                              referenceId: PgBuildColumn<
                                  "identity",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "identity";
                                  },
                              >;
                              status: PgBuildColumn<
                                  "identity",
                                  Set$Type<
                                      SetNotNull<(...)>,
                                      (...) | (...) | (...) | (...) | (...) | (...),
                                  >,
                                  {
                                      data: (...) | (...) | (...) | (...) | (...) | (...);
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "identity";
                                  },
                              >;
                              updatedAt: PgBuildColumn<
                                  "identity",
                                  SetHasDefault<SetHasDefault<(...)>>,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "identity";
                                  },
                              >;
                              uuid: PgBuildColumn<
                                  "identity",
                                  SetHasDefault<SetNotNull<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string uuid";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "identity";
                                  },
                              >;
                              verification: PgBuildColumn<
                                  "identity",
                                  Set$Type<
                                      SetHasDefault<(...)>,
                                      {
                                          amlVerification?: ...;
                                          customerVerification?: ...;
                                          identityDocumentVerification?: ...;
                                          verificationProfileId?: ...;
                                      },
                                  >,
                                  {
                                      data: {
                                          amlVerification?: ...;
                                          customerVerification?: ...;
                                          identityDocumentVerification?: ...;
                                          verificationProfileId?: ...;
                                      };
                                      dataType: "object json";
                                      driverParam: unknown;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "identity";
                                  },
                              >;
                          };
                          dialect: "pg";
                          name: "identity";
                          schema: "b2b";
                      },
                  >,
                  "enableRLS",
              >,
              "createdAt"
              | "updatedAt",
          >[]
        • Optionalpage?: number

          Defaults to 1

        • OptionalpageSize?: number

          Defaults to 50

        • OptionalpartialText?: string

          Partial text search on: id, referenceId, name, email, phone

        • OptionalphoneLike?: string

          Partial match on phone

        • Optionalphones?: string[]
        • OptionalreferenceIdLike?: string

          Partial match on reference ID

        • OptionalreferenceIds?: string[]
        • Optionalstatuses?: (
              | "ACTIVE"
              | "DISABLED"
              | "DELETED"
              | "PENDING_VERIFICATION"
              | "REVIEW"
              | "BLOCKED"
          )[]
        • 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"
                      )[];
                      countryCode: string;
                      countryOfResidence: string;
                      createdAt: Date;
                      customerVerification?: { id: string };
                      dateOfBirth?: string;
                      deletedAt?: Date;
                      displayName: string;
                      email: string;
                      fullName?: 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"
                          | "DELETED"
                          | "PENDING_VERIFICATION"
                          | "REVIEW"
                          | "BLOCKED";
                      type: "IDENTITY";
                      updatedAt: Date;
                      uuid: string;
                      verificationProfileId?: string;
                  }[];
              };
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods