> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# SDK PHP da Didit para KYC, AML e transações

> Guia rápido do SDK PHP oficial da Didit: chamadas tipadas às APIs, verificação de webhooks e tokens de autenticação com qualquer cliente PSR-18.

A biblioteca oficial da Didit para PHP. Requer PHP 8.1 ou superior e funciona com qualquer cliente HTTP compatível com PSR-18; o Guzzle é a escolha mais comum. Consulte a [visão geral dos SDKs para servidor](https://docs.didit.me/pt/integration/server-sdks/overview.md) para ver o que todos os SDKs têm em comum.

## Instalação

```bash theme={null}
composer require didit-protocol/sdk-php guzzlehttp/guzzle
```

O pacote é o [`didit-protocol/sdk-php` no Packagist](https://packagist.org/packages/didit-protocol/sdk-php). O código-fonte e o registo de alterações estão em [didit-protocol/sdk-php](https://github.com/didit-protocol/sdk-php) no GitHub.

A verificação de tokens do [Authentication](#verificar-tokens-de-authentication) também requer a extensão `openssl`.

## Configurar o cliente

`new DiditClient()` lê `DIDIT_API_KEY` a partir do ambiente. Passe argumentos nomeados para substituir esse valor, ou para definir os identificadores da organização e da aplicação de que as chamadas ao nível da aplicação (casos, redes e relatórios regulamentares) precisam. Os campos do pedido são um único array com os nomes de campos da própria API; as respostas são objetos só de leitura com propriedades em camelCase e `toArray()`.

```php theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;
use Didit\RequestOptions;

$didit = new DiditClient(
    apiKey: getenv('DIDIT_API_KEY') ?: null,
    organizationId: getenv('DIDIT_ORGANIZATION_ID') ?: null,
    applicationId: getenv('DIDIT_APPLICATION_ID') ?: null,
    timeout: 30.0,
    maxRetries: 2,
);

// Options for a single call.
$decision = $didit->sessions->retrieveDecision(
    '11111111-2222-3333-4444-555555555555',
    [],
    new RequestOptions(timeout: 5.0, maxRetries: 0),
);
echo $decision->status, "\n";
```

## Criar uma sessão

Crie uma [sessão de verificação](https://docs.didit.me/pt/sessions-api/create-session.md) para um fluxo e envie o seu utilizador para o respetivo URL.

```php theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

$didit = new DiditClient();

$session = $didit->sessions->create([
    'workflow_id' => '11111111-2222-3333-4444-555555555555',
    'vendor_data' => 'user-123',
    'callback' => 'https://example.com/verification/done',
]);
echo $session->url, "\n";
```

## Ler a decisão

Quando o utilizador terminar (ou quando o webhook chegar), [leia a decisão](https://docs.didit.me/pt/sessions-api/retrieve-session.md). Cada resultado de funcionalidade é uma lista com uma entrada por cada nó do fluxo.

```php theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

$didit = new DiditClient();

$decision = $didit->sessions->retrieveDecision('11111111-2222-3333-4444-555555555555');
echo $decision->status, "\n";
foreach ($decision->idVerifications ?? [] as $verification) {
    echo $verification->status, "\n";
}
```

## Verificar um webhook

Passe o corpo bruto, exatamente como foi recebido, e os cabeçalhos do pedido. `verify` lança `WebhookVerificationException` para qualquer entrega que não seja válida e recente, e devolve um evento tipado nos restantes casos.

```php theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;
use Didit\Exception\WebhookVerificationException;
use Didit\Webhooks\Events\StatusUpdatedEvent;
use Psr\Http\Message\MessageInterface;

$didit = new DiditClient();

/** @param array<string, string|list<string>>|MessageInterface $headers */
function handleWebhook(DiditClient $didit, string $rawBody, array|MessageInterface $headers, string $secret): int
{
    try {
        $event = $didit->webhooks->verify($rawBody, $headers, $secret);
    } catch (WebhookVerificationException $e) {
        error_log('rejected: ' . $e->reason);
        return 400;
    }
    if ($event instanceof StatusUpdatedEvent) {
        error_log($event->sessionId . ' ' . $event->status);
    }
    return 200;
}

http_response_code(handleWebhook(
    $didit,
    (string) file_get_contents('php://input'),
    getallheaders(),
    (string) getenv('DIDIT_WEBHOOK_SECRET'),
));
```

No Laravel e no Symfony, passe `$request->getContent()` e `$request->headers->all()`; com um pedido PSR-7, passe o próprio pedido como cabeçalhos. Enquanto faz a rotação do segredo, passe ambos: `[$newSecret, $oldSecret]`. Consulte [Webhooks](https://docs.didit.me/pt/integration/webhooks.md) para os eventos e o esquema de assinatura.

## Fazer a triagem de uma transação

Envie um pagamento, um levantamento ou uma transferência de criptoativos para a [monitorização de transações](https://docs.didit.me/pt/transaction-monitoring/overview.md); a resposta indica o respetivo estado e a pontuação de risco.

```php theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

$didit = new DiditClient();

$transaction = $didit->transactions->create([
    'transaction_id' => 'txn-1001',
    'transaction_category' => 'finance',
    'transaction_details' => ['direction' => 'outbound', 'amount' => 1500.0, 'currency' => 'EUR'],
    'subject' => ['entity_type' => 'individual', 'vendor_data' => 'user-123', 'full_name' => 'Maria Garcia'],
]);
echo $transaction->status, ' ', $transaction->score, "\n";
```

## Verificar tokens de Authentication

`Authentication` verifica os tokens de acesso assinados pelo emissor do seu [Authentication](https://docs.didit.me/pt/authentication/overview.md), no seu backend, sem chamar a Didit em cada pedido. Passe uma cache PSR-16 para que as chaves do emissor sejam obtidas uma vez, e não em cada pedido. Também troca códigos, atualiza tokens, verifica e revoga sessões, e executa step-ups.

> [!NOTE]
>
> A verificação de tokens executa as validações descritas em [Verificar um token no seu servidor](https://docs.didit.me/pt/authentication/tokens-and-jwks.md#verifique-um-token-no-seu-servidor), com base no emissor e nas chaves de assinatura da sua aplicação.

```php theme={null}
<?php

require 'vendor/autoload.php';

use Didit\Authentication\Authentication;
use Didit\Authentication\TokenVerificationException;

// The publishable key (pk_live_... or pk_test_...) carries your issuer URL.
$auth = Authentication::fromPublishableKey('pk_live_...');

function currentUser(Authentication $auth, string $accessToken): ?string
{
    try {
        $claims = $auth->verifyAccessToken($accessToken, audience: 'your-application-id');
    } catch (TokenVerificationException $e) {
        error_log('rejected: ' . $e->reason);
        return null;
    }
    return $claims->sub;
}
```

## Erros

```php theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;
use Didit\Exception\ApiStatusException;
use Didit\Exception\NotFoundException;

$didit = new DiditClient();

try {
    $didit->sessions->retrieveDecision('11111111-2222-3333-4444-555555555555');
} catch (NotFoundException $e) {
    echo "no such session\n";
} catch (ApiStatusException $e) {
    echo $e->status, ' ', $e->requestId, "\n";
}
```

## Listas e ficheiros

```php theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;
use Didit\File;

$didit = new DiditClient();

// Lists page through every result.
foreach ($didit->sessions->list(['status' => 'Approved']) as $session) {
    echo $session->sessionId, "\n";
}

// Uploads take File::fromPath, File::fromBytes or File::fromStream.
$result = $didit->idVerification->verify([
    'front_image' => File::fromPath('id-front.jpg'),
    'back_image' => File::fromPath('id-back.jpg'),
]);
print_r($result->toArray());
```

As páginas de endpoints do lado do servidor da [referência da API](https://docs.didit.me/pt/api-reference/overview.md) têm um exemplo em PHP para a respetiva operação, exceto para os endpoints e campos que nenhuma versão 1.0.1 ainda inclui, indicados na [visão geral](https://docs.didit.me/pt/integration/server-sdks/overview.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.