Webhook Events

List if 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`.

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 below possible values:

status	sub_status	Description
PENDING	IN_PROGRESS	Search is in progress
PENDING	NEED_INFO	Search requires additional info before work can proceed
PENDING	QA_REVIEW	Search is being reviewed by Quality Assurance
COMPLETE	COMPLETE	Search is complete
COMPLETE	CLEAR	Search is complete with no records found
COMPLETE	RECORD	Search is complete with records found
COMPLETE	NO_RESULTS_FOUND	Search is complete with no results found
COMPLETE	RESULTS_FOUND	Search is complete with results found
COMPLETE	VERIFIED_SUCCESS	Search has been verified successfully
COMPLETE	VERIFIED_REQUIRES_REVIEW	Search has been verified but requires review
COMPLETE	UNVERIFIED_MISSING_INFO	Search has not been verified due to missing info
COMPLETE	UNVERIFIED_NO_RESPONSE	Search has not been verified due to lack of response from source

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": "ALL_CRIMINAL_REQUESTS_COMPLETE",
    "eventDate": "2020-12-07T19:18:32.076Z",
    "order": {
        "userAccessCode": "string"
    }
}