Transaction
This method returns the data of a transaction, given its TGUID.
Global unique ID of the transaction.
Determines if the API will try to get biographics from the Biobase Server or not.
List of indexes to be returned. The list may contain only one index. If a provided index does not exist, it will be ignored.
OK
Validation Error
Transaction does not exist
Internal Error
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": [
{
"matchedPersonTguid": "123e4567-e89b-12d3-a456-426614174000",
"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,
"postSearchElapsed": 1
}
}This method returns a list of enrollment and updates transactions that match the search criteria.
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.
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.
Minimum timestamp, in milliseconds.
Maximum timestamp, in milliseconds.
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=namekeys=cpf:001&keys=[or]cpf:002keys=cpf:00[atstart]
Biographic data of the person. This field can be an expression.
For expressions, use the same structure described in the keys parameter.
A list of labels that may be empty. This field can be an expression. For transactions with no labels, use labels=.
The format is only the label name. For example, labels=example.
The [and] and [or] operators can be used to combine labels as described in the keys parameter, but they are only applied to labels.
The [exact] (default), [atstart], [atend], and [anywhere] modifiers can be used to change the behavior of the label search, as described in the keys parameter.
Size of the request.
Defines which page will be returned.
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.
Determines if the API will try to get biographics from the Biobase Server or not.
Order the results by creation date or update date.
List of indexes to be returned. The list may contain only one index. If a provided index does not exist, it will be ignored.
OK
Validation Error
Internal Error
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": [
{
"matchedPersonTguid": "123e4567-e89b-12d3-a456-426614174000",
"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,
"postSearchElapsed": 1
}
],
"pagination": {
"total": 1,
"count": 1,
"pageSize": 1,
"currentPage": 1,
"totalPages": 1
},
"meta": {
"tguidsWithError": [
"text"
]
}
}This method links an approved transaction to its refused transaction tguid.
Refused Transaction Tguid.
Approved transaction Tguid.
OK
Bad Request.
Missing TGUID or Invalid Transaction Status
Internal Error
PUT /gbds/v2/people/transactions/linkResentEnroll/{tguid}/newTguid/{newTguid} HTTP/1.1
Host: <ip>:8085
Accept: */*
{}Returns information about transactions that match the search criteria. The transactions will be grouped by operation and API instance (optional).
Start date to filter the transactions. Format "yyyy-MM-dd HH:mm:ss". If absent, API considers one month from the request timestamp.
End date to filter the transactions. Format "yyyy-MM-dd HH:mm:ss". If absent, API considers the request timestamp.
Flag to group results by API ID or not.
OK
Internal Error
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"
}
]
}Was this helpful?