Документи з Дія

Зміст

1 Зміст
2 Опис
3 Чекліст інтеграції
4 API параметри
5 Приклад запиту
6 Callback
7 Перевірка

Опис

Продукт використовується для отримання даних про клієнта разом зі сканами документів через сервіс Дія.

Чекліст інтеграції

Інтегрувати API метод цього розділу.

Відобразити клієнту кнопку на сайті / додатку.

Отримати успішний Callback з даними про клієнта.

HTTP METHOD: POST

API ENDPOINT: https://sign.platon.ua/api

Параметр	Значення	Опис

Параметр	Значення	Опис
`action` Обов'язковий	`GET_DOC_DIIA`	API метод
`client_key` Обов'язковий	String	API ключ мерчанта в системі PSP Platon саме для документів Дія
`client_request_id` Обов'язковий	String	Унікальним ідентифікатор запиту мерчанту
`success_url` Обов'язковий	String	URL на сторінку успішної верифікації документів
`error_url` Обов'язковий	String	URL на сторінку невдалої верифікації документів
`doc_url` Обов'язковий	String	URL, куди буде відправлено Callback з даними про клієнта
`mode` Обов'язковий	`test` `prod`	Переключення режиму тестового (`test`) та прод (`prod`) середовищ
`itn` не Обов'язковий	String	Вказати ІНН клієнта якщо він наявний. Якщо ІНН немає - параметр не передавати.
`hash` Обов'язковий	String	Контрольний підпис `md5( strtoupper( strrev($client_password). strrev($client_request_id) ) )`

<?php
$client_key = '******';
$client_password = '******************';
$client_request_id = microtime(); // рандом
$mode = 'prod';
$success_url = 'https://*************'; 
$error_url = 'https://*************';
$doc_url = 'https://*************'; 
$hash = md5(
          strtoupper(
            strrev($client_password).
            strrev($client_request_id)
          )
        );
?>

<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>GET_DOC_DIIA</title>
  </head>
  <body>
    <form method="POST" action="https://sign.platon.ua/api">
      <input type="hidden" name="action" value="GET_DOC_DIIA">
      <input type="hidden" name="client_key" value="<?= $client_key ?>">
      <input type="hidden" name="client_request_id" value="<?= $client_request_id ?>">
      <input type="hidden" name="success_url" value="<?= $success_url ?>">
      <input type="hidden" name="error_url" value="<?= $error_url ?>">
      <input type="hidden" name="doc_url" value="<?= $doc_url ?>">
      <input type="hidden" name="mode" value="<?= $mode ?>">
      <input type="hidden" name="hash" value="<?= $hash ?>">
      <button type="submit">START GET_DOC_DIIA</button>
    </form>
  </body>
</html>

<?php
declare(strict_types=1);

// ---------- ПЕРЕМЕННЫЕ
$client_key = 'PL-*****';
$api_password = '********************';

$client_request_id = 'PL-11917';

$privateKey = ''; // приватный ключ для расшифровки (можно не указывать)
$downloadFolder = './docs/';

$hash = md5(strtoupper(strrev($api_password).strrev($client_request_id)));

if (! array_key_exists('personal_data', $_POST) || ! array_key_exists('hash', $_POST)) {
    echo "не прислано данные!\n";
    return;
}

if  ($hash !== $_POST['hash']) {
    echo "подписи не совпадают!\n";
}

function isJson($string): bool
{
    json_decode($string);
    return json_last_error() === JSON_ERROR_NONE;
}

// расшифровка
$personalData = $_POST['personal_data'];
if (! isJson($_POST['personal_data'])) {
    openssl_private_decrypt(base64_decode($personalData), $decrypted, $privateKey);
    $personalData = $decrypted;
}
$personalData = json_decode($personalData, true);

// скачивание файлов
foreach ($personalData['scans'] as $scan) {
    $filename = $downloadFolder.$scan['type'].'.'.$scan['extension'];
    file_put_contents($filename, fopen($scan['link'], 'r'));
    echo "файл сохранен! $filename\n";
}

