Image Moderation

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

NameTypeDescriptionMandatory (M) , Optional (O)Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-CodeStringAuth Code -1 (Fixed)MY
X-Ipay-Client-IdStringUnique Client IDMY
X-Ipay-Client-SecretStringUnique secret keyMY
X-Ipay-Endpoint-IpStringEnd Customer IP AddressMN

Request Parameters

NameTypeMandatory (M) , Optional (O)Description
imagemultipart/form-dataMUpload single image. It must be .jpeg or .png and no larger than 5mb.
latitudeStringMCurrent location latitude
longitudeStringMCurrent location longitude
externalRefStringMYour Unique Transaction Id

Sample Request

curl --location '' \
--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
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

Content-Disposition: form-data; name="image"; filename="images.jpeg"
Content-Type: image/jpeg

Content-Disposition: form-data; name="latitude"

Content-Disposition: form-data; name="longitude"

Content-Disposition: form-data; name="externalRef"


Response Parameters

statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus message
dataArrayResponse Data (If Present)
timestampStringCurrent time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )


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
Click Try It! to start a request and see the response here!