Кабинетти ачуу

Кредиттик конвейер үчүн API

Кызматкер кабинетте жасаган иштердин баарын сиздин системаңыз API аркылуу аткарат: текшерүү түзөт, карыз алуучуга шилтеме жөнөтөт, жыйынтык отчёт менен PDFти алат. Натыйжа вебхук аркылуу келет, кызматты улам сурап туруунун кереги жок.

Принциптер

  • Даректеги версия

    Бардык методдор /api/v1 астында. Шайкеш келбеген өзгөртүүлөр жаңы версия менен чыгат, эскиси иштей берет.

  • Бирдиктүү жооп

    Ар бир метод success, code, error жана value кайтарат. Ката Accept-Language көрсөткөн тилде текст түрүндө келет.

  • Идемпотенттүүлүк

    Таймауттан кийин ошол эле Idempotency-Key менен текшерүүнү кайра түзүү аракети мурда түзүлгөн текшерүүнү кайтарат.

  • Өз арыз номериңиз

    Текшерүүгө системаңыздын externalReferenceId берилет, ал аркылуу биздин идентификаторлорду сактабай эле текшерүүнү табууга болот.

Кирүү

Система уюмдун атынан иштейт. Эки ыкма ылайыктуу, экөө тең бир API-ачкычты жана бирдей кирүү укуктарын колдонот.

  • API-ачкыч

    X-API-Key жана VeriCore-Organization-Id аталыштары. Ачкычтын сыры серверде түзүлөт, бир жолу гана көрсөтүлөт жана хеш түрүндө гана сакталат.

  • OAuth2 client credentials

    Ачкыч /api/v1/oauth/token дареги боюнча кыска мөөнөттүү токенге алмаштырылат. Стандарттуу OAuth2 агымын күткөн системаларга ылайыктуу.

  • Кирүү укуктары

    Он бир аймак: текшерүүлөр, документтер, провайдер текшерүүлөрү, кол менен текшерүү, аракеттер тарыхы, колдонууну эсепке алуу жана уюмдун жөндөөлөрү, окуу жана жазуу үчүн.

  • IP ак тизмеси

    Уюм өз ачкычтары кабыл алына турган даректерди чектей алат. Тизме бош болсо, эч кандай чектөө жок дегенди билдирет.

API аркылуу текшерүүнүн жолу

Арыздан жыйынтык отчётко чейин алты чакыруу. Сканерлөө, талдоо жана текшерүү кадамдарын платформанын оркестратору сиздин катышууңузсуз аткара алат.

  1. 01POST/api/v1/verification-cases

    Текшерүү түзүү: карыз алуучунун жана отчёттун өлкөсү, арыз ээсинин түрү, арыз номериңиз

  2. 02POST/verification-cases/{id}/upload-link

    Карыз алуучуга жүктөө порталына бир жолку шилтеме берүү

  3. 03POST/verification-cases/{id}/documents/signed-upload-url

    Же файлды кол коюлган шилтеме аркылуу өзүңүз жүктөө

  4. 04POST/verification-cases/{id}/provider-checks/start-session

    Карыз алуучу үчүн KYC же KYB сессиясын баштоо

  5. 05POST/verification-cases/{id}/summary/generate

    Жыйынтык отчёт түзүү: инсандыкты салыштыруу, аныктык, тобокелдик белгилери, сунуш

  6. 06GET/verification-cases/{id}/summary/pdf

    QR-коду бар жыйынтык отчёттун PDFин алуу

Текшерүү түзүү

Жоопто карыз алуучу үчүн порталдын дареги дароо камтылат. Шилтемени SMS же мессенджер аркылуу жөнөтүүгө, же экранда QR-код менен көрсөтүүгө болот.

POST /api/v1/verification-cases
X-API-Key: vk_live_…
VeriCore-Organization-Id: 7c1f…
Idempotency-Key: 5b0e8f2a-…

{
  "externalReferenceId": "LOAN-2026-104233",
  "applicantType": "Individual",
  "applicantCountryCode": "UZ",
  "reportCountryCode": "UZ"
}
{
  "success": true,
  "code": 200,
  "value": {
    "id": "c4d1…",
    "status": "AwaitingApplicant",
    "applicantUploadUrl": "https://app.vericore.a3.solutions/apply/…"
  }
}

Вебхуктар

Даректи керектүү окуяларга жаздырыңыз. Ар бир жеткирүүгө убакыт белгисинен жана сурамдын денесинен HMAC-SHA256 кол тамгасы коюлат, ката болсо кайталанат жана жеткирүү журналында сакталат.

case.status_changed

Текшерүү жаңы статуска өттү

document.uploaded

Карыз алуучу же системаңыз документ жүктөдү

document.status_changed

Документти иштетүү статусу өзгөрдү

manual_review.status_changed

Кол менен текшерүү тапшырмасы өзгөрдү

summary.generated

Андеррайтинг боюнча жыйынтык отчёт түзүлдү

Кол тамганы кантип текшерүү керек

HMAC-SHA256ды «убакыт белгиси, чекит, сурамдын денеси» сабынан даректин сыры менен кайра эсептеп, X-VeriCore-Signature аталышы менен салыштырыңыз. Убакыт белгиси өтө эски болгон сурамды четке кагыңыз.

X-VeriCore-Event: summary.generated
X-VeriCore-Delivery: 9a71…
X-VeriCore-Timestamp: 1791964800
X-VeriCore-Signature: 3f6c…

Берилген отчётту текшерүү

PDFтеги QR-код текшерүүнүн ачык дарегине алып барат. Аны өз «отчётту текшерүү» интерфейсиңизге орнотсоңуз болот: жооп отчёт платформа тарабынан берилгенин жана өзгөртүлбөгөнүн көрсөтөт.

QR-код аркылуу текшерилүүчү отчёт

API коргоосу

  • Ачык даректерде сурамдардын жыштыгын чектөө, отчётту сырсөз менен ачууга өзүнчө катуу лимит
  • Вебхук даректери текшерилет: жеке тармактар жана коопсуз эмес схемалар четке кагылат
  • Документтер мөөнөтү чектелген кол коюлган шилтемелер аркылуу берилет
  • Файлды сактоо ачкычын сервер эсептейт, кардар башка бирөөнүн файлын көрсөтө албайт
  • Жумушчу чөйрөдө API документациясы аноним кирүүдөн жабык

Документация жана тесттик чөйрө

Алты тилдеги Scalar интерфейси менен OpenAPI 3.1 сыпаттамасы жана интеграцияны жөндөө үчүн тесттик текшерүүлөрү бар акысыз тесттик чөйрө.

API документациясыТесттик чөйрөдөн баштоо