This endpoint retrieves all check results associated with a specific job.
Endpoint
GET /getCheckResults
Parameters
The unique identifier of the job.
Response
Returns an array of check result objects.
An array of check result objects for the job.
The unique identifier of the check result
The ID of the check that was run
The status of the check (e.g., “completed”, “in_progress”, “failed”)
The detailed result data from the check
An array of status message objects tracking the check’s progress
ISO 8601 timestamp of when the check result was created
ISO 8601 timestamp of when the check result was last updated
Error Responses
A description of the error that occurred.
Status Code | Description |
---|
404 | Job not found |
401 | Unauthorized access |
500 | Internal server error |
Example Request
curl -X GET 'https://api.parcha.ai/getCheckResults?job_id=123456' \
-H 'Authorization: Bearer YOUR_API_KEY'
Example Response
[
{
"id": "check_result_1",
"check_id": "business_profile_check",
"status": "completed",
"result": {
"business_name": "Acme Corp",
"industry": "Technology",
"risk_score": 15
},
"status_messages": [
{
"message": "Check started",
"timestamp": "2023-06-15T10:30:00Z"
},
{
"message": "Data retrieved",
"timestamp": "2023-06-15T10:31:00Z"
},
{
"message": "Check completed",
"timestamp": "2023-06-15T10:32:00Z"
}
],
"created_at": "2023-06-15T10:30:00Z",
"updated_at": "2023-06-15T10:32:00Z"
},
{
"id": "check_result_2",
"check_id": "adverse_media_screening",
"status": "completed",
"result": {
"findings": [],
"risk_level": "low"
},
"status_messages": [
{
"message": "Check started",
"timestamp": "2023-06-15T10:30:00Z"
},
{
"message": "Media search completed",
"timestamp": "2023-06-15T10:33:00Z"
}
],
"created_at": "2023-06-15T10:30:00Z",
"updated_at": "2023-06-15T10:33:00Z"
}
]
Use Cases
This endpoint is useful for:
- Retrieving all check results after a job completes
- Monitoring the status of multiple checks in a single job
- Building dashboards that display comprehensive job results
- Accessing detailed findings from all checks performed
JWT token obtained from the authentication endpoint
The ID of the job to retrieve check results for
Check results retrieved successfully