POST api/Biometric/ChangeID

Change the member ID associated with an existing enrollment to a new ID.

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 face biometrics is "FACE01".

 string

Required
RegistrationID

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

 string

Required.
NewRegistrationID

The new unique identifier (Member ID) that the existing ID will be changed to.

 string

Required.

Request Formats

application/json, text/json

Sample: 
{
  "CustomerKey": "956F7108-FFA9-42F3-9CCC-F7C14A627376",
  "EngineName": "FACE01",
  "RegistrationID": "Jhon123",
  "NewRegistrationID": "Jhon456"
}

application/xml, text/xml

Sample: 
<BiometricRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/M2SYS.Cloud.FaceAPI">
  <CustomerKey>956F7108-FFA9-42F3-9CCC-F7C14A627376</CustomerKey>
  <EngineName>FACE01</EngineName>
  <NewRegistrationID>Jhon456</NewRegistrationID>
  <RegistrationID>Jhon123</RegistrationID>
</BiometricRequest>

Response Information

Operation-specific OperationResult values:

    ChangeID: CS - Change of ID successful. (The Member ID was changed to the specified new ID.)

    ChangeID: CF - Change of ID failed.

    ChangeID: ID_NOT_EXIST - The Member ID intent for change doesn't exist in the system.

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

General OperationResult values:

    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.

 OperationNameEnum

None.
Status

The operation execution status.

 EnumOperationStatus

None.
OperationResult

The result of the operation.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "CustomerID": "956F7108-FFA9-42F3-9CCC-F7C14A627376",
  "OperationName": "6",
  "Status": "1",
  "OperationResult": "CS"
}

application/xml, text/xml

Sample: 
<MatchingResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/M2SYS.Cloud.FaceAPI">
  <CustomerID>956F7108-FFA9-42F3-9CCC-F7C14A627376</CustomerID>
  <OperationName>6</OperationName>
  <OperationResult>CS</OperationResult>
  <Status>1</Status>
</MatchingResult>