See the list of webhook events that get triggered!
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 | COUNTY_CRIMINAL , COUNTY_CIVIL , FEDERAL_CRIMINAL , and FEDERAL_CIVIL updates for a particular search request placed. |
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"
}
}
}
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"
}
}