Кабинетті ашу

Кредиттік конвейерге арналған 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 құжаттамасыСынақ ортасынан бастау