# Models

## The ResponseMeta object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"ResponseMeta":{"type":"object"}}}}
```

## The ListEnrollTransactionsResponse object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"ListEnrollTransactionsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Enroll"}},"pagination":{"$ref":"#/components/schemas/Pagination"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"httpResponse":{"$ref":"#/components/schemas/HttpResponse"}}},"Enroll":{"type":"object","properties":{"tguid":{"type":"string"},"pguid":{"type":"string"},"status":{"type":"string","enum":["ENQUEUED","PROCESSING","ENROLLED","EXCEPTION","FAILED","PENDING"]},"timestamp":{"type":"integer","format":"int64"},"progress":{"type":"number","format":"float"},"candidates":{"type":"array","items":{"$ref":"#/components/schemas/Match"}},"person":{"$ref":"#/components/schemas/Person"},"qualityAnalysis":{"$ref":"#/components/schemas/QualityAnalysis"},"failReason":{"type":"string"},"extractionIssues":{"type":"array","items":{"$ref":"#/components/schemas/ExtractionIssue"}},"externalIds":{"type":"array","items":{"$ref":"#/components/schemas/ExternalID"}},"isCurrentTransaction":{"type":"boolean"}}},"Match":{"type":"object","properties":{"matchedPersonPguid":{"type":"string"},"matchedPersonTguid":{"type":"string"},"biometricMatches":{"type":"array","items":{"$ref":"#/components/schemas/BiometricMatch"}}}},"BiometricMatch":{"type":"object","properties":{"score":{"type":"integer","format":"int32"},"queryIndex":{"type":"integer","format":"int32"},"referenceIndex":{"type":"integer","format":"int32"},"minutia":{"type":"array","items":{"$ref":"#/components/schemas/Minutiae"}}}},"Minutiae":{"type":"object","properties":{"queryIndex":{"type":"integer","format":"int32"},"referenceIndex":{"type":"integer","format":"int32"}}},"Person":{"type":"object","properties":{"pguid":{"type":"string"},"lastEnrollTguid":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"keys":{"type":"array","items":{"$ref":"#/components/schemas/Key"}},"biographics":{"type":"array","items":{"$ref":"#/components/schemas/Biographic"}},"biometric":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"auxiliaries":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/Biometric"}},"metadata":{"type":"string"},"labels":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"history":{"$ref":"#/components/schemas/History"},"auxiliaryImages":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"ebts":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}}}},"Key":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"Biographic":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"Biometric":{"type":"object","properties":{"source":{"type":"string","enum":["ORIGINAL","TEMPLATE","CONSOLIDATED_TEMPLATE"]},"type":{"type":"string","enum":["FINGERPRINT","PALMPRINT","FOOTPRINT","FACE","IRIS","VOICE","SIGNATURE","SEQUENCE_CONTROL"]},"format":{"type":"string","enum":["RAW","WSQ","JPEG","JPEG2000","PNG","TIFF","GIF","BMP","PCM","WAV","PRIVATE","ISO","ANSI","UNKNOWN","EBTS_TYPE9"]},"properties":{"$ref":"#/components/schemas/BiometricProperties"},"index":{"type":"integer","format":"int32"},"content":{"type":"string"},"quality":{"type":"integer","format":"int32"}}},"BiometricProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"},"ratio":{"type":"number","format":"double"}}},"History":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/HistoryEvent"}}}},"HistoryEvent":{"required":["type"],"type":"object","properties":{"tguid":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"QualityAnalysis":{"type":"object","properties":{"status":{"type":"string","enum":["PENDING","APPROVED","REJECTED","OK","ERROR","PENDING_DUPLICITIES"]},"assignedUser":{"type":"string"},"user":{"type":"string"},"comments":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"duplicationIssues":{"type":"array","items":{"$ref":"#/components/schemas/DuplicationIssue"}},"qualityIssues":{"type":"array","items":{"$ref":"#/components/schemas/QualityIssue"}},"sequenceControlIssues":{"type":"array","items":{"$ref":"#/components/schemas/SequenceControlMismatchIssue"}},"sequenceControlParityIssue":{"$ref":"#/components/schemas/SequenceControlParityIssue"}}},"DuplicationIssue":{"type":"object","properties":{"indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"nextDuplicate":{"type":"array","items":{"type":"integer","format":"int32"}}}},"QualityIssue":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"quality":{"type":"integer","format":"int32"}}},"SequenceControlMismatchIssue":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"matches":{"type":"array","items":{"$ref":"#/components/schemas/SequenceControlMatch"}}}},"SequenceControlMatch":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"}}},"SequenceControlParityIssue":{"type":"object","properties":{"missingIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"ExtractionIssue":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"message":{"type":"string"}}},"ExternalID":{"type":"object","properties":{"name":{"type":"string"},"key":{"type":"string"}}},"Pagination":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"count":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"currentPage":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int64"}}},"ResponseMeta":{"type":"object"},"HttpResponse":{"type":"object","properties":{"httpCode":{"type":"integer","format":"int32"},"body":{"type":"string"}}}}}}
```

