post https://api-v3.authenticating.com/user/verify/criminal/soc
Sex Offender Check
This API is used to initiate a Sex Offender check against an individual using their userAccessCode. The check runs in the background and typically takes about 2 hours to complete. Below is a detailed breakdown of the API functionality and flow:
Key Features
- Background Process: The check is performed asynchronously and can take up to 2 hours.
- Duplicate Request Handling: If a new check is initiated for the same individual before the previous one is complete, the API will return a response instructing you to wait and retry later.
- Webhook Updates: Results are sent asynchronously through Webhooks using the
SEX_OFFENDER_CHECK_STATUS_UPDATEeventType. - Final Results Retrieval: Use the Sex Offender Report API to obtain the final report once the check has been completed successfully.
API Workflow
- Initiate Check: Send a request with the
userAccessCodeto initiate the Sex Offender check. - Wait for Completion: Allow up to 2 hours for the background check to complete.
- Handle Duplicate Requests: Avoid initiating a new request for the same user before the first check completes. If attempted, the API will return a retry message.
- Webhook Notification: Receive status updates via the
SEX_OFFENDER_CHECK_STATUS_UPDATEwebhook event. - Retrieve Final Report: Once notified, use the Sex Offender Report API to access the detailed results.
Status and Sub-Status Values
For a detailed explanation of possible status and sub_status values, refer to the Criminal Status Table.
Best Practices
- Avoid Redundant Checks: Always ensure that an ongoing check is complete before initiating another request for the same individual.
- Monitor Webhooks: Implement robust webhook handling to capture
SEX_OFFENDER_CHECK_STATUS_UPDATEevents efficiently. - Automate Report Retrieval: Use the final status notification as a trigger to fetch the report using the Sex Offender Report API.