PhotoDNA Cloud Service

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

Match Edge Hash

Edge Hash is currently in preview. If you would like to learn more about edge hashing and how to be part of the preview please email m2support@microsoft.com.

Try it

Request URL

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

MatchEdgeHash accepts up to 5 hash files in one request. The .bin files are supplied as multipart/form-data. Each file would be submitted as a Key/Value pair with the key being a name and the value being the file.

[Binary data Key/Value pair with the key being a name and the value being the file.]

Response 200

{
    "TrackingId": "WUS_abc1235",
    "MatchResults": [
        {
            "Status": {
                "Code": 3000,
                "Description": "OK",
                "Exception": null
            },
            "ContentId": "image1",
            "IsMatch": false,
            "MatchDetails": {
                "AdvancedInfo": [],
                "MatchFlags": []
            }
        },
        {
            "Status": {
                "Code": 3000,
                "Description": "OK",
                "Exception": null
            },
            "ContentId": "image2",
            "IsMatch": false,
            "MatchDetails": {
                "AdvancedInfo": [],
                "MatchFlags": []
            }
        },
        {
            "Status": {
                "Code": 3000,
                "Description": "OK",
                "Exception": null
            },
            "ContentId": "image3",
            "IsMatch": false,
            "MatchDetails": {
                "AdvancedInfo": [],
                "MatchFlags": []
            }
        },
        {
            "Status": {
                "Code": 3000,
                "Description": "OK",
                "Exception": null
            },
            "ContentId": "image4",
            "IsMatch": true,
            "MatchDetails": {
                "AdvancedInfo": [],
                "MatchFlags": [
                    {
                        "AdvancedInfo": [
                            {
                                "Key": "MatchId",
                                "Value": "4567"
                            }
                        ],
                        "Source": "Test",
                        "Violations": [
                            "A1"
                        ]
                    }
                ]
            }
        },
        {
            "Status": {
                "Code": 3000,
                "Description": "OK",
                "Exception": null
            },
            "ContentId": "image5",
            "IsMatch": true,
            "MatchDetails": {
                "AdvancedInfo": [],
                "MatchFlags": [
                    {
                        "AdvancedInfo": [
                            {
                                "Key": "MatchId",
                                "Value": "1234"
                            }
                        ],
                        "Source": "Test",
                        "Violations": [
                            "A1"
                        ]
                    }
                ]
            }
        }
    ],
    "CMRequestId": null
}

If you send more than 5 files in one request you will receive the following response:
{
    "Status": {
        "Code": 3209,
        "Description": "Request Size Exceeded",
        "Exception": null
    },
    "ContentId": null,
    "IsMatch": false,
    "MatchDetails": null,
    "TrackingId": "WUS_zxc12345",
    "CMRequestId": null
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.microsoftmoderator.com/photodna/v1.0/MatchEdgeHash"
-H "Content-Type: multipart/form-data; 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}");

            var uri = "https://api.microsoftmoderator.com/photodna/v1.0/MatchEdgeHash?" + 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/photodna/v1.0/MatchEdgeHash");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "multipart/form-data");
            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
        };
      
        $.ajax({
            url: "https://api.microsoftmoderator.com/photodna/v1.0/MatchEdgeHash?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","multipart/form-data");
                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/photodna/v1.0/MatchEdgeHash";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"multipart/form-data" 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/photodna/v1.0/MatchEdgeHash');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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': 'multipart/form-data',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.microsoftmoderator.com')
    conn.request("POST", "/photodna/v1.0/MatchEdgeHash?%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': 'multipart/form-data',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.microsoftmoderator.com')
    conn.request("POST", "/photodna/v1.0/MatchEdgeHash?%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/photodna/v1.0/MatchEdgeHash')

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'multipart/form-data'
# 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