Searches

getSearchResult

get

This method returns the result of a search operation, given its TGUID. Use the searchFields query parameter to control the fields included in the response.

Path parameters

tguidstringRequired

Global unique ID of the transaction.

Query parameters

searchFieldsstring · enumOptional

Specify the level of detail to include in the search response. The options are:

• NO_FIELDS: Standard response. Only tguid, status, score, bonafideScore are possibly returned. (See specific rules for score and bonafideScore in the response model)
• BASIC_FIELDS: Adds the fields: progress, searchType, apiID, gbdsVersion, extractionElapsed, searchElapsed, postSearchElapsed, ulsearch, and latentSearch to the standard response.
• CANDIDATES: Adds the candidate list to the standard response.
• BIOMETRICS: Adds the biometrics list to the standard response.
• ALL_FIELDS: Includes all of the above in the response.

Example: ALL_FIELDSPossible values:

Responses

200

OK

application/json

400

Validation Error

application/json

500

Internal Error

application/json

get

/people/searches/{tguid}

HTTPcURLJavaScriptPython

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

{
  "data": {
    "status": "ENQUEUED",
    "tguid": "text",
    "candidates": [
      {
        "matchedPersonPguid": "text",
        "matchedPersonTguid": "text",
        "biometricMatches": [
          {
            "matchedPersonTguid": "123e4567-e89b-12d3-a456-426614174000",
            "score": 1,
            "queryIndex": 1,
            "referenceIndex": 1,
            "minutia": [
              {
                "query": 1,
                "reference": 1
              }
            ]
          }
        ]
      }
    ],
    "progress": 1,
    "request": {
      "searchType": "SAME_FINGERS",
      "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
        }
      ],
      "keys": [
        {
          "id": "text",
          "value": "text"
        }
      ],
      "pguids": [
        "text"
      ],
      "labelFilters": [
        "text"
      ],
      "isLatentSearch": true,
      "isULSearch": true,
      "numberOfCandidates": 1,
      "classificationThreshold": 1,
      "classifications": [
        "PLAIN_ARCH"
      ],
      "singularities": "NONE",
      "latentSearchOptions": {
        "scoreThreshold": 1,
        "rotationAngleThreshold": 1
      },
      "searchOptions": {
        "biometricType": {
          "scoreThreshold": 1,
          "rotationAngleThreshold": 1,
          "matcher": "DEFAULT"
        }
      },
      "user": "text",
      "uguids": [
        "text"
      ],
      "liveness": true
    },
    "failReason": "text",
    "searchType": "SAME_FINGERS",
    "biometrics": [
      {
        "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
      }
    ],
    "apiID": "text",
    "gbdsVersion": "text",
    "extractionElapsed": 1,
    "searchElapsed": 1,
    "postSearchElapsed": 1,
    "ulsearch": true,
    "latentSearch": true,
    "score": 1,
    "bonafideScore": 1,
    "metadata": {
      "x": true,
      "y": [
        {
          "id": "id"
        }
      ],
      "z": null
    }
  }
}

search

post

This method performs a biometric search a returns the people that match the search criteria.

Body

application/json

Responses

201

Created, match, not match

application/json

202

Enqueued, processing.

application/json

400

Validation Error

application/json

404

Person does not exist (if a PGUID is provided)

application/json

422

Processing Error

application/json

500

Internal Error

application/json

post

/people/searches

HTTPcURLJavaScriptPython

POST /gbds/v2/people/searches HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 820

