post https://api-v3.authenticating.com/user/verify/criminal/soc/report
Fetching Sex Offender Check Results
This API is used to retrieve the results of a previously initiated Sex Offender check. To fetch the results, you will need the userAccessCode
and the uniqueIdentifier
provided in the response for the Sex Offender Records API.
Key Features
- Results Retrieval: Access the final results of a completed Sex Offender check.
- Unique Identifier Requirement: The
uniqueIdentifier
is mandatory and must match the one provided during the check initiation.
API Workflow
- Provide Identifiers: Use the
userAccessCode
anduniqueIdentifier
to make the request. - Verify Completion: Ensure the background check is completed before fetching results.
- Fetch Results: The API returns detailed results including status, sub-status, and additional data.
Status and Sub-Status Values
For a detailed explanation of possible status
and sub_status
values, refer to the Criminal Status Table.
Best Practices
- Monitor Completion: Only attempt to fetch results after receiving a
SEX_OFFENDER_CHECK_STATUS_UPDATE
event via webhook. - Store Identifiers: Retain the
uniqueIdentifier
for subsequent requests and debugging purposes. - Automate Report Handling: Use the
reportUrl
to seamlessly integrate results into your workflow.
For additional details or troubleshooting, refer to the API Documentation.