## The ExtractionIssue object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"ExtractionIssue":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"message":{"type":"string"}}}}}}
```

## The ExternalID object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"ExternalID":{"type":"object","properties":{"name":{"type":"string"},"key":{"type":"string"}}}}}}
```

## The Enroll object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"Enroll":{"type":"object","properties":{"tguid":{"type":"string"},"pguid":{"type":"string"},"status":{"type":"string","enum":["ENQUEUED","PROCESSING","ENROLLED","EXCEPTION","FAILED","PENDING"]},"timestamp":{"type":"integer","format":"int64"},"progress":{"type":"number","format":"float"},"candidates":{"type":"array","items":{"$ref":"#/components/schemas/Match"}},"person":{"$ref":"#/components/schemas/Person"},"qualityAnalysis":{"$ref":"#/components/schemas/QualityAnalysis"},"failReason":{"type":"string"},"extractionIssues":{"type":"array","items":{"$ref":"#/components/schemas/ExtractionIssue"}},"externalIds":{"type":"array","items":{"$ref":"#/components/schemas/ExternalID"}},"isCurrentTransaction":{"type":"boolean"}}},"Match":{"type":"object","properties":{"matchedPersonPguid":{"type":"string"},"matchedPersonTguid":{"type":"string"},"biometricMatches":{"type":"array","items":{"$ref":"#/components/schemas/BiometricMatch"}}}},"BiometricMatch":{"type":"object","properties":{"score":{"type":"integer","format":"int32"},"queryIndex":{"type":"integer","format":"int32"},"referenceIndex":{"type":"integer","format":"int32"},"minutia":{"type":"array","items":{"$ref":"#/components/schemas/Minutiae"}}}},"Minutiae":{"type":"object","properties":{"queryIndex":{"type":"integer","format":"int32"},"referenceIndex":{"type":"integer","format":"int32"}}},"Person":{"type":"object","properties":{"pguid":{"type":"string"},"lastEnrollTguid":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"keys":{"type":"array","items":{"$ref":"#/components/schemas/Key"}},"biographics":{"type":"array","items":{"$ref":"#/components/schemas/Biographic"}},"biometric":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"auxiliaries":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/Biometric"}},"metadata":{"type":"string"},"labels":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"history":{"$ref":"#/components/schemas/History"},"auxiliaryImages":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"ebts":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}}}},"Key":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"Biographic":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"Biometric":{"type":"object","properties":{"source":{"type":"string","enum":["ORIGINAL","TEMPLATE","CONSOLIDATED_TEMPLATE"]},"type":{"type":"string","enum":["FINGERPRINT","PALMPRINT","FOOTPRINT","FACE","IRIS","VOICE","SIGNATURE","SEQUENCE_CONTROL"]},"format":{"type":"string","enum":["RAW","WSQ","JPEG","JPEG2000","PNG","TIFF","GIF","BMP","PCM","WAV","PRIVATE","ISO","ANSI","UNKNOWN","EBTS_TYPE9"]},"properties":{"$ref":"#/components/schemas/BiometricProperties"},"index":{"type":"integer","format":"int32"},"content":{"type":"string"},"quality":{"type":"integer","format":"int32"}}},"BiometricProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"},"ratio":{"type":"number","format":"double"}}},"History":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/HistoryEvent"}}}},"HistoryEvent":{"required":["type"],"type":"object","properties":{"tguid":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"QualityAnalysis":{"type":"object","properties":{"status":{"type":"string","enum":["PENDING","APPROVED","REJECTED","OK","ERROR","PENDING_DUPLICITIES"]},"assignedUser":{"type":"string"},"user":{"type":"string"},"comments":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"duplicationIssues":{"type":"array","items":{"$ref":"#/components/schemas/DuplicationIssue"}},"qualityIssues":{"type":"array","items":{"$ref":"#/components/schemas/QualityIssue"}},"sequenceControlIssues":{"type":"array","items":{"$ref":"#/components/schemas/SequenceControlMismatchIssue"}},"sequenceControlParityIssue":{"$ref":"#/components/schemas/SequenceControlParityIssue"}}},"DuplicationIssue":{"type":"object","properties":{"indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"nextDuplicate":{"type":"array","items":{"type":"integer","format":"int32"}}}},"QualityIssue":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"quality":{"type":"integer","format":"int32"}}},"SequenceControlMismatchIssue":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"matches":{"type":"array","items":{"$ref":"#/components/schemas/SequenceControlMatch"}}}},"SequenceControlMatch":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"}}},"SequenceControlParityIssue":{"type":"object","properties":{"missingIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"ExtractionIssue":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"message":{"type":"string"}}},"ExternalID":{"type":"object","properties":{"name":{"type":"string"},"key":{"type":"string"}}}}}}
```

## The DuplicationIssue object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"DuplicationIssue":{"type":"object","properties":{"indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"nextDuplicate":{"type":"array","items":{"type":"integer","format":"int32"}}}}}}}
```

