verifymyagecouk/verifymyage-oauth

VerifyMyAge OAuth Verification

3.0.2 2025-01-17 15:04 UTC

Requires

• league/oauth2-client: ^2.6

MIT

README

A PHP SDK for integrating with VerifyMyAge's verification service. This library provides easy-to-use methods for implementing age verification in your PHP applications.

Table of Contents

• Installation
• Features
• Usage
  • Basic Setup
  • Available Methods
  • Verification Methods
  • Verification Status
  • Supported Countries
• Examples
• Development Mode

Installation

composer require verifymyagecouk/verifymyage-oauth

Features

• Authentication flow
• Multiple verification methods
• Support for various countries
• Sandbox environment for testing
• HMAC authentication
• User data encryption

Usage

Basic Setup

use VerifyMyAge\OAuth;

// Initialize the OAuth client
$oauth = new OAuth(
    'your-client-id',
    'your-client-secret',
    'your-redirect-url'
);

// For development/testing, use sandbox mode
$oauth->useSandbox();

Available Methods

The SDK provides three different versions of the OAuth implementation:

1. OAuth (Legacy):

use VerifyMyAge\OAuth;
$oauth = new OAuth($clientId, $clientSecret, $redirectUrl);

1. OAuthV1:

use VerifyMyAge\OAuthV1;
$oauth = new OAuthV1($clientId, $clientSecret, $redirectUrl);

1. OAuthV2 (Recommended):

use VerifyMyAge\OAuthV2;
$oauth = new OAuthV2($clientId, $clientSecret, $redirectUrl);

Verification Methods

Available verification methods:

Methods::AGE_ESTIMATION
Methods::CREDIT_CARD
Methods::ID_SCAN
Methods::ID_SCAN_FACE_MATCH
Methods::EMAIL

Starting Verification (OAuthV2)

$result = $oauth->getStartVerificationUrl(
    country: Countries::UNITED_KINGDOM,
    method: Methods::ID_SCAN,
    businessSettingsId: 'your-business-settings-id',
    externalUserId: 'user-123',
    verificationId: 'verification-123',
    webhook: 'https://your-webhook.com/callback',
    stealth: false,
    runOtp: false,
    userInfo: [
        'email' => '[e-mail]'
        // Additional user information
    ]
);

Handling the OAuth Flow

1. Generate Authorization URL:

$authUrl = $oauth->redirectURL(
    country: Countries::UNITED_KINGDOM,
    method: Methods::ID_SCAN
);

1. Exchange Code for Token:

After the user completes the verification process with us, we will redirect the user back to you using your redirect URL provided to us in the first step, we will keep all the query strings you've sent and also add two new ones, First as code and Second as verification_id. The code must be used in this function, so we can authenticate your request and identify the verification that you want to get the result.

$token = $oauth->exchangeCodeByToken($code);

Supported Countries

The SDK supports various countries including:

• United Kingdom (Countries::UNITED_KINGDOM)
• France (Countries::FRANCE)
• Germany (Countries::GERMANY)
• United States (Countries::UNITED_STATES_OF_AMERICA)
• Demo mode (Countries::DEMO)

Development Mode

For testing and development, use the sandbox environment:

$oauth->useSandbox();

This will direct all requests to the sandbox API endpoint.

Complete Example

Here's a complete example of implementing age verification:

<?php

use VerifyMyAge\OAuthV2;
use VerifyMyAge\Countries;
use VerifyMyAge\Methods;

// Initialize the OAuth client
$oauth = new OAuthV2(
    clientID: 'your-client-id',
    clientSecret: 'your-client-secret',
    redirectURL: 'https://your-app.com/callback'
);

// Use sandbox for development
$oauth->useSandbox();

// Start verification process
$verificationResult = $oauth->getStartVerificationUrl(
    country: Countries::UNITED_KINGDOM,
    method: Methods::ID_SCAN,
    businessSettingsId: 'your-business-id',
    externalUserId: 'user-123',
    webhook: 'https://your-app.com/webhook'
);

// Handle the verification response
if (isset($verificationResult['verification_url'])) {
    // Redirect user to verification URL
    header('Location: ' . $verificationResult['verification_url']);
    exit;
}

Verification Status (OAuthV1 & OAuthV2)

For detailed information about how to check the verification status, please refer to the official documentation: Verification Status Documentation

Security Considerations

• Always use HTTPS for redirect URLs
• Keep your client credentials secure
• Validate all user input
• Implement proper error handling
• Use webhook validation for callbacks

Error Handling

The SDK throws exceptions for invalid inputs or API errors. Always wrap API calls in try-catch blocks:

try {
    $result = $oauth->getStartVerificationUrl(...);
} catch (\Exception $e) {
    // Handle the error appropriately
    error_log($e->getMessage());
}