GetJobsByCaseId
This endpoint retrieves all jobs associated with a specific case ID for a given agent.
Endpoint
GET /getJobsByCaseId
Parameters
The unique identifier of the case.
The key of the agent associated with the jobs.
Whether to include detailed check results in the response.
Whether to include status messages in the response.
Response
The response follows the JobsResponse model, which typically includes:
An array of job objects associated with the case ID.
Each job object may include:
The unique identifier of the job.
The current status of the job (e.g., “pending”, “completed”, “failed”).
The timestamp when the job was created.
The timestamp when the job was last updated.
An array of check results, if include_check_results is true.
An array of status messages, if include_status_messages is true.
Error Responses
A description of the error that occurred.
| Status Code | Description |
|---|---|
| 404 | Case or jobs not found |
| 403 | Unauthorized access to agent |
| 500 | Internal server error |
Example Request
curl -X GET 'https://api.parcha.ai/getJobsByCaseId?case_id=123456&agent_key=your_agent_key&include_check_results=true&include_status_messages=true' \
-H 'Authorization: Bearer YOUR_API_KEY'
Example Response
{
"jobs": [
{
"id": "job_789012",
"status": "completed",
"created_at": "2023-06-15T10:00:00Z",
"updated_at": "2023-06-15T10:05:00Z",
"check_results": [
{
"id": "check_345678",
"type": "business_verification",
"status": "completed",
"result": {
"verified": true,
"risk_score": 25
}
}
],
"status_messages": [
{
"timestamp": "2023-06-15T10:01:00Z",
"message": "Business verification check started"
},
{
"timestamp": "2023-06-15T10:05:00Z",
"message": "Business verification check completed"
}
]
}
]
}
Notes
- This endpoint requires authentication. Make sure to include your API key in the request headers.
- The user must have access to the specified agent to retrieve the jobs.
- The
include_check_resultsandinclude_status_messagesparameters allow you to control the level of detail in the response. Setting these totruemay increase the response size and processing time. - The structure of check results may vary depending on the type of checks performed in the jobs.