Webhooks in Identity Proofing

June 24, 2026 22:54

In Identity Proofing, decision changes for a case trigger the identityProofing.statusChange event. Depending on the field that changes, the following values are included in the payload provided with the webhook:

decision
caseStatus
queue
rejectionCode
tags
assignee
verifiedFraud

Refer to the following payload example:

sidebar. Webhook payload example

{
  "inquiryId": "8V6CFF359HS5QQ6G",
  "authenticationId": "3b42bd08-9ccc-4886-bcaa-8da4ab607675",
  "apiVersion": "v1",
  "clientId": "900900",
  "eventType": "identityProofing.statusChange",
  "creationDateTime": "2022-05-24T23:13:02Z",
  "eventDateTime": "2022-05-24T23:18:00Z",
  "fieldsUpdated": [
    { "fieldName": "decision", "oldValue": "Review", "newValue": "Deny" },
    { "fieldName": "caseStatus", "oldValue": "ASSIGNED", "newValue": "CLOSED" },
  ],
  "fields": [
    "decision": "Review",
    "caseStatus": "ASSIGNED",
    "verifiedFraud": false,
    "assignee": {
      "userName": "John Doe",
      "userId": "00u22ugh06xewQmyo0h8"
    },
    "user": {
      "userName": "John Doe",
      "userId": "00u276zqqm0YiI5td0h8"
    },
    "queue": "",
    "tags": [
      "Phone",
      "listAcountId",
      "addresstype",
      "velocityIP30D",
      "velocityApplicantAddress",
      "ssntag",
      "listTag",
      "channnel",
      "velocityApplicantEmail1",
      "addressValidationCode",
      "addressCity",
      "AddressPostalCode",
      "identityTag",
      "countryCodeTag"
  ]
}

Refer to the following properties table for an explanation of each property returned in the webhook payload.

sidebar. Payload properties table

JSON Path	Type	Description
inquiryId	String	A customer-supplied identifier used to track the status across the inquiry or customer journey.
authenticationId	String	UUID generated by Identity Proofing. Identifies and correlates all interactions for an authentication attempt by the end user.
apiVersion	String	The version of the API used in the webhook event.
clientId	String	The client ID used in the event. This matches the client ID for your organization provided in Kount 360.
eventType	String	A string containing the type of event that occurred.
creationDateTime	String	Date/time indicating when the transaction or request was placed.
eventDateTime	String	Date/time indicating when the event occurred.
fieldsUpdated	Array	Array of objects describing each field that changed as part of the trigger activity.
fieldName	String	Name of the field that was updated that triggered the webhook.
oldValue	String	Previous value of the changed field.
newValue	String	New value of the field.
fields	Array	Full list of current values for the relevant fields with or without changes.

Webhook results notifications

Although not an active API call, your server must expose a registered endpoint to listen for status update webhooks to receive real-time, asynchronous notifications as a consumer progresses through and finishes the verification flow. As the consumer completes the capture of their ID and takes a photo of themselves, Kount 360 sends an HTTP POST request to your pre-configured URL.

Event type: DOCVerification.StatusUpdate

Note

The webhook does not contain any personally identifiable information (PII).

To receive all related details collected by Document Verification, call the GET Document Verification Details API endpoint with getDetails as true in the API request.

Message Sent notification payload example

Triggered when the SMS link is successfully dispatched to the consumer.

{
    "apiVersion": "v1",
    "clientId": "700027596473280",
    "documentVerificationStatus": "MESSAGE_SENT",
    "verificationAttempts": "0",
    "authenticationId": "ed94604f-5aa1-4428-b043-3b2c286fe349",
    "id": "d59e5aef-de4c-4fe7-bb77-9e5238034d8f",
    "eventType": "DOCVerification.StatusUpdate",
    "sendAttempts": "1",
    "sessionId": "2e88b59b-6bed-499b-afbf-ed0d47cda2e8"
}

Flow Begun notification payload example

Triggered when the user clicks the verification link and opens the capture interface.

{
    "apiVersion": "v1",
    "clientId": "700027596473280",
    "documentVerificationStatus": "FLOW_BEGUN",
    "verificationAttempts": "1",
    "authenticationId": "ed94604f-5aa1-4428-b043-3b2c286fe349",
    "id": "e8b0938f-16c0-f514-6734-7b492b5e0e75",
    "eventType": "DOCVerification.StatusUpdate",
    "sendAttempts": "1",
    "sessionId": "2e88b59b-6bed-499b-afbf-ed0d47cda2e8"
}

Flow Completed: Success notification payload example

Triggered when the user completes the flow and passes all verification checks.

{
    "apiVersion": "v1",
    "clientId": "700027596473280",
    "documentVerificationStatus": "complete",
    "verificationAttempts": "",
    "authenticationId": "332425fd-8177-489e-8771-e6d45fe3ca0d",
    "id": "63d74aa4-a029-b303-59ed-156fa44146b6",
    "eventType": "DOCVerification.StatusUpdate",
    "sendAttempts": "",
    "sessionId": "f56ac04a-2393-4113-bfe3-2823e67fa7b7",
    "documentVerificationResults": {
        "overallResultStatus": "OK",
        "reasonMsg": "This session passed because it passed all of Incode's tests: ID Verification, Face Recognition, Liveness Detection",
        "livenessStatus": "OK",
        "faceRecognitionStatus": "OK",
        "ocrConfidenceStatus": "OK",
        "idValidationStatus": "OK"
    }
}

Flow Completed: Fail notification payload example

Triggered when the user completes the flow but fails one or more verification checks. The payload includes specific failure reasons.

{
    "apiVersion": "v1",
    "clientId": "700027596473280",
    "documentVerificationStatus": "complete",
    "verificationAttempts": "",
    "authenticationId": "ed94604f-5aa1-4428-b043-3b2c286fe349",
    "id": "091f8d93-930a-4857-5f91-bfef86dd1f03",
    "eventType": "DOCVerification.StatusUpdate",
    "sendAttempts": "",
    "sessionId": "2e88b59b-6bed-499b-afbf-ed0d47cda2e8",
    "documentVerificationResults": {
        "overallResultStatus": "FAIL",
        "reasonMsg": "This session failed because of Face Recognition, ID Verification",
        "livenessStatus": "OK",
        "faceRecognitionStatus": "FAIL",
        "ocrConfidenceStatus": "OK",
        "idValidationStatus": "FAIL"
    }
}

Terminated notification payload example

Triggered when the session times out according to your configured SMS or Email timeout settings.

{
    "apiVersion": "v1",
    "clientId": "700027596473280",
    "documentVerificationStatus": "TERMINATED",
    "verificationAttempts": "0",
    "authenticationId": "58e965da-bd96-42d3-88a2-5f0af7c82847",
    "id": "da08f782-1990-44e7-b547-0680583605c2",
    "eventType": "DOCVerification.StatusUpdate",
    "sendAttempts": "1",
    "sessionId": "8c1c47b6-8b0b-4e62-849e-db4d238bc435"
}

Was this article helpful?

0 out of 0 found this helpful