Анализатор идентификаторов (предварительная версия)

Анализатор идентификаторов предоставляет несколько различных продуктов проверки подлинности, необходимо получить базовые знания о каждом продукте, чтобы выбрать оптимальное решение для вашего приложения.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)

Контакт
Имя	Поддержка анализатора идентификаторов
URL	https://www.idanalyzer.com/contact.html
Адрес электронной почты	support@idanalyzer.com

Метаданные соединителя
Publisher	Эвита Techology
Веб-сайт	https://www.idanalyzer.com/
Политика конфиденциальности	https://www.idanalyzer.com/privacy-policy.html
Категории	ИТ-операции; Продуктивность

Платформа анализатора идентификаторов предоставляет предприятиям, организациям и отдельным лицам решение для проверки подлинности, которое работает без границ, решение, которое можно адаптировать к конкретным потребностям и требованиям, а также систему безопасности, которая постоянно обновляется и улучшается.

Предоставление полного доступа к удостоверениям и информации в более чем 4000+ различных формах идентификаторов в 190+ странах мира, это очень глобальное решение, разработанное с учетом современного мира.

Предпосылки

Учетная запись разработчика с анализатором идентификаторов. Вы можете зарегистрировать бесплатную учетную запись при регистрации
После регистрации учетной записи вы получите ключ API на веб-портале анализатора идентификаторов. Использование этого ключа API для проверки подлинности с помощью соединителя

Получение учетных данных

Перейдите к разделу "Регистрация"
Введите необходимые сведения.
Проверьте сообщение электронной почты при появлении запроса на это.
Вы увидите новый ключ API на веб-портале анализатора идентификаторов с сведениями о вашей учетной записи. Нажмите кнопку "Копировать", чтобы сохранить ее в буфер обмена для последующего использования.

Часто задаваемые вопросы

Я беспокоюсь о конфиденциальности своего клиента, сохраняет ли API сведения о моем клиенте?

Все будет храниться только в хранилище клиента и не будет произвольно утечки. Он не будет иметь копию в другом месте.

Что такое "кредиты", как приобрести кредиты API?

Оставшийся предоплаченный кредит для вашей учетной записи. Если у вас есть ежемесячный план, ваша ежемесячная квота будет использоваться перед предоплаченным кредитом.

Как проверить, является ли документ реальным или поддельным?

Включите проверку подлинности, результат будет содержать оценку проверки подлинности.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:


По умолчанию	Параметры для создания подключения.	Все регионы	Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательно
Ключ API	securestring	Ключ API для этого API	True

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Добавление образа в Хранилище	Вы можете отправить изображение и добавить его в существующую запись хранилища, выполнив HTTP-запрос POST.
Запись Update Vault	Можно обновить значение одного поля или значений нескольких полей в записи хранилища, выполнив HTTP-запрос POST.
Обучение по поиску лиц	Перед выполнением поиска лиц необходимо выполнить команду обучения для обучения наборов данных документов в хранилище. Вы также можете обучить данные хранилища через веб-портал. Задача обучения асинхронна, время обучения зависит от количества записей и изображений хранилища. Это может занять от нескольких секунд до часа.
Основные параметры API	API проверки идентификатора с несколькими функциями для проверки удаленного физического документа, его подлинности и лица соответствуют документу с фотографией пользователя.
Поиск базы данных AML	API AML позволяет искать глобальную базу данных AML анализатора идентификаторов для санкций, PEPs и хотели, чтобы преступники использовали имя, номер документа или оба. Вы можете дополнительно отфильтровать результаты с днем рождения и национальностью.
Поиск лиц	Поиск лиц позволяет выполнять поиск по всему хранилищу с помощью изображения человека. Чтобы использовать функцию поиска лиц, необходимо включить индексирование лиц на веб-портале и периодически обучать наборы данных хранилища.
Получение содержимого записи хранилища	При добавлении записей в хранилище основные API и API DocuPass возвращают идентификатор записи хранилища с именем vault vaultid. Идентификатор можно использовать для запроса содержимого записи в хранилище, отправив HTTP-запрос POST в следующую конечную точку.
Проверка обратного вызова	Чтобы убедиться, что данные были отправлены с нашего сервера.
Создание сеанса DocuPass	Вы можете создать сеанс проверки для каждого пользователя, требующего проверки личности.
Создание сеанса подписи DocuPass	Вы можете создать сеанс подписи, в котором пользователь будет просматривать и подписывать юридический документ электронной почты без проверки подлинности. Если вы хотите выполнить проверку подлинности и подписать какой-то документ, создайте сеанс проверки личности.
Состояние обучения	Проверьте, продолжается ли обучение хранилища или завершено.
Список и фильтрация записей	Чтобы перечислить все записи, хранящиеся в хранилище, или найти записи с определенными значениями, отправьте HTTP-запрос POST в следующую конечную точку.
Удаление записи из хранилища	Вы можете удалить один или несколько записей хранилища, выполнив HTTP-запрос POST.
Удаление образа из хранилища	Вы можете удалить изображение внутри записи хранилища, выполнив HTTP-запрос POST. Обратите внимание, что после удаления изображения URL-адрес изображения может быть доступен в течение короткого периода времени из-за кэширования.

Добавление образа в Хранилище

Идентификатор операции:: AddImageToVault

Вы можете отправить изображение и добавить его в существующую запись хранилища, выполнив HTTP-запрос POST.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
apikey	apikey	True	string	Закрытый ключ API доступен на веб-портале.
id	id	True	string	Идентификатор записи Хранилища для добавления изображения в
type	type	True	string	Задайте тип изображения: 0=document и 1=person
image	image		string	Данные изображения в кодировке Base64.
imageurl	imageurl		string	URL-адрес удаленного образа.

Возвращаемое значение

Имя	Путь	Тип	Описание
success	success	integer
id	image.id	string	Идентификатор изображения
type	image.type	string	0 для документа и 1 для человека
hash	image.hash	string	Хэш MD5 изображения
URL-адрес	image.url	string	URL-адрес изображения
createtime	image.createtime	string	Изображение времени было отправлено в формате UTC

Запись Update Vault

Идентификатор операции:: UpdateVaultEntry

