Class RelatedPersonQueryService

constructor

• new RelatedPersonQueryService(
      args: { db: B2bDatabase },
  ): RelatedPersonQueryService

  Parameters

  • args: { db: B2bDatabase }

  Returns RelatedPersonQueryService

Staticinstance

get

• get(
      __namedParameters: {
          customerId: string;
          id: string;
          organizationId?: string;
      },
  ): Promise<
      {
          ok: true;
          value: | {
              address?: {
                  city: string;
                  countryCode: string;
                  line1: string;
                  line2?: string;
                  postalCode?: string;
                  regionCode?: string;
              };
              countryOfBirth?: string;
              countryOfResidence: string;
              createdAt: Date;
              dateOfBirth?: string;
              deletedAt?: Date;
              email: string
              | null;
              id: string;
              identityDocument?: {
                  expiryDate: string;
                  issuingCountry: string;
                  number: string;
                  type: "PASSPORT" | "DRIVER_LICENSE" | "ID_CARD";
              };
              isBeneficialOwner?: boolean;
              isPoliticallyExposed?: boolean;
              name: { firstName: string; lastName: string; middleName?: string }
              | null;
              nationality?: string;
              occupationCode?: string;
              organizationId: string;
              ownershipPercent?: number;
              phone: string | null;
              requiredInfo: RequiredInfoField[];
              roleDescription: string;
              routeFusionDocumentsUploadedAt?: string;
              sex?: "OTHER" | "MALE" | "FEMALE";
              sharesAllocated?: number;
              status:
                  | "PENDING_VERIFICATION"
                  | "ACTION_REQUIRED"
                  | "APPROVED"
                  | "DELETED"
                  | "REVIEW"
                  | "BLOCKED";
              statusDescription: string;
              taxId?: string;
              title?: string;
              type: "CONTROL"
              | "BENEFICIAL_OWNER";
              typeDescription: string;
              updatedAt: Date;
              verificationReasonCode?:
                  | "OTHER"
                  | "INVALID_TAX_ID"
                  | "ADDRESS_MISMATCH"
                  | "REGISTRY_NOT_FOUND"
                  | "DOCUMENT_ISSUE"
                  | "IDENTITY_MISMATCH";
              verificationReasonCodeDescription?: string;
          }
          | null;
      },
  >

  Parameters

  • __namedParameters: { customerId: string; id: string; organizationId?: string }

    • customerId: string

    • id: string

    • OptionalorganizationId?: string

      When provided, scopes to a specific organization (the API path case). When omitted, scopes by customer only — used by the document flow, which knows the related person id but not its organization.

  Returns Promise<
      {
          ok: true;
          value: | {
              address?: {
                  city: string;
                  countryCode: string;
                  line1: string;
                  line2?: string;
                  postalCode?: string;
                  regionCode?: string;
              };
              countryOfBirth?: string;
              countryOfResidence: string;
              createdAt: Date;
              dateOfBirth?: string;
              deletedAt?: Date;
              email: string
              | null;
              id: string;
              identityDocument?: {
                  expiryDate: string;
                  issuingCountry: string;
                  number: string;
                  type: "PASSPORT" | "DRIVER_LICENSE" | "ID_CARD";
              };
              isBeneficialOwner?: boolean;
              isPoliticallyExposed?: boolean;
              name: { firstName: string; lastName: string; middleName?: string }
              | null;
              nationality?: string;
              occupationCode?: string;
              organizationId: string;
              ownershipPercent?: number;
              phone: string | null;
              requiredInfo: RequiredInfoField[];
              roleDescription: string;
              routeFusionDocumentsUploadedAt?: string;
              sex?: "OTHER" | "MALE" | "FEMALE";
              sharesAllocated?: number;
              status:
                  | "PENDING_VERIFICATION"
                  | "ACTION_REQUIRED"
                  | "APPROVED"
                  | "DELETED"
                  | "REVIEW"
                  | "BLOCKED";
              statusDescription: string;
              taxId?: string;
              title?: string;
              type: "CONTROL"
              | "BENEFICIAL_OWNER";
              typeDescription: string;
              updatedAt: Date;
              verificationReasonCode?:
                  | "OTHER"
                  | "INVALID_TAX_ID"
                  | "ADDRESS_MISMATCH"
                  | "REGISTRY_NOT_FOUND"
                  | "DOCUMENT_ISSUE"
                  | "IDENTITY_MISMATCH";
              verificationReasonCodeDescription?: string;
          }
          | null;
      },
  >

search

