Exceptions

gbds-ping

get

This method is used to check the API availability.

Responses

200

default response

*/*

get

/gbds/v2/operations/ping

HTTPcURLJavaScriptPython

GET /gbds/v2/operations/ping HTTP/1.1
Host: <ip>:8084
Accept: */*

200

default response

{
  "data": "text",
  "httpResponse": {
    "httpCode": 1,
    "body": "text"
  }
}

listExceptions

get

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

Query parameters

startDateinteger · int64Optional

endDateinteger · int64Optional

userstringOptional

keysstring[]Optional

biographicsstring[]Optional

labelsstring[]Required

Responses

200

default response

application/json

get

/gbds/v2/exceptions

HTTPcURLJavaScriptPython

GET /gbds/v2/exceptions?labels=text HTTP/1.1
Host: <ip>:8084
Accept: */*

200

default response

{
  "data": [
    {
      "enrollPguid": "text",
      "enrollTguid": "text",
      "transactionTimestamp": 1,
      "match": {
        "matchedPersonPguid": "text",
        "matchedPersonTguid": "text",
        "biometricMatches": [
          {
            "score": 1,
            "queryIndex": 1,
            "referenceIndex": 1,
            "minutia": [
              {
                "queryIndex": 1,
                "referenceIndex": 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
  },
  "httpResponse": {
    "httpCode": 1,
    "body": "text"
  }
}

listByTransaction

get

This method returns the exception list from a given exception.

Path parameters

tguidstringRequired

Responses

200

default response

application/json

get

/gbds/v2/exceptions/{tguid}

HTTPcURLJavaScriptPython

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

200

default response

{
  "data": [
    {
      "enrollPguid": "text",
      "enrollTguid": "text",
      "transactionTimestamp": 1,
      "match": {
        "matchedPersonPguid": "text",
        "matchedPersonTguid": "text",
        "biometricMatches": [
          {
            "score": 1,
            "queryIndex": 1,
            "referenceIndex": 1,
            "minutia": [
              {
                "queryIndex": 1,
                "referenceIndex": 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
  },
  "httpResponse": {
    "httpCode": 1,
    "body": "text"
  }
}

assignException

put

This method assigns an exception to a given user.

Path parameters

tguidstringRequired

pguidstringRequired

userstringRequired

Responses

200

default response

*/*

Responseobject

put

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

HTTPcURLJavaScriptPython

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

200

default response

{}

treat

post

This method provides the treatment for a given exception.

Body

application/json

Responses

200

default response

*/*

post

/gbds/v2/exceptions/treatment

HTTPcURLJavaScriptPython

POST /gbds/v2/exceptions/treatment HTTP/1.1
Host: <ip>:8084
Content-Type: application/json
Accept: */*
Content-Length: 475

{
  "data": {
    "enrollTguid": "text",
    "exceptionPguid": "text",
    "exceptionAnalysis": {
      "status": "ANALYSIS",
      "exceptionTimestamp": 1,
      "user": "text",
      "comments": "text"
    },
    "referenceIndexes": [
      1
    ]
  },
  "meta": {
    "timeout": 1,
    "discardReference": true
  },
  "subject": {
    "name": "text",
    "roles": [
      {}
    ],
    "permissions": [
      {}
    ]
  },
  "validatedExceptionTreatment": {
    "enrollTguid": "text",
    "exceptionPguid": "text",
    "exceptionAnalysis": {
      "status": "ANALYSIS",
      "exceptionTimestamp": 1,
      "user": "text",
      "comments": "text"
    },
    "referenceIndexes": [
      1
    ]
  }
}

200

default response

{
  "data": {
    "status": "OK",
    "treatTguid": "text",
    "failReason": "text"
  },
  "httpResponse": {
    "httpCode": 1,
    "body": "text"
  }
}

gbds-getPerson

get

This method returns the information of a person, given its PGUID.

Path parameters

pguidstringRequired

Query parameters

Responses

200

default response

*/*

get

/gbds/v2/people/{pguid}

HTTPcURLJavaScriptPython

GET /gbds/v2/people/{pguid} HTTP/1.1
Host: <ip>:8084
Accept: */*

