Dispute Conciliation Report API
This endpoint facilitates the conciliation report update of a dispute from respective ODR Institution to SMART ODR via API.
This API endpoint is designed to handle conciliation report related to dispute resolution cases.
Endpoint
POST https://<apiserver>.smartodr.com/update_conciliation_report
Versioning
The Dispute Update API is a versioned API. Updates are released quarterly.
Initial Release:
- Version
1.0.0
- Version
Adding a New Feature:
- Version
1.1.0
- Version
Fixing a Bug:
- Version
1.1.1
- Version
Making a Backward-Incompatible Change:
- Version
2.0.0
- Version
Authentication
All incoming requests from ODR Institutions will include a valid access token in the Authorization header. SMART ODR should validate this token to ensure the request is from the respective ODR Institutions.
Authorization: `Signature keyId="${unique_key_id}|${token}|RS256" algorithm="RS256" type="update" `
unique_key_id : Unique token generated by ODR Institutions from SMART ODR Portal
token : Signed JWT Token [RS256]
Token Payload
The payload of the JWT includes the following information:
- email: The primary email address of the user associated with the ODR Institution.
- phone: The primary phone number of the user associated with the ODR Institution.
Request Body Parameters
Field | Data Type | Description |
---|---|---|
disputeId | String | Unique identifier for the dispute. |
disputetype | String | Type of dispute. |
role | String | Role of the user changing the status (e.g., User, Administrator). |
userName | String | User's name initiating the update. |
ConciliationReport | Object | Conciliation Report of the dispute. |
DisputeArbitrators | Array | Conciliators assigned to dispute. |
User Reference Table
Role | Description |
---|---|
MEDIATOR | Mediator |
ARBITRATOR | Arbitrator |
SYSADMIN | System Administrator |
CASEMANAGER | Case Manager |
PETITIONER | Petitioner |
RESPONDENT | Respondent |
Example:
{
"dispute": {
"disputeId": "DMDP-DP-2024-07-649989",
"disputetype": "conciliation",
"role": "CASEMANAGER",
"userName": "John Doe",
"ConciliationReport": {
"isFeePaidByMP": false, // Fee paid by Market Participant
"mpFeesDate": "2025-01-10", // Date of Fee paid by Market Participant
"conOutcome": "Resolved in favor of complainant", // Conciliation Outcome "In favour of Investor" || "Matter Withdrawn After referred to Conciliation" || "Matter Dismissed" || "Mutual Settlement"
"admissibleClaimAmount": 1700.5, // Admissible Claim Value
"complianceStatus": "Complied by Market Participant", // Complied by "Complied by Market Participant" || "Complied by Investor" || "Not Complied by Market Participant" || "Not Complied by Investor"
"invoiceDate": "2025-01-16", // Date of Invoice
"receiptOfConOrder": "2025-01-25",
"conOrderDate": "2025-01-30", // Conciliation Order Date
"conOrderCompliedDate": "2025-02-05", // Date of Conciliation Order Complied
"orderCompliedByMP": true, // Order complied by Market Participant
"settlementAgreementExecuted": true, // Settlement Agreement Executed
"settlementAgreementDate": "2025-02-10" // Date of Settlement Agreement Executed
},
"DisputeArbitrators": [{
"arbitratorName": "Smith Doe",
"arbitratorPAN": "ABCDE1234K",
"arbitratorAppointedDate": "2025-01-15",
"arbitratorAcceptanceDate": "2025-01-20",
"arbitratorRejectionDate": null,
"isReappointed": false,
"isApproved": true,
"reappointedBehalfOf": null, // If this is reappointed on behalf of earlier arbitartor please mention the name on whose behalf it's appointed
"arbIndex": 1 // This is used to specify which arbitrator is appointed
}]
}
}
The dispute parameter contains the JSON string with information about the dispute, as described in the previous section.
DisputeArbitrators array holds objects that represent the details of an conciliator involved in a dispute. Each object contains the following information:
arbitratorName
: The name of the conciliator (e.g., "Smith Doe").arbitratorPAN
: The pan number of the conciliator.arbitratorAppointedDate
: The date on which the conciliator was initially appointed.arbitratorAcceptanceDate
: The date on which the conciliator accepted the appointment.arbitratorRejectionDate
: The date on which the conciliator rejected the appointment (if applicable; otherwise, it is null).isReappointed
: A boolean flag indicating whether this conciliator is a reappointment, meaning they are being appointed on behalf of a previous arbitrator.isApproved
: A boolean flag showing whether the arbitrator's appointment has been approved.reappointedBehalfOf
: If the conciliator is reappointed on behalf of another, this field holds the name of the earlier arbitrator; otherwise, it is null.arbIndex
: An index value used to identify the arbitrator's sequence or position in the dispute process.
Success Response
If the conciliation report update is successful, the API returns a 200 OK status along with a JSON object containing relevant information.
Fields in the Response
Field | Data Type | Description |
---|---|---|
success | Boolean | Indicates whether the update was successful (true ) or (false ). |
message | String | Conciliation award saved successfully. ComplainId: {reference_id} |
Example:
{
"success": true,
"message": "Conciliation award saved successfully. ComplainId: DMSB-SB-2023-10-328523",
}
Error Response
Fields in the Response Field Data Type Description success Boolean Indicates whether the update was successful (true) or (false). message String A detailed error message describing the issue.
Example:
{
"success": false,
"message": "Error message describing the issue"
}