• search(
      __namedParameters: {
          createdAt?: DbTimestampCriteria;
          customerId: string;
          ids?: string[];
          includeDeleted?: boolean;
          orderBy?: DbOrderByCriterion<
              Omit<
                  PgTableWithColumns<
                      {
                          columns: {
                              countryOfResidence: PgBuildColumn<
                                  "related_person",
                                  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: "related_person";
                                  },
                              >;
                              createdAt: PgBuildColumn<
                                  "related_person",
                                  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: "related_person";
                                  },
                              >;
                              customerExternalId: PgBuildColumn<
                                  "related_person",
                                  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: "related_person";
                                  },
                              >;
                              customerId: PgBuildColumn<
                                  "related_person",
                                  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: "related_person";
                                  },
                              >;
                              data: PgBuildColumn<
                                  "related_person",
                                  Set$Type<
                                      SetNotNull<(...)>,
                                      {
                                          address?: ...;
                                          countryOfBirth?: ...;
                                          dateOfBirth?: ...;
                                          identityDocument?: ...;
                                          isBeneficialOwner?: ...;
                                          isPoliticallyExposed?: ...;
                                          nationality?: ...;
                                          occupationCode?: ...;
                                          ownershipPercent?: ...;
                                          personReferenceId?: ...;
                                          routeFusionDocumentsUploadedAt?: ...;
                                          routeFusionRepresentativeId?: ...;
                                          sex?: ...;
                                          sharesAllocated?: ...;
                                          taxId?: ...;
                                          title?: ...;
                                          verificationProfileId?: ...;
                                          zenusPersonId?: ...;
                                      },
                                  >,
                                  {
                                      data: {
                                          address?: ...;
                                          countryOfBirth?: ...;
                                          dateOfBirth?: ...;
                                          identityDocument?: ...;
                                          isBeneficialOwner?: ...;
                                          isPoliticallyExposed?: ...;
                                          nationality?: ...;
                                          occupationCode?: ...;
                                          ownershipPercent?: ...;
                                          personReferenceId?: ...;
                                          routeFusionDocumentsUploadedAt?: ...;
                                          routeFusionRepresentativeId?: ...;
                                          sex?: ...;
                                          sharesAllocated?: ...;
                                          taxId?: ...;
                                          title?: ...;
                                          verificationProfileId?: ...;
                                          zenusPersonId?: ...;
                                      };
                                      dataType: "object json";
                                      driverParam: unknown;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "related_person";
                                  },
                              >;
                              deletedAt: PgBuildColumn<
                                  "related_person",
                                  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: "related_person";
                                  },
                              >;
                              email: PgBuildColumn<
                                  "related_person",
                                  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: "related_person";
                                  },
                              >;
                              externalId: PgBuildColumn<
                                  "related_person",
                                  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: "related_person";
                                  },
                              >;
                              id: PgBuildColumn<
                                  "related_person",
                                  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: "related_person";
                                  },
                              >;
                              name: PgBuildColumn<
                                  "related_person",
                                  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: "related_person";
                                  },
                              >;
                              organizationExternalId: PgBuildColumn<
                                  "related_person",
                                  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: "related_person";
                                  },
                              >;
                              organizationId: PgBuildColumn<
                                  "related_person",
                                  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: "related_person";
                                  },
                              >;
                              phone: PgBuildColumn<
                                  "related_person",
                                  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: "related_person";
                                  },
                              >;
                              status: PgBuildColumn<
                                  "related_person",
                                  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: "related_person";
                                  },
                              >;
                              type: PgBuildColumn<
                                  "related_person",
                                  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: "related_person";
                                  },
                              >;
                              updatedAt: PgBuildColumn<
                                  "related_person",
                                  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: "related_person";
                                  },
                              >;
                              verificationProfileId: PgBuildColumn<
                                  "related_person",
                                  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: "related_person";
                                  },
                              >;
                              verificationReasons: PgBuildColumn<
                                  "related_person",
                                  Set$Type<PgJsonbBuilder, VerificationReasons>,
                                  {
                                      data: VerificationReasons;
                                      dataType: "object json";
                                      driverParam: unknown;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "related_person";
                                  },
                              >;
                          };
                          dialect: "pg";
                          isAlias: false;
                          name: "related_person";
                          schema: "b2b";
                      },
                  >,
                  "enableRLS",
              >,
              "createdAt"
              | "updatedAt",
          >[];
          organizationId?: string;
          page?: number;
          pageSize?: number;
          statuses?: (
              | "PENDING_VERIFICATION"
              | "ACTION_REQUIRED"
              | "APPROVED"
              | "DELETED"
              | "REVIEW"
              | "BLOCKED"
          )[];
          tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
          types?: ("CONTROL" | "BENEFICIAL_OWNER")[];
          updatedAt?: DbTimestampCriteria;
          verificationProfileIds?: string[];
      },
  ): Promise<
      {
          ok: true;
          value: {
              hasNext: boolean;
              items: {
                  address?: {
                      city: string;
                      countryCode: string;
                      line1: string;
                      line2?: string;
                      postalCode?: string;
                      regionCode?: string;
                  };
                  countryOfBirth?: string;
                  countryOfResidence: string;
                  createdAt: Date;
                  dateOfBirth?: string;
                  deletedAt?: Date;
                  email: string
                  | null;
                  id: string;
                  identityDocument?: {
                      expiryDate: string;
                      issuingCountry: string;
                      number: string;
                      type: "PASSPORT" | "DRIVER_LICENSE" | "ID_CARD";
                  };
                  isBeneficialOwner?: boolean;
                  isPoliticallyExposed?: boolean;
                  name: | { firstName: string; lastName: string; middleName?: string }
                  | null;
                  nationality?: string;
                  occupationCode?: string;
                  organizationId: string;
                  ownershipPercent?: number;
                  phone: string | null;
                  requiredInfo: RequiredInfoField[];
                  roleDescription: string;
                  routeFusionDocumentsUploadedAt?: string;
                  sex?: "OTHER" | "MALE" | "FEMALE";
                  sharesAllocated?: number;
                  status:
                      | "PENDING_VERIFICATION"
                      | "ACTION_REQUIRED"
                      | "APPROVED"
                      | "DELETED"
                      | "REVIEW"
                      | "BLOCKED";
                  statusDescription: string;
                  taxId?: string;
                  title?: string;
                  type: "CONTROL"
                  | "BENEFICIAL_OWNER";
                  typeDescription: string;
                  updatedAt: Date;
                  verificationReasonCode?:
                      | "OTHER"
                      | "INVALID_TAX_ID"
                      | "ADDRESS_MISMATCH"
                      | "REGISTRY_NOT_FOUND"
                      | "DOCUMENT_ISSUE"
                      | "IDENTITY_MISMATCH";
                  verificationReasonCodeDescription?: string;
              }[];
              total: number;
          };
      },
  >

  Parameters

  • __namedParameters: {
        createdAt?: DbTimestampCriteria;
        customerId: string;
        ids?: string[];
        includeDeleted?: boolean;
        orderBy?: DbOrderByCriterion<
            Omit<
                PgTableWithColumns<
                    {
                        columns: {
                            countryOfResidence: PgBuildColumn<
                                "related_person",
                                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: "related_person";
                                },
                            >;
                            createdAt: PgBuildColumn<
                                "related_person",
                                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: "related_person";
                                },
                            >;
                            customerExternalId: PgBuildColumn<
                                "related_person",
                                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: "related_person";
                                },
                            >;
                            customerId: PgBuildColumn<
                                "related_person",
                                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: "related_person";
                                },
                            >;
                            data: PgBuildColumn<
                                "related_person",
                                Set$Type<
                                    SetNotNull<(...)>,
                                    {
                                        address?: ...;
                                        countryOfBirth?: ...;
                                        dateOfBirth?: ...;
                                        identityDocument?: ...;
                                        isBeneficialOwner?: ...;
                                        isPoliticallyExposed?: ...;
                                        nationality?: ...;
                                        occupationCode?: ...;
                                        ownershipPercent?: ...;
                                        personReferenceId?: ...;
                                        routeFusionDocumentsUploadedAt?: ...;
                                        routeFusionRepresentativeId?: ...;
                                        sex?: ...;
                                        sharesAllocated?: ...;
                                        taxId?: ...;
                                        title?: ...;
                                        verificationProfileId?: ...;
                                        zenusPersonId?: ...;
                                    },
                                >,
                                {
                                    data: {
                                        address?: ...;
                                        countryOfBirth?: ...;
                                        dateOfBirth?: ...;
                                        identityDocument?: ...;
                                        isBeneficialOwner?: ...;
                                        isPoliticallyExposed?: ...;
                                        nationality?: ...;
                                        occupationCode?: ...;
                                        ownershipPercent?: ...;
                                        personReferenceId?: ...;
                                        routeFusionDocumentsUploadedAt?: ...;
                                        routeFusionRepresentativeId?: ...;
                                        sex?: ...;
                                        sharesAllocated?: ...;
                                        taxId?: ...;
                                        title?: ...;
                                        verificationProfileId?: ...;
                                        zenusPersonId?: ...;
                                    };
                                    dataType: "object json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "related_person";
                                },
                            >;
                            deletedAt: PgBuildColumn<
                                "related_person",
                                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: "related_person";
                                },
                            >;
                            email: PgBuildColumn<
                                "related_person",
                                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: "related_person";
                                },
                            >;
                            externalId: PgBuildColumn<
                                "related_person",
                                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: "related_person";
                                },
                            >;
                            id: PgBuildColumn<
                                "related_person",
                                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: "related_person";
                                },
                            >;
                            name: PgBuildColumn<
                                "related_person",
                                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: "related_person";
                                },
                            >;
                            organizationExternalId: PgBuildColumn<
                                "related_person",
                                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: "related_person";
                                },
                            >;
                            organizationId: PgBuildColumn<
                                "related_person",
                                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: "related_person";
                                },
                            >;
                            phone: PgBuildColumn<
                                "related_person",
                                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: "related_person";
                                },
                            >;
                            status: PgBuildColumn<
                                "related_person",
                                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: "related_person";
                                },
                            >;
                            type: PgBuildColumn<
                                "related_person",
                                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: "related_person";
                                },
                            >;
                            updatedAt: PgBuildColumn<
                                "related_person",
                                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: "related_person";
                                },
                            >;
                            verificationProfileId: PgBuildColumn<
                                "related_person",
                                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: "related_person";
                                },
                            >;
                            verificationReasons: PgBuildColumn<
                                "related_person",
                                Set$Type<PgJsonbBuilder, VerificationReasons>,
                                {
                                    data: VerificationReasons;
                                    dataType: "object json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "related_person";
                                },
                            >;
                        };
                        dialect: "pg";
                        isAlias: false;
                        name: "related_person";
                        schema: "b2b";
                    },
                >,
                "enableRLS",
            >,
            "createdAt"
            | "updatedAt",
        >[];
        organizationId?: string;
        page?: number;
        pageSize?: number;
        statuses?: (
            | "PENDING_VERIFICATION"
            | "ACTION_REQUIRED"
            | "APPROVED"
            | "DELETED"
            | "REVIEW"
            | "BLOCKED"
        )[];
        tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
        types?: ("CONTROL" | "BENEFICIAL_OWNER")[];
        updatedAt?: DbTimestampCriteria;
        verificationProfileIds?: string[];
    }

    • OptionalcreatedAt?: DbTimestampCriteria

    • customerId: string

    • Optionalids?: string[]

    • OptionalincludeDeleted?: boolean

    • OptionalorderBy?: DbOrderByCriterion<
          Omit<
              PgTableWithColumns<
                  {
                      columns: {
                          countryOfResidence: PgBuildColumn<
                              "related_person",
                              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: "related_person";
                              },
                          >;
                          createdAt: PgBuildColumn<
                              "related_person",
                              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: "related_person";
                              },
                          >;
                          customerExternalId: PgBuildColumn<
                              "related_person",
                              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: "related_person";
                              },
                          >;
                          customerId: PgBuildColumn<
                              "related_person",
                              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: "related_person";
                              },
                          >;
                          data: PgBuildColumn<
                              "related_person",
                              Set$Type<
                                  SetNotNull<(...)>,
                                  {
                                      address?: ...;
                                      countryOfBirth?: ...;
                                      dateOfBirth?: ...;
                                      identityDocument?: ...;
                                      isBeneficialOwner?: ...;
                                      isPoliticallyExposed?: ...;
                                      nationality?: ...;
                                      occupationCode?: ...;
                                      ownershipPercent?: ...;
                                      personReferenceId?: ...;
                                      routeFusionDocumentsUploadedAt?: ...;
                                      routeFusionRepresentativeId?: ...;
                                      sex?: ...;
                                      sharesAllocated?: ...;
                                      taxId?: ...;
                                      title?: ...;
                                      verificationProfileId?: ...;
                                      zenusPersonId?: ...;
                                  },
                              >,
                              {
                                  data: {
                                      address?: ...;
                                      countryOfBirth?: ...;
                                      dateOfBirth?: ...;
                                      identityDocument?: ...;
                                      isBeneficialOwner?: ...;
                                      isPoliticallyExposed?: ...;
                                      nationality?: ...;
                                      occupationCode?: ...;
                                      ownershipPercent?: ...;
                                      personReferenceId?: ...;
                                      routeFusionDocumentsUploadedAt?: ...;
                                      routeFusionRepresentativeId?: ...;
                                      sex?: ...;
                                      sharesAllocated?: ...;
                                      taxId?: ...;
                                      title?: ...;
                                      verificationProfileId?: ...;
                                      zenusPersonId?: ...;
                                  };
                                  dataType: "object json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "related_person";
                              },
                          >;
                          deletedAt: PgBuildColumn<
                              "related_person",
                              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: "related_person";
                              },
                          >;
                          email: PgBuildColumn<
                              "related_person",
                              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: "related_person";
                              },
                          >;
                          externalId: PgBuildColumn<
                              "related_person",
                              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: "related_person";
                              },
                          >;
                          id: PgBuildColumn<
                              "related_person",
                              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: "related_person";
                              },
                          >;
                          name: PgBuildColumn<
                              "related_person",
                              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: "related_person";
                              },
                          >;
                          organizationExternalId: PgBuildColumn<
                              "related_person",
                              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: "related_person";
                              },
                          >;
                          organizationId: PgBuildColumn<
                              "related_person",
                              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: "related_person";
                              },
                          >;
                          phone: PgBuildColumn<
                              "related_person",
                              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: "related_person";
                              },
                          >;
                          status: PgBuildColumn<
                              "related_person",
                              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: "related_person";
                              },
                          >;
                          type: PgBuildColumn<
                              "related_person",
                              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: "related_person";
                              },
                          >;
                          updatedAt: PgBuildColumn<
                              "related_person",
                              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: "related_person";
                              },
                          >;
                          verificationProfileId: PgBuildColumn<
                              "related_person",
                              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: "related_person";
                              },
                          >;
                          verificationReasons: PgBuildColumn<
                              "related_person",
                              Set$Type<PgJsonbBuilder, VerificationReasons>,
                              {
                                  data: VerificationReasons;
                                  dataType: "object json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "related_person";
                              },
                          >;
                      };
                      dialect: "pg";
                      isAlias: false;
                      name: "related_person";
                      schema: "b2b";
                  },
              >,
              "enableRLS",
          >,
          "createdAt"
          | "updatedAt",
      >[]

    • OptionalorganizationId?: string

      Omit to search every business of the customer.

    • Optionalpage?: number

      Defaults to 1

    • OptionalpageSize?: number

      Defaults to 50

    • Optionalstatuses?: (
          | "PENDING_VERIFICATION"
          | "ACTION_REQUIRED"
          | "APPROVED"
          | "DELETED"
          | "REVIEW"
          | "BLOCKED"
      )[]

    • Optionaltx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>

      Reads inside this transaction rather than on a pool connection.

    • Optionaltypes?: ("CONTROL" | "BENEFICIAL_OWNER")[]

    • OptionalupdatedAt?: DbTimestampCriteria

    • OptionalverificationProfileIds?: string[]

      The person's AiPrise user profile ids.

  Returns Promise<
      {
          ok: true;
          value: {
              hasNext: boolean;
              items: {
                  address?: {
                      city: string;
                      countryCode: string;
                      line1: string;
                      line2?: string;
                      postalCode?: string;
                      regionCode?: string;
                  };
                  countryOfBirth?: string;
                  countryOfResidence: string;
                  createdAt: Date;
                  dateOfBirth?: string;
                  deletedAt?: Date;
                  email: string
                  | null;
                  id: string;
                  identityDocument?: {
                      expiryDate: string;
                      issuingCountry: string;
                      number: string;
                      type: "PASSPORT" | "DRIVER_LICENSE" | "ID_CARD";
                  };
                  isBeneficialOwner?: boolean;
                  isPoliticallyExposed?: boolean;
                  name: | { firstName: string; lastName: string; middleName?: string }
                  | null;
                  nationality?: string;
                  occupationCode?: string;
                  organizationId: string;
                  ownershipPercent?: number;
                  phone: string | null;
                  requiredInfo: RequiredInfoField[];
                  roleDescription: string;
                  routeFusionDocumentsUploadedAt?: string;
                  sex?: "OTHER" | "MALE" | "FEMALE";
                  sharesAllocated?: number;
                  status:
                      | "PENDING_VERIFICATION"
                      | "ACTION_REQUIRED"
                      | "APPROVED"
                      | "DELETED"
                      | "REVIEW"
                      | "BLOCKED";
                  statusDescription: string;
                  taxId?: string;
                  title?: string;
                  type: "CONTROL"
                  | "BENEFICIAL_OWNER";
                  typeDescription: string;
                  updatedAt: Date;
                  verificationReasonCode?:
                      | "OTHER"
                      | "INVALID_TAX_ID"
                      | "ADDRESS_MISMATCH"
                      | "REGISTRY_NOT_FOUND"
                      | "DOCUMENT_ISSUE"
                      | "IDENTITY_MISMATCH";
                  verificationReasonCodeDescription?: string;
              }[];
              total: number;
          };
      },
  >