Articheck API Integration

Webhook Format

Articheck will send verification results via webhooks to the URL provided by the partner. The webhook will use the POST method with the following payload:

{
  "external_id": "string",
  "status": "ApplicantStatus",
  "message": "string or null"
}

Applicant Status Values

ApplicantStatus(StrEnum):
    INIT = 'init'
    PENDING = 'pending'
    APPROVED = 'approved'
    REJECTED = 'rejected'

Security Verification

A header X-Signature will be included, which contains a value generated as follows:

import hmac
import hashlib

hmac.new(
    key=str(webhook_secret_key).encode(),
    msg=data.encode(),
    digestmod=hashlib.sha256,
).hexdigest()

This is a SHA-256 hash of the request body (data) using the webhook_secret_key. Partners should calculate this hash and compare it with the X-Signature header to verify security. If the values match, the security check is passed.