## The QualityAnalysis object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"QualityAnalysis":{"type":"object","properties":{"status":{"type":"string","enum":["PENDING","APPROVED","REJECTED","OK","ERROR","PENDING_DUPLICITIES"]},"assignedUser":{"type":"string"},"user":{"type":"string"},"comments":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"duplicationIssues":{"type":"array","items":{"$ref":"#/components/schemas/DuplicationIssue"}},"qualityIssues":{"type":"array","items":{"$ref":"#/components/schemas/QualityIssue"}},"sequenceControlIssues":{"type":"array","items":{"$ref":"#/components/schemas/SequenceControlMismatchIssue"}},"sequenceControlParityIssue":{"$ref":"#/components/schemas/SequenceControlParityIssue"}}},"DuplicationIssue":{"type":"object","properties":{"indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"nextDuplicate":{"type":"array","items":{"type":"integer","format":"int32"}}}},"QualityIssue":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"quality":{"type":"integer","format":"int32"}}},"SequenceControlMismatchIssue":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"matches":{"type":"array","items":{"$ref":"#/components/schemas/SequenceControlMatch"}}}},"SequenceControlMatch":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"}}},"SequenceControlParityIssue":{"type":"object","properties":{"missingIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}}}}}
```

## The QualityIssue object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"QualityIssue":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"quality":{"type":"integer","format":"int32"}}}}}}
```

## The SequenceControlMatch object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"SequenceControlMatch":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"}}}}}}
```

## The SequenceControlMismatchIssue object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"SequenceControlMismatchIssue":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"matches":{"type":"array","items":{"$ref":"#/components/schemas/SequenceControlMatch"}}}},"SequenceControlMatch":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"}}}}}}
```

