PHPackages                             prelude-so/sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Authentication & Authorization](/categories/authentication)
4. /
5. prelude-so/sdk

ActiveLibrary[Authentication & Authorization](/categories/authentication)

prelude-so/sdk
==============

PHP SDK for Prelude services including OTP SMS verification

1.2.2(10mo ago)0302↓50%[1 issues](https://github.com/AndreaAlhena/prelude-sdk/issues)1MITPHPPHP >=8.1CI passing

Since Aug 2Pushed 10mo agoCompare

[ Source](https://github.com/AndreaAlhena/prelude-sdk)[ Packagist](https://packagist.org/packages/prelude-so/sdk)[ Docs](https://github.com/AndreaAlhena/prelude-sdk)[ RSS](/packages/prelude-so-sdk/feed)WikiDiscussions main Synced 3mo ago

READMEChangelogDependencies (5)Versions (22)Used By (1)

Prelude PHP SDK
===============

[](#prelude-php-sdk)

[![codecov](https://camo.githubusercontent.com/2974e41a541437507c64e0cb1dff9a8d4f3f3b663e0c3a7d71914c3b03916b76/68747470733a2f2f636f6465636f762e696f2f6769746875622f416e64726561416c68656e612f7072656c7564652d73646b2f67726170682f62616467652e7376673f746f6b656e3d38443051584c4f303858)](https://codecov.io/github/AndreaAlhena/prelude-sdk)[![Made with Trae](https://camo.githubusercontent.com/a744c283025bab322f80b1cefc34e9b85c643871d3ff32d16a2a2eb640b8c686/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4d616465253230776974682d5472616525323041492d626c756576696f6c65743f7374796c653d666c617426636f6c6f723d333246303842)](https://trae.ai)

A comprehensive PHP SDK for integrating with [Prelude.so](https://prelude.so) services, including OTP verification.

Installation
------------

[](#installation)

Install the SDK using Composer:

```
composer require prelude-so/sdk
```

Requirements
------------

[](#requirements)

- PHP 8.1 or higher
- ext-json
- GuzzleHttp 7.0+

Table of Contents
-----------------

[](#table-of-contents)

- [Installation](#installation)
- [Requirements](#requirements)
- [Quick Start](#quick-start)
- [Configuration](#configuration)
- [Verification Service](#verification-service)
    - [Create Verification](#create-verification)
    - [Check OTP](#check-otp)
    - [Resend OTP](#resend-otp)
- [Lookup Service](#lookup-service)
    - [Phone Number Lookup](#phone-number-lookup)
- [Transactional Service](#transactional-service)
    - [Send Transactional Message](#send-transactional-message)
- [Watch Service](#watch-service)
    - [Predict Verification Outcome](#predict-verification-outcome)
    - [Send Feedback](#send-feedback)
    - [Dispatch Events](#dispatch-events)
- [Webhook Service](#webhook-service)
    - [Basic Usage](#basic-usage)
    - [Available Methods](#available-methods)
    - [Benefits](#benefits)
- [Webhook Events](#webhook-events)
    - [Basic Webhook Processing](#basic-webhook-processing)
    - [Verify Webhook Events](#verify-webhook-events)
    - [Transactional Webhook Events](#transactional-webhook-events)
    - [Generic Webhook Events](#generic-webhook-events)
    - [Event Type Detection](#event-type-detection)
    - [Working with Price Objects](#working-with-price-objects)
- [Examples](#examples)
- [Error Handling](#error-handling)
- [Models](#models)
- [Development](#development)
- [Contributing](#contributing)
- [License](#license)
- [Support](#support)

Quick Start
-----------

[](#quick-start)

```