PHPackages idanalyzer/id-analyzer-v2-php-sdk - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Authentication & Authorization](/categories/authentication) 4. / 5. idanalyzer/id-analyzer-v2-php-sdk ActiveLibrary[Authentication & Authorization](/categories/authentication) idanalyzer/id-analyzer-v2-php-sdk ================================= ID scanning and verification PHP SDK for worldwide driver license, passport, ID card scanning and identity verification using ID Analyzer API V2. 1.2.0(2w ago)01.8k1[1 PRs](https://github.com/idanalyzer/id-analyzer-v2-php/pulls)MITPHPPHP >=7.4CI passing Since Mar 21Pushed 2w ago1 watchersCompare [ Source](https://github.com/idanalyzer/id-analyzer-v2-php)[ Packagist](https://packagist.org/packages/idanalyzer/id-analyzer-v2-php-sdk)[ Docs](https://www.idanalyzer.com)[ RSS](/packages/idanalyzer-id-analyzer-v2-php-sdk/feed)WikiDiscussions main Synced 2d ago READMEChangelog (3)Dependencies (2)Versions (9)Used By (0) ID Analyzer PHP SDK โ€” Identity Verification, KYC, Document & Biometric API ============================================================================== [](#id-analyzer-php-sdk--identity-verification-kyc-document--biometric-api) [![Packagist version](https://camo.githubusercontent.com/223abab64ce9faeb3a72e3344983bb74531fbfc875022039e77428b1b3444251/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6964616e616c797a65722f69642d616e616c797a65722d76322d7068702d73646b2e737667)](https://packagist.org/packages/idanalyzer/id-analyzer-v2-php-sdk)[![PHP version](https://camo.githubusercontent.com/07a2e9ec5b2c77036f6b2593639b4bfb9029fb30c80d2b9e46bd32b0e221ade5/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f6964616e616c797a65722f69642d616e616c797a65722d76322d7068702d73646b2e737667)](https://packagist.org/packages/idanalyzer/id-analyzer-v2-php-sdk)[![license](https://camo.githubusercontent.com/e71caafbaaceafad287cdd2d56bc8b689912ffaa14565e698a104d92d158c42b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6964616e616c797a65722f69642d616e616c797a65722d76322d7068702d73646b2e737667)](LICENSE) Official PHP client library for the **[ID Analyzer](https://www.idanalyzer.com) API v2** โ€” automate identity document verification, KYC onboarding and biometric checks in minutes. Scan and authenticate **passports, driver's licenses, ID cards, visas and residence permits from 190+ countries**, run **1:1 face match and liveness detection**, screen against **AML / PEP / sanctions** watchlists, and onboard users remotely with **DocuPass** hosted verification & e-signature. - ๐ŸŒ **Website:** [www.idanalyzer.com](https://www.idanalyzer.com) - ๐Ÿ“š **Developer docs & API reference:** [developer.idanalyzer.com](https://developer.idanalyzer.com/help) - ๐Ÿ“– **Full SDK class reference (auto-generated):** - ๐Ÿ”‘ **Get your API key:** [portal2.idanalyzer.com](https://portal2.idanalyzer.com) - ๐Ÿ’ฌ **Support:** Features -------- [](#features) - **Document OCR & authentication** โ€” passport, driver's license, ID card, visa & residence-permit recognition from 190+ countries, including MRZ and PDF417 / AAMVA barcode parsing. - **Biometric verification** โ€” 1:1 face match and liveness / presentation-attack detection. - **AML screening** โ€” PEP, sanctions, watchlist and adverse-media checks. - **DocuPass** โ€” hosted, no-code remote identity verification, KYC/AML onboarding and legally-binding e-signature. - **KYC profiles, transaction vault, contract generation and webhooks.** - **US & EU data-residency regions.** > โš ๏ธ Never embed your API key in client-side apps (mobile, browser JS). Call the API from your server. Installation ------------ [](#installation) ``` composer require idanalyzer/id-analyzer-v2-php-sdk ``` Requires PHP 7.4+ (Guzzle 7, PSR-4). Authentication & region --------------------------- [](#authentication--region) Pass the zone as the second constructor argument โ€” `"us"` (default, `https://api2.idanalyzer.com`) or `"eu"` (`https://api2-eu.idanalyzer.com`): ``` $client = new IDAnalyzer2\Client("YOUR_API_KEY", "eu"); ``` Usage ----- [](#usage) Every endpoint is a request class under `IDAnalyzer2\Api\โ€ฆ`. Set its public properties, then call `$client->Do($request)`, which returns a `[$result, $err]` tuple โ€” `$result` is the decoded response object and `$err` is an `ApiError` (or `null`). Image/document inputs accept a base64 string, a file path/URL, or a `ref:` cache reference from a previous scan. ``` require_once __DIR__.'/vendor/autoload.php'; use IDAnalyzer2\Client; use IDAnalyzer2\Api\Scanner\StandardScan; $client = new Client("YOUR_API_KEY"); $scan = new StandardScan(); $scan->document = base64_encode(file_get_contents('id_front.jpg')); $scan->face = base64_encode(file_get_contents('selfie.jpg')); // optional biometric check $scan->profile = "security_medium"; // a preset, or your KYC profile ID list($result, $err) = $client->Do($scan); if ($err !== null) { echo 'API error: '.$err->message; } else { echo $result->decision; // accept / review / reject } ``` Examples -------- [](#examples) ### Document scanning [](#document-scanning) ``` use IDAnalyzer2\Api\Scanner\QuickScan; // fast OCR use IDAnalyzer2\Api\Scanner\VeryQuickScan; // fastest OCR-only $qs = new QuickScan(); $qs->document = base64_encode(file_get_contents('id_front.jpg')); $qs->documentBack = base64_encode(file_get_contents('id_back.jpg')); // optional $qs->saveFile = true; // cache the image 24h and return a ref: hash list($result, $err) = $client->Do($qs); ``` ### Biometric โ€” face match & liveness [](#biometric--face-match--liveness) ``` use IDAnalyzer2\Api\Biometric\FaceVerification; use IDAnalyzer2\Api\Biometric\LivenessVerification; $face = new FaceVerification(); $face->reference = base64_encode(file_get_contents('id_portrait.jpg')); $face->face = base64_encode(file_get_contents('selfie.jpg')); $face->profile = "security_medium"; list($result, $err) = $client->Do($face); $live = new LivenessVerification(); $live->face = base64_encode(file_get_contents('selfie.jpg')); $live->profile = "security_medium"; list($result, $err) = $client->Do($live); ``` ### AML / PEP / sanctions screening [](#aml--pep--sanctions-screening) ``` use IDAnalyzer2\Api\AML\AMLSearch; use IDAnalyzer2\Api\AML\AMLV3Search; $aml = new AMLSearch(); $aml->name = "John Smith"; $aml->country = "US"; // optional ISO-2 filter list($result, $err) = $client->Do($aml); // POST /aml $amlv3 = new AMLV3Search(); $amlv3->text = "John Smith"; $amlv3->limit = 10; $amlv3->page = 1; list($result, $err) = $client->Do($amlv3); // POST /amlv3 ``` ### KYB โ€” business verification [](#kyb--business-verification) Verify a business from its registration/incorporation document: extract details, check official company registries, screen against sanctions/PEP, and return directors/owners to verify. Supply a document and/or known business identifiers (at least one of document, legalName or registrationNumber). ``` use IDAnalyzer2\Api\KYB\KYBVerify; // From a registration/incorporation document $kyb = new KYBVerify(); $kyb->document = base64_encode(file_get_contents('./registration.jpg')); list($result, $err) = $client->Do($kyb); // POST /kyb // Or from known business details $kyb = new KYBVerify(); $kyb->legalName = "ACME CORPORATION"; $kyb->registrationNumber = "12345678"; $kyb->countryIso2 = "US"; // ISO-2 country of registration list($result, $err) = $client->Do($kyb); // POST /kyb ``` ### Contracts โ€” generate & manage templates [](#contracts--generate--manage-templates) ``` use IDAnalyzer2\Api\Contract\GenerateContract; use IDAnalyzer2\Api\Contract\CreateTemplate; use IDAnalyzer2\Api\Contract\LsTemplate; use IDAnalyzer2\Api\Contract\TemplateDetail; use IDAnalyzer2\Api\Contract\EdTemplate; use IDAnalyzer2\Api\Contract\RmTemplate; // Create a template $create = new CreateTemplate(); $create->name = "NDA"; $create->content = "Signed by %{fullName}"; $create->orientation = "0"; $create->font = "Arial"; $create->timezone = "UTC"; list($tpl, $err) = $client->Do($create); $templateId = $tpl->templateId; // Generate a document from a template + data $gen = new GenerateContract(); $gen->templateId = $templateId; $gen->format = "PDF"; $gen->fillData = ["fullName" => "Mark"]; list($doc, $err) = $client->Do($gen); // List / detail / edit / remove $client->Do(new LsTemplate()); $detail = new TemplateDetail(); $detail->templateId = $templateId; $client->Do($detail); $rm = new RmTemplate(); $rm->templateId = $templateId; $client->Do($rm); ``` ### Transactions โ€” history, decisions, vault & export [](#transactions--history-decisions-vault--export) ``` use IDAnalyzer2\Api\Transaction\LsTransaction; use IDAnalyzer2\Api\Transaction\TransactionDetail; use IDAnalyzer2\Api\Transaction\EdTransaction; use IDAnalyzer2\Api\Transaction\RmTransaction; use IDAnalyzer2\Api\Transaction\OutputImage; use IDAnalyzer2\Api\Transaction\OutputFile; use IDAnalyzer2\Api\Transaction\ExportTransaction; // List & fetch $client->Do(new LsTransaction()); $detail = new TransactionDetail(); $detail->transactionId = "TX_ID"; $client->Do($detail); // Update decision / delete $ed = new EdTransaction(); $ed->transactionId = "TX_ID"; $ed->decision = "reject"; $client->Do($ed); $rm = new RmTransaction(); $rm->transactionId = "TX_ID"; $client->Do($rm); // Download a vault image / file (returns raw bytes) $oi = new OutputImage(); $oi->imageToken = "IMAGE_TOKEN"; list($bytes, $err) = $client->Do($oi); file_put_contents("image.jpg", $bytes); $of = new OutputFile(); $of->fileName = "audit-report.pdf"; list($bytes, $err) = $client->Do($of); file_put_contents($of->fileName, $bytes); // Export an archive (zip is base64 in the response) $et = new ExportTransaction(); $et->exportType = "json"; $et->createdAtMin = (string)(time() - 86400); $et->createdAtMax = (string)time(); list($export, $err) = $client->Do($et); file_put_contents("export.zip", base64_decode($export->Base64)); ``` ### DocuPass โ€” hosted remote verification & e-signature [](#docupass--hosted-remote-verification--e-signature) ``` use IDAnalyzer2\Api\Docupass\CreateDocupass; use IDAnalyzer2\Api\Docupass\LsDocupass; use IDAnalyzer2\Api\Docupass\DocupassDetail; use IDAnalyzer2\Api\Docupass\RmDocupass; $create = new CreateDocupass(); $create->profile = "security_medium"; // or your KYC profile ID $create->mode = 0; // 0=Document+Face, 1=Document, 2=Face, 3=e-Signature list($docupass, $err) = $client->Do($create); // send the user to the returned verification URL / reference echo $docupass->reference; $client->Do(new LsDocupass()); $d = new DocupassDetail(); $d->reference = $docupass->reference; $client->Do($d); $rm = new RmDocupass(); $rm->reference = $docupass->reference; $client->Do($rm); ``` ### KYC profiles [](#kyc-profiles) ``` use IDAnalyzer2\Api\Profile\CreateProfile; use IDAnalyzer2\Api\Profile\LsProfile; use IDAnalyzer2\Api\Profile\ProfileDetail; use IDAnalyzer2\Api\Profile\EdProfile; use IDAnalyzer2\Api\Profile\RmProfile; use IDAnalyzer2\Api\Profile\ExportProfile; $create = new CreateProfile(); // optionally set name, thresholds, decisions, acceptedDocuments, webhookโ€ฆ list($profile, $err) = $client->Do($create); $profileId = $profile->id; $client->Do(new LsProfile()); $d = new ProfileDetail(); $d->profileId = $profileId; $client->Do($d); $rm = new RmProfile(); $rm->profileId = $profileId; $client->Do($rm); $ex = new ExportProfile(); $ex->profileId = $profileId; $client->Do($ex); ``` ### Webhooks & account [](#webhooks--account) ``` use IDAnalyzer2\Api\Webhook\LsWebhook; use IDAnalyzer2\Api\Webhook\ResendWebhook; use IDAnalyzer2\Api\Webhook\RmWebhook; use IDAnalyzer2\Api\Account\MyAccount; $client->Do(new LsWebhook()); $resend = new ResendWebhook(); $resend->webhookId = "WEBHOOK_ID"; $client->Do($resend); $rm = new RmWebhook(); $rm->webhookId = "WEBHOOK_ID"; $client->Do($rm); // Account quota & usage list($account, $err) = $client->Do(new MyAccount()); ``` Runnable versions of every example are in the [`/example`](example) folder. API reference ------------- [](#api-reference) GroupRequest classes (`IDAnalyzer2\Api\โ€ฆ`)EndpointScanner`Scanner\StandardScan``POST /scan``Scanner\QuickScan``POST /quickscan``Scanner\VeryQuickScan``POST /veryquickscan`Biometric`Biometric\FaceVerification``POST /face``Biometric\LivenessVerification``POST /liveness`AML`AML\AMLSearch``POST /aml``AML\AMLV3Search``POST /amlv3`KYB`KYB\KYBVerify``POST /kyb`Contract`Contract\GenerateContract``POST /generate``Contract\CreateTemplate` / `LsTemplate` / `TemplateDetail` / `EdTemplate` / `RmTemplate``/contract`Transaction`Transaction\LsTransaction` / `TransactionDetail` / `EdTransaction` / `RmTransaction``/transaction``Transaction\ExportTransaction``POST /export/transaction``Transaction\OutputImage` / `OutputFile``/imagevault` ยท `/filevault`Docupass`Docupass\CreateDocupass` / `LsDocupass` / `DocupassDetail` / `RmDocupass``/docupass`Profile`Profile\CreateProfile` / `LsProfile` / `ProfileDetail` / `EdProfile` / `RmProfile` / `ExportProfile``/profile`Webhook`Webhook\LsWebhook` / `ResendWebhook` / `RmWebhook``/webhook`Account`Account\MyAccount``GET /myaccount`Full parameter-level reference: **[developer.idanalyzer.com/help/php](https://developer.idanalyzer.com/help/php)**. Resources --------- [](#resources) - [ID Analyzer website](https://www.idanalyzer.com) - [Developer documentation & API reference](https://developer.idanalyzer.com/help) - [PHP SDK guide](https://developer.idanalyzer.com/help/php) - [Dashboard โ€” get your API key](https://portal2.idanalyzer.com) Other ID Analyzer SDKs ---------------------- [](#other-id-analyzer-sdks) [PHP](https://github.com/idanalyzer/id-analyzer-v2-php) ยท [Python](https://github.com/idanalyzer/id-analyzer-v2-python) ยท [Node.js](https://github.com/idanalyzer/id-analyzer-v2-nodejs) ยท [.NET](https://github.com/idanalyzer/id-analyzer-v2-dotnet) ยท [Java](https://github.com/idanalyzer/id-analyzer-v2-java) ยท [Go](https://github.com/idanalyzer/id-analyzer-v2-go) License ------- [](#license) MIT ยฉ [ID Analyzer](https://www.idanalyzer.com) โ€” see [LICENSE](LICENSE). ### Health Score 46 โ€” FairBetter than 92% of packages Maintenance97 Actively maintained with recent releases Popularity22 Limited adoption so far Community10 Small or concentrated contributor base Maturity47 Maturing project, gaining track record Bus Factor1 Top contributor holds 60.7% of commits โ€” single point of failure How is this calculated?**Maintenance (25%)** โ€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** โ€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** โ€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** โ€” Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~136 days Recently: every ~146 days Total 7 Last Release 16d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/b9653151e2558bbc8b42b957b2ac79d3d7243050d30a0d7a57be048ca684ede6?d=identicon)[idanalyzer](/maintainers/idanalyzer) --- Top Contributors [![jeremyevith](https://avatars.githubusercontent.com/u/79330287?v=4)](https://github.com/jeremyevith "jeremyevith (17 commits)")[![marktohark](https://avatars.githubusercontent.com/u/19359934?v=4)](https://github.com/marktohark "marktohark (11 commits)") --- Tags pdf417passportamlmrzID Cardidentity verificationdriver licenseid verificationid ocrid analyzeraamvapep ### Embed Badge ![Health badge](/badges/idanalyzer-id-analyzer-v2-php-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/idanalyzer-id-analyzer-v2-php-sdk/health.svg)](https://phpackages.com/packages/idanalyzer-id-analyzer-v2-php-sdk) ``` ### Alternatives [aws/aws-sdk-php AWS SDK for PHP - Use Amazon Web Services in your PHP project 6.3k543.5M2.6k](/packages/aws-aws-sdk-php)[neuron-core/neuron-ai The PHP Agentic Framework. 2.0k656.1k38](/packages/neuron-core-neuron-ai)[tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3741.3M46](/packages/tencentcloud-tencentcloud-sdk-php)[tempest/framework The PHP framework that gets out of your way. 2.2k34.4k15](/packages/tempest-framework)[ellaisys/aws-cognito Laravel Authentication using AWS Cognito (Web and API) 123256.9k1](/packages/ellaisys-aws-cognito)[eslazarev/wildberries-sdk Wildberries OpenAPI clients (generated). 273.0k](/packages/eslazarev-wildberries-sdk) PHPackages ยฉ 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)