Skip to main content
Version: Next

Prelude SDK for Laravel

A Laravel integration for the official Prelude PHP SDK. Phone number verification (OTP), lookups, transactional messages, notifications and anti-fraud signals — wired into the Laravel container, configured the Laravel way and testable without ever hitting the API.

This package is a thin, idiomatic binding layer. The underlying API reference (request parameters, response shapes, error codes) lives in the official Prelude documentation; these pages focus on how to use that SDK from a Laravel application.

Features​

  • Verification — create and check phone number (OTP) verifications.
  • Verification Management — manage test/excluded phone numbers and sender IDs.
  • Lookup — retrieve carrier, line type, country and fraud metadata for a number.
  • Transactional — send transactional messages from a template.
  • Notify — send notifications (single or batch) and manage subscriptions.
  • Watch — anti-fraud signals: predict outcomes, report events and send feedback.
  • First-class testing — swap the SDK client for a fake transporter and assert on requests without any network calls.

At a glance​

use AndreaAlhena\PreludeSdkLaravel\Facades\Prelude;

// Start a verification
$verification = Prelude::verification()->create(
    target: ['type' => 'phone_number', 'value' => '+39012345678'],
);

// Check the code submitted by the user
$check = Prelude::verification()->check(
    target: ['type' => 'phone_number', 'value' => '+39012345678'],
    code: '123456',
);

Documentation versions​

This site is versioned. Use the version selector in the top navigation to switch between releases: Next tracks the latest unreleased documentation from the develop branch, while tagged versions correspond to published package releases.

Continue to Installation to get started.