Можно обновить значение одного поля или значений нескольких полей в записи хранилища, выполнив HTTP-запрос POST.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
apikey	apikey	True	string	Закрытый ключ API доступен на веб-портале.
id	id	True	string	Идентификатор записи хранилища.
адрес1	address1		string	Адресная строка 1.
Адрес2	address2		string	Адресная строка 2.
блок	block		string	Задайте этот параметр, чтобы заблокировать отправку того же документа в Core API или DocuPass. 0. Нет блока 1. Блокировать номер документа 2: блокировать имя/фамилию 3: блокировать номер документа и имя/фамилию.
customdata1	customdata1		string	5 пользовательских строк, которые можно использовать для добавления пользовательской memo в запись.
customdata2	customdata2		string	5 пользовательских строк, которые можно использовать для добавления пользовательской memo в запись.
customdata3	customdata3		string	5 пользовательских строк, которые можно использовать для добавления пользовательской memo в запись.
customdata4	customdata4		string	5 пользовательских строк, которые можно использовать для добавления пользовательской memo в запись.
customdata5	customdata5		string	5 пользовательских строк, которые можно использовать для добавления пользовательской memo в запись.
Dob	dob		string	Дата рождения (гггг-MM-DD).
documentName	documentName		string	Имя документа.
documentNumber	documentNumber		string	Уникальный идентификатор документа (Passport No./Driver License No. и т. д.
documentType	documentType		string	P: Passport D: Водительская лицензия I: Удостоверение V: Visa R: Карта проживания O: Другие
docupass_customid	docupass_customid		string	customid, переданный при создании проверки DocuPass.
docupass_failedreason	docupass_failedreason		string	Если проверка DocuPass завершилась сбоем, причина сбоя.
docupass_reference	docupass_reference		string	Справочник по коду сеанса DocuPass.
docupass_success	docupass_success		string	0 или 1, выполнена ли проверка DocuPass успешно или завершилась ошибкой.
электронная почта	email		string	Адрес электронной почты пользователя.
истечение	expiry		string	Дата окончания срока действия (гггг-MM-DD)
eyeColor	eyeColor		string	Цвет глаз.
Имя	firstName		string	Имя / заданное имя
firstName_local	firstName_local		string	Имя на локальном языке.
fullName	fullName		string	Полное имя (обновление других полей имен не будет обновлять fullName)
fullName_local	fullName_local		string	Имя на локальном языке.
волосый цвет	hairColor		string	Цвет волос.
height	height		string	Высота человека.
issueAuthority	issueAuthority		string	Выдача центра документа.
Выдан	issued		string	Дата выпуска (ГГГГ-MM-DD)
issuerOrg_iso2	issuerOrg_iso2		string	Документ, выданный код страны в ISO2. Пример: США
issuerOrg_region_abbr	issuerOrg_region_abbr		string	Аббревиатура издателя документов или государства. Пример: ЦС
issuerOrg_region_full	issuerOrg_region_full		string	Издатель документов заквас или состояние. Пример: Калифорния
Стационарные	landline		string	Номер телефона с телефонной линией пользователя.
lastName	lastName		string	Фамилия или имя семьи.
lastName_local	lastName_local		string	Фамилия на локальном языке.
второе имя	middleName		string	По промежуточному имени.
middleName_local	middleName_local		string	Промежуточное имя на локальном языке.
mobile	mobile		string	Номер мобильного телефона пользователя.
nationality_iso2	nationality_iso2		string	Гражданство владельца документа в ISO2. Пример: США
необязательные данные	optionalData		string	Дополнительные неспецифические данные, включенные в документ.
optionalData2	optionalData2		string	Дополнительные неспецифические данные, включенные в документ.
personalNumber	personalNumber		string	Дополнительный номер идентификатора документа.
placeOfBirth	placeOfBirth		string	Место рождения.
почтовый индекс	postcode		string	Почтовый код адреса.
Ограничения	restrictions		string	Ограничения на движение.
секс	sex		string	M: Male F: Female X: Unspecified
trustlevel	trustlevel		string	0. Неопределенное 1. Недопустимый документ 2: подозрительный 3. Допустимая оценка вычисляется автоматически, если включена проверка подлинности.
trustnote	trustnote		string
vehicleClass	vehicleClass		string	Класс транспортных средств на водительскую лицензию.
weight	weight		string	Вес человека.

Возвращаемое значение

Имя	Путь	Тип	Описание
success	success	integer

Обучение по поиску лиц

Идентификатор операции:: FaceSearchTraining

Перед выполнением поиска лиц необходимо выполнить команду обучения для обучения наборов данных документов в хранилище. Вы также можете обучить данные хранилища через веб-портал. Задача обучения асинхронна, время обучения зависит от количества записей и изображений хранилища. Это может занять от нескольких секунд до часа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
apikey	apikey	True	string	Закрытый ключ API доступен на веб-портале.

Возвращаемое значение

Имя	Путь	Тип	Описание
success	success	integer

Основные параметры API

Идентификатор операции:: SettingCoreAPI

API проверки идентификатора с несколькими функциями для проверки удаленного физического документа, его подлинности и лица соответствуют документу с фотографией пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
apikey	apikey	True	string	Закрытый ключ API доступен на веб-портале.
file_base64	file_base64		string	Вы можете отправить изображение в кодировке Base64 в виде строки с помощью приложения/x-www-form-urlencoded или application/json.
URL-адрес	url		string	Базовый API может загружать удаленный образ с сервера.
file_back_base64	file_back_base64		string	В кодировке Base64 изображение задней части документа для выполнения двойной проверки.
url_back	url_back		string	Удаленное изображение задней части документа для выполнения двойной проверки.
face_base64	face_base64		string	Изображение лица человека в кодировке Base64 для проверки биометрии фотографии.
faceurl	faceurl		string	Удаленное изображение лица человека для выполнения биометрических проверок фотографии.
video_base64	video_base64		string	Видео в кодировке Base64 для выполнения биометрических проверок видео.
videourl	videourl		string	Удаленное размещенное видео селфи для выполнения биометрических проверок видео.
секретный код	passcode		string	4 цифры
точность	accuracy		integer	Настройте скорость и точность распознавания документов и результатов ocr. Низкая точность снижает время отклика до 1 секунды, а высокая точность обычно занимает 2~3 секунды.
authenticate	authenticate		boolean	Проверьте документ, чтобы проверить, является ли документ аутентичным и не был изменен.
authenticate_module	authenticate_module		string	Укажите модуль, используемый для проверки документа.
biometric_threshold	biometric_threshold		float	Укажите минимальную оценку для прохождения биометрической проверки лиц
return_confidence	return_confidence		boolean	Возвращает оценку достоверности для каждого поля данных.
return_empty	return_empty		boolean	Api можно получить, чтобы возвращать значение NULL в пустых полях, включив этот параметр.
ocr_scaledown	ocr_scaledown		integer	Число от 500 до 4000 или 0
outputimage	outputimage		boolean	Создание обрезанного изображения документа.
выходная часть	outputface		boolean	Создание обрезанного изображения области лица в документе.
outputmode	outputmode		string	Выводит обрезанный документ и лицо в виде URL-адреса или содержимого в кодировке Base64.
dualsidecheck	dualsidecheck		boolean	Проверьте, совпадают ли имена, номер документа и тип документа между передней и задней частью документа при выполнении двойной проверки. Если возникает ошибка 14 несоответствия сведений.
verify_expiry	verify_expiry		boolean	Проверьте, действителен ли документ на основе его даты окончания срока действия.
verify_documentno	verify_documentno		string	Проверьте, совпадает ли указанный номер документа с документом.
verify_dob	verify_dob		string	Проверьте, совпадает ли дата рождения с документом. (ГГГГ/ММ/ДД)
verify_age	verify_age		string	Проверьте, находится ли держатель документа в возрасте между заданным диапазоном. (диапазон, пример: 18–40)
verify_address	verify_address		string	Проверьте, совпадают ли предоставленные адреса с документом.
verify_postcode	verify_postcode		string	Проверьте, соответствует ли предоставленный почтовый код документу.
country	country		string	Проверьте, был ли документ выдан указанными странами, если не будет выдан код ошибки 10. Разделите несколько значений с запятыми. Например, "США", ЦС будет принимать документы из Соединенных Штатов и Канады.
region	region		string	Проверьте, был ли документ выдан указанным состоянием, если не будет создан код ошибки 11. Разделите несколько значений с запятыми. Например, ca, TX будет принимать документы из Калифорнии и Техаса.
type	type		string	Проверьте, был ли документ одним из указанных типов, если не будет возникать код ошибки 12. Например, "PD" принимает как паспорт, так и водительские лицензии.
контрольный список	checkblocklist		boolean	Проверьте данные документа для заблокированных записей в хранилище. Если документ соответствует одной из заблокированных ошибок записи 15, будет выдана ошибка
vault_save	vault_save		boolean	Сохраните изображение документа и синтаксический анализ данных в защищенном хранилище. Вы можете перечислять, искать и обновлять записи документов в хранилище с помощью API хранилища или веб-портала.
vault_saveunrecognized	vault_saveunrecognized		boolean	Сохраните изображение документа в хранилище, даже если документ не удается распознать.
vault_noduplicate	vault_noduplicate		boolean	Запретить сохранение повторяющихся изображений.
vault_automerge	vault_automerge		boolean	Автоматическое слияние изображений с одинаковым номером документа в одну запись внутри хранилища.
vault_customdata1	vault_customdata1		string	Добавьте до 5 пользовательских строк, которые будут связаны с записью хранилища, это может быть полезно для фильтрации и поиска записей.
vault_customdata2	vault_customdata2		string	Добавьте до 5 пользовательских строк, которые будут связаны с записью хранилища, это может быть полезно для фильтрации и поиска записей.
vault_customdata3	vault_customdata3		string	Добавьте до 5 пользовательских строк, которые будут связаны с записью хранилища, это может быть полезно для фильтрации и поиска записей.
vault_customdata4	vault_customdata4		string	Добавьте до 5 пользовательских строк, которые будут связаны с записью хранилища, это может быть полезно для фильтрации и поиска записей.
vault_customdata5	vault_customdata5		string	Добавьте до 5 пользовательских строк, которые будут связаны с записью хранилища, это может быть полезно для фильтрации и поиска записей.
aml_check	aml_check		boolean	Проверьте имя и номер документа владельца документа в базе данных AML анализатора идентификаторов.
aml_database	aml_database		string	Разделите каждый код базы данных запятыми, например un_sc,us_ofac.
aml_strict_match	aml_strict_match		boolean	Включите этот параметр для уменьшения ложноположительных срабатываний путем сопоставления только сущностей с одинаковым гражданством и днем рождения.
contract_generate	contract_generate		string	Идентификатор шаблона контракта для автоматического заполнения данными пользователя.
contract_format	contract_format		string	Формат выходного документа. Необязательные компоненты: PDF, DOCX, HTML.
contract_prefill_data	contract_prefill_data		object

Возвращаемое значение

Имя	Путь	Тип	Описание
documentNumber	result.documentNumber	string	Уникальный идентификатор, связанный с документом (например, Passport No./Driver License No./Driver License No./Card Number etc)
personalNumber	result.personalNumber	string	Уникальный личный идентификатор, связанный с человеком в стране (например, номер национального идентификатора)
Имя	result.firstName	string	Имя / заданное имя
lastName	result.lastName	string	Фамилия / Имя семьи
второе имя	result.middleName	string	По промежуточному имени
fullName	result.fullName	string	Если имя и фамилия не могут быть различаемыми полным именем, будет возвращено вместо него.
firstName_local	result.firstName_local	string	Имя на локальном языке, если оно доступно
lastName_local	result.lastName_local	string	Фамилия на локальном языке, если она доступна
middleName_local	result.middleName_local	string	Среднее имя на локальном языке, если оно доступно
fullName_local	result.fullName_local	string	Полное имя на локальном языке, если оно доступно
секс	result.sex	string	Пол M=Male F=Female X=Unspecified
height	result.height	string	Высота человека
weight	result.weight	string	Вес человека
волосый цвет	result.hairColor	string	Цвет волос - ANSI D-20 код цвета волос (3 буквы)
eyeColor	result.eyeColor	string	Цвет глаза - ANSI D-20 цветовой код глаза (3 буквы)
возраст	result.age	integer	Возраст владельца документа
Dob	result.dob	string	Дата рождения в ггГГ/ММ/ДД
dob_day	result.dob_day	integer	Дата рождения от 1 до 31
dob_month	result.dob_month	integer	Дата рождения месяца от 1 до 12
dob_year	result.dob_year	integer	Дата рождения года в ггГГ
истечение	result.expiry	string	Дата окончания срока действия документа в ггГГ/ММ/ДД
expiry_day	result.expiry_day	integer	День истечения срока действия от 1 до 31
expiry_month	result.expiry_month	integer	Срок действия 1–12
expiry_year	result.expiry_year	integer	Срок действия срока действия в ггГГ
daysToExpiry	result.daysToExpiry	integer	Количество дней до истечения срока действия документа
Выдан	result.issued	string	Дата проблемы в ггГГ/ММ/ДД
issued_day	result.issued_day	integer	День выпуска 1–31
issued_month	result.issued_month	integer	Месяц выпуска 1–12
issued_year	result.issued_year	integer	Год выпуска в ггГГ
daysFromIssue	result.daysFromIssue	integer	Количество дней с момента выдачи документа
адрес1	result.address1	string	Строка адреса 1
Адрес2	result.address2	string	Строка адреса 2
почтовый индекс	result.postcode	string	Почтовый код адреса
placeOfBirth	result.placeOfBirth	string	Место рождения
vehicleClass	result.vehicleClass	string	Класс транспортного средства водительской лицензии
Ограничения	result.restrictions	string	Ограничения на лицензии драйвера
одобрение	result.endorsement	string	Подтверждение лицензии водителя
необязательные данные	result.optionalData	string	Дополнительные неспецифические данные, включенные в документ
optionalData2	result.optionalData2	string	Дополнительные неспецифические данные, включенные в документ
documentType	result.documentType	string	Тип документа: P=Passport, D=Водительская лицензия, I=Identity Card, V=Visa, R=Резиденция карточка, O=Other
documentSide	result.documentSide	string	Сторона документа: FRONT, BACK или BIODATA
issuerOrg_region_full	result.issuerOrg_region_full	string	Издатель документов заквас или состояние. (например, Калифорния)
issuerOrg_region_abbr	result.issuerOrg_region_abbr	string	Аббревиатура издателя документов или государства. (например, ЦС)
issuerOrg_full	result.issuerOrg_full	string	Документ, выданный страной. (например, Соединенные Штаты)
issuerOrg_iso2	result.issuerOrg_iso2	string	Документ, выданный код страны в ISO2. (например, США)
issuerOrg_iso3	result.issuerOrg_iso3	string	Документ, выданный код страны в ISO3. (например, США)
nationality_full	result.nationality_full	string	Национальность владельца документа. (например, Соединенные Штаты)
nationality_iso2	result.nationality_iso2	string	Гражданство владельца документа в ISO2. (например, США)
nationality_iso3	result.nationality_iso3	string	Гражданство владельца документа в ISO3. (например, США)
internalId	result.internalId	string	Используется для идентификации уникального идентификатора документа в системе анализатора идентификаторов, один и тот же тип документа должен иметь тот же идентификатор.
documentNumber	confidence.documentNumber	float	уровень достоверности documentNumber
Имя	confidence.firstName	float	уровень достоверности firstName
lastName	confidence.lastName	float	уровень достоверности фамилии /имя семейства
второе имя	confidence.middleName	float	уровень достоверности средних имен
dob_month	confidence.dob_month	float	уровень достоверности dob_month
dob_day	confidence.dob_day	float	уровень достоверности dob_day
dob_year	confidence.dob_year	float	уровень достоверности dob_year
issued_month	confidence.issued_month	float	уровень достоверности issued_month
issued_day	confidence.issued_day	float	уровень достоверности issued_day
issued_year	confidence.issued_year	float	уровень достоверности issued_year
expiry_month	confidence.expiry_month	float	уровень достоверности expiry_month
expiry_day	confidence.expiry_day	float	уровень достоверности expiry_day
expiry_year	confidence.expiry_year	float	уровень достоверности expiry_year
секс	confidence.sex	float	уровень достоверности секса
height	confidence.height	float	уровень достоверности высоты
weight	confidence.weight	float	уровень достоверности веса
адрес1	confidence.address1	float	Уровень достоверности адреса1
Адрес2	confidence.address2	float	уровень достоверности адреса2
почтовый индекс	confidence.postcode	float	уровень достоверности почтового кода
vehicleClass	confidence.vehicleClass	float	уровень достоверности транспортного класса
Ограничения	confidence.restrictions	float	уровень достоверности ограничений
одобрение	confidence.endorsement	float	уровень достоверности подтверждения
eyeColor	confidence.eyeColor	float	уровень достоверности eyeColor
возраст	confidence.age	float	уровень достоверности возраста
Dob	confidence.dob	float	Уровень достоверности dob
daysToExpiry	confidence.daysToExpiry	float	уровень достоверности днейToExpiry
истечение	confidence.expiry	float	уровень достоверности срока действия
Выдан	confidence.issued	float	уровень достоверности выданных
daysFromIssue	confidence.daysFromIssue	float	уровень достоверности днейFromIssue
fullName	confidence.fullName	float	уровень достоверности fullName
isIdentical	face.isIdentical	boolean	Биометрическая проверка пройдена или не выполнена
уверенность	face.confidence	string	Значение от 0 до 1 о том, насколько похожи два лица, 1 идентичны.
ошибка	face.error	integer	Код ошибки
error_message	face.error_message	string	Сообщение об ошибке. Пример. Не удалось найти данные лица в изображении лица
пройденный	verification.passed	boolean	Если документ прошел все проверки, возвращает значение true. Если документ не удалось выполнить по крайней мере один тип проверки, возвращает значение false.
лицо	verification.result.face	boolean	Если включена биометрическая проверка, превышает ли оценка достоверности сходства пороговое значение.
notexpired	verification.result.notexpired	boolean	Не истек ли срок действия документа.
имя	verification.result.name	boolean	Совпадает ли указанное имя с именем, проанализированным с идентификатором.
Dob	verification.result.dob	boolean	Совпадает ли предоставленный день рождения с идентификатором.
documentNumber	verification.result.documentNumber	boolean	Указывает, совпадает ли указанный номер документа с номером документа, проанализированным с идентификатором.
почтовый индекс	verification.result.postcode	boolean	Соответствует ли предоставленный почтовый код синтаксическому анализу с идентификатором.
address	verification.result.address	boolean	Совпадает ли предоставленный адрес с адресом, проанализированным с идентификатором.
checkdigit	verification.result.checkdigit	boolean	Если тип документа имеет алгоритм проверки цифры и звука, допустимы ли эти цифры.
возраст	verification.result.age	boolean	Указывает, находится ли владелец документа в пределах заданного возраста.
cccode	verification.result.cccode	boolean	Если тип документа имеет реализацию китайского коммерческого кода (CC code), допустимы ли коды CC.
счёт	authentication.score	float	Оценка будет плавать от 0 до 1. Допустимые документы будут иметь оценку ближе к 1, а поддельные или измененные документы будут иметь оценку ближе к 0. Ваше усмотрение решить границу, хорошая отправная точка будет отклонять оценку менее 0,5
пройденный	authentication.breakdown.data_visibility.passed	boolean
пройденный	authentication.breakdown.image_quality.passed	boolean
пройденный	authentication.breakdown.feature_referencing.passed	boolean
пройденный	authentication.breakdown.exif_check.passed	boolean
код	authentication.breakdown.exif_check.code	integer
причина	authentication.breakdown.exif_check.reason	string
severity	authentication.breakdown.exif_check.severity	string
пройденный	authentication.breakdown.publicity_check.passed	boolean
код	authentication.breakdown.publicity_check.code	integer
причина	authentication.breakdown.publicity_check.reason	string
severity	authentication.breakdown.publicity_check.severity	string
пройденный	authentication.breakdown.text_analysis.passed	boolean
пройденный	authentication.breakdown.biometric_analysis.passed	boolean
пройденный	authentication.breakdown.security_feature_check.passed	boolean
код	authentication.breakdown.security_feature_check.code	integer
причина	authentication.breakdown.security_feature_check.reason	string
severity	authentication.breakdown.security_feature_check.severity	string
пройденный	authentication.breakdown.recapture_check.passed	boolean
код	authentication.breakdown.recapture_check.code	integer
причина	authentication.breakdown.recapture_check.reason	string
severity	authentication.breakdown.recapture_check.severity	string
warning	authentication.warning	array of string	Массив строк, содержащий предупреждающие сообщения о действительности документа.
aml	aml	array of object	Массив, содержащий список совпадений AML, возвращает пустой массив, если совпадение не найдено. Дополнительные сведения см. в справочнике по API AML.
Объект	aml.entity	string	лицо или юридическое лицо
полное имя	aml.fullname	array of string	Имена лиц или юридических лиц
имя	aml.firstname	array of string	Имена пользователей
фамилия	aml.lastname	array of string	Фамилии пользователя
промежуточное имя	aml.middlename	array of string	По промежуточному имени пользователя
alias	aml.alias	array of string	Альтернативные или внешние имена сущности
Dob	aml.dob	array of string	День рождения Перона, может прийти в YYYY, ГГГГ-ММ, или ГГГГ-MM-DD форматы.
address	aml.address	array of string	Адрес или страна проживания сущности
национальность	aml.nationality	array of string	Страна или национальность сущности
родина	aml.birthplace	array of string	Место рождения Перона
gender	aml.gender	array of string	Пол Перона: M или F
documentnumber	aml.documentnumber	array of object	Список документов, связанных с сущностью.
id	aml.documentnumber.id	string	Номер документа
id_formatted	aml.documentnumber.id_formatted	string	Номер буквенно-цифрового документа
country	aml.documentnumber.country	string	Код страны ISO2
type	aml.documentnumber.type	string	P = passport number, I = ID number, D = Номер лицензии на управление, O = Other/Unknown document type
программа	aml.program	array of string	Программы санкционировать
заметка	aml.note	array of string	Дополнительная заметка для сущности
time	aml.time	string	Метка времени UTC TZ при добавлении сущности в исходный список или последнее обновление
статус	aml.status	string	Позиция или название сущности или текущего состояния санкции
source	aml.source	array of string	Список официальных URL-адресов источника
база данных	aml.database	string	Код базы данных AML анализатора идентификаторов
schema	aml.schema	string
document_url	contract.document_url	string	URL-адрес созданного документа
ошибка	contract.error	string	Если не удалось создать контракт, это поле будет содержать причину, например "Недопустимый идентификатор шаблона контракта".
vaultid	vaultid	string	Уникальный идентификатор записи хранилища, если vault_save включен.
соответствие	matchrate	float	Соотношение полей, успешно распознанных API, низкое соотношение означает, что изображение документа слишком размыто.
output	output	string	Если для выходных данных задано значение true, и outputmode является URL-адресом, это поле будет содержать URL-адрес (или массив URL-адресов для двойной проверки), указывающий на обрезанное изображение документа. Ссылка гарантируется только в течение 600 секунд и будет удалена в любое время после.
выходная часть	outputface	string	Если для выходного лица задано значение true, и выходной модуля является URL-адресом, указывающим на изображение обрезанного лица. Ссылка гарантируется только в течение 600 секунд и будет удалена в любое время после.
Обрезанные	cropped	string	Если для выходных данных задано значение true, и outputmode имеет значение base64, это поле будет содержать изображение в кодировке Base64 (или массив изображений в кодировке Base64 для двойной проверки) обрезанного документа в формате JPEG
обрезка	croppedface	string	Если выходной интерфейс имеет значение true, и outputmode имеет значение base64, это поле будет содержать изображение в кодировке Base64 области обрезанного лица документа в формате JPEG.
executionTime	executionTime	float	Время выполнения операции API в секундах.
responseID	responseID	string	Уникальный идентификатор для идентификации запроса или ответа.
quota	quota	integer	Оставшаяся квота API, сбрасывается в начале каждого месяца для бесплатного или ежегодного подписчика или в начале каждого цикла выставления счетов для ежемесячного подписчика. Если у вас есть план подписки, ваша ежемесячная квота будет использоваться до вашего кредита.
Благодарности	credit	integer	Оставшийся тестовый кредит для вашей учетной записи. Если у вас есть план подписки, ваша ежемесячная квота будет использоваться до вашего кредита.

Поиск базы данных AML

Идентификатор операции:: SearchingAML

API AML позволяет искать глобальную базу данных AML анализатора идентификаторов для санкций, PEPs и хотели, чтобы преступники использовали имя, номер документа или оба. Вы можете дополнительно отфильтровать результаты с днем рождения и национальностью.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
apikey	apikey	True	string	Закрытый ключ API доступен на веб-портале.
имя	name		string	Имя или псевдоним пользователя или организации на любом языке.
documentnumber	documentnumber		string	Номер паспорта человека, номер национального идентификатора или номер водительского удостоверения и т. д.
Объект	entity		string	person: Person; юридическое значение: компания или организация
country	country		string	Возвращает только сущности с соответствующей страной или национальностью или без сведений о стране.
Dob	dob		string	Возвращает только сущности с соответствующими днями рождения или без сведений о днях рождения.
база данных	database		string	Укажите исходные базы данных для проверки AML, если осталось пустым, будут проверяться все исходные базы данных. Разделите каждый код базы данных запятыми, например un_sc,us_ofac. Полный список исходных баз данных и соответствующего кода см. в обзоре API AML.

Возвращаемое значение

Имя	Путь	Тип	Описание
aml	items	array of object	Массив, содержащий список совпадений AML, возвращает пустой массив, если совпадение не найдено. Дополнительные сведения см. в справочнике по API AML.
Объект	items.entity	string	лицо или юридическое лицо
полное имя	items.fullname	array of string	Имена лиц или юридических лиц
имя	items.firstname	array of string	Имена пользователей
фамилия	items.lastname	array of string	Фамилии пользователя
промежуточное имя	items.middlename	array of string	По промежуточному имени пользователя
alias	items.alias	array of string	Альтернативные или внешние имена сущности
Dob	items.dob	array of string	День рождения Перона, может прийти в YYYY, ГГГГ-ММ, или ГГГГ-MM-DD форматы.
address	items.address	array of string	Адрес или страна проживания сущности
национальность	items.nationality	array of string	Страна или национальность сущности
родина	items.birthplace	array of string	Место рождения Перона
gender	items.gender	array of string	Пол Перона: M или F
documentnumber	items.documentnumber	array of object	Список документов, связанных с сущностью.
id	items.documentnumber.id	string	Номер документа
id_formatted	items.documentnumber.id_formatted	string	Номер буквенно-цифрового документа
country	items.documentnumber.country	string	Код страны ISO2
type	items.documentnumber.type	string	P = passport number, I = ID number, D = Номер лицензии на управление, O = Other/Unknown document type
программа	items.program	array of string	Программы санкционировать
заметка	items.note	array of string	Дополнительная заметка для сущности
time	items.time	string	Метка времени UTC TZ при добавлении сущности в исходный список или последнее обновление
статус	items.status	string	Позиция или название сущности или текущего состояния санкции
source	items.source	array of string	Список официальных URL-адресов источника
база данных	items.database	string	Код базы данных AML анализатора идентификаторов
schema	items.schema	string

Поиск лиц

Идентификатор операции:: FaceSearch

Поиск лиц позволяет выполнять поиск по всему хранилищу с помощью изображения человека. Чтобы использовать функцию поиска лиц, необходимо включить индексирование лиц на веб-портале и периодически обучать наборы данных хранилища.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
apikey	apikey	True	string	Закрытый ключ API доступен на веб-портале.
image	image		string	Данные изображения в кодировке Base64.
imageurl	imageurl		string	URL-адрес удаленного образа.
maxentry	maxentry		integer	Количество возвращаемых записей в диапазоне от 1 до 10.
threshold	threshold		float	Установите минимальную оценку сходства лиц, необходимую в диапазоне от 0 до 1.

Возвращаемое значение

Имя	Путь	Тип	Описание
items	items	array of	Если найдены соответствующие записи, будет возвращен список документов с полным содержимым, аналогичный команде списка.

Получение содержимого записи хранилища

Идентификатор операции:: GetVault

При добавлении записей в хранилище основные API и API DocuPass возвращают идентификатор записи хранилища с именем vault vaultid. Идентификатор можно использовать для запроса содержимого записи в хранилище, отправив HTTP-запрос POST в следующую конечную точку.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
apikey	apikey	True	string	Закрытый ключ API доступен на веб-портале.
id	id		string	Идентификатор записи хранилища.

Возвращаемое значение

Имя	Путь	Тип	Описание
success	success	integer
id	data.id	string	Идентификатор записи хранилища
createtime	data.createtime	string	Метка времени создания записи в формате UTC
updatetime	data.updatetime	string	Метка времени последнего изменения в формате UTC
trustlevel	data.trustlevel	string	Эта оценка вычисляется автоматически, если включена проверка подлинности. (0: неопределенный, 1: недопустимый документ, 2: подозрительный, 3: допустимый)
trustnote	data.trustnote	string	Предупреждения, связанные с допустимостью документа.
docupass_reference	data.docupass_reference	string	Справочник по коду сеанса DocuPass
docupass_success	data.docupass_success	string	0 или 1, выполнена ли проверка DocuPass успешно или завершилась ошибкой.
docupass_failedreason	data.docupass_failedreason	string	Если проверка DocuPass завершилась сбоем, причина сбоя.
docupass_customid	data.docupass_customid	string	customid, переданный при создании проверки DocuPass.
documentNumber	data.documentNumber	string	Уникальный идентификатор документа (Passport No./Driver License No. и т. д.
documentNumber_formatted	data.documentNumber_formatted	string	Автоматически созданная строка documentNumber без символов, это поле полезно для фильтрации результатов.
personalNumber	data.personalNumber	string	Дополнительный номер идентификатора документа
Имя	data.firstName	string	Имя / заданное имя
второе имя	data.middleName	string	По промежуточному имени
lastName	data.lastName	string	Фамилия / Имя семьи
fullName	data.fullName	string	Полное имя (обновление других полей имен не будет обновлять fullName)
firstName_local	data.firstName_local	string	Имя на локальном языке
middleName_local	data.middleName_local	string	Промежуточное имя на локальном языке
lastName_local	data.lastName_local	string	Фамилия на локальном языке
fullName_local	data.fullName_local	string	Полное имя на локальном языке
Dob	data.dob	string	Дата рождения
Выдан	data.issued	string	Дата проблемы
истечение	data.expiry	string	Дата окончания срока действия
секс	data.sex	string	M: Male, F: Женщина, X: Не указано
height	data.height	string	Высота человека
weight	data.weight	string	Вес человека
волосый цвет	data.hairColor	string	Цвет волос
eyeColor	data.eyeColor	string	Цвет глаз
адрес1	data.address1	string	Строка адреса 1
Адрес2	data.address2	string	Строка адреса 2
почтовый индекс	data.postcode	string	Почтовый код адреса
placeOfBirth	data.placeOfBirth	string	Место рождения
documentType	data.documentType	string	P: Passport, D: Водительская лицензия, I: Удостоверение карты, V: Visa, R: Карта проживания, O: Другие
documentName	data.documentName	string	Имя документа
vehicleClass	data.vehicleClass	string	Класс транспортных средств на водительскую лицензию
Ограничения	data.restrictions	string	Ограничения на движение
одобрение	data.endorsement	string	Подтверждение лицензии водителя
электронная почта	data.email	string	Адрес электронной почты пользователя
mobile	data.mobile	string	Номер мобильного телефона пользователя
Стационарные	data.landline	string	Номер телефона телефонной линии пользователя
issueAuthority	data.issueAuthority	string	Центр выдачи документа
issuerOrg_region_full	data.issuerOrg_region_full	string	Издатель документов заквас или состояние. Пример: Калифорния
issuerOrg_region_abbr	data.issuerOrg_region_abbr	string	Аббревиатура издателя документов или государства. Пример: ЦС
issuerOrg_iso2	data.issuerOrg_iso2	string	Документ, выданный код страны в ISO2. Пример: США
nationality_iso2	data.nationality_iso2	string	Гражданство владельца документа в ISO2. Пример: США
необязательные данные	data.optionalData	string	Дополнительные неспецифические данные, включенные в документ
optionalData2	data.optionalData2	string	Дополнительные неспецифические данные, включенные в документ
customdata1	data.customdata1	string	5 пользовательских строк, которые можно использовать для добавления пользовательской memo в запись
customdata2	data.customdata2	string	5 пользовательских строк, которые можно использовать для добавления пользовательской memo в запись
customdata3	data.customdata3	string	5 пользовательских строк, которые можно использовать для добавления пользовательской memo в запись
customdata4	data.customdata4	string	5 пользовательских строк, которые можно использовать для добавления пользовательской memo в запись
customdata5	data.customdata5	string	5 пользовательских строк, которые можно использовать для добавления пользовательской memo в запись
блок	data.block	string	Задайте этот параметр, чтобы заблокировать отправку того же документа в Core API или DocuPass.
контракт	data.contract	string	Ссылка на контракт или юридические документы, созданные или подписанные с помощью Core API или DocuPass
image	data.image	array of object	Содержит список изображений, связанных с записью.
id	data.image.id	string	Идентификатор изображения
type	data.image.type	string	0 для документа и 1 для человека
hash	data.image.hash	string	Хэш MD5 изображения
URL-адрес	data.image.url	string	URL-адрес изображения
createtime	data.image.createtime	string	Изображение времени было отправлено в формате UTC

Проверка обратного вызова

Идентификатор операции:: ValidatingCallback

Чтобы убедиться, что данные были отправлены с нашего сервера.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
apikey	apikey	True	string	Закрытый ключ API доступен на веб-портале.
справочник	reference	True	string	Справочный код, полученный в POST BODY.
hash	hash	True	string	Хэш получил в POST BODY.

Возвращаемое значение

Имя	Путь	Тип	Описание
success	success	boolean
справочник	reference	string	Справочный код для сеанса DocuPass

Создание сеанса DocuPass

Идентификатор операции:: CreatingDocuPass

Вы можете создать сеанс проверки для каждого пользователя, требующего проверки личности.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
apikey	apikey	True	string	Закрытый ключ API доступен на веб-портале.
type	type		integer	0. Модуль Iframe ,1: мобильный модуль, 2: модуль перенаправления, 3: динамический мобильный модуль
имя компании	companyname	True	string	Название вашей компании или продукта.
callbackurl	callbackurl		string	URL-адрес веб-перехватчика или обратного вызова для получения результата проверки.
биометрический	biometric		integer	Попросите пользователя взять фотографию селфи или видео селфи для проверки лица.
biometric_threshold	biometric_threshold		float	Укажите минимальную оценку для прохождения биометрической проверки лиц
authenticate_minscore	authenticate_minscore		float	Документ должен соответствовать минимальной оценке подлинности для прохождения проверки. Установите значение 0, чтобы отключить проверку допустимости или подлинности.
authenticate_module	authenticate_module		integer	Укажите модуль, используемый для проверки документа.
maxattempt	maxattempt		integer	Максимальное количество попыток сбоя для каждого запроса проверки.
successredir	successredir		string	Браузер будет перенаправлен на этот URL-адрес при успешной проверке удостоверения.
failredir	failredir		string	Браузер будет перенаправлен на этот URL-адрес при сбое проверки удостоверения.
customid	customid		string	Это полезно для идентификации пользователя в базе данных. Это значение будет храниться в docupass_customid в хранилище.
многоразовый	reusable		boolean	Включение этого параметра позволит нескольким пользователям проверить удостоверение по одному URL-адресу, будет создан новый справочный код DocuPass для каждого пользователя автоматически.
phoneverification	phoneverification		boolean	Требуется ли пользователю ввести номер телефона для проверки, DocuPass поддерживает проверку номера мобильного или стационарного номера. (Только подписчик)
тип документа	documenttype		string	Пользователь должен отправить определенный тип документа. Например, "PD" принимает как паспорт, так и водительские лицензии.
documentcountry	documentcountry		string	Код страны ISO ALPHA-2.
documentregion	documentregion		string	Полное имя или сокращенное имя штата или региона.
dualsidecheck	dualsidecheck		boolean	Проверьте, совпадают ли имена, номер документа и тип документа между передней и задней частью документа при выполнении двойной проверки. Если возникает ошибка 14 несоответствия сведений.
verify_expiry	verify_expiry		boolean	Только принять документ, не истекший
verify_documentno	verify_documentno		string	Номер документа, требующий проверки.
verify_name	verify_name		string	Полное имя, включая имя и фамилию, требующую проверки.
verify_dob	verify_dob		string	Дата рождения, требующая проверки, в формате ГГГГ/ММ/ДД.
verify_age	verify_age		string	Диапазон возрастов, пример: 18-40
verify_address	verify_address		string	Полный адрес, требующий проверки.
verify_postcode	verify_postcode		string	Полный почтовый код, требующий проверки.
verify_phone	verify_phone		string	Полный номер телефона, требующий проверки.
vault_save	vault_save		boolean	Сохраните пользовательские документы и синтаксический анализ данных в хранилище.
return_documentimage	return_documentimage		boolean	Возврат изображения документа, отправленного пользователем в запросе обратного вызова.
return_faceimage	return_faceimage		boolean	Возвращает изображение лица, отправленное пользователем в запросе обратного вызова.
return_type	return_type		integer	Укажите тип возвращаемого изображения, содержимое изображения в кодировке Base64 или URL-адрес изображения. (URL-адрес изображения будет храниться только в течение 7 дней)
welcomemessage	welcomemessage		string	Замените универсальное приветствие на первой странице настраиваемым текстом (максимум 1000 символов)
nobranding	nobranding		boolean	Скрыть логотип фирменной символики на всех страницах DocuPass. (Только подписчик)
logo	logo		string	Логотип пользовательской фирменной символики. (Только подписчик)
customhtmlurl	customhtmlurl		string	Используйте собственную HTML-страницу и CSS для DocuPass. (Только подписчик)
language	language		string	DocuPass автоматически обнаруживает язык пользовательского устройства и отображает соответствующий язык.
истечение	expiry		integer	Количество секунд до истечения срока действия сеанса DocuPass. По истечении срока действия пользователь не сможет продолжать работу с текущим сеансом, также будет отправлен обратный вызов сбоем.
qr_color	qr_color		string	Цвет переднего плана QR-кода. (Только для live Mobile и Standard Mobile)
qr_bgcolor	qr_bgcolor		string	Цвет фона QR-кода. (Только для live Mobile и Standard Mobile)
qr_size	qr_size		integer	Размер QR-кода (1–50). (Только для live Mobile и Standard Mobile)
qr_margin	qr_margin		integer	Толщина границы QR-кода (1–50). (Только для live Mobile и Standard Mobile)

Возвращаемое значение

Имя	Путь	Тип	Описание
справочник	reference	string	Уникальный справочный код для сеанса DocuPass.
type	type	integer	Созданный тип модуля DocuPass.
customid	customid	string	Пользовательский идентификатор, используемый при создании сеанса DocuPass.
URL-адрес	url	string	Уникальный URL-адрес веб-приложения DocuPass. Отправьте эту ссылку пользователю или вставьте его в веб-сайт или мобильное приложение, чтобы начать проверку подлинности.
qrcode	qrcode	string	URL-адрес изображения QR-кода для пользователя для сканирования
base_url	base_url	string	Вы можете отправить эту ссылку пользователю и попросить его ввести справочный код, чтобы начать проверку.
HTML	html	string	Пример HTML, который можно вставить на веб-страницу.
smssent	smssent	integer	Содержит номер телефона в качестве подтверждения при успешной отправке SMS через параметр sms_verification_link.
истечение	expiry	integer	Метка времени UTC UNIX, указывающая, когда истекает срок действия этого сеанса, пользователь больше не сможет использовать эту ссылку, а обратный вызов будет отправлен.

Создание сеанса подписи DocuPass

Идентификатор операции:: CreatingDocuPassSignatureSession

Вы можете создать сеанс подписи, в котором пользователь будет просматривать и подписывать юридический документ электронной почты без проверки подлинности. Если вы хотите выполнить проверку подлинности и подписать какой-то документ, создайте сеанс проверки личности.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
apikey	apikey	True	string	Закрытый ключ API доступен на веб-портале.
имя компании	companyname	True	string	Имя вашей компании будет отображаться на странице проверки, чтобы конечный пользователь знал, что они отправляют сведения о удостоверении в вашу компанию
идентификатор_шаблона	template_id		string	Идентификатор шаблона контракта для автоматического заполнения данными пользователя.
contract_format	contract_format		string	Формат выходного документа. (PDF, DOCX, HTML)
callbackurl	callbackurl		string	Файл контракта будет отправлен на этот URL-адрес. Необходимо включить vault_save или указать обратный вызов, чтобы сохранить созданный документ.
successredir	successredir		string	Браузер будет перенаправлен на этот URL-адрес после проверки и подписания документа. Ссылочный код DocuPass и customid будут добавлены в конец URL-адреса.
customid	customid		string	Пользовательская строка, которая будет отправлена обратно в URL-адрес обратного вызова сервера и добавлена к URL-адресам перенаправления, заданным successredir и failredir в качестве строки запроса. Это полезно для идентификации пользователя в базе данных. Это значение будет храниться в docupass_customid в хранилище.
многоразовый	reusable		boolean	При навигации по этому параметру несколько пользователей смогут просматривать и подписывать документы по одному URL-адресу, новый справочный код DocuPass будет создан автоматически для каждого пользователя.
sms_contract_link	sms_contract_link		string	Полный международный мобильный номер
vault_save	vault_save		boolean	Сохраните созданный документ в хранилище. Необходимо включить vault_save или указать обратный вызов, чтобы сохранить созданный документ.
nobranding	nobranding		boolean	Скрыть логотип фирменной символики на всех страницах DocuPass.
customhtmlurl	customhtmlurl		string	Используйте собственную HTML-страницу и CSS для DocuPass. После внесения изменений в HTML и CSS необходимо отправить их на собственный сервер, в начале каждого сеанса DocuPass скачайте последнюю HTML-страницу с сервера.
language	language		string	DocuPass автоматически обнаруживает язык пользовательского устройства и отображает соответствующий язык. Задайте этот параметр для переопределения автоматического обнаружения языка. (en, fr, nl, de, es, zh-TW, zh-CN)
истечение	expiry		integer	Количество секунд до истечения срока действия сеанса DocuPass. По истечении срока действия пользователь не сможет продолжать работу с текущим сеансом, также будет отправлен обратный вызов сбоем.
qr_color	qr_color		string	Цвет переднего плана QR-кода
qr_bgcolor	qr_bgcolor		string	Цвет фона QR-кода
qr_size	qr_size		integer	Размер QR-кода
qr_margin	qr_margin		integer	Толщина границы QR-кода

Возвращаемое значение

Имя	Путь	Тип	Описание
справочник	reference	string	Уникальный справочный код для сеанса DocuPass.
customid	customid	string	Пользовательский идентификатор, используемый при создании сеанса DocuPass.
URL-адрес	url	string	Уникальный URL-адрес веб-приложения DocuPass. Отправьте эту ссылку пользователю или вставьте его в веб-сайт или мобильное приложение, чтобы просмотреть и подписать документ.
qrcode	qrcode	string	URL-адрес изображения QR-кода для пользователя для сканирования
base_url	base_url	string	Вы можете отправить эту ссылку пользователю и попросить его ввести справочный код для подписывания документов.
html_qrcode	html_qrcode	string	Пример HTML для отображения QR-кода на веб-странице.
html_iframe	html_iframe	string	Пример HTML для вставки iframe в веб-страницу.
smssent	smssent	string	Содержит номер телефона в качестве подтверждения при успешной отправке SMS через параметр sms_contract_link.
истечение	expiry	integer	Метка времени UTC UNIX, указывающая, когда истекает срок действия этого сеанса, пользователь больше не сможет использовать эту ссылку, а обратный вызов будет отправлен.

Состояние обучения

Идентификатор операции:: TrainingStatus

Проверьте, продолжается ли обучение хранилища или завершено.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
apikey	apikey	True	string	Закрытый ключ API доступен на веб-портале.

Возвращаемое значение

Имя	Путь	Тип	Описание
статус	status	string	не обучен: никогда не обучено, не запущено: обучение не выполняется, выполняется: обучение выполняется успешно: обучение выполнено успешно, завершилось сбоем: обучение завершилось сбоем.
startTime	startTime	string	Время начала последнего обучения в формате UTC.
statusChangeTime	statusChangeTime	string	Время последнего изменения состояния в формате UTC.
lastSuccessTime	lastSuccessTime	string	Время последнего успешного обучения в формате UTC.
ошибка	error	string	Сообщение об ошибке, связанное с состоянием обучения сбоем.

Список и фильтрация записей

Идентификатор операции:: ListVaultEntries

Чтобы перечислить все записи, хранящиеся в хранилище, или найти записи с определенными значениями, отправьте HTTP-запрос POST в следующую конечную точку.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
apikey	apikey	True	string	Закрытый ключ API доступен на веб-портале.
orderby	orderby		string	Имя поля, используемого для упорядочивания результата.
sort	sort		string	ASC для сортировки приводит к возрастанию, DESC для сортировки в порядке убывания.
limit	limit		integer	Количество возвращаемых записей хранилища. (от 1 до 100)
offset	offset		integer	Возвращаемый список, начиная с определенной записи, например, при ограничении=10 для доступа к третьей странице результатов, используйте смещение=20
фильтр	filter		array of string	фильтр

Возвращаемое значение

Имя	Путь	Тип	Описание
limit	limit	integer	Текущее ограничение
offset	offset	integer	Текущее смещение
nextoffset	nextoffset	integer	Значение смещения для следующего набора данных. Если текущий набор данных является окончательным набором данных, это поле не будет возвращено.
итог	total	integer	Общее количество найденных записей.
items	items	array of	Массив найденных записей и их полного содержимого, идентичный содержимому, возвращаемого методом GET.

Удаление записи из хранилища

Идентификатор операции:: DeleteVaultEntry

Вы можете удалить один или несколько записей хранилища, выполнив HTTP-запрос POST.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
apikey	apikey	True	string	Закрытый ключ API доступен на веб-портале.
id	id	True	array of string	id

Возвращаемое значение

Имя	Путь	Тип	Описание
success	success	integer

Удаление образа из хранилища

Идентификатор операции:: DeleteImageFromVault

Вы можете удалить изображение внутри записи хранилища, выполнив HTTP-запрос POST. Обратите внимание, что после удаления изображения URL-адрес изображения может быть доступен в течение короткого периода времени из-за кэширования.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
apikey	apikey	True	string	Закрытый ключ API доступен на веб-портале.
id	id	True	string	Идентификатор записи хранилища, содержащий изображение.
imageid	imageid		string	идентификатор изображения для удаления.

Возвращаемое значение

Имя	Путь	Тип	Описание
success	success	integer