Exceptions
This method returns an exception for a given person/transaction.
Global unique ID of the transaction.
Global unique ID of the person.
OK
Enrollment transaction does not exist, the exception does not exist
Internal Error
GET /gbds/v2/exceptions/{tguid}/{pguid} HTTP/1.1
Host: <ip>:8085
Accept: */*
{
"data": {
"enrollPguid": "text",
"enrollTguid": "text",
"transactionTimestamp": 1,
"match": {
"matchedPersonPguid": "text",
"matchedPersonTguid": "text",
"biometricMatches": [
{
"score": 1,
"queryIndex": 1,
"referenceIndex": 1,
"minutia": [
{
"query": 1,
"reference": 1
}
]
}
]
},
"assignedUser": "text",
"exceptionAnalysis": {
"status": "ANALYSIS",
"exceptionTimestamp": 1,
"user": "text",
"comments": "text"
},
"transactionType": "ENROLL"
}
}This method returns a list of exceptions that match the given search criteria.
Minimum timestamp, in milliseconds.
Maximum timestamp, in milliseconds.
ID of the user.
List of key values. Only anomalies.
List of biographic values.
A list of labels of the person.
OK
Validation Error
Internal Error
GET /gbds/v2/exceptions HTTP/1.1
Host: <ip>:8085
Accept: */*
{
"data": [
{
"enrollPguid": "text",
"enrollTguid": "text",
"transactionTimestamp": 1,
"match": {
"matchedPersonPguid": "text",
"matchedPersonTguid": "text",
"biometricMatches": [
{
"score": 1,
"queryIndex": 1,
"referenceIndex": 1,
"minutia": [
{
"query": 1,
"reference": 1
}
]
}
]
},
"assignedUser": "text",
"exceptionAnalysis": {
"status": "ANALYSIS",
"exceptionTimestamp": 1,
"user": "text",
"comments": "text"
},
"transactionType": "ENROLL"
}
],
"pagination": {
"total": 1,
"count": 1,
"pageSize": 1,
"currentPage": 1,
"totalPages": 1
}
}This method removes the assignment of a user to an exception.
Global unique ID of the transaction.
Global unique ID of the person.
Deleted
Exception does not exist
Internal Error
DELETE /gbds/v2/exceptions/{tguid}/{pguid}/users HTTP/1.1
Host: <ip>:8085
Accept: */*
{}This method returns the exception list from a given exception.
Global unique ID of the transaction.
OK
Enrollment transaction does not exist
Internal Error
GET /gbds/v2/exceptions/{tguid} HTTP/1.1
Host: <ip>:8085
Accept: */*
{
"data": [
{
"enrollPguid": "text",
"enrollTguid": "text",
"transactionTimestamp": 1,
"match": {
"matchedPersonPguid": "text",
"matchedPersonTguid": "text",
"biometricMatches": [
{
"score": 1,
"queryIndex": 1,
"referenceIndex": 1,
"minutia": [
{
"query": 1,
"reference": 1
}
]
}
]
},
"assignedUser": "text",
"exceptionAnalysis": {
"status": "ANALYSIS",
"exceptionTimestamp": 1,
"user": "text",
"comments": "text"
},
"transactionType": "ENROLL"
}
],
"pagination": {
"total": 1,
"count": 1,
"pageSize": 1,
"currentPage": 1,
"totalPages": 1
}
}This method assigns an exception to a given user.
Global unique ID of the transaction.
Global unique ID of the person.
ID of the user.
OK
Exception does not exist
Internal Error
PUT /gbds/v2/exceptions/{tguid}/{pguid}/users/{user} HTTP/1.1
Host: <ip>:8085
Accept: */*
{}This method returns the status of the treatment given to a specific transaction.
Global unique ID of the transaction.
Ok, enqueued, Error
Validation Error
Exception treatment transaction does not exist
Internal Error
GET /gbds/v2/exceptions/treatment/{tguid} HTTP/1.1
Host: <ip>:8085
Accept: */*
{
"status": "OK",
"treatTguid": "text",
"failReason": "text"
}This method provides the treatment for a given exception.
Enqueued
OK
Validation Error
User not authorized to treat exception.
Exception treatment transaction does not exist, exception does not exist
Internal Error
POST /gbds/v2/exceptions/treatment HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 220
{
"data": {
"enrollTguid": "text",
"exceptionPguid": "text",
"exceptionAnalysis": {
"status": "ANALYSIS",
"exceptionTimestamp": 1,
"user": "text",
"comments": "text"
},
"referenceIndexes": [
1
]
},
"meta": {
"timeout": 1,
"discardReference": true
}
}{
"status": "OK",
"treatTguid": "text",
"failReason": "text"
}Global unique ID of the person.
OK
Validation Error
Internal Error
GET /gbds/v2/exceptions/byEntrant/{pguid} HTTP/1.1
Host: <ip>:8085
Accept: */*
{
"data": [
{
"enrollPguid": "text",
"enrollTguid": "text",
"transactionTimestamp": 1,
"match": {
"matchedPersonPguid": "text",
"matchedPersonTguid": "text",
"biometricMatches": [
{
"score": 1,
"queryIndex": 1,
"referenceIndex": 1,
"minutia": [
{
"query": 1,
"reference": 1
}
]
}
]
},
"assignedUser": "text",
"exceptionAnalysis": {
"status": "ANALYSIS",
"exceptionTimestamp": 1,
"user": "text",
"comments": "text"
},
"transactionType": "ENROLL"
}
],
"pagination": {
"total": 1,
"count": 1,
"pageSize": 1,
"currentPage": 1,
"totalPages": 1
}
}Global unique ID of the person.
OK
Validation Error
Internal Error
GET /gbds/v2/exceptions/byReference/{pguid} HTTP/1.1
Host: <ip>:8085
Accept: */*
{
"data": [
{
"enrollPguid": "text",
"enrollTguid": "text",
"transactionTimestamp": 1,
"match": {
"matchedPersonPguid": "text",
"matchedPersonTguid": "text",
"biometricMatches": [
{
"score": 1,
"queryIndex": 1,
"referenceIndex": 1,
"minutia": [
{
"query": 1,
"reference": 1
}
]
}
]
},
"assignedUser": "text",
"exceptionAnalysis": {
"status": "ANALYSIS",
"exceptionTimestamp": 1,
"user": "text",
"comments": "text"
},
"transactionType": "ENROLL"
}
],
"pagination": {
"total": 1,
"count": 1,
"pageSize": 1,
"currentPage": 1,
"totalPages": 1
}
}