Dispute Arbitration Report API

This endpoint facilitates the arbitration report update of a dispute from respective ODR Institution to SMART ODR via API.

This API endpoint is designed to handle arbitration report related to dispute resolution cases.

Endpoint

POST https://<apiserver>.smartodr.com/update_arbitration_report

Versioning

The Dispute Update API is a versioned API. Updates are released quarterly.

• Initial Release:

  • Version 1.0.0

• Adding a New Feature:

  • Version 1.1.0

• Fixing a Bug:

  • Version 1.1.1

• Making a Backward-Incompatible Change:

  • Version 2.0.0

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.

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.
ArbitrationReport	Object	Arbitration Report of the dispute.
DisputeArbitrators	Array	Arbitrators 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": "arbitration",
    "role": "CASEMANAGER",
    "userName": "John Doe",
    "ArbitrationReport": {
      "isFeePaidByMP": true, // Fee paid by Market Participant
      "mpFeesDate": "2025-01-15", // Date of Fee paid by Market Participant
      "isFeePaidByInvestor": false, // Fee paid by Investor
      "investorFeesDate": null, // Date of Fee paid by Investor
      "arbitratorType": "Sole", // "Sole" || "Panel"
      "counterClaimAmount": 1500.50, // Counter Claim Amount
      "arbitralAwardAmount": 2000, // Arbitral Award Amount
      "arbitralAwardDate": "2025-01-20", // Award Date
      "receiptOfArbitralAwardDate": "2025-01-22", // Award Received Date
      "arbitralAwardSentDate": "2025-01-23", // Award Sent Date
      "noOfHearings": 3, // Number of Hearings
      "awardInFavor": "Investor", // Award in Favor of "Market Participant" || "Investor"
      "isIntentionReceived": false, // S.34 Intention Received?
      "intentionReceivedDate": null, // Date of Intention Received
    },
    "DisputeArbitrators": [{ // It's an array because you can send multiple arbitrators when the panel type is Panel, if it's sole only single object needs to be passed
      "arbitratorName": "Smith Doe",
      "arbitratorPAN": "ABCDE1234H",
      "arbitratorAppointedDate": "2025-01-15",
      "arbitratorAcceptanceDate": "2025-01-20",
      "arbitratorRejectionDate": null,
      "isReappointed": false,
      "isApproved": true,
      "reappointedBehalfOf": null, // If this is reappointed on behalf of earlier arbitrator please mention the name on whose behalf it's appointed
      "arbIndex": 1 // This is used to specify which arbitrator is appointed
    }, {
      "arbitratorName": "Karen Graham",
      "arbitratorPAN": "ABCDE1234I",
      "arbitratorAppointedDate": "2025-01-15",
      "arbitratorAcceptanceDate": "2025-01-20",
      "arbitratorRejectionDate": null,
      "isReappointed": false,
      "isApproved": true,
      "reappointedBehalfOf": null, // If this is reappointed on behalf of earlier arbitrator please mention the name on whose behalf it's appointed
      "arbIndex": 2 // This is used to specify which arbitrator is appointed
    }, {
      "arbitratorName": "Aaron K. Johnson",
      "arbitratorPAN": "ABCDE1234J",
      "arbitratorAppointedDate": "2025-01-15",
      "arbitratorAcceptanceDate": null,
      "arbitratorRejectionDate": "2025-01-20",
      "isReappointed": false,
      "isApproved": false,
      "reappointedBehalfOf": null, // If this is reappointed on behalf of earlier arbitrator please mention the name on whose behalf it's appointed
      "arbIndex": 3 // This is used to specify which arbitrator is appointed
    }, {
      "arbitratorName": "Audrey Henderson",
      "arbitratorPAN": "ABCDE1234K",
      "arbitratorAppointedDate": "2025-01-21",
      "arbitratorAcceptanceDate": "2025-01-25",
      "arbitratorRejectionDate": null,
      "isReappointed": true,
      "isApproved": true,
      "reappointedBehalfOf": "ABCDE1234J", // If this is reappointed on behalf of earlier arbitrator please mention the PAN on whose behalf it's appointed
      "arbIndex": 3 // 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 arbitrator involved in a dispute. Each object contains the following information:

• arbitratorName: The name of the arbitrator (e.g., "Smith Doe").
• arbitratorPAN: The pan number of the arbitrator.
• arbitratorAppointedDate: The date on which the arbitrator was initially appointed.
• arbitratorAcceptanceDate: The date on which the arbitrator accepted the appointment.
• arbitratorRejectionDate: The date on which the arbitrator rejected the appointment (if applicable; otherwise, it is null).
• isReappointed: A boolean flag indicating whether this arbitrator 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 arbitrator 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 arbitration 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	Arbitration award saved successfully. ComplainId: {reference_id}

Example:

{
  "success": true,
  "message": "Arbitration 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"
}