Add a New Webhook Subscription

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

EventDescription
USER_PII_UPDATEUser's PII has been updated.
SELF_VERIFICATION_TRY_STATUSMedallion™ try status.
CRIMINAL_REQUEST_STATUS_UPDATECOUNTY CRIMINAL, COUNTY CIVIL, FEDERAL CRIMINAL and FEDERAL CIVIL updates for a particular search request pleaced.
ALL_CRIMINAL_REQUESTS_COMPLETEAll county criminal requests have been completed for a particular user
UPLOAD_ID_ENHANCED_REVIEW_STATUSUpload ID Enhanced review completed. Results can be fetched though Test Results Object.
UPLOAD_PASSPORT_ENHANCED_REVIEW_STATUSUpload Passport Enhanced review completed. Results can be fetched though Test Results Object.
USER_PDF_REPORT_GENERATIONEach 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"
    }
}

The Create a Webhook Subscription function sets up the webhook subscription URL.

The client must code this webhookURL on their end to receive any asynchronous data from Authenticate.

This is a one-time action. Once the URL is added, it doesn't need to be changed until the webhook URL changes.


🚧

companyAccessCode is required.

You can find the companyAccessCode in the Authenticate Portal. Alternatively - the webhook URL can also be added under the Settings.

The Webhook Payload will have the same basic structure for every method/functionality, but the order parameter will differ for different events.

Language
Authorization
Bearer
API KEY
Click Try It! to start a request and see the response here!