---
title: "getSearchResult"
method: GET
path: "/people/searches/{tguid}"
tags: ["searches"]
---

# getSearchResult

`GET /people/searches/{tguid}`

## Request

- Base URL: `http://<ip>:8085/gbds/v2`
- URL: `http://<ip>:8085/gbds/v2/people/searches/{tguid}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/griaule/apis/gbds-api/docs/people/searches/:tguid/get.ts> (a function with typed inputs; its response is checked against the schema)

This method returns the result of a search operation, given its TGUID.

## Path parameters

- `tguid` string, required

## Response `200`

OK

- GetSearchesResponse
  - `data` Search
    - `status` 'ENQUEUED' | 'PREPARED' | 'PROCESSING' | 'MATCH' | 'NOT_MATCH' | 'FAILED' | 'PENDING' | 'PERSON_NOT_FOUND': Status of the search.
    - `tguid` string: Search transaction TGUID.
    - `candidates` Match[]: List of match candidates.
      - `matchedPersonPguid` string: PGUID of the person the candidate was matched against.
      - `matchedPersonTguid` string: TGUID of the person the candidate was matched against.
      - `biometricMatches` BiometricMatch[]: Information about the match.
        - `score` integer: Score of the match.
        - `queryIndex` integer: Index of the biometric data that was sent and caused a match.
        - `referenceIndex` integer: Index of the biometric data, from the already enrolled person, which matched.
        - `minutia` Minutiae[]: Array of minutia matches. Returned only for latent searches.
          - `query` integer: Index of Minutiae, from the provided biometric data, which was involved in the match.
          - `reference` integer: Index of Minutiae, from biometric data already in the database, which was involved in the match.
    - `progress` number, float
    - `request` SearchSpec
      - `searchType` 'SAME_FINGERS' | 'ALL_FINGERS' | 'CROSSED_WINDOW_TWEEZERS': Type of finger to be searched.
      - `biometric` Biometric[]: If only one biometric is provided, a match score will be returned. If more than one biometric is provided, a list of candidates can be retrieved using getSearchResult.
        - `index` integer
        - `content` string
        - `width` integer
        - `height` integer
        - `resolution` integer
      - `keys` Key[]
        - `id` string: Name of entity identifier.
        - `value` string: Value of entity identifier.
      - `pguids` string[]: This field is a list of PGUIDs. If the list is empty or null, the search will be against the entire database. If it has only one PGUID, the search will be 1:1. It is possible to make 1:1 searches with more than one PGUID.
      - `labelFilters` string[]: Used for 1:N operations. The filters will be compared with the labels field registered by the enroll method.
      - `isLatentSearch` boolean: Flag indicating if the search is a Latent Search.
      - `isULSearch` boolean: Flag indicating if the search is an UL Search.
      - `numberOfCandidates` integer: Number of candidates to be returned.
      - `classificationThreshold` integer: Threshold for either classifying biometric data or marking it as UNKNOWN.
      - `classifications` string[]: Vector containing the classifications to be considered. Defaults to UNKNOWN.
      - `singularities` 'NONE' | 'NO_DELTA_ALL_CORES' | 'ONE_DELTA_NO_CORES' | 'ONE_DELTA_ALL_CORES': Singularities to be considered. Defaults to NONE.
      - `latentSearchOptions` LatentSearchOptions
        - `scoreThreshold` integer: Search score threshold.
        - `rotationAngleThreshold` integer: Rotation angle threshold for searching.
      - `searchOptions` SearchOptions
        - `biometricType` object: biometricType must contain its data and be one of the following values - FINGERPRINT, PALMPRINT, FACE, IRIS, NEWBORN_PALMPRINT, i.e., you must substitute the "biometricType" field name by one of the ENUM names.
          - `scoreThreshold` integer: Search score threshold.
          - `rotationAngleThreshold` integer: Rotation angle threshold for searching.
          - `matcher` 'DEFAULT' | 'MOBILE': Define which ginger preset will be used.
      - `user` string
      - `uguids` string[]: Globally unique ID of the UL. Can be a list of uguids.
      - `liveness` boolean: Flag to request liveness verification on query face image. If activated, a bonafide score will be returned.
    - `failReason` string: Fail message on why search didn't complete.
    - `searchType` 'SAME_FINGERS' | 'ALL_FINGERS' | 'CROSSED_WINDOW_TWEEZERS': Type of finger that was searched.
    - `biometrics` Biometric[]: List of biometrics
      - `index` integer
      - `content` string
      - `width` integer
      - `height` integer
      - `resolution` integer
    - `apiID` string: API ID
    - `gbdsVersion` string: GBDS Version
    - `extractionElapsed` integer: Time to complete the extraction.
    - `searchElapsed` integer: Time to complete the search.
    - `postSearchElapsed` integer: Time to complete the post match.
    - `ulsearch` boolean: Unsolved latent search.
    - `latentSearch` boolean: Latent search.
    - `score` integer: Score of the biometric comparison. Only returned if a single biometric was provided in the payload of the request that created the search.
    - `bonafideScore` integer: Bonafide score of the liveness verification. Only returned if the `liveness` flag was set to `true` in the payload of the request that created the search. Ranges from 0 to 100 (0=attack, 100=genuine).

## Other responses

- `400`: Validation Error
- `500`: Internal Error

---

[API](https://skmtc.dev/griaule/apis/gbds-api.md) - [All operations](https://skmtc.dev/griaule/apis/gbds-api/llms.txt) - [OpenAPI document](https://skmtc.dev/griaule/apis/gbds-api/revisions/fa80f482ec5e?raw)