{"info":{"_postman_id":"0e444659-967f-4982-8b26-36d7125aaa11","name":"Sama | API Docs","description":"

Sama is a totally new way to resolve disputes

between businesses and customers, employers and employees,
landlords and tenants, professionals and clients, or anyone else
– fully online, in a fast and cost effective manner.

Sama, using sophisticated technology and a network of skilled
professionals makes sure that when the week ends, so does
your dispute.

$\"\"$

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"16250413","collectionId":"0e444659-967f-4982-8b26-36d7125aaa11","publishedId":"UVXdQKCP","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-01-19T11:49:26.000Z"},"item":[{"name":"Generate API Key","item":[],"id":"a98a1b81-7a11-477c-ba93-be44cb0846f2","description":"

API KEY is a compulsory entity to access the APIs of Sama.

How to create API Key :

Step 1 : Login into Sama v2 (https://odr.sama.live) portal using the organization manager with permission index 1

Step 2 : Click on the avatar icon on top right corner of the screen

Step 3 : Click on Edit Profile , to go to Profile.

Step 4 : Go to Account Settings

Step 5 : Copy the API Key on top of the Account Settings section.

\n","_postman_id":"a98a1b81-7a11-477c-ba93-be44cb0846f2"},{"name":"Base URLs","item":[],"id":"071073c3-2c00-4bd7-8755-b471e0e413c6","description":"

For the production server the base URL for any api call is https://api.sama.live |

For the sandbox server the base URL is https://dev.v2.sama.live |

But this documentation is configured to run on the Sandbox environment which is using https://dev.v2.sama.live for executing api call.

When you switch to your production environment make sure to use the production base url.

\n","_postman_id":"071073c3-2c00-4bd7-8755-b471e0e413c6"},{"name":"Request Body & Encryption","item":[],"id":"8dffc5b8-6a6a-4ba6-b432-e2067af59428","description":"

The Request Body of any Post or PUT request has be in the below format

{

\"encData\":\"encrypted request body mentioned in the api docs\"

}

Note - Please encrypt the data after converting the data to a JSON string
Use AES 256 to encrypt and use the access token as the Key to encryption

\n","_postman_id":"8dffc5b8-6a6a-4ba6-b432-e2067af59428"},{"name":"Response Body & Decryption","item":[],"id":"0adc125e-679a-48e0-9ec3-91eaf429a58f","description":"

The format of the response should always follow the below JSOn format

{

\"error\":\"false\", // or true

\"message\":\"message if any from the server\",

\"data\" : { } // response data

}

error - true means there is a issue in the API Call
error - false means everything went well
message - if any message from the server specifying the error
data - the encrypted response from the server

The Data can be decrypted using AES 256 Algo and using access Token as key.

\n","_postman_id":"0adc125e-679a-48e0-9ec3-91eaf429a58f"},{"name":"GET Access Token","id":"d1750383-2f49-4411-a454-1ea250547aea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://dev.v2.sama.live/getAccessToken","description":"

Use Case

Access token is required to access any Sama api along with the API KEY

\n","urlObject":{"protocol":"https","path":["getAccessToken"],"host":["dev","v2","sama","live"],"query":[],"variable":[]}},"response":[{"id":"7a2d72b5-4d92-460f-a58f-7e36081eb1b3","name":"Response","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://dev.v2.sama.live/getAccessToken"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 19 Jan 2022 10:40:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"183"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"b7-rIke5oHRAE9UUiBjG72z7XCtSRE\""}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"message\": true,\n \"data\": {\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoxNjQyNTg4ODQ5MzQ2LCJpYXQiOjE2NDI1ODg4NDl9.xPm98G-XbfayAoj_n5dcsHBicq225KVaq9t84KcZC7Q\"\n }\n}"}],"_postman_id":"d1750383-2f49-4411-a454-1ea250547aea"},{"name":"Create Single Complaint","id":"284213b5-e11f-440c-8a44-972ac1b305e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"sama Your Access Token","type":"default"},{"key":"Token","value":"Your API KEY","type":"default"}],"body":{"mode":"raw","raw":"{\n \"encData\":\"Encrypted Request JSON\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dev.v2.sama.live/SamaV2Api/complaint/createOne","description":"

Request JSON

{

\"disputetypeResolutionProcess\":\"arbitration / conciliation\", // Choice of dispute resolution process while filing cases - Mandatory Field

\"categoryOfDispute\":\"Personal Loan / Credit Card / Insta OD\", // Product category of case referred - Mandatory Field

\"disputeZone\":\"Any State in India\", // State from where case referred - Mandatory Field

\"loanAmount\":\"100000\", // Amount sanctioned while availing credit facility - Example - Credit Card Limit - Mandatory Field

\"claimAmount\":\"150000\", // Total outstanding due while referring case - Mandatory Field

\"complainBrief\":\"Few Words about the complaint\", - Optional Field

\"loanAccountNumber\":\"Unique Loan Account Number\", // Unique Identification Number , Example - Customer ID / Loan Account Number - Mandatory Field

\"loanIssuingDate\":\"21/08/2020\", // Date of Credit amount sanctioned in date format - Mandatory Field

\"petitionerName\" : \"John Doe\", // Name of enterprise representative - Mandatory Field

\"petitionerPhone\": \"10 Digit Phone Number\", // Contact Number of enterprise representative Mandatory Field

\"petitionerEmail\":\"Valid Email Address\", // Official Email Address of enterprise representative - Optional Field

\"petitionerAddress\" : \"Valid Postal Address\", // Branch Address of enterprise representative Mandatory Field

\"respondentName\":\"Full Name of the Respondent\", // Full Name of the enterprise customer against whom proceedings are filed for - Mandatory Field

\"respondentPhone\":\"10 Digit Phone Number\", // Contact Number of the enterprise customer against whom proceedings are filed for - Mandatory Field

\"respondentEmail\":\"Valid Email Address\", // Email Address of the enterprise customer against whom proceedings are filed for - Mandatory Field

\"respondentAddress\": \"Full Postal Address of the Respondent\", // Postal Address of the enterprise customer against whom proceedings are filed for - Mandatory Field

\"natureOfRelationship\":\"Customer\", // Example - Customer / Borrower - Optional Field

\"monthlyInstallmentAmount\":\"10000\", // Example - EMI Amount in INR - Optional Field

\"rateOfInterest\":\"2%\", // Annual rate of interest agreed at the time of availing credit - Optional Field

\"noOfDefaultedInstalment\":\"15\", // No of months since account delinquent - Optional Field

\"dueDate\":\"02/02/2021\" // Date on which total outstanding due is collated for case filing - Mandatory Field

}

\n","urlObject":{"protocol":"https","path":["SamaV2Api","complaint","createOne"],"host":["dev","v2","sama","live"],"query":[],"variable":[]}},"response":[{"id":"188d5c61-ed2c-4b2d-a69d-89475f327b2a","name":"Create Single Complaint","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"sama Your Access Token","type":"default"},{"key":"Token","value":"Your API KEY","type":"default"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://dev.v2.sama.live/SamaV2Api/complaint/createOne"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"49"},{"key":"ETag","value":"W/\"31-tdgRpKWAQycdtFb/oJZYw0wRTjU\""},{"key":"Date","value":"Wed, 19 Jan 2022 13:11:36 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"encData\":\"Encrypted Request JSON\"\n}"},{"id":"1ed8752c-3666-450b-bc37-d11414249be4","name":"Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"sama Your Access Token","type":"default"},{"key":"Token","value":"Your API KEY","type":"default"}],"body":{"mode":"raw","raw":"{\n \"disputetypeResolutionProcess\":\"arbitration\", \n \"categoryOfDispute\":\"Loan\",\n \"disputeZone\":\"Maharastra\", \n \"loanAmount\":\"100.50\", \n \"claimAmount\":\"110.75\",\n \"complainBrief\":\"Few Words about the complaint\", \n \"loanAccountNumber\":\"Unique Loan Account Number - Required\", \n \"loanIssuingDate\":\"DD/MM/YYYY\", \n \"petitionerName\" : \"Pushpendu Ghosh\", \n \"petitionerPhone\": \"7047434141\",\n \"petitionerEmail\":\"pushpendu@sama.live\",\n \"petitionerAddress\" : \"Address of the DSM\", \n \"respondentName\":\"Full Name of the Respondent\",\n \"respondentPhone\":\"7047434141\",\n \"respondentEmail\":\"Valid Email ID of the respondent\", \n \"respondentAddress\": \"Full Postal Address of the Respondent\",\n \"natureOfRelationship\":\"Customer\", \n \"monthlyInstallmentAmount\":\"20\",\n \"rateOfInterest\":\"2%\",\n \"noOfDefaultedInstalment\":\"15\",\n \"dueData\":\"DD/MM/YYYY\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dev.v2.sama.live/SamaV2Api/complaint/createOne"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"49"},{"key":"ETag","value":"W/\"31-tdgRpKWAQycdtFb/oJZYw0wRTjU\""},{"key":"Date","value":"Wed, 19 Jan 2022 13:11:36 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": true,\n \"message\": \"Unauthorized\",\n \"data\": {}\n}"}],"_postman_id":"284213b5-e11f-440c-8a44-972ac1b305e7"}]}