Exceptions

getException

get

This method returns an exception for a given person/transaction.

Path parameters

tguidstringRequired

Global unique ID of the transaction.

pguidstringRequired

Global unique ID of the person.

Responses

200

OK

application/json

404

Enrollment transaction does not exist, the exception does not exist

application/json

500

Internal Error

application/json

get

/exceptions/{tguid}/{pguid}

HTTPcURLJavaScriptPython

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"
  }
}

listExceptions

get

This method returns a list of exceptions that match the given search criteria.

Query parameters

startDateinteger · int64Optional

Minimum timestamp, in milliseconds.

endDateinteger · int64Optional

Maximum timestamp, in milliseconds.

userstringOptional

ID of the user.

keysstring[]Optional

List of key values. Only anomalies.

biographicsstring[]Optional

List of biographic values.

labelsstring[]Optional

A list of labels of the person.

pageIndexinteger · int32Optional

pageSizeinteger · int32Optional

Responses

200

OK

application/json

400

Validation Error

application/json

500

Internal Error

application/json

get

/exceptions

HTTPcURLJavaScriptPython

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
  }
}

unassignException

delete

This method removes the assignment of a user to an exception.

Path parameters

tguidstringRequired

Global unique ID of the transaction.

pguidstringRequired

Global unique ID of the person.

Responses

204

Deleted

*/*

404

Exception does not exist

application/json

500

Internal Error

application/json

delete

/exceptions/{tguid}/{pguid}/users

HTTPcURLJavaScriptPython

DELETE /gbds/v2/exceptions/{tguid}/{pguid}/users HTTP/1.1
Host: <ip>:8085
Accept: */*

{}

listByTransaction

get

This method returns the exception list from a given exception.

Path parameters

tguidstringRequired

Global unique ID of the transaction.

Responses

200

OK

application/json

404

Enrollment transaction does not exist

application/json

500

Internal Error

application/json

get

/exceptions/{tguid}

HTTPcURLJavaScriptPython

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
  }
}

assignException

put

This method assigns an exception to a given user.

Path parameters

tguidstringRequired

Global unique ID of the transaction.

pguidstringRequired

Global unique ID of the person.

userstringRequired

ID of the user.

Responses

201

OK

*/*

404

Exception does not exist

application/json

500

Internal Error

application/json

put

/exceptions/{tguid}/{pguid}/users/{user}

HTTPcURLJavaScriptPython

PUT /gbds/v2/exceptions/{tguid}/{pguid}/users/{user} HTTP/1.1
Host: <ip>:8085
Accept: */*

{}

getTreatResult

get

This method returns the status of the treatment given to a specific transaction.

Path parameters

tguidstringRequired

Global unique ID of the transaction.

Responses

200

Ok, enqueued, Error

application/json

statusstring · enumOptional

Status of the treat operation.

Possible values:

treatTguidstringOptional

TGUID of treat operation.

failReasonstringOptional

If the treatment call failed, this field will contain a message describing the nature of the failure.

400

Validation Error

application/json

404

Exception treatment transaction does not exist

application/json

500

Internal Error

application/json

get

/exceptions/treatment/{tguid}

HTTPcURLJavaScriptPython

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

{
  "status": "OK",
  "treatTguid": "text",
  "failReason": "text"
}

treatException

post

This method provides the treatment for a given exception.

Body

application/json

Responses

201

Enqueued

application/json

202

OK

application/json

400

Validation Error

application/json

403

User not authorized to treat exception.

application/json

404

Exception treatment transaction does not exist, exception does not exist

application/json

500

Internal Error

application/json

post

/exceptions/treatment

HTTPcURLJavaScriptPython

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"
}

getExceptionByEntrantPguid

get

Path parameters

pguidstringRequired

Global unique ID of the person.

Responses

200

OK

application/json

400

Validation Error

application/json

500

Internal Error

application/json

get

/exceptions/byEntrant/{pguid}

HTTPcURLJavaScriptPython

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
  }
}

getExceptionByReferencePguid

get

Path parameters

pguidstringRequired

Global unique ID of the person.

Responses

200

OK

application/json

400

Validation Error

application/json

500

Internal Error

application/json

get

/exceptions/byReference/{pguid}

HTTPcURLJavaScriptPython

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
  }
}