200

default response

{
  "data": {
    "pguid": "text",
    "lastEnrollTguid": "text",
    "timestamp": 1,
    "keys": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "biographics": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "biometric": [
      {
        "source": "ORIGINAL",
        "type": "FINGERPRINT",
        "format": "RAW",
        "properties": {
          "width": 1,
          "height": 1,
          "resolution": 1,
          "ratio": 1
        },
        "index": 1,
        "content": "text",
        "quality": 1
      }
    ],
    "metadata": "text",
    "labels": [
      "text"
    ],
    "history": {
      "events": [
        {
          "tguid": "text",
          "timestamp": 1,
          "type": "text"
        }
      ]
    },
    "auxiliaryImages": [
      {
        "source": "ORIGINAL",
        "type": "FINGERPRINT",
        "format": "RAW",
        "properties": {
          "width": 1,
          "height": 1,
          "resolution": 1,
          "ratio": 1
        },
        "index": 1,
        "content": "text",
        "quality": 1
      }
    ],
    "ebts": [
      {
        "source": "ORIGINAL",
        "type": "FINGERPRINT",
        "format": "RAW",
        "properties": {
          "width": 1,
          "height": 1,
          "resolution": 1,
          "ratio": 1
        },
        "index": 1,
        "content": "text",
        "quality": 1
      }
    ]
  },
  "httpResponse": {
    "httpCode": 1,
    "body": "text"
  }
}

getTransaction

get

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

Path parameters

tguidstringRequired

Query parameters

Responses

200

default response

application/json

get

/gbds/v2/people/transactions/{tguid}

HTTPcURLJavaScriptPython

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

200

default response

{
  "data": {
    "tguid": "text",
    "pguid": "text",
    "status": "ENQUEUED",
    "timestamp": 1,
    "progress": 1,
    "candidates": [
      {
        "matchedPersonPguid": "text",
        "matchedPersonTguid": "text",
        "biometricMatches": [
          {
            "score": 1,
            "queryIndex": 1,
            "referenceIndex": 1,
            "minutia": [
              {
                "queryIndex": 1,
                "referenceIndex": 1
              }
            ]
          }
        ]
      }
    ],
    "person": {
      "pguid": "text",
      "lastEnrollTguid": "text",
      "timestamp": 1,
      "keys": [
        {
          "id": "text",
          "value": "text"
        }
      ],
      "biographics": [
        {
          "id": "text",
          "value": "text"
        }
      ],
      "biometric": [
        {
          "source": "ORIGINAL",
          "type": "FINGERPRINT",
          "format": "RAW",
          "properties": {
            "width": 1,
            "height": 1,
            "resolution": 1,
            "ratio": 1
          },
          "index": 1,
          "content": "text",
          "quality": 1
        }
      ],
      "metadata": "text",
      "labels": [
        "text"
      ],
      "history": {
        "events": [
          {
            "tguid": "text",
            "timestamp": 1,
            "type": "text"
          }
        ]
      },
      "auxiliaryImages": [
        {
          "source": "ORIGINAL",
          "type": "FINGERPRINT",
          "format": "RAW",
          "properties": {
            "width": 1,
            "height": 1,
            "resolution": 1,
            "ratio": 1
          },
          "index": 1,
          "content": "text",
          "quality": 1
        }
      ],
      "ebts": [
        {
          "source": "ORIGINAL",
          "type": "FINGERPRINT",
          "format": "RAW",
          "properties": {
            "width": 1,
            "height": 1,
            "resolution": 1,
            "ratio": 1
          },
          "index": 1,
          "content": "text",
          "quality": 1
        }
      ]
    },
    "qualityAnalysis": {
      "status": "PENDING",
      "assignedUser": "text",
      "user": "text",
      "comments": "text",
      "timestamp": 1,
      "duplicationIssues": [
        {
          "indexes": [
            1
          ],
          "nextDuplicate": [
            1
          ]
        }
      ],
      "qualityIssues": [
        {
          "index": 1,
          "quality": 1
        }
      ],
      "sequenceControlIssues": [
        {
          "index": 1,
          "matches": [
            {
              "index": 1,
              "score": 1
            }
          ]
        }
      ],
      "sequenceControlParityIssue": {
        "missingIndexes": [
          1
        ]
      }
    },
    "failReason": "text",
    "extractionIssues": [
      {
        "index": 1,
        "message": "text"
      }
    ],
    "externalIds": [
      {
        "name": "text",
        "key": "text"
      }
    ],
    "isCurrentTransaction": true
  },
  "httpResponse": {
    "httpCode": 1,
    "body": "text"
  }
}

