PhotoDNA Cloud Service v2

This API has operations to check image PhotoDNA hashes against databases of hashes of known child exploitation images.

Match

Details

This operation accepts one image at a time with a maximum rate limit of 5 requests per second. The image is checked for matches against known child exploitation hash datasets provided by organizations like:
  • National Center for Missing and Exploited Children (NCMEC)
  • Industry hash sharing – US (TC)
More hash sources will be added over time. To see the current list of hash sources please log into your account at https://myphotodna.microsoftmoderator.com

Testing

Integration with the API can be tested using this set of sample images, some of which will return matches against the 'Test' source.

PhotoDNA high volume tier

For customers sending more than 10 million transactions per month:
  1. Add your Content Moderator subscription keys to the 'Enable High Volume Tier' section of the PhotoDNA Portal.
    • When entering your key into the portal make sure you choose the same data center as your Content Moderator instance.
    • If you need keys, you can get them here.
  2. Add the header to the request called Enable-Evaluation with one of the following values:
    • always - will perform image evaluation on every request
    • afterinitialquota - will perform image evaluation only after free monthly quota has been exceeded

Try it

Request URL

Request parameters

(optional)
boolean

Enables additional detection capabilities to broaden the spectrum of matches. Note: Using this feature will increase system response time.

Request headers

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Profile.

Request body

The request body can be an image; the following MIME types are supported

  • Content-Type: image/gif
  • Content-Type: image/jpeg
  • Content-Type: image/png
  • Content-Type: image/bmp
  • Content-Type: image/tiff

Alternatively, a publicly accessible URL of an image (gif, jpeg, png, bmp, or tiff) could be provided as in the example below (Content-Type: application/json);
N.B., response time from the service may be adversely affected by external sources' download speeds.

{
  "DataRepresentation": "URL",
  "Value": "https://pdnasampleimages.blob.core.windows.net/matchedimages/img_130.jpg"
}

Response 200

Name Description
Status Status codes and corresponding descriptions:
  • 3000: OK
  • 3002: Invalid or missing request parameter(s)
  • 3004: Unknown scenario or unhandled error occurred while processing request
  • 3206: The given file could not be verified as an image
  • 3208: Image size in pixels is not within allowed range (minimum size is 160x160 pixels; maximum size is 4MB)
TrackingId UniqueID that identifies this individual request.
IsMatch Boolean value indicating whether the submitted image matched a known image
MatchDetails

Collection of MatchFlags.

MatchFlag: Specifies the source of known image which the submitted image matched.

Note: Submitted images may match images from multiple sources.

EvaluateResponse

Collection of image evaluation flags:

  • AdultClassificationScore: Numeric score representing the likelihood of adult content
  • IsImageAdultClassified: Boolean representing whether or not adult content was found
  • RacyClassificationScore: Numeric score representing the likelihood of racy content
  • IsImageRacyClassified: Boolean representing whether or not racy content was found
  • AdvancedInfo: reserved for future use
  • Result: Boolean representing whether or not adult and/or racy content was found

Note: this object is null unless the header 'Enable-Evaluation' is present and a valid Content Moderator key has been provided in PhototDNA portal.

{
  "Status": {
    "Code": 3000,
    "Description": "OK",
    "Exception": null
  },
  "TrackingId": "1_photodna_a0e3d02b-1a0a-4b38-827f-764acd288c25",
  "ContentId": "TestId",
  "IsMatch": true,
  "MatchDetails": {
    "AdvancedInfo": [],
    "MatchFlags": [
      {
        "AdvancedInfo": [
          {
            "Key": "MatchId",
            "Value": "104149"
          }
        ],
        "Source": "Test"
      }
    ]
  },
  "EvaluateResponse": {
    "AdultClassificationScore": 0.0522861182689667,
    "IsImageAdultClassified": false,
    "RacyClassificationScore": 0.05853521078825,
    "IsImageRacyClassified": false,
    "AdvancedInfo": [],
    "Result": false,
    "Status": {
      "Code": 3000,
      "Description": "OK",
      "Exception": null
    },
    "TrackingId": "247adf2e-e3e7-4055-a9b4-4b31f2502278"
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.microsoftmoderator.com/v2/PhotoDNA/Match?enhance=false"
-H "Content-Type: application/json; charset=utf-8"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii '{body}' 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["enhance"] = "false";
            var uri = "https://api.microsoftmoderator.com/v2/PhotoDNA/Match?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.microsoftmoderator.com/v2/PhotoDNA/Match");

            builder.setParameter("enhance", "false");

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "enhance": "false",
        };
      
        $.ajax({
            url: "https://api.microsoftmoderator.com/v2/PhotoDNA/Match?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.microsoftmoderator.com/v2/PhotoDNA/Match";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"enhance=false",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.microsoftmoderator.com/v2/PhotoDNA/Match');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'enhance' => 'false',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'enhance': 'false',
})

try:
    conn = httplib.HTTPSConnection('api.microsoftmoderator.com')
    conn.request("POST", "/v2/PhotoDNA/Match?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'enhance': 'false',
})

try:
    conn = http.client.HTTPSConnection('api.microsoftmoderator.com')
    conn.request("POST", "/v2/PhotoDNA/Match?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.microsoftmoderator.com/v2/PhotoDNA/Match')

query = URI.encode_www_form({
    # Request parameters
    'enhance' => 'false'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body