Перейти до основного вмісту

Документація для розробників

Усе необхідне для інтеграції перевірки особи у ваш застосунок.

Швидкий старт

REST API

Повний REST API зі специфікацією OpenAPI. Усі кінцеві точки задокументовано зі схемами запитів/відповідей.

TypeScript SDK

@noxverify/sdk -- Типобезпечний клієнт для Node.js та браузера. Встановіть за допомогою npm install @noxverify/sdk

Вебхуки

Сповіщення про події в реальному часі з підписами HMAC-SHA256 для безпечної перевірки доставки.

Приклад інтеграції

verify.ts
import { createNoxVerifyClient } from '@noxverify/sdk';

const nox = createNoxVerifyClient({ apiKey: 'nv_live_...' });

const verification = await nox.verifyIdentity({
 type: 'kyc_individual',
 returnUrl: 'https://yourapp.com/callback',
});

Базова URL-адреса API

https://api.noxverify.com/v1

Автентифікація

API-ключі через заголовок Authorization:

Authorization: Bearer nv_live_...

Основні кінцеві точки

Кінцева точкаОпис
POST/cases
Створити нову справу про перевірку
GET/cases/:id
Отримати статус справи
POST/cases/:id/personal-details
Надіслати персональні дані
POST/biometrics/selfie-check
Почати біометричну перевірку
POST/aml/screen
Запустити скринінг AML

Повна документація незабаром

Звʼяжіться з нами для раннього доступу до API та підтримки інтеграції.

Звʼязатися з відділом продажів