SOAP API

Access the BioID Web Service with SOAP API

The BioID Web Service (BWS) has been designed using a service-oriented architecture (SOA) and is implemented as a Windows Communication Foundation (WCF) service using the SOAP protocol, which allows platform-independent implementation on the customer's side. No installation on on-premise systems is needed since all access to BWS is done remotely over standard ports.

Before you begin

You need to have access to an existing BWS installation. If you don't have this access, you can register for a trial instanceFor this you need a BioID account with a confirmed email address.

The access to the service instances is restricted with standard X.509 client certificates. You can download this certificate from the BWS Portal.

The service-, operation- and data-contracts of the current version of BWS are available online as a single WSDL metadata document. (XML file).

IBioIDWebService Interface Documentation

The BioID Web Service contract is based on the IBioIDWebService interface, which makes up the BWS API:

[ServiceContract(Namespace = "http://www.bioid.com/2011/12/bws", Name = "IBioIDWebService"]
public interface IBioIDWebService
{
    bool Enroll (BiometricClassID classId, Sample[] samples, EnrollmentFlags flags, out string messages);
    bool Verify (BiometricClassID classId, Sample[] samples, ClassificationFlags flags, out string messages);
    bool Identify (BiometricClassID partition, Sample[] samples, ClassificationFlags flags, int maxResults, out ScoredClass[] matches, out string messages);
    bool LivenessDetection(Sample[] samples, out string messages);
    bool VideoLivenessDetection(byte[] video, out string messages);
	bool PhotoVerify(Sample[] samples, Sample photo, int accuracy, out string messages);
    bool QualityCheck (Sample[] samples, out Sample[] processedSamples, out string messages, TestFlags flags, string issuer);
    bool Status (out string status);
    bool DeleteClass (BiometricClassID classId);
    bool IsEnrolled (BiometricClassID classId, Trait trait);
}