## The SequenceControlParityIssue object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"SequenceControlParityIssue":{"type":"object","properties":{"missingIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}}}}}
```

## The GetEnrollTransactionsResponse object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"GetEnrollTransactionsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Enroll"},"httpResponse":{"$ref":"#/components/schemas/HttpResponse"}}},"Enroll":{"type":"object","properties":{"tguid":{"type":"string"},"pguid":{"type":"string"},"status":{"type":"string","enum":["ENQUEUED","PROCESSING","ENROLLED","EXCEPTION","FAILED","PENDING"]},"timestamp":{"type":"integer","format":"int64"},"progress":{"type":"number","format":"float"},"candidates":{"type":"array","items":{"$ref":"#/components/schemas/Match"}},"person":{"$ref":"#/components/schemas/Person"},"qualityAnalysis":{"$ref":"#/components/schemas/QualityAnalysis"},"failReason":{"type":"string"},"extractionIssues":{"type":"array","items":{"$ref":"#/components/schemas/ExtractionIssue"}},"externalIds":{"type":"array","items":{"$ref":"#/components/schemas/ExternalID"}},"isCurrentTransaction":{"type":"boolean"}}},"Match":{"type":"object","properties":{"matchedPersonPguid":{"type":"string"},"matchedPersonTguid":{"type":"string"},"biometricMatches":{"type":"array","items":{"$ref":"#/components/schemas/BiometricMatch"}}}},"BiometricMatch":{"type":"object","properties":{"score":{"type":"integer","format":"int32"},"queryIndex":{"type":"integer","format":"int32"},"referenceIndex":{"type":"integer","format":"int32"},"minutia":{"type":"array","items":{"$ref":"#/components/schemas/Minutiae"}}}},"Minutiae":{"type":"object","properties":{"queryIndex":{"type":"integer","format":"int32"},"referenceIndex":{"type":"integer","format":"int32"}}},"Person":{"type":"object","properties":{"pguid":{"type":"string"},"lastEnrollTguid":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"keys":{"type":"array","items":{"$ref":"#/components/schemas/Key"}},"biographics":{"type":"array","items":{"$ref":"#/components/schemas/Biographic"}},"biometric":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"auxiliaries":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/Biometric"}},"metadata":{"type":"string"},"labels":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"history":{"$ref":"#/components/schemas/History"},"auxiliaryImages":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"ebts":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}}}},"Key":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"Biographic":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"Biometric":{"type":"object","properties":{"source":{"type":"string","enum":["ORIGINAL","TEMPLATE","CONSOLIDATED_TEMPLATE"]},"type":{"type":"string","enum":["FINGERPRINT","PALMPRINT","FOOTPRINT","FACE","IRIS","VOICE","SIGNATURE","SEQUENCE_CONTROL"]},"format":{"type":"string","enum":["RAW","WSQ","JPEG","JPEG2000","PNG","TIFF","GIF","BMP","PCM","WAV","PRIVATE","ISO","ANSI","UNKNOWN","EBTS_TYPE9"]},"properties":{"$ref":"#/components/schemas/BiometricProperties"},"index":{"type":"integer","format":"int32"},"content":{"type":"string"},"quality":{"type":"integer","format":"int32"}}},"BiometricProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"},"ratio":{"type":"number","format":"double"}}},"History":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/HistoryEvent"}}}},"HistoryEvent":{"required":["type"],"type":"object","properties":{"tguid":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"QualityAnalysis":{"type":"object","properties":{"status":{"type":"string","enum":["PENDING","APPROVED","REJECTED","OK","ERROR","PENDING_DUPLICITIES"]},"assignedUser":{"type":"string"},"user":{"type":"string"},"comments":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"duplicationIssues":{"type":"array","items":{"$ref":"#/components/schemas/DuplicationIssue"}},"qualityIssues":{"type":"array","items":{"$ref":"#/components/schemas/QualityIssue"}},"sequenceControlIssues":{"type":"array","items":{"$ref":"#/components/schemas/SequenceControlMismatchIssue"}},"sequenceControlParityIssue":{"$ref":"#/components/schemas/SequenceControlParityIssue"}}},"DuplicationIssue":{"type":"object","properties":{"indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"nextDuplicate":{"type":"array","items":{"type":"integer","format":"int32"}}}},"QualityIssue":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"quality":{"type":"integer","format":"int32"}}},"SequenceControlMismatchIssue":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"matches":{"type":"array","items":{"$ref":"#/components/schemas/SequenceControlMatch"}}}},"SequenceControlMatch":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"}}},"SequenceControlParityIssue":{"type":"object","properties":{"missingIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"ExtractionIssue":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"message":{"type":"string"}}},"ExternalID":{"type":"object","properties":{"name":{"type":"string"},"key":{"type":"string"}}},"HttpResponse":{"type":"object","properties":{"httpCode":{"type":"integer","format":"int32"},"body":{"type":"string"}}}}}}
```

