Skip to main content

FaceMatchUniquenessEntity

idstringrequired

Face ID

transactionIdstringrequired

Transaction id

confidenceScorenumberrequired

Confidence score

errorCodenumber

Error code

errorMessagestring

Error message

analyseIdstring

Analise id

folderIdstringrequired

Check folder id

referenceIdstringrequired

Reference ID for the face match uniqueness check

reputationLevelnumberrequired

Reputation level

resolutionstringrequired

Resolution status of analyses

Possible values: [BIOMETRY, QUALITY, COLLECTION]

sourceMedia object[]required

Source media

  • Array [
  • mediaIdstringrequired

    Media resource id

    resourceTypestringrequired

    Media resource type

    Possible values: [IMAGE_USER_PROFILE, IMAGE_FOLDER, IMAGE_SHOTS_SET, IMAGE_RESULT_ANALYSE_SINGLE, IMAGE_RESULT_ANALYSE_GROUP, IMAGE_COLLECTION_PERSON, SHOTS_SET_FOLDER, VIDEO_FOLDER, PASSIVE_FACEMATCH, PASSIVE_LIVENESS, PASSIVE_LIVENESS_VIDEO, IMAGE]

  • ]
  • typestringrequired

    Check type

    Possible values: [BIOMETRY, QUALITY, COLLECTION]

    deactivateAtstring<date-time>

    Expiration date of the service

    Example: 2023-01-01T00:00:00Z
    persons object[]

    Persons involved in the face match uniqueness check

  • Array [
  • idstringrequired

    Identifier of the matched person.

    applicantIdstringrequired

    Identifier of the applicant the matched person belongs to.

    externalIdstringrequired

    External identifier of the matched applicant.

    reputationLevelnumberrequired

    Reputation level of the matched person, as returned by the face recognition provider.

    confidenceScorenumberrequired

    Confidence of the match, as returned by the face recognition provider.

    sourceMedia object[]required

    Media of the matched person.

  • Array [
  • mediaIdstringrequired

    Media resource id

    resourceTypestringrequired

    Media resource type

    Possible values: [IMAGE_USER_PROFILE, IMAGE_FOLDER, IMAGE_SHOTS_SET, IMAGE_RESULT_ANALYSE_SINGLE, IMAGE_RESULT_ANALYSE_GROUP, IMAGE_COLLECTION_PERSON, SHOTS_SET_FOLDER, VIDEO_FOLDER, PASSIVE_FACEMATCH, PASSIVE_LIVENESS, PASSIVE_LIVENESS_VIDEO, IMAGE]

  • ]
  • ]
  • createdAtstring<date-time>

    Face step create date

    FaceMatchUniquenessEntity
    {
    "id": "string",
    "transactionId": "string",
    "confidenceScore": 0,
    "errorCode": 0,
    "errorMessage": "string",
    "analyseId": "string",
    "folderId": "string",
    "referenceId": "string",
    "reputationLevel": 0,
    "resolution": "BIOMETRY",
    "sourceMedia": [
    {
    "mediaId": "string",
    "resourceType": "IMAGE_USER_PROFILE"
    }
    ],
    "type": "BIOMETRY",
    "deactivateAt": "2023-01-01T00:00:00Z",
    "persons": [
    {
    "id": "string",
    "applicantId": "string",
    "externalId": "string",
    "reputationLevel": 0,
    "confidenceScore": 0,
    "sourceMedia": [
    {
    "mediaId": "string",
    "resourceType": "IMAGE_USER_PROFILE"
    }
    ]
    }
    ],
    "createdAt": "2024-07-29T15:51:28.071Z"
    }