Sinch Node.js SDK - v1.5.0
    Preparing search index...

    Variable startVerificationHelperConst

    startVerificationHelper: {
        buildCalloutRequest: (
            phoneNumber: string,
            reference?: string,
            locale?: string,
        ) => StartCalloutVerificationRequestData;
        buildDataRequest: (
            phoneNumber: string,
            reference?: string,
        ) => StartDataVerificationRequestData;
        buildFlashCallRequest: (
            phoneNumber: string,
            reference?: string,
            dialTimeout?: number,
            interceptionTimeout?: number,
            additionalOptions?: Record<string, unknown>,
        ) => StartFlashCallVerificationRequestData;
        buildPhoneCallRequest: (
            phoneNumber: string,
            reference?: string,
            locale?: string,
            additionalOptions?: Record<string, unknown>,
        ) => StartPhoneCallVerificationRequestData;
        buildSeamlessRequest: (
            phoneNumber: string,
            reference?: string,
        ) => StartSeamlessVerificationRequestData;
        buildSmsRequest: (
            phoneNumber: string,
            reference?: string,
            smsOptions?: SmsOptions,
        ) => StartSmsVerificationRequestData;
        buildWhatsAppRequest: (
            phoneNumber: string,
            reference?: string,
            whatsAppOptions?: WhatsAppOptions,
        ) => StartWhatsAppVerificationRequestData;
    }

    Type Declaration

    • buildCalloutRequest: (
          phoneNumber: string,
          reference?: string,
          locale?: string,
      ) => StartCalloutVerificationRequestData

      Builds a callout request body with the provided phone number, reference, and locale.

      Use the method buildPhoneCallRequest() instead

    • buildDataRequest: (phoneNumber: string, reference?: string) => StartDataVerificationRequestData

      Builds a request object for initiating a data verification process.

    • buildFlashCallRequest: (
          phoneNumber: string,
          reference?: string,
          dialTimeout?: number,
          interceptionTimeout?: number,
          additionalOptions?: Record<string, unknown>,
      ) => StartFlashCallVerificationRequestData

      Builds a request object for starting a flash call verification process.

    • buildPhoneCallRequest: (
          phoneNumber: string,
          reference?: string,
          locale?: string,
          additionalOptions?: Record<string, unknown>,
      ) => StartPhoneCallVerificationRequestData

      Builds a request object for starting a phone call verification process.

    • buildSeamlessRequest: (
          phoneNumber: string,
          reference?: string,
      ) => StartSeamlessVerificationRequestData

      Builds a seamless verification request body with the provided phone number and optional reference.

      Use the method buildDataRequest() instead

    • buildSmsRequest: (
          phoneNumber: string,
          reference?: string,
          smsOptions?: SmsOptions,
      ) => StartSmsVerificationRequestData

      Builds a request object for starting an SMS verification process.

    • buildWhatsAppRequest: (
          phoneNumber: string,
          reference?: string,
          whatsAppOptions?: WhatsAppOptions,
      ) => StartWhatsAppVerificationRequestData

      Builds a request object for starting a WhatsApp verification process.