Class IdentityService

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

Hierarchy (View Summary)

IdentityQueryService
- IdentityService

Index

Constructors

constructor

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

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`dbHelper

dbHelper: DbHelper

Methods

create

create(
    __namedParameters: Omit<
        {
            amlVerification?: {
                id: string;
                status: "PENDING"
                | "REVIEW"
                | "APPROVED"
                | "DECLINED";
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryOfResidence: string;
            createdAt: Date;
            customerVerification?: { id: string };
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string;
            id: string;
            identityDocumentVerification?: {
                id: string;
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
            };
            name?: { firstName: string; lastName: string; middleName?: string };
            phone: string;
            referenceId?: string;
            status:
                | "ACTIVE"
                | "DISABLED"
                | "PENDING_VERIFICATION"
                | "REVIEW"
                | "BLOCKED"
                | "DELETED";
            updatedAt: Date;
            uuid: string;
            verificationProfileId?: string;
        },
        | "id"
        | "name"
        | "status"
        | "createdAt"
        | "updatedAt"
        | "uuid"
        | "deletedAt"
        | "dateOfBirth"
        | "verificationProfileId"
        | "amlVerification"
        | "identityDocumentVerification"
        | "capabilities",
    > & {
        customerId: string;
        dateOfBirth: string;
        name: { firstName: string; lastName: string; middleName?: string };
    },
): Promise<
    | {
        error: | ServiceError<"CANNOT_BYO_KYC" | "PRODUCT_INACTIVE">
        | ServiceError<
            | "INVALID_COUNTRY"
            | "INVALID_PHONE"
            | "INVALID_EMAIL"
            | "INVALID_DATE_OF_BIRTH",
        >
        | ServiceError<"DUPLICATE", { duplicateIds: string[] }>;
        ok: false;
    }
    | {
        ok: true;
        value: {
            amlVerification?: {
                id: string;
                status: "PENDING"
                | "REVIEW"
                | "APPROVED"
                | "DECLINED";
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryOfResidence: string;
            createdAt: Date;
            customerVerification?: { id: string };
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string;
            id: string;
            identityDocumentVerification?: {
                id: string;
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
            };
            name?: { firstName: string; lastName: string; middleName?: string };
            phone: string;
            referenceId?: string;
            status:
                | "ACTIVE"
                | "DISABLED"
                | "PENDING_VERIFICATION"
                | "REVIEW"
                | "BLOCKED"
                | "DELETED";
            updatedAt: Date;
            uuid: string;
            verificationProfileId?: string;
        };
    },
>
Parameters
- __namedParameters: Omit<
      {
          amlVerification?: {
              id: string;
              status: "PENDING"
              | "REVIEW"
              | "APPROVED"
              | "DECLINED";
          };
          capabilities: (
              | "TRANSACT"
              | "MANAGE_PAYMENT_INSTRUMENT"
              | "MANAGE_LEDGER_ACCOUNT"
              | "MANAGE_DEPOSIT_MEMO"
          )[];
          countryOfResidence: string;
          createdAt: Date;
          customerVerification?: { id: string };
          dateOfBirth?: string;
          deletedAt?: Date;
          email: string;
          id: string;
          identityDocumentVerification?: {
              id: string;
              status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
          };
          name?: { firstName: string; lastName: string; middleName?: string };
          phone: string;
          referenceId?: string;
          status:
              | "ACTIVE"
              | "DISABLED"
              | "PENDING_VERIFICATION"
              | "REVIEW"
              | "BLOCKED"
              | "DELETED";
          updatedAt: Date;
          uuid: string;
          verificationProfileId?: string;
      },
      | "id"
      | "name"
      | "status"
      | "createdAt"
      | "updatedAt"
      | "uuid"
      | "deletedAt"
      | "dateOfBirth"
      | "verificationProfileId"
      | "amlVerification"
      | "identityDocumentVerification"
      | "capabilities",
  > & {
      customerId: string;
      dateOfBirth: string;
      name: { firstName: string; lastName: string; middleName?: string };
  }
Returns Promise<
    | {
        error: | ServiceError<"CANNOT_BYO_KYC" | "PRODUCT_INACTIVE">
        | ServiceError<
            | "INVALID_COUNTRY"
            | "INVALID_PHONE"
            | "INVALID_EMAIL"
            | "INVALID_DATE_OF_BIRTH",
        >
        | ServiceError<"DUPLICATE", { duplicateIds: string[] }>;
        ok: false;
    }
    | {
        ok: true;
        value: {
            amlVerification?: {
                id: string;
                status: "PENDING"
                | "REVIEW"
                | "APPROVED"
                | "DECLINED";
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryOfResidence: string;
            createdAt: Date;
            customerVerification?: { id: string };
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string;
            id: string;
            identityDocumentVerification?: {
                id: string;
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
            };
            name?: { firstName: string; lastName: string; middleName?: string };
            phone: string;
            referenceId?: string;
            status:
                | "ACTIVE"
                | "DISABLED"
                | "PENDING_VERIFICATION"
                | "REVIEW"
                | "BLOCKED"
                | "DELETED";
            updatedAt: Date;
            uuid: string;
            verificationProfileId?: string;
        };
    },
>
- Defined in packages/entity-services/src/identity/IdentityService.ts:47

delete

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

get

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

getVerificationUrl

getVerificationUrl(
    __namedParameters: {
        customerId: string;
        id: string;
        redirectUrl: string;
    },
): Promise<
    | { ok: true; value: { url: string } }
    | { error: ServiceError; ok: false },
>
Parameters
- __namedParameters: { customerId: string; id: string; redirectUrl: string }
  - customerId: string
  - id: string
  - redirectUrl: string
    The URL to redirect to, after verification is completed
Returns Promise<
| { ok: true; value: { url: string } }
| { error: ServiceError; ok: false },
>
URL to start an identity document verification session
- Defined in packages/entity-services/src/identity/IdentityService.ts:345

search

search(
    __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[];
        nameLike?: string;
        orderBy?: DbOrderByCriterion<
            Omit<
                PgTableWithColumns<
                    {
                        columns: {
                            countryOfResidence: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "countryOfResidence";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            createdAt: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgTimestamp";
                                    data: Date;
                                    dataType: "date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "createdAt";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            customerId: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgInteger";
                                    data: number;
                                    dataType: "number";
                                    driverParam: (...)
                                    | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "customerId";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            data: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgJsonb";
                                    data: { dateOfBirth?: ... };
                                    dataType: "json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "data";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                { $type: { dateOfBirth?: ... } },
                            >;
                            deletedAt: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgTimestamp";
                                    data: Date;
                                    dataType: "date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "deletedAt";
                                    notNull: false;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            email: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "email";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            externalId: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: true;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "externalId";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            id: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgInteger";
                                    data: number;
                                    dataType: "number";
                                    driverParam: (...)
                                    | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: "byDefault";
                                    isAutoincrement: false;
                                    isPrimaryKey: true;
                                    name: "id";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            name: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgJsonb";
                                    data: { firstName: ...; lastName: ...; middleName?: ... };
                                    dataType: "json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "name";
                                    notNull: false;
                                    tableName: "identity";
                                },
                                {},
                                { $type: { firstName: ...; lastName: ...; middleName?: ... } },
                            >;
                            phone: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "phone";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            referenceId: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "referenceId";
                                    notNull: false;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            status: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgText";
                                    data: (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: [(...), ...(...)[]];
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "status";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                { $type: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...) },
                            >;
                            updatedAt: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgTimestamp";
                                    data: Date;
                                    dataType: "date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "updatedAt";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            uuid: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgUUID";
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "uuid";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {},
                            >;
                            verification: PgColumn<
                                {
                                    baseColumn: never;
                                    columnType: "PgJsonb";
                                    data: {
                                        amlVerification?: ...;
                                        customerVerification?: ...;
                                        identityDocumentVerification?: ...;
                                        verificationProfileId?: ...;
                                    };
                                    dataType: "json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: "verification";
                                    notNull: true;
                                    tableName: "identity";
                                },
                                {},
                                {
                                    $type: {
                                        amlVerification?: ...;
                                        customerVerification?: ...;
                                        identityDocumentVerification?: ...;
                                        verificationProfileId?: ...;
                                    };
                                },
                            >;
                        };
                        dialect: "pg";
                        name: "identity";
                        schema: "b2b";
                    },
                >,
                "enableRLS",
            >,
            "createdAt"
            | "updatedAt",
        >[];
        page?: number;
        pageSize?: number;
        partialText?: string;
        phoneLike?: string;
        phones?: string[];
        referenceIdLike?: string;
        referenceIds?: string[];
        statuses?: (
            | "ACTIVE"
            | "DISABLED"
            | "PENDING_VERIFICATION"
            | "REVIEW"
            | "BLOCKED"
            | "DELETED"
        )[];
        updatedAt?: DbTimestampCriteria;
    },
): Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: {
                amlVerification?: {
                    id: string;
                    status: "PENDING"
                    | "REVIEW"
                    | "APPROVED"
                    | "DECLINED";
                };
                capabilities: (
                    | "TRANSACT"
                    | "MANAGE_PAYMENT_INSTRUMENT"
                    | "MANAGE_LEDGER_ACCOUNT"
                    | "MANAGE_DEPOSIT_MEMO"
                )[];
                countryOfResidence: string;
                createdAt: Date;
                customerVerification?: { id: string };
                dateOfBirth?: string;
                deletedAt?: Date;
                email: string;
                id: string;
                identityDocumentVerification?: {
                    id: string;
                    status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                };
                name?: { firstName: string; lastName: string; middleName?: string };
                phone: string;
                referenceId?: string;
                status:
                    | "ACTIVE"
                    | "DISABLED"
                    | "PENDING_VERIFICATION"
                    | "REVIEW"
                    | "BLOCKED"
                    | "DELETED";
                updatedAt: Date;
                uuid: string;
                verificationProfileId?: string;
            }[];
        };
    },
>
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[];
      nameLike?: string;
      orderBy?: DbOrderByCriterion<
          Omit<
              PgTableWithColumns<
                  {
                      columns: {
                          countryOfResidence: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "countryOfResidence";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          createdAt: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgTimestamp";
                                  data: Date;
                                  dataType: "date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "createdAt";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          customerId: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgInteger";
                                  data: number;
                                  dataType: "number";
                                  driverParam: (...)
                                  | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "customerId";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          data: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgJsonb";
                                  data: { dateOfBirth?: ... };
                                  dataType: "json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "data";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              { $type: { dateOfBirth?: ... } },
                          >;
                          deletedAt: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgTimestamp";
                                  data: Date;
                                  dataType: "date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "deletedAt";
                                  notNull: false;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          email: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "email";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          externalId: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: true;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "externalId";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          id: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgInteger";
                                  data: number;
                                  dataType: "number";
                                  driverParam: (...)
                                  | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: "byDefault";
                                  isAutoincrement: false;
                                  isPrimaryKey: true;
                                  name: "id";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          name: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgJsonb";
                                  data: { firstName: ...; lastName: ...; middleName?: ... };
                                  dataType: "json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "name";
                                  notNull: false;
                                  tableName: "identity";
                              },
                              {},
                              { $type: { firstName: ...; lastName: ...; middleName?: ... } },
                          >;
                          phone: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "phone";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          referenceId: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "referenceId";
                                  notNull: false;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          status: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgText";
                                  data: (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...);
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: [(...), ...(...)[]];
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "status";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              { $type: (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...) },
                          >;
                          updatedAt: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgTimestamp";
                                  data: Date;
                                  dataType: "date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "updatedAt";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          uuid: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgUUID";
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "uuid";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {},
                          >;
                          verification: PgColumn<
                              {
                                  baseColumn: never;
                                  columnType: "PgJsonb";
                                  data: {
                                      amlVerification?: ...;
                                      customerVerification?: ...;
                                      identityDocumentVerification?: ...;
                                      verificationProfileId?: ...;
                                  };
                                  dataType: "json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: "verification";
                                  notNull: true;
                                  tableName: "identity";
                              },
                              {},
                              {
                                  $type: {
                                      amlVerification?: ...;
                                      customerVerification?: ...;
                                      identityDocumentVerification?: ...;
                                      verificationProfileId?: ...;
                                  };
                              },
                          >;
                      };
                      dialect: "pg";
                      name: "identity";
                      schema: "b2b";
                  },
              >,
              "enableRLS",
          >,
          "createdAt"
          | "updatedAt",
      >[];
      page?: number;
      pageSize?: number;
      partialText?: string;
      phoneLike?: string;
      phones?: string[];
      referenceIdLike?: string;
      referenceIds?: string[];
      statuses?: (
          | "ACTIVE"
          | "DISABLED"
          | "PENDING_VERIFICATION"
          | "REVIEW"
          | "BLOCKED"
          | "DELETED"
      )[];
      updatedAt?: DbTimestampCriteria;
  }
  - OptionalamlVerificationStatuses?: ("PENDING" | "REVIEW" | "APPROVED" | "DECLINED")[]
  - OptionalcountriesOfResidence?: string[]
  - OptionalcreatedAt?: DbTimestampCriteria
  - 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
  - OptionalnameLike?: string
    Partial match on first, middle, last name or full name
  - OptionalorderBy?: DbOrderByCriterion<
        Omit<
            PgTableWithColumns<
                {
                    columns: {
                        countryOfResidence: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "countryOfResidence";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        createdAt: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgTimestamp";
                                data: Date;
                                dataType: "date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "createdAt";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        customerId: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgInteger";
                                data: number;
                                dataType: "number";
                                driverParam: (...)
                                | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "customerId";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        data: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgJsonb";
                                data: { dateOfBirth?: ... };
                                dataType: "json";
                                driverParam: unknown;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "data";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            { $type: { dateOfBirth?: ... } },
                        >;
                        deletedAt: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgTimestamp";
                                data: Date;
                                dataType: "date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "deletedAt";
                                notNull: false;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        email: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "email";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        externalId: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: true;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "externalId";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        id: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgInteger";
                                data: number;
                                dataType: "number";
                                driverParam: (...)
                                | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: "byDefault";
                                isAutoincrement: false;
                                isPrimaryKey: true;
                                name: "id";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        name: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgJsonb";
                                data: { firstName: ...; lastName: ...; middleName?: ... };
                                dataType: "json";
                                driverParam: unknown;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "name";
                                notNull: false;
                                tableName: "identity";
                            },
                            {},
                            { $type: { firstName: ...; lastName: ...; middleName?: ... } },
                        >;
                        phone: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "phone";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        referenceId: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "referenceId";
                                notNull: false;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        status: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgText";
                                data: (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                                dataType: "string";
                                driverParam: string;
                                enumValues: [(...), ...(...)[]];
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "status";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            { $type: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...) },
                        >;
                        updatedAt: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgTimestamp";
                                data: Date;
                                dataType: "date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "updatedAt";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        uuid: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgUUID";
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "uuid";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {},
                        >;
                        verification: PgColumn<
                            {
                                baseColumn: never;
                                columnType: "PgJsonb";
                                data: {
                                    amlVerification?: ...;
                                    customerVerification?: ...;
                                    identityDocumentVerification?: ...;
                                    verificationProfileId?: ...;
                                };
                                dataType: "json";
                                driverParam: unknown;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: "verification";
                                notNull: true;
                                tableName: "identity";
                            },
                            {},
                            {
                                $type: {
                                    amlVerification?: ...;
                                    customerVerification?: ...;
                                    identityDocumentVerification?: ...;
                                    verificationProfileId?: ...;
                                };
                            },
                        >;
                    };
                    dialect: "pg";
                    name: "identity";
                    schema: "b2b";
                },
            >,
            "enableRLS",
        >,
        "createdAt"
        | "updatedAt",
    >[]
  - Optionalpage?: number
    Defaults to 1
  - OptionalpageSize?: number
    Defaults to 50
  - 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"
        | "PENDING_VERIFICATION"
        | "REVIEW"
        | "BLOCKED"
        | "DELETED"
    )[]
  - OptionalupdatedAt?: DbTimestampCriteria
Returns Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: {
                amlVerification?: {
                    id: string;
                    status: "PENDING"
                    | "REVIEW"
                    | "APPROVED"
                    | "DECLINED";
                };
                capabilities: (
                    | "TRANSACT"
                    | "MANAGE_PAYMENT_INSTRUMENT"
                    | "MANAGE_LEDGER_ACCOUNT"
                    | "MANAGE_DEPOSIT_MEMO"
                )[];
                countryOfResidence: string;
                createdAt: Date;
                customerVerification?: { id: string };
                dateOfBirth?: string;
                deletedAt?: Date;
                email: string;
                id: string;
                identityDocumentVerification?: {
                    id: string;
                    status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
                };
                name?: { firstName: string; lastName: string; middleName?: string };
                phone: string;
                referenceId?: string;
                status:
                    | "ACTIVE"
                    | "DISABLED"
                    | "PENDING_VERIFICATION"
                    | "REVIEW"
                    | "BLOCKED"
                    | "DELETED";
                updatedAt: Date;
                uuid: string;
                verificationProfileId?: string;
            }[];
        };
    },
>
Inherited from IdentityQueryService.search
- Defined in packages/entity-services/src/identity/IdentityQueryService.ts:69

update

update(
    __namedParameters: {
        customerId: string;
        data: Partial<
            Pick<
                Identity,
                | "name"
                | "dateOfBirth"
                | "phone"
                | "email"
                | "referenceId"
                | "customerVerification",
            > & { status: Extract<Identity["status"], "ACTIVE" | "DISABLED"> },
        >;
        id: string;
    },
): Promise<
    | {
        error: | ServiceError<
            | "INVALID_COUNTRY"
            | "INVALID_PHONE"
            | "INVALID_EMAIL"
            | "INVALID_DATE_OF_BIRTH",
        >
        | ServiceError<"DUPLICATE", { duplicateIds: string[] }>
        | ServiceError<
            | "NOT_FOUND"
            | "MISSING_NAME"
            | "CANNOT_BYO_KYC"
            | "INVALID_STATUS"
            | "CANNOT_UPDATE_NAME",
        >;
        ok: false;
    }
    | {
        ok: true;
        value: {
            amlVerification?: {
                id: string;
                status: "PENDING"
                | "REVIEW"
                | "APPROVED"
                | "DECLINED";
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryOfResidence: string;
            createdAt: Date;
            customerVerification?: { id: string };
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string;
            id: string;
            identityDocumentVerification?: {
                id: string;
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
            };
            name?: { firstName: string; lastName: string; middleName?: string };
            phone: string;
            referenceId?: string;
            status:
                | "ACTIVE"
                | "DISABLED"
                | "PENDING_VERIFICATION"
                | "REVIEW"
                | "BLOCKED"
                | "DELETED";
            updatedAt: Date;
            uuid: string;
            verificationProfileId?: string;
        };
    },
>
Some changes may trigger a verification and put the identity in PENDING status.
Parameters
- __namedParameters: {
      customerId: string;
      data: Partial<
          Pick<
              Identity,
              | "name"
              | "dateOfBirth"
              | "phone"
              | "email"
              | "referenceId"
              | "customerVerification",
          > & { status: Extract<Identity["status"], "ACTIVE" | "DISABLED"> },
      >;
      id: string;
  }
Returns Promise<
    | {
        error: | ServiceError<
            | "INVALID_COUNTRY"
            | "INVALID_PHONE"
            | "INVALID_EMAIL"
            | "INVALID_DATE_OF_BIRTH",
        >
        | ServiceError<"DUPLICATE", { duplicateIds: string[] }>
        | ServiceError<
            | "NOT_FOUND"
            | "MISSING_NAME"
            | "CANNOT_BYO_KYC"
            | "INVALID_STATUS"
            | "CANNOT_UPDATE_NAME",
        >;
        ok: false;
    }
    | {
        ok: true;
        value: {
            amlVerification?: {
                id: string;
                status: "PENDING"
                | "REVIEW"
                | "APPROVED"
                | "DECLINED";
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryOfResidence: string;
            createdAt: Date;
            customerVerification?: { id: string };
            dateOfBirth?: string;
            deletedAt?: Date;
            email: string;
            id: string;
            identityDocumentVerification?: {
                id: string;
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
            };
            name?: { firstName: string; lastName: string; middleName?: string };
            phone: string;
            referenceId?: string;
            status:
                | "ACTIVE"
                | "DISABLED"
                | "PENDING_VERIFICATION"
                | "REVIEW"
                | "BLOCKED"
                | "DELETED";
            updatedAt: Date;
            uuid: string;
            verificationProfileId?: string;
        };
    },
>
- Defined in packages/entity-services/src/identity/IdentityService.ts:165

Class IdentityService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns IdentityService

Properties

Protected Readonlydb

Protected ReadonlydbHelper

Methods

create

Parameters

delete

Parameters

get

Parameters

getVerificationUrl

Parameters

customerId: string

id: string

redirectUrl: string

Returns Promise< | { ok: true; value: { url: string } } | { error: ServiceError; ok: false },>

search

Parameters

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

OptionalcountriesOfResidence?: string[]

OptionalcreatedAt?: DbTimestampCriteria

customerId: string

OptionalemailLike?: string

Optionalemails?: string[]

OptionalhasCustomerVerification?: boolean

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

Optionalids?: string[]

OptionalnameLike?: string

Optionalpage?: number

OptionalpageSize?: number

OptionalpartialText?: string

OptionalphoneLike?: string

Optionalphones?: string[]

OptionalreferenceIdLike?: string

OptionalreferenceIds?: string[]

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

OptionalupdatedAt?: DbTimestampCriteria

update

Parameters

Settings

On This Page

`Protected` `Readonly`db

`Protected` `Readonly`dbHelper

Returns Promise<
| { ok: true; value: { url: string } }
| { error: ServiceError; ok: false },
>

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

`Optional`countriesOfResidence?: string[]

`Optional`createdAt?: DbTimestampCriteria

`Optional`emailLike?: string

`Optional`emails?: string[]

`Optional`hasCustomerVerification?: boolean

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

`Optional`ids?: string[]

`Optional`nameLike?: string

`Optional`page?: number

`Optional`pageSize?: number

`Optional`partialText?: string

`Optional`phoneLike?: string

`Optional`phones?: string[]

`Optional`referenceIdLike?: string

`Optional`referenceIds?: string[]

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

`Optional`updatedAt?: DbTimestampCriteria