README

PHP SDK to use VerifyMyContent Identity-Check OAuth service.

Installation

composer require verifymycontent/identity-check

Get Started

The main class to handle the moderation integration process is the \VerifyMyContent\IdentityCheck\VMC. It will abstract the HMAC generation for the API calls.

Start an Identity Verification

<?php
require(__DIR__ . "/vendor/autoload.php");

$vmc = new \VerifyMyContent\IdentityCheck\VMC(getenv('VMC_API_KEY'), getenv('VMC_API_SECRET'));
//$vmc->useSandbox();

try {
    $response = $vmc->createIdentityVerification([
            "customer" => [
                "id" => "YOUR-CUSTOMER-UNIQUE-ID",
                "email" => "person@example.com",
                "phone" => "+4412345678"
            ],
            "redirect_uri" => "https://example.com/callback",
            "webhook" => "https://example.com/webhook",
        ]
    );
    
    // save $response->id if you want to save the verification of your customer

    // redirect user to check identity
    header("Location: {$response->redirect_uri}");
} catch (Exception $e) {
  echo $e;
}

Retrieve Identity Verification by ID

Retrieves a specific identity verification to get current status.

• Pass the id of the identity verification to the getIdentityVerification method.
• Receive an \VerifyMyContent\SDK\IdentityVerification\Entity\Responses\GetIdentityVerificationResponse (library used internally by this sdk).

<?php
require(__DIR__ . "/vendor/autoload.php");

$vmc = new \VerifyMyContent\IdentityCheck\VMC(getenv('VMC_API_KEY'), getenv('VMC_API_SECRET'));
//$vmc->useSandbox();

$response = $vmc->getIdentityVerification("YOUR-IDENTITY-VERIFICATION-ID");

// Printing current status
echo "Status: {$response->status}";

Receive an Identity Verification Webhook

Receive a webhook from VerifyMyContent when the identity verification status changes.

• Receive a webhook from VerifyMyContent with the $_POST data that can be parsed using method parseIdentityVerificationWebhookPayload.

<?php
require(__DIR__ . "/vendor/autoload.php");

$vmc = new \VerifyMyContent\IdentityCheck\VMC(getenv('VMC_API_KEY'), getenv('VMC_API_SECRET'));

$jsonPayload = '{
  "id": "ABC-123-5678-ABC",
  "customer_id": "customer_id",
  "status": "pending"
}';
$data = json_decode($jsonPayload, true);
$webhook = $vmc->parseIdentityVerificationWebhookPayload($data);

// Printing current status
echo "Status: {$webhook->status} received from verification {$webhook->id}";

// This is how you can check if the identity verification is approved.
if ($webhook->status === \VerifyMyContent\SDK\IdentityVerification\IdentityVerificationStatus::APPROVED) {
    // do your thing
}

Start a Re-Identification

<?php
require(__DIR__ . "/vendor/autoload.php");

$vmc = new \VerifyMyContent\IdentityCheck\VMC(getenv('VMC_API_KEY'), getenv('VMC_API_SECRET'));
//$vmc->useSandbox();

try {
    $response = $vmc->createReIdentification([
        "customer" => [
            "id" => "YOUR-CUSTOMER-UNIQUE-ID",
            "email" => "person@example.com", // optional
        ],
        "redirect_uri" => "https://example.com/callback",
        "webhook" => "https://example.com/webhook",
    ]);

    // redirect user to re-identify
    header("Location: {$response->redirect_uri}");
} catch (\VerifyMyContent\SDK\ReIdentification\Exception\FeatureNotEnabledException $e) {
    echo "Re-identification feature not enabled for this account.";
} catch (\VerifyMyContent\SDK\ReIdentification\Exception\NoApprovedVerificationFoundException $e) {
    echo "No approved verification found for this customer.";
} catch (Exception $e) {
    echo $e;
}

Retrieve Re-Identification by ID

Retrieves a specific re-identification to get current status.

• Pass the id of the re-identification to the getReIdentification method.
• Receive an \VerifyMyContent\SDK\ReIdentification\Entity\Responses\GetReIdentificationResponse (library used internally by this sdk).

<?php
require(__DIR__ . "/vendor/autoload.php");

$vmc = new \VerifyMyContent\IdentityCheck\VMC(getenv('VMC_API_KEY'), getenv('VMC_API_SECRET'));
//$vmc->useSandbox();

$response = $vmc->getReIdentification("YOUR-RE-IDENTIFICATION-ID");

// Printing current status
echo "Status: {$response->status}";

Receive a Re-Identification Webhook

<?php
require(__DIR__ . "/vendor/autoload.php");

$vmc = new \VerifyMyContent\IdentityCheck\VMC(getenv('VMC_API_KEY'), getenv('VMC_API_SECRET'));

$data = json_decode(file_get_contents('php://input'), true);
$webhook = $vmc->parseReIdentificationWebhookPayload($data);

// Printing current status
echo "Status: {$webhook->status} received from re-identification {$webhook->id}";

Add allowed redirect urls

Update the list of allowed redirect urls

<?php
require(__DIR__ . "/vendor/autoload.php");

$vmc = new \VerifyMyContent\IdentityCheck\VMC(getenv('VMC_API_KEY'), getenv('VMC_API_SECRET'));
$vmc->useSandbox();

try{
  $vmc->addAllowedRedirectUrls(["https://teste1.com", "https://teste2.com"]);
  echo "Urls replaced with success";
}catch(Exception $e){
  echo "Error";
  var_export($e);
}

Remove allowed redirect urls

Remove allowed redirect urls from the list

<?php
require(__DIR__ . "/vendor/autoload.php");

$vmc = new \VerifyMyContent\IdentityCheck\VMC(getenv('VMC_API_KEY'), getenv('VMC_API_SECRET'));
$vmc->useSandbox();

try{
  $vmc->removeAllowedRedirectUrls(["https://teste1.com"]);
  echo "Urls removed with success";
}catch(Exception $e){
  echo "Error";
  var_export($e);
}