// персональные данные
var_dump($personalData);

IP адреси сервера відправки:

104.248.247.85
104.21.35.224
172.67.180.63

Редирект клиента при успешной верификации документов:

После успешной авторизации на success_url будет перенаправлен браузер клиента и методом GET переданы параметры.

https://YOUR_SUCCESS_PAGE/RA/callback/cachcallback.php? request_id=0.47912000%201625658249&
id=99c93434-82e4-4191-8f01- c8e6fe5623a0&
url=aHR0cHM6Ly93d3cucHJpdmF0MjQudWEvcmQva2VwP2hhc2g9cmQva2VwL3siY2xpZW50SWQiOiJQTEFUT05fOTljOTM0MzQtODJlNC00MTkxLThmMDEtYzhlNmZlNTYyM2EwIiwib3BlcmF0aW9uSWQiOiJSMXBhVm1GTVkyTjBhMFJrVjNaWlYySkhibXB6YzJkRmVuaHZWVnAyVTNseFMxRk9TVVpQVUZWWldVcDRaVmhXWVc1UmRHOTNaMWxzWVU1U2JYQktTMWxsIiwiYWN0aW9 uIjoic2lnbiJ9&
qr=aHR0cHM6Ly9zaWduLnBsYXRvbi51YS9hcGkvdjEvc21hcnQtaWQvOTljOTM0MzQtODJlNC00MTkxLThmMDEtYzhlNmZlNTYyM2EwL3FyP3Npe mU9MjUw

Параметр	Значение	Описание

Параметр	Значение	Описание
`request_id`	String	Уникальный идентификатор запроса мерчанта
`id`	String	Уникальный идентификатор запроса Platon
`url`	String	URL для редиректа клиента для подписания документов в base64
`qr_code`	String	QR-код для редиректа клиента для подписания документов в base64

При успешном запросе:

Параметры		Описание

Параметры		Описание
`fields`	Область данных общей информации
	`firstName`	имя
	`middleName`	отчество
	`lastName`	фамилия
	`phone`	актуальный телефон
	`inn`	идентификационный номер налогоплательщика
	`clId`	идентификатор клиента (необязательное поле и может отсутствовать)
	`clIdText`	статических текст подтверждения выдачи информации
	`birthDay`	дата рождения
	`sex`	пол (M - мужской, F - женский)
	`email`	email
	`resident`	определение резидентности (стандарт ISO(2)) UA — резидент /UA — нерезидент
	`dateModification`	последняя дата модификации данных в объекте (dd.MM.yyyy HH:mm:ss.S)
`addresses`	Область данных адреса регистрации/рождения
	`type`	тип адреса juridical — адрес регистрации (штамп в паспорте) factual — адрес фактический (реально проживает) birth – адрес рождения
	`country`	страна
	`state`	область
	`area`	район
	`city`	город
	`subTown`	микрорайон/жилмассив и пр. в городе
	`street`	улица
	`houseNo`	номер дома
	`flatNo`	номер квартиры
`documents`	Область данных документа регистрации
	`type`	тип документа passport – гражданский паспорт zpassport – загранпаспорт ident – удостоверение личности (высылается любой документ регистрации) idpassport — пластиковый паспорт govregistration - свидетельство государственной регистрации
	`series`	серия (отсутствует в idpassport)
	`number`	номер
	`issue`	кем выдан
	`dateIssue`	когда выдан
	`dateExpiration`	срок действия (dd.MM.yyyy)
	`issueCountryIso2`	страна выдачи
`scans`	Сканы
	`type`	типы сканов passport — скан гражданского паспорта zpassport — скан загранпаспорта inn – скан идентификационного налогового номера personalPhoto – фотография личности (анфас)
	`file`	файл
	`dateCreate`	дата сканирования
	`extension`	тип расширения файла
`edrpou`		ОКПО юридического лица

При неуспешном запросе:

Для індивідуальної перевірки необхідно завантажити файли документів підписаних КЕП на офіційний ресурс Центрального засвідчувального органу.