VeriFlow.me Service API
    VeriFlow.me Service API
    • Introduction
    • API Authentication
    • Webhook
    • Prices
    • Dashboard
      • 0. Secure Login & OTP
      • 1. Main Dashboard
      • 2. Verifications
      • 3. New Verification
      • 4. Verification Detail
      • 5. Manual Review
    • Services
      • Session Request
        • Create a new Session Request
        • Update a Request
        • Fetch a single request by its ID
        • Fetch all requests for the authenticated organization
      • Standalone
        • Create a new ID Verification Request
        • Create a new Face Match Request
        • Create a new Age Estimation Request
        • Create a new Proof of Address Request
        • Create a new AML Screening Request
        • Create a new Face Search Request
        • Create a new Passive Liveness Request
        • Create a new Database Validation Request
      • Phone Verification
        • Create a new Phone Verification Request
        • Check a Phone Verification Code
      • Email Verification
        • Create a new Email Verification Request
        • Check an Email Verification Code

    Webhook

    Webhooks allow your application to receive real-time notifications about changes to a verification session status on web app workflows. Here's how you can configure and handle these notifications securely.

    Webhook Event#

    When the status of a request changes (e.g., after VeriFlow.me processes an change), Veriflow can send a notification to an endpoint you configure. This allows your application to react to events in real-time.

    Endpoint Configuration#

    URL: You must provide your webhook URL in your organization's settings within VeriFlow.me.
    Method: POST

    Request Body#

    VeriFlow.me will send a simple JSON payload containing the unique ID of the request and its new status.
    id: The unique identifier for the request (req_...).
    status: The new status of the request (e.g., approved, declined, in_process).
    Example Payload:
    {
  "id": "req_12345abcde",
  "status": "approved"
}

    Security#

    The outgoing webhook from VeriFlow.me does not include a cryptographic signature. To secure your endpoint, we recommend the following:
    Use a hard-to-guess, unique URL for your webhook listener.
    Accept traffic only from VeriFlow.me's IP addresses, if possible.

    Retrieving Full Event Details#

    The webhook payload is intentionally lightweight. To get the complete, up-to-date details of the request, your application should use the id from the payload to make a call to the VeriFlow.me API.
    Action: Upon receiving the webhook, make a GET request to /v2/requests/{id}.
    Example:
    If you receive the payload above, fetch the full request details by calling:
    GET /v2/requests/req_12345abcde
    This ensures you are acting on the most current and complete data for the request.

    Responses#

    Your endpoint should return a 200 status code to acknowledge receipt of the webhook. If VeriFlow.me receives a different status code, we may retry sending the webhook.

    Error Responses#

    If your endpoint encounters an error, you can return an appropriate HTTP status code (e.g., 400 Bad Request, 500 Internal Server Error). VeriFlow.me will interpret any non-2xx status code as a failure and may retry the webhook.
    Modificado en 2025-11-18 00:50:49
    Anterior
    API Authentication
    Siguiente
    Prices
    Built with