Add a New Webhook Subscription

post https://api-v3.authenticating.com/company/webhook

This endpoint will be used to add the webhook subscription.

The client has to code this webhookURL on their end to receive any asynchronous data sent by authenticating.com.

If you don't have your companyAccessCode, please contact support.

The Webhook Payload will consist of the same basic structure for every method/functionality. The order parameter will be different for different events.

Webhook Events

Event	Description
USER_PII_UPDATE	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 pleaced.
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 though Test Results Object.
UPLOAD_PASSPORT_ENHANCED_REVIEW_STATUS	Upload Passport Enhanced review completed. Results can be fetched though Test Results Object.
USER_PDF_REPORT_GENERATION	Each stage of user pdf report generation. There are 3 stages: "INITIATED", "COMPLETED" and "FAILED". The "reportLink" and "expires" fields are only present at "COMPLETED" stage.

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"
    }
}