README

为 Innov8tif eKYC API 提供简单 SDK。

安装

您可以通过 composer 安装此包

composer require raditzfarhan/innov8tif-ekyc

可用方法

OkeyDoc

菲律宾

• drivingLicense(string $idImageBase64Image, ?mixed $caseNo)
• sss(string $idImageBase64Image, ?mixed $caseNo)
• umid(string $idImageBase64Image, ?mixed $caseNo)
• voterId(string $idImageBase64Image, ?mixed $caseNo)
• postalId(string $idImageBase64Image, ?mixed $caseNo)
• prcProfessionalIdCard(string $idImageBase64Image, ?mixed $caseNo)
• nationalId(string $idImageBase64Image)

参数

更多详情，请参考这里。

OkeyID

• ocr(string $base64ImageString, ?string $backImage, ?string $docTypeEnabled, ?string $faceImageEnabled, ?string $imageEnabled, ?string $imageFormat)
• documentType(string $base64ImageString, string $backImage, string $imageFormat, ?bool $imageEnabled)

参数

更多详情，请参考这里。

使用方法

OkeyDoc

use RaditzFarhan\Innov8tifEkyc\OkeyDoc\PH\Client;
use RaditzFarhan\Innov8tifEkyc\Exceptions\APIError;

...

$client = new Client($apiKey);

$caseNo = 'CASE 1234';
$idImageBase64Image = '/9j/4AAQSkZJ...fYs1wRtQHt//Z\r\n';

try {
    $response = $client->drivingLicense($idImageBase64Image, $caseNo);
    
    // success, do something with $response
} catch (APIError $e) {
    // Catch API Error
    // $e->getStatus()
    // $e->getMessage()
    // $e->getMessageCode()
    // $e->getMetaData()
    // $e->getResponseData() // raw response
    throw $e;
} catch (\Throwable $th) {
    throw $th;
}

OkeyID

use RaditzFarhan\Innov8tifEkyc\OkeyID\Client;
use RaditzFarhan\Innov8tifEkyc\Exceptions\APIError;

...

$client = new Client($apiKey);

$base64ImageString = '/9j/4AAQSkZJ...fYs1wRtQHt//Z\r\n';

try {
    $response = $client->ocr($base64ImageString);
    
    // success, do something with $response
} catch (APIError $e) {
    // Catch API Error
    // $e->getStatus()
    // $e->getMessage()
    // $e->getResponseData() // raw response
    throw $e;
} catch (\Throwable $th) {
    throw $th;
}

测试

composer test

变更日志

请查看 CHANGELOG 获取更多最近更改信息。

贡献

请参考 CONTRIBUTING 获取详细说明。

安全

如果您发现任何安全相关的问题，请通过电子邮件 raditzfarhan@gmail.com 而不是使用问题跟踪器。

鸣谢

• Farhan
• 所有贡献者

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 获取更多信息。