Quality

getQualityControl

get

This method returns the quality analysis result for a given transaction.

Path parameters

tguidstringRequired

Global unique ID of the transaction.

Query parameters

biographicBasebooleanOptional

Responses

200

application/json

get

/people/transactions/qualityAnalysis/{tguid}

GET /gbds/v2/people/transactions/qualityAnalysis/{tguid} HTTP/1.1
Host: <ip>:8085
Accept: */*

200

{
  "data": {
    "tguid": "123e4567-e89b-12d3-a456-426614174000",
    "pguid": "123e4567-e89b-12d3-a456-426614174000",
    "created": 1719841414392,
    "updated": 1719860745366,
    "qualityStatus": "PENDING",
    "enrollStatus": "ENQUEUED",
    "person": {
      "pguid": "text",
      "lastEnrollTguid": "text",
      "timestamp": 1,
      "keys": [
        {
          "id": "text",
          "value": "text"
        }
      ],
      "biographics": [
        {
          "id": "text",
          "value": "text"
        }
      ],
      "biometric": [
        {
          "source": "CONSOLIDATED_TEMPLATE",
          "type": "FINGERPRINT",
          "format": "PRIVATE",
          "properties": {
            "width": 1,
            "height": 1,
            "resolution": 1,
            "ratio": 1,
            "matcherId": 1,
            "extractorId": 1
          },
          "index": 1,
          "content": "text",
          "quality": 1
        }
      ],
      "auxiliaries": [
        {
          "source": "CONSOLIDATED_TEMPLATE",
          "type": "FINGERPRINT",
          "format": "PRIVATE",
          "properties": {
            "width": 1,
            "height": 1,
            "resolution": 1,
            "ratio": 1,
            "matcherId": 1,
            "extractorId": 1
          },
          "index": 1,
          "content": "text",
          "quality": 1
        }
      ],
      "metadata": [
        "text"
      ],
      "labels": [
        "text"
      ],
      "history": {
        "events": [
          {
            "tguid": "text",
            "timestamp": 1,
            "type": "text",
            "targetTguid": "text"
          }
        ]
      },
      "biographicBaseStatus": "UNAVAILABLE"
    },
    "transactionType": "ENROLL",
    "issues": {
      "lowQuality": 1,
      "duplication": 1,
      "sequenceControl": 1
    },
    "apiID": "123e4567-e89b-12d3-a456-426614174000",
    "gbdsVersion": "text"
  }
}

listQualityControl

get

This method returns a list of transactions with quality analysis.

Query parameters

enrollStatusstring · enumOptional

Select only enrolls with a specific status, e.g., ENROLLED.

This parameter can be a list. To do so, pass it multiple times with the desired values.

NOTE: At least one of the parameters enrollStatus or qualityStatus is required.

Possible values:

qualityStatusstring · enumOptional

Filter with specific quality status.

This parameter can be a list. To do so, pass it multiple times with the desired values.

NOTE: At least one of the parameters enrollStatus or qualityStatus is required.

Possible values:

startDateinteger · int64Optional

Minimum timestamp, in milliseconds.

endDateinteger · int64Optional

Maximum timestamp, in milliseconds.

keysstring[]Optional

Array of keys that uniquely identify the person. This field can be an expression.

The following structure can be used for both keys and biographics:

Format	Description
`<id>:<value>`	Searches for exceptions with incoming or reference keys/biographics with the passed id and value.
`<id>:`	Searches for exceptions with incoming or reference keys/biographics with the id and any value.
`:<value>`	Searches for exceptions with incoming or reference keys/biographics with the value and any id.

From the second keys/biographics item onwards, before each id or value, you can include an operator:

[and]: performs an AND operation with the previous item.
[or]: performs an OR operation with the previous item.

These operators may be applied to both keys and biographics.

On every operation on an id or value, the default behavior will be to test for exact matches. To change this behavior, you can include a modifier at the end of the id or value:

[exact]: tests for exact matches. This is the default behavior, the same as not including any modifier.
[atstart]: searches for content that starts with the passed id/value.
[atend]: searches for content that ends with the passed id/value.
[anywhere]: searches for content that contains the passed id/value.

IMPORTANT: Be careful when using modifiers other than [exact]. They can slow down the search.

Examples:

keys=cpf:001&biographics=name
keys=cpf:001&keys=[or]cpf:002
keys=cpf:00[atstart]

biographicsstring[]Optional

Biographic data of the person. This field can be an expression.

For expressions, use the same structure described in the keys parameter.

labelsstringOptional

A list of labels that may be empty. This field can be an expression. For transactions with no labels, use "labels=".

pageSizeinteger · int32Optional

Defines the number of results per page.

Default: 20

pageIndexinteger · int32Optional

Defines which page will be returned.

Default: 0

orderBystring · enumOptional

Order the results by creation date or update date.

Possible values:

biographicBasebooleanOptional

Responses

200

application/json

get

/people/transactions/qualityAnalysis

GET /gbds/v2/people/transactions/qualityAnalysis HTTP/1.1
Host: <ip>:8085
Accept: */*

