Laravel Sumsub Sdk Laravel Package

Getting Started

Install the package via Composer:

composer require shureban/laravel-sumsub-sdk

Publish the configuration file (if needed):

php artisan vendor:publish --provider="Shureban\LaravelSumsubSdk\SumsubServiceProvider"

Register the service provider in config/app.php (if not auto-discovered).

First Use Case: Verify identity checks via SumSub's API:

use Shureban\LaravelSumsubSdk\Facades\Sumsub;

$response = Sumsub::verifyIdentity($request->document, $request->selfie);

Implementation Patterns

Document Verification Workflow

1. Upload Documents: Use Sumsub::uploadDocument() for ID scans or passports.
2. Trigger Verification: Call Sumsub::verifyIdentity() with document + selfie.
3. Handle Callback: Configure webhook routes (/sumsub/callback) to process results.

Shareholder Registry Integration (New)

For SHAREHOLDER_REGISTRY document types (v2.2.6+):

$response = Sumsub::verifyShareholderRegistry(
    $request->registryDocument,
    $request->additionalData // e.g., shareholder ID
);

Error Handling

Wrap API calls in try-catch:

try {
    $result = Sumsub::verifyIdentity(...);
} catch (\Shureban\LaravelSumsubSdk\Exceptions\SumsubException $e) {
    // Log or notify (e.g., Slack)
    return back()->withErrors(['verification' => $e->getMessage()]);
}

Gotchas and Tips

Debugging

• Enable Debug Mode: Set SUMSUB_DEBUG=true in .env to log raw API responses.
• Webhook Testing: Use Sumsub::simulateWebhook() in tests to mock callbacks.

Configuration Quirks

• Document Subtypes: For SHAREHOLDER_REGISTRY, ensure the document_subtype is explicitly set in the request payload:

  $payload = [
      'document_type' => 'SHAREHOLDER_REGISTRY',
      'document_subtype' => 'REGISTRY_CERTIFICATE', // Example
      // ...
  ];
  

Extension Points

• Custom Verification Logic: Override App\Services\SumsubVerificationService to extend default behavior.
• Webhook Validation: Validate payloads with Sumsub::validateWebhookSignature() before processing.

Pitfalls

• Rate Limits: Monitor X-RateLimit-Remaining headers; implement retries with exponential backoff.
• Document Size: Ensure files comply with SumSub’s size limits (e.g., max 10MB for PDFs).