Transaction

getTransaction

get

This method returns the data of a transaction, given its TGUID.

Path parameters

tguidstringRequired

Global unique ID of the transaction.

Query parameters

biographicBasebooleanOptional

Determines if the API will try to get biographics from the Biobase Server or not.

Responses

200

OK

application/json

400

Validation Error

application/json

404

Transaction does not exist

application/json

500

Internal Error

application/json

get

/people/transactions/{tguid}

HTTPcURLJavaScriptPython

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

{
  "data": {
    "tguid": "text",
    "pguid": "text",
    "status": "ENQUEUED",
    "timestamp": 1,
    "progress": 1,
    "candidates": [
      {
        "matchedPersonPguid": "text",
        "matchedPersonTguid": "text",
        "biometricMatches": [
          {
            "score": 1,
            "queryIndex": 1,
            "referenceIndex": 1,
            "minutia": [
              {
                "query": 1,
                "reference": 1
              }
            ]
          }
        ]
      }
    ],
    "exceptions": [
      {
        "matchedPersonPguid": "text",
        "matchedPersonTguid": "text",
        "biometricMatches": [
          {
            "score": 1,
            "queryIndex": 1,
            "referenceIndex": 1,
            "minutia": [
              {
                "query": 1,
                "reference": 1
              }
            ]
          }
        ]
      }
    ],
    "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"
    },
    "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
            }
          ]
        }
      ]
    },
    "failReason": "text",
    "isCurrentTransaction": true,
    "refusedReason": {
      "matchedPeopleThatAreReferenceInSomeExceptionUnderAnalysis": [
        "text"
      ],
      "matchedTransactionsThatHaveAnExceptionUnderAnalysis": [
        "text"
      ]
    },
    "bonafideScore": 1
  }
}

listTransactions

get

This method returns a list of enrollment and updates transactions that match the search criteria.

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 keys that uniquely identify the person. This field can be an expression.

biographicsstring[]Optional

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

labelsstringOptional

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

pageSizeinteger · int32Optional

Size of the request.

pageIndexinteger · int32Optional

Defines which page will be returned.

manuallyReviewedbooleanOptional

List transactions for MIR with parameter manuallyReviewed. Transactions are now manually reviewed if they once have the status PENDING (caught by quality control) and they were approved or rejected.

biographicBasebooleanOptional

Determines if the API will try to get biographics from the Biobase Server or not.

Responses

200

OK

application/json

400

Validation Error

application/json

500

Internal Error

application/json

get

/people/transactions

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "tguid": "text",
      "pguid": "text",
      "status": "ENQUEUED",
      "timestamp": 1,
      "progress": 1,
      "candidates": [
        {
          "matchedPersonPguid": "text",
          "matchedPersonTguid": "text",
          "biometricMatches": [
            {
              "score": 1,
              "queryIndex": 1,
              "referenceIndex": 1,
              "minutia": [
                {
                  "query": 1,
                  "reference": 1
                }
              ]
            }
          ]
        }
      ],
      "exceptions": [
        {
          "matchedPersonPguid": "text",
          "matchedPersonTguid": "text",
          "biometricMatches": [
            {
              "score": 1,
              "queryIndex": 1,
              "referenceIndex": 1,
              "minutia": [
                {
                  "query": 1,
                  "reference": 1
                }
              ]
            }
          ]
        }
      ],
      "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"
      },
      "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
              }
            ]
          }
        ]
      },
      "failReason": "text",
      "isCurrentTransaction": true,
      "refusedReason": {
        "matchedPeopleThatAreReferenceInSomeExceptionUnderAnalysis": [
          "text"
        ],
        "matchedTransactionsThatHaveAnExceptionUnderAnalysis": [
          "text"
        ]
      },
      "bonafideScore": 1
    }
  ],
  "pagination": {
    "total": 1,
    "count": 1,
    "pageSize": 1,
    "currentPage": 1,
    "totalPages": 1
  },
  "meta": {
    "tguidsWithError": [
      "text"
    ]
  }
}

linkEnroll

put

This method links an approved transaction to its refused transaction tguid.

Path parameters

tguidstringRequired

Refused Transaction Tguid.

newTguidstringRequired

Approved transaction Tguid.

Responses

200

OK

*/*

Responseobject

400

Bad Request.

application/json

422

Missing TGUID or Invalid Transaction Status

application/json

500

Internal Error

application/json

put

/people/transactions/linkResentEnroll/{tguid}/newTguid/{newTguid}

HTTPcURLJavaScriptPython

PUT /gbds/v2/people/transactions/linkResentEnroll/{tguid}/newTguid/{newTguid} HTTP/1.1
Host: <ip>:8085
Accept: */*

{}

transactionReport

get

Returns information about transactions that match the search criteria. The transactions will be grouped by operation and API instance (optional).

Query parameters

startstringOptional

Start date to filter the transactions. Format "yyyy-MM-dd HH:mm:ss". If absent, API considers one month from the request timestamp.

endstringOptional

End date to filter the transactions. Format "yyyy-MM-dd HH:mm:ss". If absent, API considers the request timestamp.

byApiIdbooleanOptional

Flag to group results by API ID or not.

Responses

200

OK

application/json

500

Internal Error

application/json

get

/people/transactions/report

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "count": 1,
      "extractionTimeAvg": 1,
      "extractionTimeMin": 1,
      "extractionTimeMax": 1,
      "extractionQualityAvg": 1,
      "extractionQualityMin": 1,
      "extractionQualityMax": 1,
      "matchAvg": 1,
      "matchMin": 1,
      "matchMax": 1,
      "totalAvg": 1,
      "totalMin": 1,
      "totalMax": 1,
      "type": "ENROLL",
      "apiId": "text"
    }
  ]
}