200

{
  "data": [
    {
      "tguid": "123e4567-e89b-12d3-a456-426614174000",
      "pguid": "123e4567-e89b-12d3-a456-426614174000",
      "created": 1719841414392,
      "updated": 1719860745366,
      "qualityStatus": "PENDING",
      "enrollStatus": "ENQUEUED",
      "person": {
        "pguid": "text",
        "lastEnrollTguid": "text",
        "timestamp": 1,
        "keys": [
          {
            "id": "text",
            "value": "text"
          }
        ],
        "biographics": [
          {
            "id": "text",
            "value": "text"
          }
        ],
        "biometric": [
          {
            "source": "CONSOLIDATED_TEMPLATE",
            "type": "FINGERPRINT",
            "format": "PRIVATE",
            "properties": {
              "width": 1,
              "height": 1,
              "resolution": 1,
              "ratio": 1,
              "matcherId": 1,
              "extractorId": 1
            },
            "index": 1,
            "content": "text",
            "quality": 1
          }
        ],
        "auxiliaries": [
          {
            "source": "CONSOLIDATED_TEMPLATE",
            "type": "FINGERPRINT",
            "format": "PRIVATE",
            "properties": {
              "width": 1,
              "height": 1,
              "resolution": 1,
              "ratio": 1,
              "matcherId": 1,
              "extractorId": 1
            },
            "index": 1,
            "content": "text",
            "quality": 1
          }
        ],
        "metadata": [
          "text"
        ],
        "labels": [
          "text"
        ],
        "history": {
          "events": [
            {
              "tguid": "text",
              "timestamp": 1,
              "type": "text",
              "targetTguid": "text"
            }
          ]
        },
        "biographicBaseStatus": "UNAVAILABLE"
      },
      "transactionType": "ENROLL",
      "issues": {
        "lowQuality": 1,
        "duplication": 1,
        "sequenceControl": 1
      },
      "apiID": "123e4567-e89b-12d3-a456-426614174000",
      "gbdsVersion": "text"
    }
  ],
  "pagination": {
    "total": 1,
    "count": 1,
    "pageSize": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

qualityAnalysis

put

This method provides the quality analysis result for a given transaction.

Path parameters

tguidstringRequired

Global unique ID of the transaction.

Body

Responses

200

application/json

400

Validation Error

application/json

403

Enrollment is not assigned, enroll has a different assigned user.

application/json

404

Enrollment transaction does not exist

application/json

422

Invalid transaction state.

application/json

500

Internal Error

application/json

put

/people/transactions/{tguid}/qualityAnalysis

PUT /gbds/v2/people/transactions/{tguid}/qualityAnalysis HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 487

{
  "data": {
    "qualityAnalysis": {
      "status": "PENDING",
      "user": "text",
      "comments": "text",
      "timestamp": 1,
      "duplicationIssues": [
        {
          "indexes": [
            1
          ]
        }
      ],
      "qualityIssues": [
        {
          "index": 1,
          "quality": 1
        }
      ],
      "sequenceControlIssues": [
        {
          "index": 1,
          "matches": [
            {
              "index": 1,
              "score": 1
            }
          ]
        }
      ]
    },
    "biometric": [
      {
        "source": "CONSOLIDATED_TEMPLATE",
        "type": "FINGERPRINT",
        "format": "PRIVATE",
        "properties": {
          "width": 1,
          "height": 1,
          "resolution": 1,
          "ratio": 1,
          "matcherId": 1,
          "extractorId": 1
        },
        "index": 1,
        "content": "text",
        "quality": 1
      }
    ]
  },
  "meta": {
    "timeout": 1
  }
}

{
  "data": {
    "newTransactionGUID": "text"
  }
}

unassignPendingEnroll

delete

This method removes the assignment of a user to quality analysis.

Path parameters

tguidstringRequired

Global unique ID of the transaction.

Responses

204

Deleted

application/json

Responseobject

404

Enrollment transaction does not exist

application/json

422

Enrollment is not pending, enrollment is already unassigned.

application/json

500

Internal Error

application/json

delete

/people/transactions/{tguid}/qualityAnalysis/users

DELETE /gbds/v2/people/transactions/{tguid}/qualityAnalysis/users HTTP/1.1
Host: <ip>:8085
Accept: */*

{}

assignPendingEnroll

put

This method assigns a quality analysis operation to a given user.

Path parameters

tguidstringRequired

Global unique ID of the transaction.

userNamestringRequired

ID of the user.

Responses

200

application/json

Responseobject

404

Enrollment transaction does not exist

application/json

422

Enrollment is not pending, enrollment is already assigned.

application/json

500

Internal Error

application/json

put

/people/transactions/{tguid}/qualityAnalysis/users/{userName}

PUT /gbds/v2/people/transactions/{tguid}/qualityAnalysis/users/{userName} HTTP/1.1
Host: <ip>:8085
Accept: */*

{}

Was this helpful?