Windows SDK for the Microsoft Face API, part of Cognitive Services

Microsoft Face API: Windows Client Library & Sample

This repo contains the Windows client library & sample for the Microsoft Face API, an offering within Microsoft Cognitive Services, formerly known as Project Oxford.

The Client Library

The client library is a thin C# client wrapper for Microsoft Face API. The easiest way to use this client library is to get microsoft.projectoxford.face package from nuget.

Please go to Face API Package in nuget for more details.

The Sample

This sample is a Windows WPF application to demonstrate the use of Face API. It demonstrates face detection, face verification, face grouping, finding similar faces, and face identification.

Build the Sample

  1. Starting in the folder where you clone the repository (this folder)
  2. In a git command line tool, type git submodule init (or do this through a UI)
  3. Pull in the shared Windows code by calling git submodule update
  4. Start Microsoft Visual Studio 2015 and select File > Open > Project/Solution.
  5. Go to Sample-WPF Folder.
  6. Double-click the Visual Studio 2015 Solution (.sln) file FaceAPI-WPF-Samples.
  7. Press Ctrl+Shift+B, or select Build > Build Solution.

Run the Sample

After the build is complete, press F5 to run the sample.

First, you must obtain a Face API subscription key by following instructions on our website.

Locate the text edit box saying "Paste your subscription key here to start" on the top right corner. Paste your subscription key. You can choose to persist your subscription key in your machine by clicking "Save Key" button. When you want to delete the subscription key from the machine, click "Delete Key" to remove it from your machine.

Click on "Select Scenario" to use samples of different scenarios, and follow the instructions on screen.

Microsoft will receive the images you upload and may use them to improve Face API and related services. By submitting an image, you confirm you have consent from everyone in it.

There are sample images to be used with this sample application. You can find these images under Face > Windows > Data folder. Please note the use of these images is licensed under LICENSE-IMAGE.


We welcome contributions. Feel free to file issues and pull requests on the repo and we'll address them as we can. Learn more about how you can help on our Contribution Rules & Guidelines.

You can reach out to us anytime with questions and suggestions using our communities below:

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.


  • 8/2016 update for July 2016 Face API changes

    Client Library

    • VerifyAsync interface with faceId, personGroupId and personId as paramters.
    • Optional user-specified confidenceThreshold paramter in IdentifyAsync.
    • FindSimilarMatchMode enum declaration and adopted in FindSimilarAsync.
    • New ListPersonGroupsAsync interface with start and top as paramters and recommend to use ListPersonGroupsAsync instead of GetPersonGroupsAsync.


    • Verfication demo for face and person authentication.
    • FindSimilar demo of MatchFace mode.


All Microsoft Cognitive Services SDKs and samples are licensed with the MIT License. For more details, see LICENSE.

Sample images are licensed separately, please refer to LICENSE-IMAGE

Developer Code of Conduct

Developers using Cognitive Services, including this client library & sample, are expected to follow the “Developer Code of Conduct for Microsoft Cognitive Services”, found at

Related Repositories



A curated list of awesome Machine Learning frameworks, libraries and software. ...



A :zap:Magic Mirror:zap: powered by a UWP Hosted Web App :rocket: ...



Implements face recognition algorithms for MATLAB/GNU Octave and Python. ...



Universal Windows Platform (UWP) sample app that shows usage of speech, Cortana, ...



Python SDK for the Microsoft Face API, part of Cognitive Services ...