## The TreatExceptionsValidatedRequest object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"TreatExceptionsValidatedRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExceptionTreatment"},"meta":{"$ref":"#/components/schemas/Meta"},"subject":{"$ref":"#/components/schemas/Subject"},"validatedExceptionTreatment":{"$ref":"#/components/schemas/ValidatedExceptionTreatment"}}},"ExceptionTreatment":{"type":"object","properties":{"enrollTguid":{"type":"string"},"exceptionPguid":{"type":"string"},"exceptionAnalysis":{"$ref":"#/components/schemas/ExceptionAnalysis"},"referenceIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"ExceptionAnalysis":{"type":"object","properties":{"status":{"type":"string","enum":["ANALYSIS","DIFFERENT_FINGERS","SAME_FINGERS","INCORRECT_ENROLL","RECOLLECT","MERGE_TRANSACTIONS","APPROVE","REJECT","ERROR"]},"exceptionTimestamp":{"type":"integer","format":"int64"},"user":{"type":"string"},"comments":{"type":"string"}}},"Meta":{"type":"object","properties":{"timeout":{"type":"integer","format":"int32"},"discardReference":{"type":"boolean"}}},"Subject":{"type":"object","properties":{"name":{"type":"string"},"roles":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Role"}},"permissions":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Permission"}}}},"Role":{"type":"object"},"Permission":{"type":"object"},"ValidatedExceptionTreatment":{"type":"object","properties":{"enrollTguid":{"type":"string"},"exceptionPguid":{"type":"string"},"exceptionAnalysis":{"$ref":"#/components/schemas/ExceptionAnalysis"},"referenceIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}}}}}
```

## The Meta object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"Meta":{"type":"object","properties":{"timeout":{"type":"integer","format":"int32"},"discardReference":{"type":"boolean"}}}}}}
```

## The Permission object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"Permission":{"type":"object"}}}}
```

## The Role object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"Role":{"type":"object"}}}}
```

## The Subject object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"Subject":{"type":"object","properties":{"name":{"type":"string"},"roles":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Role"}},"permissions":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Permission"}}}},"Role":{"type":"object"},"Permission":{"type":"object"}}}}
```

## The ValidatedExceptionTreatment object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"ValidatedExceptionTreatment":{"type":"object","properties":{"enrollTguid":{"type":"string"},"exceptionPguid":{"type":"string"},"exceptionAnalysis":{"$ref":"#/components/schemas/ExceptionAnalysis"},"referenceIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"ExceptionAnalysis":{"type":"object","properties":{"status":{"type":"string","enum":["ANALYSIS","DIFFERENT_FINGERS","SAME_FINGERS","INCORRECT_ENROLL","RECOLLECT","MERGE_TRANSACTIONS","APPROVE","REJECT","ERROR"]},"exceptionTimestamp":{"type":"integer","format":"int64"},"user":{"type":"string"},"comments":{"type":"string"}}}}}}
```

## The ExceptionTreatment object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"ExceptionTreatment":{"type":"object","properties":{"enrollTguid":{"type":"string"},"exceptionPguid":{"type":"string"},"exceptionAnalysis":{"$ref":"#/components/schemas/ExceptionAnalysis"},"referenceIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"ExceptionAnalysis":{"type":"object","properties":{"status":{"type":"string","enum":["ANALYSIS","DIFFERENT_FINGERS","SAME_FINGERS","INCORRECT_ENROLL","RECOLLECT","MERGE_TRANSACTIONS","APPROVE","REJECT","ERROR"]},"exceptionTimestamp":{"type":"integer","format":"int64"},"user":{"type":"string"},"comments":{"type":"string"}}}}}}
```

## The HttpResponse object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"HttpResponse":{"type":"object","properties":{"httpCode":{"type":"integer","format":"int32"},"body":{"type":"string"}}}}}}
```

## The Pagination object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"Pagination":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"count":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"currentPage":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int64"}}}}}}
```

## The Exception object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"Exception":{"type":"object","properties":{"enrollPguid":{"type":"string"},"enrollTguid":{"type":"string"},"transactionTimestamp":{"type":"integer","format":"int64"},"match":{"$ref":"#/components/schemas/Match"},"assignedUser":{"type":"string"},"exceptionAnalysis":{"$ref":"#/components/schemas/ExceptionAnalysis"},"transactionType":{"type":"string","enum":["ENROLL","UPDATE"]}}},"Match":{"type":"object","properties":{"matchedPersonPguid":{"type":"string"},"matchedPersonTguid":{"type":"string"},"biometricMatches":{"type":"array","items":{"$ref":"#/components/schemas/BiometricMatch"}}}},"BiometricMatch":{"type":"object","properties":{"score":{"type":"integer","format":"int32"},"queryIndex":{"type":"integer","format":"int32"},"referenceIndex":{"type":"integer","format":"int32"},"minutia":{"type":"array","items":{"$ref":"#/components/schemas/Minutiae"}}}},"Minutiae":{"type":"object","properties":{"queryIndex":{"type":"integer","format":"int32"},"referenceIndex":{"type":"integer","format":"int32"}}},"ExceptionAnalysis":{"type":"object","properties":{"status":{"type":"string","enum":["ANALYSIS","DIFFERENT_FINGERS","SAME_FINGERS","INCORRECT_ENROLL","RECOLLECT","MERGE_TRANSACTIONS","APPROVE","REJECT","ERROR"]},"exceptionTimestamp":{"type":"integer","format":"int64"},"user":{"type":"string"},"comments":{"type":"string"}}}}}}
```

