PHPackages                             signifyd/signifyd-php - 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. [API Development](/categories/api)
4. /
5. signifyd/signifyd-php

ActiveLibrary[API Development](/categories/api)

signifyd/signifyd-php
=====================

Signifyd client API plugin for PHP

4.1.6(5mo ago)11861.6k—4.7%14[1 PRs](https://github.com/signifyd/signifyd-php/pulls)1MITPHPPHP >=5.5.0CI failing

Since Dec 9Pushed 5mo ago43 watchersCompare

[ Source](https://github.com/signifyd/signifyd-php)[ Packagist](https://packagist.org/packages/signifyd/signifyd-php)[ RSS](/packages/signifyd-signifyd-php/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (2)Versions (81)Used By (1)

⚠️ WARNING ⚠️
-------------

[](#warning-warning-warning)

> **V2 SDK is deprecated**Please refer to our [V3 API documentation](https://docs.signifyd.com) and download the OpenAPI specification linked at the top of the page to generate PHP and other SDKs for the latest version of Signifyd's Antifraud APIs.

Signifyd V2 PHP SDK
===================

[](#signifyd-v2-php-sdk)

This repository contains the PHP SDK client for the **deprecated** [Signifyd V2 API](https://developer.signifyd.com/api-v2/).

Overview
--------

[](#overview)

This document will give an overview on the available methods in the Signifyd PHP library. Also examples for this methods will be provided.

Support
-------

[](#support)

For questions or issues please contact our [support team](https://www.signifyd.com/contact/). You can submit feedback and suggestions for improvement [here](https://github.com/signifyd/php/issues).

Examples
--------

[](#examples)

If you are looking for a sample code that was tested and works, check out the [`sdk-examples`](https://github.com/signifyd/signifyd-php/tree/development-not-for-use/sdk-examples) repository.

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

[](#requirements)

- `PHP >= 5.6.0`
- In order to use the API you need to provide your API key. You can find your API key on your [account page](https://app.signifyd.com/settings).

Installing the SDK
------------------

[](#installing-the-sdk)

##### With composer

[](#with-composer)

The Signifyd PHP SDK is available on Packagist. To add it to your project, simply run command below to get the latest version:

```
$ php composer.phar require signifyd/signifyd-php

```

If you want you can specify a version by adding it to the command:

```
$ php composer.phar require signifyd/signifyd-php:DESIRED_VERSION_HERE

```

Or add the this line under the `"require"` key in your `composer.json`:

```
{
    "require" : {
        ...
        "signifyd/signifyd-php": "DESIRED_VERSION_HERE"
    }
}

```

Change DESIRED\_VERSION\_HERE by the version description which most fits to your business. To learn more about version numbers check Composer documentation.

After adding the line you must install the Signifyd PHP SDK dependency by running:

```
$ php composer.phar install

```

Getting Started
---------------

[](#getting-started)

There are 3 api classes that each represents the 3 main parts of the API

***CASE API*** Which works with cases which are orders submitted to Signifyd for review. A case contains payment, recipient, product, shipping, and account information.

***GUARANTEE API*** Which works with guarantee which is a financial liability shift that protects online retailers in case of chargebacks. View our product manual to learn more.

***WEBHOOKS API*** Which works with webhooks which are messages sent by SIGNIFYD via HTTP POST to a url you configure on your Notifications page in the SIGNIFYD settings. Webhook messages are sent when certain events occur in the life of an investigation. They allow your application to receive pushed updates about a case, rather than poll SIGNIFYD for status changes.

API Clases
----------

[](#api-clases)

### CaseApi

[](#caseapi)

The CaseApi is the class the maps the main case functionality of the Signify API. This class has the methods that work with the Signify investigations (called cases).

There are multiple ways to instantiate the CaseApi class. Usage examples:

```