listTransactions

get

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

Query parameters

enrollStatusstring · enumOptionalPossible values:

qualityStatusstring · enumOptionalPossible values:

startDateinteger · int64Optional

endDateinteger · int64Optional

pageSizeinteger · int32Optional

pageIndexinteger · int32Optional

Responses

200

default response

application/json

get

/gbds/v2/people/transactions

HTTPcURLJavaScriptPython

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

200

default response

{
  "data": [
    {
      "tguid": "text",
      "pguid": "text",
      "status": "ENQUEUED",
      "timestamp": 1,
      "progress": 1,
      "candidates": [
        {
          "matchedPersonPguid": "text",
          "matchedPersonTguid": "text",
          "biometricMatches": [
            {
              "score": 1,
              "queryIndex": 1,
              "referenceIndex": 1,
              "minutia": [
                {
                  "queryIndex": 1,
                  "referenceIndex": 1
                }
              ]
            }
          ]
        }
      ],
      "person": {
        "pguid": "text",
        "lastEnrollTguid": "text",
        "timestamp": 1,
        "keys": [
          {
            "id": "text",
            "value": "text"
          }
        ],
        "biographics": [
          {
            "id": "text",
            "value": "text"
          }
        ],
        "biometric": [
          {
            "source": "ORIGINAL",
            "type": "FINGERPRINT",
            "format": "RAW",
            "properties": {
              "width": 1,
              "height": 1,
              "resolution": 1,
              "ratio": 1
            },
            "index": 1,
            "content": "text",
            "quality": 1
          }
        ],
        "metadata": "text",
        "labels": [
          "text"
        ],
        "history": {
          "events": [
            {
              "tguid": "text",
              "timestamp": 1,
              "type": "text"
            }
          ]
        },
        "auxiliaryImages": [
          {
            "source": "ORIGINAL",
            "type": "FINGERPRINT",
            "format": "RAW",
            "properties": {
              "width": 1,
              "height": 1,
              "resolution": 1,
              "ratio": 1
            },
            "index": 1,
            "content": "text",
            "quality": 1
          }
        ],
        "ebts": [
          {
            "source": "ORIGINAL",
            "type": "FINGERPRINT",
            "format": "RAW",
            "properties": {
              "width": 1,
              "height": 1,
              "resolution": 1,
              "ratio": 1
            },
            "index": 1,
            "content": "text",
            "quality": 1
          }
        ]
      },
      "qualityAnalysis": {
        "status": "PENDING",
        "assignedUser": "text",
        "user": "text",
        "comments": "text",
        "timestamp": 1,
        "duplicationIssues": [
          {
            "indexes": [
              1
            ],
            "nextDuplicate": [
              1
            ]
          }
        ],
        "qualityIssues": [
          {
            "index": 1,
            "quality": 1
          }
        ],
        "sequenceControlIssues": [
          {
            "index": 1,
            "matches": [
              {
                "index": 1,
                "score": 1
              }
            ]
          }
        ],
        "sequenceControlParityIssue": {
          "missingIndexes": [
            1
          ]
        }
      },
      "failReason": "text",
      "extractionIssues": [
        {
          "index": 1,
          "message": "text"
        }
      ],
      "externalIds": [
        {
          "name": "text",
          "key": "text"
        }
      ],
      "isCurrentTransaction": true
    }
  ],
  "pagination": {
    "total": 1,
    "count": 1,
    "pageSize": 1,
    "currentPage": 1,
    "totalPages": 1
  },
  "meta": {},
  "httpResponse": {
    "httpCode": 1,
    "body": "text"
  }
}