{
  "data": {
    "searchType": "SAME_FINGERS",
    "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
      }
    ],
    "keys": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "pguids": [
      "text"
    ],
    "labelFilters": [
      "text"
    ],
    "isLatentSearch": true,
    "isULSearch": true,
    "numberOfCandidates": 1,
    "classificationThreshold": 1,
    "classifications": [
      "PLAIN_ARCH"
    ],
    "singularities": "NONE",
    "latentSearchOptions": {
      "scoreThreshold": 1,
      "rotationAngleThreshold": 1
    },
    "searchOptions": {
      "biometricType": {
        "scoreThreshold": 1,
        "rotationAngleThreshold": 1,
        "matcher": "DEFAULT"
      }
    },
    "user": "text",
    "uguids": [
      "text"
    ],
    "liveness": true
  },
  "meta": {
    "timeout": 1,
    "priority": "GOD_PRIORITY",
    "metadata": {
      "x": true,
      "y": [
        {
          "id": "id"
        }
      ],
      "z": null
    },
    "verifyResult": true
  }
}

{
  "data": {
    "status": "ENQUEUED",
    "tguid": "text",
    "score": 1,
    "bonafideScore": 1,
    "candidates": [
      {
        "matchedPersonPguid": "text",
        "matchedPersonTguid": "text",
        "biometricMatches": [
          {
            "matchedPersonTguid": "123e4567-e89b-12d3-a456-426614174000",
            "score": 1,
            "queryIndex": 1,
            "referenceIndex": 1,
            "minutia": [
              {
                "query": 1,
                "reference": 1
              }
            ]
          }
        ]
      }
    ],
    "progress": 1,
    "searchType": "SAME_FINGERS",
    "metadata": {
      "x": true,
      "y": [
        {
          "id": "id"
        }
      ],
      "z": null
    },
    "apiID": "text",
    "gbdsVersion": "text",
    "extractionElapsed": 1,
    "searchElapsed": 1,
    "postSearchElapsed": 1,
    "ulsearch": true,
    "latentSearch": true
  }
}

rematch

put

Triggers a new matching process (rematch) on transactions or persons whose data were updated, recalculating candidates and results.

Query parameters

tguidstring[]Optional

Responses

200

OK

application/json

put

/people/searches/rematch

HTTPcURLJavaScriptPython

PUT /gbds/v2/people/searches/rematch HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

{
  "data": [
    {
      "status": "ENQUEUED",
      "tguid": "text",
      "candidates": [
        {
          "matchedPersonPguid": "text",
          "matchedPersonTguid": "text",
          "biometricMatches": [
            {
              "matchedPersonTguid": "123e4567-e89b-12d3-a456-426614174000",
              "score": 1,
              "queryIndex": 1,
              "referenceIndex": 1,
              "minutia": [
                {
                  "query": 1,
                  "reference": 1
                }
              ]
            }
          ]
        }
      ],
      "progress": 1,
      "request": {
        "searchType": "SAME_FINGERS",
        "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
          }
        ],
        "keys": [
          {
            "id": "text",
            "value": "text"
          }
        ],
        "pguids": [
          "text"
        ],
        "labelFilters": [
          "text"
        ],
        "isLatentSearch": true,
        "isULSearch": true,
        "numberOfCandidates": 1,
        "classificationThreshold": 1,
        "classifications": [
          "PLAIN_ARCH"
        ],
        "singularities": "NONE",
        "latentSearchOptions": {
          "scoreThreshold": 1,
          "rotationAngleThreshold": 1
        },
        "searchOptions": {
          "biometricType": {
            "scoreThreshold": 1,
            "rotationAngleThreshold": 1,
            "matcher": "DEFAULT"
          }
        },
        "user": "text",
        "uguids": [
          "text"
        ],
        "liveness": true
      },
      "failReason": "text",
      "searchType": "SAME_FINGERS",
      "biometrics": [
        {
          "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
        }
      ],
      "apiID": "text",
      "gbdsVersion": "text",
      "extractionElapsed": 1,
      "searchElapsed": 1,
      "postSearchElapsed": 1,
      "ulsearch": true,
      "latentSearch": true,
      "score": 1,
      "bonafideScore": 1,
      "metadata": {
        "x": true,
        "y": [
          {
            "id": "id"
          }
        ],
        "z": null
      }
    }
  ],
  "httpResponse": {
    "httpCode": 1,
    "body": "text"
  }
}