Webhook Events

List of events for when the webhooks get triggered.

Event	Description
`USER_PII_UPDATE`	The user's PII has been updated.
`SELF_VERIFICATION_TRY_STATUS`	Medallion™ try status
`CRIMINAL_REQUEST_STATUS_UPDATE`	Triggered when County Criminal, County Civil, Federal Criminal, or Federal Civil search requests placed or has an update.
`ALL_CRIMINAL_REQUESTS_COMPLETE`	All county criminal requests have been completed for a particular user.
`UPLOAD_ID_ENHANCED_REVIEW_STATUS`	Upload ID Enhanced review completed. Results can be fetched through the Test Results Object.
`UPLOAD_PASSPORT_ENHANCED_REVIEW_STATUS`	Upload Passport Enhanced review completed. Results can be fetched through the Test Results Object.
`USER_PDF_REPORT_GENERATION`	Each stage of user pdf report generation. There are three stages:`INITIATED`,`COMPLETED`, and `FAILED`. The `reportLink` and `expires` fields are only shown when the stage is `COMPLETED`.
`SEX_OFFENDER_CHECK_STATUS_UPDATE`	Sex Offender Check has been completed for a particular user.

Webhook Payload Structures:

Sample webhook payload structures

User profile update:

{
  "id": "string",
  "event": "USER_PII_UPDATE",
  "eventDate": "2020-12-07T19:18:32.076Z",
  "order": {
    "userAccessCode": "string"
  }
}

Medallion™ and Review ID/Passport:

{
    "id": "string",
    "event": "SELF_VERIFICATION_TRY_STATUS" / "UPLOAD_ID_ENHANCED_REVIEW_STATUS" / "UPLOAD_PASSPORT_ENHANCED_REVIEW_STATUS",
    "eventDate": "2020-12-07T19:18:32.076Z",
    "order": {
        "userAccessCode": "string",
        "status": "string",
        "verificationMethod": "string"
    }
}

All Asynchronous Criminal Requests:

{
  "id": "string",
  "event": "CRIMINAL_REQUEST_STATUS_UPDATE",
  "eventDate": "2020-12-07T19:18:32.076Z",
  "order": {
    "userAccessCode": "string",
    "orderDetails": {
      "unique_identifier": "string",
      "search_type": "string",
      "search_status": "string",
      "search_sub_status": "string"
    }
  }
}

The search_type field is an ENUM and has the following possible values:

Value	Description
`CRIMINAL`	County Criminal Record
`CRIMINAL_FEDERAL`	Federal Criminal Record
`CIVIL_FEDERAL`	Federal Civil Record
`CIVIL_COUNTY`	County Civil Record

The status & sub_status fields are of ENUM type and have the these possible values.

All Criminal Requests Completed for a User:

{
  "id": "string",
  "event": "ALL_CRIMINAL_REQUESTS_COMPLETE",
  "eventDate": "2020-12-07T19:18:32.076Z",
  "order": {
    "userAccessCode": "string"
  }
}

User PDF Report Generation:

{
  "id": "string",
  "event": "USER_PDF_REPORT_GENERATION",
  "eventDate": "2020-12-07T19:18:32.076Z",
  "order": {
    "userAccessCode": "string",
    "status": "string",
    "reportUUID": "string",
    "reportLink": "string",
    "expires": "2020-12-07T19:18:32.076Z"
  }
}

True Continuous Monitoring™ Record Found:

{
  "id": "string",
  "event": "MONITORING_RECORD_FOUND",
  "eventDate": "2020-12-07T19:18:32.076Z",
  "order": {
    "userAccessCode": "string"
  }
}

Sex Offender Check Status Update:

{
  "id": "string",
  "event": "SEX_OFFENDER_CHECK_STATUS_UPDATE",
  "eventDate": "2024-05-07T19:18:32.076Z",
  "order": {
    "userAccessCode": "string",
    "orderDetails": {
      "unique_identifier": "string",
      "search_type": "string",
      "search_status": "string",
      "search_sub_status": "string"
    }
  }
}