post https://api.instantpay.in/identity/imageModeration
Image moderation, also known as content moderation or image filtering, refers to the process of monitoring, reviewing, and managing user-generated images on online platforms to ensure they comply with community guidelines, terms of service, and legal regulations. The goal of image moderation is to maintain a safe, appropriate, and respectful environment for users by identifying and removing images that contain inappropriate, offensive, or prohibited content, such as graphic violence, nudity, hate speech, explicit or adult content, illegal activities, or copyrighted material.
Header Parameters
| Name | Type | Description | Mandatory (M) , Optional (O) | Provided by INSTANTPAY (Y/N) |
|---|---|---|---|---|
| X-Ipay-Auth-Code | String | Auth Code -1 (Fixed) | M | Y |
| X-Ipay-Client-Id | String | Unique Client ID | M | Y |
| X-Ipay-Client-Secret | String | Unique secret key | M | Y |
| X-Ipay-Endpoint-Ip | String | End Customer IP Address | M | N |
Request Parameters
| Name | Type | Mandatory (M) , Optional (O) | Description |
|---|---|---|---|
| image | multipart/form-data | M | Upload single image. It must be .jpeg or .png and no larger than 5mb. |
| latitude | String | M | Current location latitude |
| longitude | String | M | Current location longitude |
| externalRef | String | M | Your Unique Transaction Id |
Sample Request
curl --location 'https://api.instantpay.in/identity/imageModeration' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--form 'image=@"/Users/name/Downloads/images.jpeg"' \
--form 'latitude="0"' \
--form 'longitude="0"' \
--form 'externalRef="1709631778"'
POST /identity/imageModeration HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
Content-Length: 470
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="image"; filename="images.jpeg"
Content-Type: image/jpeg
(data)
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="latitude"
0
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="longitude"
0
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="externalRef"
1709631667
------WebKitFormBoundary7MA4YWxkTrZu0gW--
Response Parameters
| Name | Type | Description |
|---|---|---|
| statuscode | String | InstantPay Status Code |
| actcode | String | Action Code |
| status | String | Status message |
| data | Array | Response Data (If Present) |
| timestamp | String | Current time (YYYY-MM-DD HH:II:SS) |
| ipay_uuid | String | Request reference number |
| orderid | String | Transaction Id ( If transaction otherwise it is null ) |
| environment | String | Live/Sandbox |
Note :
- externalRef must be unique and in alpha numeric characters.
- Click here for guidelines for entering data in latitude/ longitude parameter.
Sample Response
{
"statuscode": "TXN",
"actcode": null,
"status": "Sucesses",
"data": {
"imageModeration": {
"ModerationLabels": [
{
"Confidence": 95.53679656982422,
"Name": "Non-Explicit Image",
"ParentName": "",
"TaxonomyLevel": 1
},
{
"Confidence": 95.53679656982422,
"Name": "Kissing on the Lips",
"ParentName": "Non-Explicit",
"TaxonomyLevel": 2
}
],
"ModerationModelVersion": "7.0",
"HumanLoopActivationOutput": null,
"ContentTypes": [],
"ProjectVersion": []
},
"pool": {
"referenceId": "1240305121446YDVSA",
"openingBalance": "25.10",
"paymentAmount": "0.00",
"mode": "DR",
"closingBalance": "25.10"
}
},
"timestamp": "2024-03-05 12:14:46",
"ipay_uuid": "h0059b7d37c1-28da-475b-bdba-913525c7c166-uu0hKPxwm4M1",
"orderid": "1240305121446YDVSA",
"environment": "LIVE",
"internalCode": null
}