CodeIgniter

composer require constaia/constaia-php

CONSTAIA_API_KEY = ck_test_...
CONSTAIA_WEBHOOK_SECRET = whsec_...

<?php

namespace Config;

use CodeIgniter\Config\BaseService;
use Constaia\Client;

class Services extends BaseService
{
    public static function constaia(bool $getShared = true): Client
    {
        if ($getShared) {
            return static::getSharedInstance('constaia');
        }

        return new Client(env('CONSTAIA_API_KEY'), ['timeout' => 60, 'max_retries' => 2]);
    }
}

<?php

namespace App\Controllers;

use CodeIgniter\HTTP\ResponseInterface;
use Constaia\Exception\ConstaiaException;
use Constaia\Exception\InsufficientCreditsException;
use Constaia\Exception\InvalidRequestException;
use Constaia\Exception\RateLimitException;

class Documents extends BaseController
{
    public function upload(): ResponseInterface
    {
        $rules = ['file' => 'uploaded[file]|max_size[file,20480]|ext_in[file,jpg,jpeg,png,webp,heic,pdf]'];
        if (!$this->validate($rules)) {
            return $this->error(implode(' ', $this->validator->getErrors()), 400);
        }

        $file = $this->request->getFile('file');
        if (!$file->isValid() || $file->hasMoved()) {
            return $this->error('No document received.', 400);
        }

        // Only the language is taken from the widget.
        $fromBrowser = json_decode((string) $this->request->getPost('options'), true);
        $language = is_array($fromBrowser) && in_array($fromBrowser['language'] ?? '', ['es', 'en', 'pt', 'fr'], true)
            ? $fromBrowser['language']
            : 'es';

        try {
            $analysis = service('constaia')->analyze($file->getTempName(), [
                'filename' => $file->getClientName(),
                'expect'   => ['es_dni', 'es_nie', 'passport'],
                'checks'   => ['not_expired' => true, 'min_age_years' => 18],
                'storage'  => 'none',
                'language' => $language,
                'metadata' => ['user_id' => (string) session('user_id')],
            ]);
        } catch (InvalidRequestException $e) {
            return $this->error(match ($e->errorCode) {
                'file_too_large' => 'The file is larger than 20 MB.',
                'unsupported_file_type' => 'Upload an image (JPG, PNG, WEBP, HEIC) or a PDF.',
                'unreadable_image', 'unreadable_pdf' => 'We cannot read the document. Try another photo.',
                default => 'The document could not be processed.',
            }, 422);
        } catch (InsufficientCreditsException | RateLimitException $e) {
            log_message('error', 'Constaia {code} request_id={id}', ['code' => $e->errorCode, 'id' => $e->requestId]);

            return $this->error('The service is busy. Try again in a few minutes.', 503);
        } catch (ConstaiaException $e) {
            log_message('error', 'Constaia {status} {code} request_id={id}', [
                'status' => $e->httpStatus, 'code' => $e->errorCode, 'id' => $e->requestId,
            ]);

            return $this->error('We could not check the document. Please try again later.', 502);
        }

        // Store $analysis->id and $analysis->verdictStatus() in your model here.

        return $this->response->setJSON([
            'id'       => $analysis->id,
            'object'   => 'analysis',
            'status'   => $analysis->status,
            'document' => $analysis->document?->toArray(),
            'verdict'  => $analysis->verdict?->toArray(),
            'warnings' => $analysis->warnings ?? [],
        ]);
    }

    private function error(string $message, int $status): ResponseInterface
    {
        return $this->response->setStatusCode($status)->setJSON(['error' => ['message' => $message]]);
    }
}

<script type="module" src="https://cdn.jsdelivr.net/npm/@constaia/widget@0.1"></script>

<constaia-upload
    endpoint="<?= site_url('documents') ?>"
    document="es_dni"
    lang="en"
    headers='<?= json_encode([csrf_header() => csrf_hash()]) ?>'
></constaia-upload>

$routes->post('documents', 'Documents::upload', ['filter' => 'session']);
$routes->post('webhooks/constaia', 'ConstaiaWebhook::receive');

public array $globals = [
    'before' => [
        'csrf' => ['except' => ['webhooks/constaia']],
    ],
    'after' => [],
];

<?php

namespace App\Controllers;

use CodeIgniter\HTTP\ResponseInterface;
use Constaia\Exception\SignatureVerificationException;
use Constaia\Webhook;

class ConstaiaWebhook extends BaseController
{
    public function receive(): ResponseInterface
    {
        $headers = [];
        foreach (['webhook-id', 'webhook-timestamp', 'webhook-signature'] as $name) {
            $headers[$name] = $this->request->getHeaderLine($name);
        }

        try {
            $event = Webhook::verify((string) $this->request->getBody(), $headers, (string) env('CONSTAIA_WEBHOOK_SECRET'));
        } catch (SignatureVerificationException) {
            return $this->response->setStatusCode(400);
        }

        $cacheKey = 'constaia_wh_' . md5($this->request->getHeaderLine('webhook-id'));
        if (cache($cacheKey) !== null) {
            return $this->response->setStatusCode(204);
        }
        cache()->save($cacheKey, 1, 4 * DAY);

        switch ($event['type']) {
            case 'analysis.completed':
            case 'analysis.review_required':
            case 'analysis.failed':
                $analysis = $event['data'];
                log_message('info', 'Constaia {id}: {status}', [
                    'id' => $analysis['id'],
                    'status' => $analysis['verdict']['status'] ?? $analysis['status'],
                ]);
                // Update your model; if the work is heavy, put it in a queue.
                break;
            case 'credits.low':
                log_message('warning', 'Constaia credits low: {n}', ['n' => $event['data']['credits_available']]);
                break;
        }

        return $this->response->setStatusCode(204);
    }
}

<?php

use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\FeatureTestTrait;
use Constaia\Webhook;

final class ConstaiaTest extends CIUnitTestCase
{
    use FeatureTestTrait;

    public function testValidDni(): void
    {
        $analysis = service('constaia')->analyze(SUPPORTPATH . 'fixtures/dni_valid.jpg', ['expect' => 'es_dni']);

        $this->assertTrue($analysis->isValid());
        $this->assertSame('12345678Z', $analysis->field('document_number'));
    }

    public function testExpiredDni(): void
    {
        $analysis = service('constaia')->analyze(SUPPORTPATH . 'fixtures/dni_expired.jpg', ['expect' => 'es_dni']);

        $this->assertTrue($analysis->isInvalid());
        $this->assertSame('Caducado el 15/06/2020.', $analysis->verdict->reasons[1]->message);
    }

    public function testSignedWebhook(): void
    {
        $payload = json_encode(['type' => 'analysis.completed', 'created_at' => date(DATE_ATOM), 'data' => ['id' => 'an_test', 'status' => 'completed']]);
        $headers = Webhook::headers($payload, env('CONSTAIA_WEBHOOK_SECRET'));

        $this->withHeaders($headers + ['Content-Type' => 'application/json'])
            ->withBody($payload)
            ->post('webhooks/constaia')
            ->assertStatus(204);
    }
}