POST api/Biometric/Register

Enroll a member's biometric data.

Request Information

Body Parameters

BiometricRequest
NameDescriptionTypeAdditional information
CustomerKey

Customer-specific key provided by the vendor.

 string

Required
EngineName

The biometric modality for which the customer subscribed. The engine name for fingervein biometrics is "FVHT01".

 string

Required
RegistrationID

The unique identifier (Member ID) of the biometric enrollment that the requested operation will be performed on.

 string

Required.
BiometricXml

The biometric template with xml formatting. The template data should be base64 encoded of fingervein binary template data.

 string

Required.

Request Formats

application/json, text/json

Sample: 
{
  "CustomerKey": "CDCF2B70-1A92-4789-A6CE-C79BE7E954AF",
  "EngineName": "FVHT01",
  "RegistrationID": "Jhon123",
  "BiometricXml": "<Fingers>\r\n    <Finger POS='1'>base64String of fingervein template</Finger>\r\n    <Finger POS='2'>base64String of fingervein template</Finger>\r\n</Fingers>"
}

application/xml, text/xml

Sample: 
<BiometricRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BioPluginCloudAPI.Models">
  <BiometricXml>
    <Fingers>
      <Finger POS="1">base64String of fingervein template</Finger>
      <Finger POS="2">base64String of fingervein template</Finger>
    </Fingers>
  </BiometricXml>
  <CustomerKey>CDCF2B70-1A92-4789-A6CE-C79BE7E954AF</CustomerKey>
  <EngineName>FVHT01</EngineName>
  <RegistrationID>Jhon123</RegistrationID>
</BiometricRequest>

Response Information

Operation-specific OperationResult values:

    Register: SUCCESS - Enrollment successful. (The Member ID and associated biometric data added to system.)

    Register: FAILED - Enrollment failed.

    IsRegistered: YES - There is biometric data enrolled with the requested Member ID.

    Identify: MATCH_FOUND - Match found. (The submitted biometric data matched that of an enrolled member.)

General OperationResult values:

    INVALID_TEMPLATE: The submitted BiometricXml was not correctly formatted.

    CUSTOMER_INFO_NOT_FOUND: The specified CustomerKey was not found in the system. Please contat your vendor for assistance.

    INVALID_ENGINE: The specified EngineName was not valid.

    INVALID_REQUEST: The submitted request was not correctly formatted.

    LICENSE_ERROR: A system license limitation prevented your request from being fulfilled. Please contact your vendor for assistance.

    INTERNAL_ERROR: An unexpected system error was encountered. Please contact your vendor for assistance.

    CACHE_NOT_AVAILABLE: The requested record is not available in the system. Please contact your vendor for assistance.

Resource Description

MatchingResult
NameDescriptionTypeAdditional information
CustomerID

Customer Key that was used to make the request.

 string

None.
OperationName

Name of operation that was requested.

 EnumOperationName

None.
Status

The operation execution status.

 EnumOperationStatus

None.
OperationResult

The result of the operation.

 string

None.
BestResult

Biometric matched record with the highest confidence score.

 ScoreResult

None.
DetailResult

All biometric matched records.

 Collection of ScoreResult

None.
MatchCount

Number of biometric matched records.

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "CustomerID": "CDCF2B70-1A92-4789-A6CE-C79BE7E954AF",
  "OperationName": "2",
  "Status": "1",
  "OperationResult": "SUCCESS",
  "BestResult": "{'Score': 0,'ID': '', 'FingerPosition':0}",
  "DetailResult": "[]",
  "MatchCount": "0"
}

application/xml, text/xml

Sample: 
<MatchingResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BioPluginCloudAPI">
  <BestResult>
    <ID></ID>
    <Score>0</Score>
  </BestResult>
  <CustomerID>CDCF2B70-1A92-4789-A6CE-C79BE7E954AF</CustomerID>
  <DetailResult>
    <ScoreResult>
      <ID></ID>
      <Score>0</Score>
      <FingerPosition>0</FingerPosition>
    </ScoreResult>
  </DetailResult>
  <MatchCount>0</MatchCount>
  <OperationName>2</OperationName>
  <OperationResult>SUCCESS</OperationResult>
  <Status>1</Status>
</MatchingResult>