Начало работы
Интеграция / SDK
Проверка пользователей
Верификация бизнеса
Мониторинг транзакций
Журнал измененийcurl -X POST 'https://verification.didit.me/v3/id-verification/' \
-H 'x-api-key: YOUR_API_KEY' \
-F 'front_image=@./id_front.jpg' \
-F 'back_image=@./id_back.jpg' \
-F 'perform_document_liveness=true' \
-F 'save_api_request=true' \
-F 'vendor_data=user-123'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.id_verification.verify(
front_image=open("front_image.jpg", "rb"),
back_image=open("back_image.jpg", "rb"),
perform_document_liveness=True,
save_api_request=True,
vendor_data="user-123",
metadata={"flow": "onboarding"},
)
print(result)import Didit, { fileFromPath } from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.idVerification.verify({
front_image: await fileFromPath("front_image.jpg"),
back_image: await fileFromPath("back_image.jpg"),
perform_document_liveness: true,
save_api_request: true,
vendor_data: "user-123",
metadata: { flow: "onboarding" },
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.IDVerification.Verify(ctx, didit.IDVerificationVerifyParams{
FrontImage: didit.FileFromPath("front_image.jpg"),
BackImage: didit.Some(didit.FileFromPath("back_image.jpg")),
PerformDocumentLiveness: didit.Bool(true),
SaveAPIRequest: didit.Bool(true),
VendorData: didit.String("user-123"),
Metadata: didit.Some(map[string]any{"flow": "onboarding"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.nio.file.Path;
import java.util.Map;
import me.didit.Didit;
import me.didit.types.IdVerificationVerifyParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.idVerification().verify(IdVerificationVerifyParams.builder()
.frontImage(Path.of("front_image.jpg"))
.backImage(Path.of("back_image.jpg"))
.performDocumentLiveness(true)
.saveApiRequest(true)
.vendorData("user-123")
.metadata(Map.of("flow", "onboarding"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
use Didit\File;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->idVerification->verify([
'front_image' => File::fromPath('front_image.jpg'),
'back_image' => File::fromPath('back_image.jpg'),
'perform_document_liveness' => true,
'save_api_request' => true,
'vendor_data' => 'user-123',
'metadata' => ['flow' => 'onboarding'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.id_verification.verify(
front_image: Pathname("front_image.jpg"),
back_image: Pathname("back_image.jpg"),
perform_document_liveness: true,
save_api_request: true,
vendor_data: "user-123",
metadata: { flow: "onboarding" }
)
puts result.to_husing System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.IdVerification.VerifyAsync(new IdVerificationVerifyParams
{
FrontImage = FileUpload.FromPath("front_image.jpg"),
BackImage = FileUpload.FromPath("back_image.jpg"),
PerformDocumentLiveness = true,
SaveApiRequest = true,
VendorData = "user-123",
Metadata = new Dictionary<string, object> { ["flow"] = "onboarding" },
});
Console.WriteLine(JsonSerializer.Serialize(result));Верификация личности API: OCR и подлинность документов
Верификация документов Didit: 220+ стран и 14,000+ типов документов. Проверка подлинности, OCR, MRZ, менее 2 с, оплата по факту, без контрактов.
curl -X POST 'https://verification.didit.me/v3/id-verification/' \
-H 'x-api-key: YOUR_API_KEY' \
-F 'front_image=@./id_front.jpg' \
-F 'back_image=@./id_back.jpg' \
-F 'perform_document_liveness=true' \
-F 'save_api_request=true' \
-F 'vendor_data=user-123'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.id_verification.verify(
front_image=open("front_image.jpg", "rb"),
back_image=open("back_image.jpg", "rb"),
perform_document_liveness=True,
save_api_request=True,
vendor_data="user-123",
metadata={"flow": "onboarding"},
)
print(result)import Didit, { fileFromPath } from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.idVerification.verify({
front_image: await fileFromPath("front_image.jpg"),
back_image: await fileFromPath("back_image.jpg"),
perform_document_liveness: true,
save_api_request: true,
vendor_data: "user-123",
metadata: { flow: "onboarding" },
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.IDVerification.Verify(ctx, didit.IDVerificationVerifyParams{
FrontImage: didit.FileFromPath("front_image.jpg"),
BackImage: didit.Some(didit.FileFromPath("back_image.jpg")),
PerformDocumentLiveness: didit.Bool(true),
SaveAPIRequest: didit.Bool(true),
VendorData: didit.String("user-123"),
Metadata: didit.Some(map[string]any{"flow": "onboarding"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.nio.file.Path;
import java.util.Map;
import me.didit.Didit;
import me.didit.types.IdVerificationVerifyParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.idVerification().verify(IdVerificationVerifyParams.builder()
.frontImage(Path.of("front_image.jpg"))
.backImage(Path.of("back_image.jpg"))
.performDocumentLiveness(true)
.saveApiRequest(true)
.vendorData("user-123")
.metadata(Map.of("flow", "onboarding"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
use Didit\File;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->idVerification->verify([
'front_image' => File::fromPath('front_image.jpg'),
'back_image' => File::fromPath('back_image.jpg'),
'perform_document_liveness' => true,
'save_api_request' => true,
'vendor_data' => 'user-123',
'metadata' => ['flow' => 'onboarding'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.id_verification.verify(
front_image: Pathname("front_image.jpg"),
back_image: Pathname("back_image.jpg"),
perform_document_liveness: true,
save_api_request: true,
vendor_data: "user-123",
metadata: { flow: "onboarding" }
)
puts result.to_husing System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.IdVerification.VerifyAsync(new IdVerificationVerifyParams
{
FrontImage = FileUpload.FromPath("front_image.jpg"),
BackImage = FileUpload.FromPath("back_image.jpg"),
PerformDocumentLiveness = true,
SaveApiRequest = true,
VendorData = "user-123",
Metadata = new Dictionary<string, object> { ["flow"] = "onboarding" },
});
Console.WriteLine(JsonSerializer.Serialize(result));Авторизации
API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys.
Тело
Лицевая сторона документа, удостоверяющего личность. Допустимые расширения: tiff, jpg, jpeg, png, webp, pdf. Максимальный размер загружаемого файла: 10 MB (файлы большего размера отклоняются с ошибкой 400). PDF-файлы преобразуются в изображение перед OCR; для зашифрованных PDF требуется front_image_password. Изображения автоматически сжимаются примерно до 0.5 MB, и применяется ориентация EXIF. Загружайте полный необрезанный снимок, на котором видны все четыре угла документа.
Пароль для расшифровки front_image, если это зашифрованный PDF-файл. Передача зашифрованного PDF без пароля (или с неверным паролем) возвращает 400.
Обратная сторона документа — отправляйте её всегда, когда она есть у документа (многие ID-карты содержат MRZ или штрихкод на обороте; если её опустить, поля MRZ и обратной стороны в ответе останутся пустыми — этот endpoint не выдаёт предупреждение об отсутствии MRZ). Те же ограничения по формату и размеру, что и для front_image. Если поле опущено, back_image и поля обратной стороны в ответе будут null.
Пароль для расшифровки back_image, если это зашифрованный PDF-файл.
Проверяет оба изображения на мошенничество при предъявлении: пересъёмку с экрана (SCREEN_CAPTURE_DETECTED), печатные копии (PRINTED_COPY_DETECTED) и манипуляции с портретом (PORTRAIT_MANIPULATION_DETECTED). Любое из них приводит к автоматическому отклонению. Включено по умолчанию; установите значение false, чтобы пропустить проверку на мошенничество и сократить задержку. Если проверка включена, но провайдер не возвращает пригодную для использования оценку, возвращается статус In Review с предупреждением DOCUMENT_LIVENESS_NOT_COMPUTED вместо Approved.
true
Принимается и валидируется (1–120), но в настоящее время не применяется этим endpoint — по этому полю никогда не создаётся предупреждение MINIMUM_AGE_NOT_MET. Применяйте правила возраста на основе возвращаемых date_of_birth/age или используйте сценарий сессии верификации с возрастными ограничениями.
1 <= x <= 120Действие, если не удаётся прочитать срок действия (EXPIRATION_DATE_NOT_DETECTED). По умолчанию NO_ACTION, так как во многих документах срок действия не указывается. Примечание: обнаруженный и истёкший срок действия всегда приводит к отклонению (DOCUMENT_EXPIRED) независимо от этой опции.
NO_ACTION, DECLINE Что делать, если извлеченная MRZ не проходит проверку контрольных цифр (MRZ_VALIDATION_FAILED). Отсутствие MRZ на этом endpoint не вызывает предупреждения. Актуально только для документов, содержащих MRZ. Значение REVIEW не поддерживается на этом endpoint и возвращает 400.
NO_ACTION, DECLINE Действие при внутренней несогласованности извлечённых данных: DATA_INCONSISTENT, MRZ_AND_DATA_EXTRACTED_FROM_OCR_NOT_SAME (визуальная зона расходится с MRZ) или DOCUMENT_NAME_DIFFERENT_FROM_OTHER_APPROVED_DOCUMENTS.
NO_ACTION, DECLINE Действие при физическом перекрытии важного печатного поля на снимке (CRITICAL_FIELD_OCCLUSION_DETECTED) - номера удостоверения личности, имени, даты рождения или срока действия. По умолчанию отклоняет, как и при других рисках целостности документа на этом endpoint: скрытие номеров, с которыми сверяется отчёт, указывает на отредактированный документ. Считанное значение скрытого поля в любом случае удаляется из извлечённых данных, поэтому ему обычно сопутствует предупреждение *_NOT_DETECTED. Значение REVIEW не поддерживается на этом endpoint и возвращает 400.
NO_ACTION, DECLINE Действие, если номер не соответствует формату органа выдачи для данного типа документа (DOCUMENT_NUMBER_FORMAT_MISMATCH, PERSONAL_NUMBER_FORMAT_MISMATCH). По умолчанию NO_ACTION, что регистрирует предупреждение без изменения статуса. REVIEW не поддерживается на этом endpoint и возвращает 400.
NO_ACTION, DECLINE Предпочтительная система письма для полей имени/адреса в документах, содержащих текст как на латинице, так и не на латинице (арабский, кириллица, CJK, …). latin возвращает транслитерированные/латинские значения; non_latin отдаёт предпочтение оригинальной системе письма.
latin, non_latin Если true (по умолчанию), сохраняет вызов как сессию типа API — видимую в Business Console, доступную через GET /v3/session/{sessionId}/decision/ по возвращённому request_id, анонсируемую через webhook status.updated, с возвратом изображений документов в виде URL-адресов медиа. Если false, ничего не сохраняется, request_id является временным UUID, а изображения возвращаются встроенными в виде строк base64 JPEG.
true
Необязательная непрозрачная строка (ваш внутренний идентификатор пользователя, email, UUID…), сохраняемая в сессии и возвращаемая в ответе. Используйте её для сопоставления вызовов API с вашими собственными записями и для последующей фильтрации сессий.
"user-123"
Необязательный объект JSON, сохраняемый вместе с сессией (когда save_api_request=true) и возвращаемый обратно в ответе. В multipart-запросах отправляйте его как строковое поле в формате JSON (например, metadata={"flow":"onboarding"}) — он парсится в объект.
{ "flow": "onboarding" }
Ответ
Документ обработан. Значение id_verification.status: Approved, Declined или In Review; каждая обнаруженная проблема детализирована в id_verification.warnings. Статус In Review возвращается, когда запрошенная проверка живости документа не дала пригодного результата (DOCUMENT_LIVENESS_NOT_COMPUTED). Для проблемного документа по-прежнему возвращается 200 со статусом status: "Declined": проверяйте тело ответа, а не только HTTP-код. Если save_api_request=true, request_id представляет собой сохранённый id сессии, а поля изображений являются временными URL медиафайлов; при save_api_request=false они передаются как встроенные base64-строки JPEG.
Идентификатор сохраненной сессии при save_api_request=true (доступен для использования с GET /v3/session/{sessionId}/decision/); в противном случае это временный корреляционный UUID.
Show child attributes
Show child attributes
Эхо-значение переданного вами vendor_data или null.
Эхо-значение переданного вами объекта metadata или null.
Временная метка ISO 8601 (UTC) момента генерации ответа.