## The ExceptionAnalysis object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"ExceptionAnalysis":{"type":"object","properties":{"status":{"type":"string","enum":["ANALYSIS","DIFFERENT_FINGERS","SAME_FINGERS","INCORRECT_ENROLL","RECOLLECT","MERGE_TRANSACTIONS","APPROVE","REJECT","ERROR"]},"exceptionTimestamp":{"type":"integer","format":"int64"},"user":{"type":"string"},"comments":{"type":"string"}}}}}}
```

## The Match object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"Match":{"type":"object","properties":{"matchedPersonPguid":{"type":"string"},"matchedPersonTguid":{"type":"string"},"biometricMatches":{"type":"array","items":{"$ref":"#/components/schemas/BiometricMatch"}}}},"BiometricMatch":{"type":"object","properties":{"score":{"type":"integer","format":"int32"},"queryIndex":{"type":"integer","format":"int32"},"referenceIndex":{"type":"integer","format":"int32"},"minutia":{"type":"array","items":{"$ref":"#/components/schemas/Minutiae"}}}},"Minutiae":{"type":"object","properties":{"queryIndex":{"type":"integer","format":"int32"},"referenceIndex":{"type":"integer","format":"int32"}}}}}}
```

## The BiometricMatch object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"BiometricMatch":{"type":"object","properties":{"score":{"type":"integer","format":"int32"},"queryIndex":{"type":"integer","format":"int32"},"referenceIndex":{"type":"integer","format":"int32"},"minutia":{"type":"array","items":{"$ref":"#/components/schemas/Minutiae"}}}},"Minutiae":{"type":"object","properties":{"queryIndex":{"type":"integer","format":"int32"},"referenceIndex":{"type":"integer","format":"int32"}}}}}}
```

## The Minutiae object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"Minutiae":{"type":"object","properties":{"queryIndex":{"type":"integer","format":"int32"},"referenceIndex":{"type":"integer","format":"int32"}}}}}}
```

## The Data object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"Data":{"type":"object","properties":{"status":{"type":"string","enum":["OK","ENQUEUED","ERROR"]},"treatTguid":{"type":"string"},"failReason":{"type":"string"}}}}}}
```

## The Person object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"Person":{"type":"object","properties":{"pguid":{"type":"string"},"lastEnrollTguid":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"keys":{"type":"array","items":{"$ref":"#/components/schemas/Key"}},"biographics":{"type":"array","items":{"$ref":"#/components/schemas/Biographic"}},"biometric":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"auxiliaries":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/Biometric"}},"metadata":{"type":"string"},"labels":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"history":{"$ref":"#/components/schemas/History"},"auxiliaryImages":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"ebts":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}}}},"Key":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"Biographic":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"Biometric":{"type":"object","properties":{"source":{"type":"string","enum":["ORIGINAL","TEMPLATE","CONSOLIDATED_TEMPLATE"]},"type":{"type":"string","enum":["FINGERPRINT","PALMPRINT","FOOTPRINT","FACE","IRIS","VOICE","SIGNATURE","SEQUENCE_CONTROL"]},"format":{"type":"string","enum":["RAW","WSQ","JPEG","JPEG2000","PNG","TIFF","GIF","BMP","PCM","WAV","PRIVATE","ISO","ANSI","UNKNOWN","EBTS_TYPE9"]},"properties":{"$ref":"#/components/schemas/BiometricProperties"},"index":{"type":"integer","format":"int32"},"content":{"type":"string"},"quality":{"type":"integer","format":"int32"}}},"BiometricProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"},"ratio":{"type":"number","format":"double"}}},"History":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/HistoryEvent"}}}},"HistoryEvent":{"required":["type"],"type":"object","properties":{"tguid":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}}}}}
```

