Case Status

​

API Response Explanation

​

1. Dynamic Data Inclusion

• The API response is tailored based on the checks initiated.
  • For example, if you have initiated a case for Aadhaar verification, you will receive the Aadhaar section in the response.
  • If no case is initiated for Criminal Check, the response will exclude the Criminal Check section.

​

2. Structure of the Response

• status: Indicates the overall success or failure of the API request.
• code: The HTTP status code for the request.
• message: A descriptive message about the request.
• data: Contains the details for all initiated checks.

​

3. Example API Response

{
  "status": "success",
  "code": 200,
  "message": "Request processed successfully.",
  "data": {
    "case_id": "12345",
    "aadhaar": {
      "status": "verified",
      "aadhaar_number": "********3434"
    },
    "pan": {
      "status": "verified",
      "pan_number": "CX892I8Q0W"
    },
    "criminal_check": {
      "status": "In Progress",
      "description": "Candidate's consent is pending for the background verification process to start.",
      "data": {
        "email": "sumit@example.com",
        "name": "Sumit"
      }
    }
  }
}

​

4. Best Practices for Using the API

• Initiate Required Cases:
  • Ensure you raise a case for the checks you need, as only those will be included in the response.
• Handle Missing Sections:
  • Design your application to handle scenarios where a section might be absent if no case was raised for that check.
• Monitor Pending Cases:
  • Track checks with the status In Progress and take necessary follow-up actions as needed.

​

Error Handling in the API Response

​

1. Error Format

• Fields:
  • error: A descriptive message about the issue.
  • status_code: The HTTP status code representing the type of error.
• Errors are included only in the section where they occur, leaving other sections unaffected.

​

2. Example of an Error in a Section

"aadhaar": {
  "error": "No Aadhaar Found",
  "status_code": 404
}

​

3. Mixed Response Example

{
  "status": "success",
  "code": 200,
  "message": "string",
  "data": {
    "case_id": "string",
    "aadhaar": {
      "error": "No Aadhaar Found",
      "status_code": 404
    },
    "pan": {
      "status": "verified",
      "pan_number": "CX892I8Q0W"
    },
    "criminal_check": {
      "status": "In Progress",
      "description": "Candidate's consent is pending for the background verification process to start.",
      "data": {
        "email": "sumit@example.com",
        "name": "Sumit"
      }
    }
  }
}

​

4. Key Points About Error Handling

1. Section-Specific Errors:
   • Errors are confined to the relevant section. For example, an Aadhaar error will not impact other sections such as PAN or Criminal Check.
2. Consistent Response Structure:
   • Sections without errors continue to show valid data or processing statuses.
3. Ease of Debugging:
   • Developers can easily identify issues by checking the error field in each section.
   • The status_code provides additional context for categorizing and resolving errors.

​

5. Best Practices for Handling Errors

• Programmatic Checks:
  • Always check for the error field in each section before processing its data.
  • Use the status_code to determine the nature of the error (e.g., 404 for missing data, 500 for server-side errors).
• Graceful Degradation:
  • Implement logic to handle missing or failed sections gracefully without impacting the overall process.
• Logging and Notification:
  • Log errors for troubleshooting and debugging.
  • Notify users or administrators in case of critical issues, such as missing data for mandatory checks.