--- title: "getTransaction" method: GET path: "/people/transactions/{tguid}" tags: ["transaction"] --- # getTransaction `GET /people/transactions/{tguid}` This method returns the data of a transaction, given its TGUID. ## Path parameters - `tguid` string, required ## Query parameters - `enrollFields` string[] - `personFields` string[] - `biometricFields` string[] - `biographicBase` boolean ## Response `200` OK - GetEnrollTransactionsResponse - `data` Enroll - `tguid` string — Global unique ID of the transaction. - `pguid` string — PGUID of the UL candidate. - `status` 'ENQUEUED' | 'PROCESSING' | 'ENROLLED' | 'EXCEPTION' | 'FAILED' | 'PENDING' | 'REFUSED' | 'RESENT_ENROLL' — Status of the enroll transaction. - `timestamp` integer — Timestamp of Enroll creation. - `progress` number, float — Progress of the Enroll operation. - `candidates` Match[] — Identify 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. - `exceptions` Match[] — Exception candidates (verify post match results) - `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. - `person` Person - `pguid` string — Global unique ID of the Person. This attribute is assigned by the AFIS once the person is successfully enrolled - `lastEnrollTguid` string — Global unique ID of the latest transaction on this Person. - `timestamp` integer — Timestamp of the latest transaction on this Person. - `keys` Key[] - `id` string — Name of entity identifier. - `value` string — Value of entity identifier. - `biographics` Biographic[] - `key` string — Biographic key. - `type` 'TEXT' | 'FACE' — Biographic type. It can be TEXT or FACE. - `value` string — Biographic value. Faces are encoded in Base64. - `biometric` Biometric[] - `index` integer - `content` string - `width` integer - `height` integer - `resolution` integer - `auxiliaries` Biometric[] - `index` integer - `content` string - `width` integer - `height` integer - `resolution` integer - `metadata` string[] — Arbitrary data associated with the person. - `labels` string[] — Arbitrary labels associated with a person, which can be used as filters for database queries. - `history` History - `events` HistoryEvent[] - `tguid` string - `timestamp` string, date-time - `type` 'ENROLL' | 'UPDATE' | 'DISABLE_TRANSACTION' | 'DELETE_BIOMETRIC' | 'INCORRECT_ENROLL_TREATMENT' - `biographicBaseStatus` 'UNAVAILABLE' | 'TIMEOUT' | 'UNAUTHORIZED' | 'INVALID_DATA' | 'NOT_FOUND' | 'OK' — Status of the biographic base. - `UNAVAILABLE`: When all Biobase Servers are off. - `TIMEOUT`: When at least one Biobase Server is ON but the call timed out. - `UNAUTHORIZED`: - If the **lookAllServers** conf is **ON**, it indicates that all running servers returned that the API authentication is unauthorized. - If the **lookAllServers** conf is **OFF**, it indicates that the server that received the biographic request returned that the API authentication is unauthorized. - `INVALID_DATA`: The Biobase Server returned that the data request from the API is invalid. It is not supposed to happen if Biobase Server is implemented according to the Biographic Base API. - `NOT_FOUND`: - If the **lookAllServers** conf is **ON**, it indicates that the person keys were not found on all Biobase Servers configured. - If the **lookAllServers** conf is **OFF**, it indicates that person keys were not found on the server that received the biographic request. - `OK`: The Biobase Server returned biographics/face for the given person keys. - `qualityAnalysis` QualityAnalysis - `status` 'PENDING' | 'APPROVED' | 'REJECTED' | 'OK' | 'ERROR' | 'PENDING_DUPLICITIES' — Status of the analysis. - `user` string — Username of whom issued the approval. - `comments` string — User comments on the approval. - `timestamp` integer — Creation time of the approval, be it manual or automatic. If the enroll did not have any anomalies, the approval was automatic, thus this field will be equal to the enroll time. Otherwise, this timestamp will be the time when the user either approved or rejected the enrollment. - `duplicationIssues` DuplicationIssue[] - `indexes` integer[] — List of pairs of duplicated indexes found. - `qualityIssues` QualityIssue[] - `index` integer — Index of the referred finger. - `quality` integer — Quality calculated for the template. - `sequenceControlIssues` SequenceControlIssue[] - `index` integer — Index of the problematic finger. - `matches` object[] — List of sequence control indexes that matched the given finger and its matching score. - `index` integer - `score` integer - `failReason` string — Message describing why the enroll failed - `isCurrentTransaction` boolean — Whether this is the current transaction for the person identified by PGUID. - `refusedReason` EnrollRefusedReason - `matchedPeopleThatAreReferenceInSomeExceptionUnderAnalysis` string[] — List of PGUID of the people that is the reference in some exception under analysis. - `matchedTransactionsThatHaveAnExceptionUnderAnalysis` string[] — List of TGUID of entrant transactions with the exception under analysis. - `bonafideScore` integer — Bonafide score of the liveness verification. Only returned if the `liveness` flag was set to `true` in the payload of the enroll/update request. Ranges from 0 to 100 (0=attack, 100=genuine). ## Other responses - `400` — Validation Error - `404` — Transaction does not exist - `500` — Internal Error --- [API](https://skmtc.net/griaule/apis/gbds-api.md) · [All operations](https://skmtc.net/griaule/apis/gbds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/griaule/gbds-api/versions/fa80f482ec5e/schema)