## The History object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"History":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/HistoryEvent"}}}},"HistoryEvent":{"required":["type"],"type":"object","properties":{"tguid":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}}}}}
```

## The HistoryEvent object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"HistoryEvent":{"required":["type"],"type":"object","properties":{"tguid":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}}}}}
```

## The Key object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"Key":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The Biographic object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"Biographic":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The Biometric object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"Biometric":{"type":"object","properties":{"source":{"type":"string","enum":["ORIGINAL","TEMPLATE","CONSOLIDATED_TEMPLATE"]},"type":{"type":"string","enum":["FINGERPRINT","PALMPRINT","FOOTPRINT","FACE","IRIS","VOICE","SIGNATURE","SEQUENCE_CONTROL"]},"format":{"type":"string","enum":["RAW","WSQ","JPEG","JPEG2000","PNG","TIFF","GIF","BMP","PCM","WAV","PRIVATE","ISO","ANSI","UNKNOWN","EBTS_TYPE9"]},"properties":{"$ref":"#/components/schemas/BiometricProperties"},"index":{"type":"integer","format":"int32"},"content":{"type":"string"},"quality":{"type":"integer","format":"int32"}}},"BiometricProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"},"ratio":{"type":"number","format":"double"}}}}}}
```

## The BiometricProperties object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"BiometricProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"},"ratio":{"type":"number","format":"double"}}}}}}
```

## The GetPeopleResponse object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"GetPeopleResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Person"},"httpResponse":{"$ref":"#/components/schemas/HttpResponse"}}},"Person":{"type":"object","properties":{"pguid":{"type":"string"},"lastEnrollTguid":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"keys":{"type":"array","items":{"$ref":"#/components/schemas/Key"}},"biographics":{"type":"array","items":{"$ref":"#/components/schemas/Biographic"}},"biometric":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"auxiliaries":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/Biometric"}},"metadata":{"type":"string"},"labels":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"history":{"$ref":"#/components/schemas/History"},"auxiliaryImages":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"ebts":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}}}},"Key":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"Biographic":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"Biometric":{"type":"object","properties":{"source":{"type":"string","enum":["ORIGINAL","TEMPLATE","CONSOLIDATED_TEMPLATE"]},"type":{"type":"string","enum":["FINGERPRINT","PALMPRINT","FOOTPRINT","FACE","IRIS","VOICE","SIGNATURE","SEQUENCE_CONTROL"]},"format":{"type":"string","enum":["RAW","WSQ","JPEG","JPEG2000","PNG","TIFF","GIF","BMP","PCM","WAV","PRIVATE","ISO","ANSI","UNKNOWN","EBTS_TYPE9"]},"properties":{"$ref":"#/components/schemas/BiometricProperties"},"index":{"type":"integer","format":"int32"},"content":{"type":"string"},"quality":{"type":"integer","format":"int32"}}},"BiometricProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"},"ratio":{"type":"number","format":"double"}}},"History":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/HistoryEvent"}}}},"HistoryEvent":{"required":["type"],"type":"object","properties":{"tguid":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"HttpResponse":{"type":"object","properties":{"httpCode":{"type":"integer","format":"int32"},"body":{"type":"string"}}}}}}
```

## The TreatExceptionsResponse object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"TreatExceptionsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Data"},"httpResponse":{"$ref":"#/components/schemas/HttpResponse"}}},"Data":{"type":"object","properties":{"status":{"type":"string","enum":["OK","ENQUEUED","ERROR"]},"treatTguid":{"type":"string"},"failReason":{"type":"string"}}},"HttpResponse":{"type":"object","properties":{"httpCode":{"type":"integer","format":"int32"},"body":{"type":"string"}}}}}}
```

