1. Webhooks
Vrtx Docs
  • Auth
    • Token
      POST
  • Onboarding
    • Start onboarding
      POST
    • Verify onboarding OTP
      POST
    • Resend onboarding OTP
      POST
    • Get session status
      GET
    • Initiate Nafath
      POST
    • Cancels session
      POST
    • Complete customer info
      POST
  • Webhooks
    • Process Nafath webhook
      POST
    • Process Faceki webhook
      POST
    • Process T2 webhook
      POST
  • Wallet
    • Change mobile number from profile settings
      • Change mobile number
      • Verify mobile number change OTP
      • Get mobile change status
    • Change mobile number from login screen
      • Change mobile number
      • Verify mobile number change OTP
      • Initiate Nafath
      • Get mobile number change status
  • Businesses
    • Create business
      POST
  • Transactions
    • Business Accounts
      • Get business account balance
      • Get transaction details
      • List business transactions
    • Wallet Accounts
      • Get wallet balance
      • List wallet transactions
  • Payouts
    • Create payout
      POST
    • Get payout status
      GET
    • Create bulk payout
      POST
    • Get bulk payout status
      GET
    • Get batch report
      GET
  • Cards
    • Issuance
      • Issue card
      • Get card issuance
      • Complete card issuance
      • Verify card issuance OTP
      • Convert virtual to physical
      • Verify card conversion OTP
    • Management
      • Get card
      • Change card status
      • Set or update card PIN
      • Verify card PIN OTP
      • Activate physical card
      • Verify activation OTP
      • Display sensitive data
      • Verify display sensitive data OTP
  • cards
    • Initiate card replacement
    • Verify OTP and complete card replacement
Open-Loop-v2Closed-loop V2Card Simulatoropen-loop-test
Open-Loop-v2Closed-loop V2Card Simulatoropen-loop-test
  1. Webhooks

Process Faceki webhook

POST
/webhooks/faceki
Last modified:2025-12-02 10:06:51
Processes Faceki AML screening webhook callbacks to update session status based on compliance review.
This endpoint receives webhook notifications from Faceki when a compliance officer updates
the status of an AML screening case after manual review. It processes the callback data
and updates the corresponding onboarding session status accordingly.
Security:
Payload validation and signature verification (if supported by Faceki)
Idempotent processing to handle duplicate webhooks
Request Structure (Faceki Webhook API):
payload - JSON string containing case status and reference information
Case Status Values:
CLOSED_TRUE_POSITIVE - User account blocked; onboarding rejected
CLOSED_FALSE_POSITIVE - Account status changed to active; user can proceed
REOPENED - Temporary block applied to user account
ESCALATED, UNDER_REVIEW - No change on status; user account still blocked
The payload contains case reference information that maps to the internal user profile.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200Success
application/json
Default Response
Body

đźź 400400
đźź 401401
đźź 409409
đźź 422422
đź”´500500
đź”´503503
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/webhooks/faceki' \
--header 'Content-Type: application/json' \
--data-raw '{
    "profile_id": "string",
    "full_name": "string",
    "last_checked": "string",
    "assigned_to": "string",
    "file_id": "string",
    "branch_id": "string",
    "searched_result_data": [
        {
            "name": "string",
            "first_name": "string",
            "last_name": "string",
            "middle_name": "string",
            "type": "string",
            "positions": "string",
            "name_title": "string",
            "country": "string",
            "listed_on": "string",
            "nationality": "string",
            "year_of_birth": "string",
            "place_of_birth": "string",
            "place_of_birth_city": "string",
            "place_of_birth_state": "string",
            "alias_name": [
                "string"
            ],
            "list_name": "string",
            "reason": "string",
            "additional": "string",
            "entity": "string",
            "documents": [
                null
            ],
            "request_id": "string",
            "fuzz": 0,
            "highlighted": true
        }
    ],
    "search_id": "string",
    "created_at": "string",
    "created_by": "string",
    "updated_at": "string",
    "enable_ongoing": true,
    "__v": 0,
    "custom_id": "s1d2e3f4-a5b6-7890-c1d2-e3f4a5b6c7d8",
    "status": "CLOSED_FALSE_POSITIVE",
    "risk_level": "string",
    "on_going_frequency": "string",
    "webhook": "string"
}'
Response Response Example
200 - Example 1
{
    "success": true,
    "timestamp": "string"
}
Modified at 2025-12-02 10:06:51
Previous
Process Nafath webhook
Next
Process T2 webhook
Built with