Class IdentityNotificationService

Builds the IDENTITY email payload for an identity status change and hands it to the CustomerNotificationService core. Lives in entity-services (next to the writer) so it can use the Identity domain type; the writer calls notify right where it publishes the identity.identity.statusUpdated event.

Relocated from the customer-dashboard handleIdentityEvent handler.

Index

Constructors

constructor

Methods

notify

Constructors

constructor

new IdentityNotificationService(
    args: {
        appBaseUrl: string;
        customerNotificationService: CustomerNotificationService;
        customerService: CustomerService;
        templateId: string;
    },
): IdentityNotificationService
Parameters
- args: {
      appBaseUrl: string;
      customerNotificationService: CustomerNotificationService;
      customerService: CustomerService;
      templateId: string;
  }
  - appBaseUrl: string
  - customerNotificationService: CustomerNotificationService
  - customerService: CustomerService
  - templateId: string
    SendGrid template id for the IDENTITY notification.
Returns IdentityNotificationService
- Defined in packages/entity-services/src/identity/IdentityNotificationService.ts:24

Methods

notify

notify(
    __namedParameters: {
        customerId: string;
        identity: {
            amlVerification?: {
                id: string;
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
            };
            capabilities: (
                | "TRANSACT"
                | "MANAGE_PAYMENT_INSTRUMENT"
                | "MANAGE_LEDGER_ACCOUNT"
                | "MANAGE_DEPOSIT_MEMO"
            )[];
            countryCode: string;
            countryOfResidence: string;
            createdAt: Date;
            customerVerification?: { id: string };
            dateOfBirth?: string;
            deletedAt?: Date;
            displayName: string;
            email: string;
            fullName?: string;
            id: string;
            identityDocumentVerification?: {
                id: string;
                status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
            };
            name?: { firstName: string; lastName: string; middleName?: string };
            phone: string;
            referenceId?: string;
            status:
                | "ACTIVE"
                | "DISABLED"
                | "DELETED"
                | "PENDING_VERIFICATION"
                | "REVIEW"
                | "BLOCKED";
            type: "IDENTITY";
            updatedAt: Date;
            uuid: string;
            verificationProfileId?: string;
        };
    },
): Promise<void>
Notify the relevant recipients of an identity status change. Best-effort.
Parameters
- __namedParameters: {
      customerId: string;
      identity: {
          amlVerification?: {
              id: string;
              status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
          };
          capabilities: (
              | "TRANSACT"
              | "MANAGE_PAYMENT_INSTRUMENT"
              | "MANAGE_LEDGER_ACCOUNT"
              | "MANAGE_DEPOSIT_MEMO"
          )[];
          countryCode: string;
          countryOfResidence: string;
          createdAt: Date;
          customerVerification?: { id: string };
          dateOfBirth?: string;
          deletedAt?: Date;
          displayName: string;
          email: string;
          fullName?: string;
          id: string;
          identityDocumentVerification?: {
              id: string;
              status: "PENDING" | "REVIEW" | "APPROVED" | "DECLINED";
          };
          name?: { firstName: string; lastName: string; middleName?: string };
          phone: string;
          referenceId?: string;
          status:
              | "ACTIVE"
              | "DISABLED"
              | "DELETED"
              | "PENDING_VERIFICATION"
              | "REVIEW"
              | "BLOCKED";
          type: "IDENTITY";
          updatedAt: Date;
          uuid: string;
          verificationProfileId?: string;
      };
  }
Returns Promise<void>
- Defined in packages/entity-services/src/identity/IdentityNotificationService.ts:38

Class IdentityNotificationService

Index

Constructors

Methods

Constructors

constructor

Parameters

appBaseUrl: string

customerNotificationService: CustomerNotificationService

customerService: CustomerService

templateId: string

Returns IdentityNotificationService

Methods

notify

Parameters

Returns Promise<void>

Settings

On This Page