## The ListExceptionsResponse object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"ListExceptionsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Exception"}},"pagination":{"$ref":"#/components/schemas/Pagination"},"httpResponse":{"$ref":"#/components/schemas/HttpResponse"}}},"Exception":{"type":"object","properties":{"enrollPguid":{"type":"string"},"enrollTguid":{"type":"string"},"transactionTimestamp":{"type":"integer","format":"int64"},"match":{"$ref":"#/components/schemas/Match"},"assignedUser":{"type":"string"},"exceptionAnalysis":{"$ref":"#/components/schemas/ExceptionAnalysis"},"transactionType":{"type":"string","enum":["ENROLL","UPDATE"]}}},"Match":{"type":"object","properties":{"matchedPersonPguid":{"type":"string"},"matchedPersonTguid":{"type":"string"},"biometricMatches":{"type":"array","items":{"$ref":"#/components/schemas/BiometricMatch"}}}},"BiometricMatch":{"type":"object","properties":{"score":{"type":"integer","format":"int32"},"queryIndex":{"type":"integer","format":"int32"},"referenceIndex":{"type":"integer","format":"int32"},"minutia":{"type":"array","items":{"$ref":"#/components/schemas/Minutiae"}}}},"Minutiae":{"type":"object","properties":{"queryIndex":{"type":"integer","format":"int32"},"referenceIndex":{"type":"integer","format":"int32"}}},"ExceptionAnalysis":{"type":"object","properties":{"status":{"type":"string","enum":["ANALYSIS","DIFFERENT_FINGERS","SAME_FINGERS","INCORRECT_ENROLL","RECOLLECT","MERGE_TRANSACTIONS","APPROVE","REJECT","ERROR"]},"exceptionTimestamp":{"type":"integer","format":"int64"},"user":{"type":"string"},"comments":{"type":"string"}}},"Pagination":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"count":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"currentPage":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int64"}}},"HttpResponse":{"type":"object","properties":{"httpCode":{"type":"integer","format":"int32"},"body":{"type":"string"}}}}}}
```

## The PingResponse object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"PingResponse":{"type":"object","properties":{"data":{"type":"string"},"httpResponse":{"$ref":"#/components/schemas/HttpResponse"}}},"HttpResponse":{"type":"object","properties":{"httpCode":{"type":"integer","format":"int32"},"body":{"type":"string"}}}}}}
```

## The SpidTransactionResult object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"SpidTransactionResult":{"type":"object","properties":{"status":{"type":"string","enum":["OK,","AUTHENTICATION_FAILED","DELETE_NOT_OK","DELETE_OK","DELETE_PENDING","ENROLL_OK","ENROLL_CONTIGENCY_OK","ENROLL_CACHE_OK","ENROLL_ANOMALY","ENROLL_ANOMALY_BLACKLIST","ENROLL_IN_PROGRESS","ENROLL_FAILED","UPDATE_OK","UPDATE_CONTIGENCY_OK","UPDATE_CACHE_OK","UPDATE_ANOMALY","UPDATE_ANOMALY_BLACKLIST","UPDATE_IN_PROGRESS","UPDATE_FAILED","UPDATE_REFUSED","SEARCH_MATCH","SEARCH_NOT_MATCH","SEARCH_IN_PROGRESS","SEARCH_FAILED","PERSON_FRAUD","RECOLLECT","INCORRECT_ENROLL","ERROR"]},"message":{"type":"string"},"tcn":{"type":"string"}}}}}}
```

## The SpidTransaction object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"SpidTransaction":{"type":"object","properties":{"idn":{"type":"string"},"biometrics":{"type":"array","items":{"$ref":"#/components/schemas/Biometrics"}},"protocol":{"type":"string"},"capture-date":{"type":"integer","format":"int64"},"capture-responsible":{"type":"string"},"amputated-indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"bandaged-indexes":{"type":"array","items":{"type":"integer","format":"int32"}},"ignore-face-valuation":{"type":"boolean"}}},"Biometrics":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"content":{"type":"string"},"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"}}}}}}
```

## The Biometrics object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"Biometrics":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"content":{"type":"string"},"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"}}}}}}
```

## The ConsultaIdnResponse object

```json
{"openapi":"3.0.1","info":{"title":"PSBio API Documentation","version":"5.6.7"},"components":{"schemas":{"ConsultaIdnResponse":{"type":"object","properties":{"idn":{"type":"string","description":"Unique identifier of the biometric traits owner that was consulted."},"psbioOwner":{"type":"string","description":"Name of the PSBio that owns the consulted IDN."},"indexes":{"type":"array","description":"List of biometric indexes associated with the consulted IDN.","items":{"type":"integer"}}}}}}}
```