# Models

## The Error object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"Error":{"type":"object","properties":{"type":{"type":"string","enum":["VALIDATION_ERROR","PROCESSING_ERROR","INTERNAL_ERROR","SECURITY_ERROR"]},"message":{"type":"string"}}}}}}
```

## The ErrorResponse object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"type":{"type":"string","enum":["VALIDATION_ERROR","PROCESSING_ERROR","INTERNAL_ERROR","SECURITY_ERROR"]}}},"Error":{"type":"object","properties":{"type":{"type":"string","enum":["VALIDATION_ERROR","PROCESSING_ERROR","INTERNAL_ERROR","SECURITY_ERROR"]},"message":{"type":"string"}}}}}}
```

## The Biometric object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"Biometric":{"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 MissingBiometric object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"MissingBiometric":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["AMPUTATED","UNAVAILABLE"]},"reason":{"type":"string"}}}}}}
```

## The BiometricGetTransaction object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"BiometricGetTransaction":{"type":"object","properties":{"index":{"type":"integer","format":"int32"}}}}}}
```

## The LegacyTransaction object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"LegacyTransaction":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"operatorId":{"type":"string"},"type":{"type":"string","enum":["ENROLL","UPDATE","SEARCH","VERIFY","DELETE"]},"status":{"type":"string","enum":["OK","SEARCH_PENDING","SEARCH_ENQUEUED","SEARCH_MATCH","SEARCH_NOT_MATCH","SEARCH_FAILED","ENROLL_PENDING","ENROLL_ENQUEUED","ENROLL_CACHE_OK","ENROLL_OK","ENROLL_FAILED","ENROLL_EXCEPTION","DELETE_OK","DELETE_FAILED","DELETE_PENDING","REMOTE_CAPTURE_PENDING","FRAUD","ERROR","ENROLL_REJECTED","PERSON_NOT_FOUND"]},"timestamp":{"type":"integer","format":"int64"},"gbdsTguid":{"type":"string"},"spidxTguid":{"type":"string"},"psbioTcn":{"type":"string"},"biometrics":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"missingBiometrics":{"type":"array","items":{"$ref":"#/components/schemas/MissingBiometric"}}}},"Biometric":{"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"}}},"MissingBiometric":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["AMPUTATED","UNAVAILABLE"]},"reason":{"type":"string"}}}}}}
```

## The Transaction object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"Transaction":{"type":"object","properties":{"anomalies":{"type":"array","items":{"$ref":"#/components/schemas/Candidate"}},"anomalies-status":{"type":"string","enum":["ANALYSIS","DIFFERENT_FINGERS","SAME_FINGERS","INCORRECT_ENROLL","RECOLLECT","MERGE_TRANSACTIONS","ERROR"]},"person-guid":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"transaction-guid":{"type":"string"},"transaction-type":{"type":"string","enum":["AUTHENTICATE","CLOSE_SESSION","ENROLL","UPDATE","SEARCH","DELETE","DELETE_BIOMETRIC","DELETE_AUXILIARY","DELETE_BIOGRAPHIC"]}}},"Candidate":{"type":"object","properties":{"anomaly":{"$ref":"#/components/schemas/Anomaly"},"person-guid":{"type":"string"},"transaction-guid":{"type":"string"},"match-info":{"type":"array","items":{"$ref":"#/components/schemas/MatchInfo"}},"biometric-count":{"type":"integer","format":"int64"}}},"Anomaly":{"type":"object","properties":{"status":{"type":"string","enum":["ANALYSIS","DIFFERENT_FINGERS","SAME_FINGERS","INCORRECT_ENROLL","RECOLLECT","MERGE_TRANSACTIONS","ERROR"]},"user":{"type":"string"},"comments":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"MatchInfo":{"type":"object","properties":{"score":{"type":"integer","format":"int32"},"matches":{"type":"array","items":{"$ref":"#/components/schemas/Match"}},"query-index":{"type":"integer","format":"int32"},"reference-index":{"type":"integer","format":"int32"}}},"Match":{"type":"object","properties":{"query":{"type":"integer","format":"int32"},"reference":{"type":"integer","format":"int32"}}}}}}
```

## The ExternalResult object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"ExternalResult":{"type":"object","properties":{"id":{"type":"string"},"message":{"type":"string"},"status":{"type":"string","enum":["OK","SEARCH_PENDING","SEARCH_ENQUEUED","SEARCH_MATCH","SEARCH_NOT_MATCH","SEARCH_FAILED","ENROLL_PENDING","ENROLL_ENQUEUED","ENROLL_CACHE_OK","ENROLL_OK","ENROLL_FAILED","ENROLL_EXCEPTION","DELETE_OK","DELETE_FAILED","DELETE_PENDING","REMOTE_CAPTURE_ACCEPTED","REMOTE_CAPTURE_REFUSED","REMOTE_CAPTURE_PENDING","REMOTE_CAPTURE_AVAILABLE","REMOTE_CAPTURE_STORED","FRAUD","ERROR","ENROLL_REJECTED","PERSON_NOT_FOUND"]}}}}}}
```

## The UserTransaction object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"UserTransaction":{"type":"object","properties":{"biometrics":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"missingBiometrics":{"type":"array","items":{"$ref":"#/components/schemas/MissingBiometric"}},"userId":{"type":"string"},"operatorId":{"type":"string"},"timestamp":{"type":"integer","format":"int64"}}},"Biometric":{"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"}}},"MissingBiometric":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["AMPUTATED","UNAVAILABLE"]},"reason":{"type":"string"}}}}}}
```

## The GetTransactionResponse object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"GetTransactionResponse":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["OK","SEARCH_PENDING","SEARCH_ENQUEUED","SEARCH_MATCH","SEARCH_NOT_MATCH","SEARCH_FAILED","ENROLL_PENDING","ENROLL_ENQUEUED","ENROLL_CACHE_OK","ENROLL_OK","ENROLL_FAILED","ENROLL_EXCEPTION","DELETE_OK","DELETE_FAILED","DELETE_PENDING","REMOTE_CAPTURE_ACCEPTED","REMOTE_CAPTURE_REFUSED","REMOTE_CAPTURE_PENDING","REMOTE_CAPTURE_AVAILABLE","REMOTE_CAPTURE_STORED","FRAUD","ERROR","ENROLL_REJECTED","PERSON_NOT_FOUND"]},"type":{"type":"string","enum":["ENROLL","UPDATE","SEARCH","VERIFY","DELETE"]},"transaction":{"type":"object","properties":{"Biometrics":{"type":"array","items":{"$ref":"#/components/schemas/BiometricGetTransaction"}},"MissingBiometrics":{"type":"array","items":{"$ref":"#/components/schemas/MissingBiometric"}}}}}},"BiometricGetTransaction":{"type":"object","properties":{"index":{"type":"integer","format":"int32"}}},"MissingBiometric":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["AMPUTATED","UNAVAILABLE"]},"reason":{"type":"string"}}}}}}
```

## The LegacyPerson object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"LegacyPerson":{"type":"object","properties":{"biometrics":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"missingBiometrics":{"type":"array","items":{"$ref":"#/components/schemas/MissingBiometric"}},"userId":{"type":"string"},"idn":{"type":"string"}}},"Biometric":{"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"}}},"MissingBiometric":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["AMPUTATED","UNAVAILABLE"]},"reason":{"type":"string"}}}}}}
```

## The Person object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"Person":{"type":"object","properties":{"approvement":{"$ref":"#/components/schemas/Approvement"},"auxiliaries":{"type":"array","items":{"$ref":"#/components/schemas/ContentData"}},"biographics":{"type":"array","items":{"$ref":"#/components/schemas/BiographicData"}},"biometrics":{"type":"array","items":{"$ref":"#/components/schemas/ContentData"}},"enroll-status":{"type":"string","enum":["ENQUEUED","PROCESSING","ENROLLED","ANOMALY","FAILED","PENDING"]},"keys":{"type":"array","items":{"$ref":"#/components/schemas/Key"}},"labels":{"type":"array","items":{"type":"string"}},"metadata":{"type":"string","format":"byte"},"person-guid":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"transaction-guid":{"type":"string"}}},"Approvement":{"type":"object","properties":{"comments":{"type":"string"},"status":{"type":"string","enum":["PENDING","APPROVED","REJECTED"]},"timestamp":{"type":"string","format":"date-time"},"user":{"type":"string"}}},"ContentData":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"content":{"type":"string"},"properties":{"$ref":"#/components/schemas/ContentProperties"},"source":{"type":"string","enum":["ORIGINAL","TEMPLATE","CONSOLIDATED_TEMPLATE"]},"type":{"type":"string","enum":["FINGERPRINT","PALMPRINT","FOOTPRINT","FACE","IRIS","VOICE","SIGNATURE","SEQUENCE_CONTROL","PLAIN_TEXT","IMAGE","AUDIO","VIDEO","NONE","OTHER","UNKNOWN"]},"format":{"type":"string","enum":["ASCII","BASE64","RAW","WSQ","PNG","JPEG","JPEG2000","TIFF","GIF","BMP","_3GP","AAC","AIFF","M4A","MP3","OGG","PCM","WAV","WMA","MKV","FLV","AVI","MOV","WMV","MP4","MPEG","MPG","M4V","PRIVATE","ISO","ANSI","NONE","OTHER","UNKNOWN"]}}},"ContentProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32","deprecated":true},"height":{"type":"integer","format":"int32","deprecated":true},"resolution":{"type":"integer","format":"int32","deprecated":true},"ratio":{"type":"number","format":"double","deprecated":true},"latent":{"type":"boolean","deprecated":true},"description":{"type":"string"},"quality":{"type":"integer","format":"int32"},"index":{"type":"string","enum":["NONE","OTHER","UNKNOWN","LEFT_LITTLE","LEFT_RING","LEFT_MIDDLE","LEFT_INDEX","LEFT_THUMB","RIGHT_THUMB","RIGHT_INDEX","RIGHT_MIDDLE","RIGHT_RING","RIGHT_LITTLE","LEFT_TOPS_CTRL","RIGHT_TOPS_CTRL","LEFT_THUMB_CTRL","RIGHT_THUMB_CTRL","LEFT_TOP","LEFT_BOTTOM","LEFT_WRITER","RIGHT_TOP","RIGHT_BOTTOM","RIGHT_WRITER","LEFT_IRIS","RIGHT_IRIS","FACE_FRONTAL","LEFT_SIDE","RIGHT_SIDE","MUGSHOT_FRONTAL","MUGSHOT_LEFT_SIDE","MUGSHOT_RIGHT_SIDE","TATOO","SCAR","MARK","SIGNATURE"]},"location":{"type":"string","enum":["NONE","OTHER","UNKNOWN","FINGERPRINT","PALM","FOOT","FACE","BACK_HEAD","LEFT_FRONT_NECK","RIGHT_FRONT_NECK","LEFT_SHOLDER","RIGHT_SHOLDER","LEFT_CHEST","RIGHT_CHEST","LEFT_ARM","RIGHT_ARM","LEFT_FOREARM","RIGHT_FOREARM","LEFT_WRIST","RIGHT_WRIST","LEFT_HAND","RIGHT_HAND","STOMACH","ABDOMEN","LEFT_RIB","RIGHT_RIB","LEFT_WAIST","RIGHT_WAIST","GROIN","LEFT_THIGH","RIGHT_THIGH","LEFT_KNEE","RIGHT_KNEE","LEFT_LOWER_LEG","RIGHT_LOWER_LEG","LEFT_FOOT","RIGHT_FOOT","LEFT_BACK_NECK","RIGHT_BACK_NECK","LEFT_BACK_SHOLDER","RIGHT_BACK_SHOLDER","LEFT_UPPER_BACK","RIGHT_UPPER_BACK","LEFT_LOWER_BACK","RIGHT_LOWER_BACK","LEFT_GLUTEUS","RIGHT_GLUTEUS","LEFT_REAR_ARM","RIGHT_REAR_ARM","LEFT_ELBOW","RIGHT_ELBOW","LEFT_REAR_FOREARM","RIGHT_REAR_FOREARM","LEFT_REAR_LEG","RIGHT_REAR_LEG","LEFT_CALF","RIGHT_CALF","LEFT_ANKLE","RIGHT_ANKLE","LEFT_HEEL","RIGHT_HEEL"]},"anomaly":{"type":"string","enum":["NONE","ADACTILY","ANKYLOSIS","ECTRODACTILY","HIPERFALANGIA","POLYDACTILY","MICRODACTILY","MACRODACTILY","SINDATILY","DAMAGED","BANDAGED","IGNORED","AMPUTATED"]},"metadata":{"type":"array","items":{"type":"string","format":"byte"}},"capture-date":{"type":"string","format":"date-time"},"capture-type":{"type":"string","enum":["FLAT","FLAT_TWO_FINGERS","ROLLED","LEFT_TOP","LEFT_BOTTOM","LEFT_WRITER","RIGHT_TOP","RIGHT_BOTTOM","RIGHT_WRITER","LIVE","FILE"]},"template-properties":{"$ref":"#/components/schemas/TemplateProperties"},"image-properties":{"$ref":"#/components/schemas/ImageProperties"},"audio-properties":{"$ref":"#/components/schemas/AudioProperties"},"video-properties":{"$ref":"#/components/schemas/VideoProperties"},"fingerprint-properties":{"$ref":"#/components/schemas/FingerprintProperties"},"face-properties":{"$ref":"#/components/schemas/FaceProperties"},"signature-properties":{"$ref":"#/components/schemas/SignatureProperties"}}},"TemplateProperties":{"type":"object","properties":{"resolution":{"type":"integer","format":"int32"}}},"ImageProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"},"ratio":{"type":"number","format":"double"}}},"AudioProperties":{"type":"object","properties":{"codec":{"type":"string","enum":["PCM","FLAC","AC3","DTS","MP3","AAC","WMA","VOX","DSS","OTHER"]},"channels":{"type":"integer","format":"int32"},"sample-size":{"type":"integer","format":"int32"},"sample-rate":{"type":"integer","format":"int32"},"bit-rate":{"type":"integer","format":"int32"}}},"VideoProperties":{"type":"object","properties":{"audio-codec":{"type":"string","enum":["PCM","FLAC","AC3","DTS","MP3","AAC","WMA","VOX","DSS","OTHER"]},"video-codec":{"type":"string","enum":["X265","X264","XVID","MPEG4","_3IVX","WMV"]},"audio-bit-rate":{"type":"integer","format":"int32"},"video-bit-rate":{"type":"integer","format":"int32"},"total-bit-rate":{"type":"integer","format":"int32"},"frame-width":{"type":"integer","format":"int32"},"frame-height":{"type":"integer","format":"int32"},"frame-rate":{"type":"integer","format":"int32"}}},"FingerprintProperties":{"type":"object","properties":{"type":{"type":"string","enum":["MAIN","SEQUENCE_CONTROL"]},"nfiq":{"type":"integer","format":"int32"},"contrast":{"type":"integer","format":"int32"},"direction":{"type":"string","enum":["LEFT_TO_RIGHT","RIGHT_TO_LEFT"]},"reversions":{"type":"integer","format":"int32"},"slips":{"type":"integer","format":"int32"},"frames":{"type":"integer","format":"int32"},"latent":{"type":"boolean"},"dirty-start":{"type":"boolean"},"dirty-latter":{"type":"boolean"}}},"FaceProperties":{"type":"object","properties":{"icao":{"type":"boolean"},"glasses":{"type":"boolean"},"shoulder":{"type":"boolean"},"smiling":{"type":"boolean"},"mouth":{"$ref":"#/components/schemas/Position"},"busy-background":{"type":"boolean"},"saturated-picture":{"type":"boolean"},"blurred-picture":{"type":"boolean"},"crop-out-of-picture":{"type":"boolean"},"skin-color":{"type":"boolean"},"face-position":{"type":"boolean"},"face-right":{"type":"boolean"},"face-left":{"type":"boolean"},"face-up":{"type":"boolean"},"face-down":{"type":"boolean"},"heavy-glasses":{"type":"boolean"},"shoulder-left":{"type":"boolean"},"shoulder-right":{"type":"boolean"},"eyes-obstruction":{"type":"boolean"},"looking-down":{"type":"boolean"},"looking-up":{"type":"boolean"},"looking-right":{"type":"boolean"},"looking-left":{"type":"boolean"},"too-open-eyes":{"type":"boolean"},"too-closed-eyes":{"type":"boolean"},"red-eyes":{"type":"boolean"},"open-mouth":{"type":"boolean"},"showing-teeth":{"type":"boolean"},"left-eye":{"$ref":"#/components/schemas/Position"},"right-eye":{"$ref":"#/components/schemas/Position"},"recomended-brightness":{"type":"number","format":"float"},"recomended-contrast":{"type":"number","format":"float"},"number-of-faces":{"type":"integer","format":"int32"}}},"Position":{"type":"object","properties":{"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"}}},"SignatureProperties":{"type":"object","properties":{"notSignable":{"type":"boolean"}}},"BiographicData":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"Key":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The OperatorEnrollPayload object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"OperatorEnrollPayload":{"type":"object","properties":{"document":{"type":"string"},"biometrics":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"status":{"type":"string","enum":["VERIFIED","GOD_MODE","PENDING","EXCEPTION","ENQUEUED","DELETED"]},"tguid":{"type":"string"}}},"Biometric":{"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 Operator object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"Operator":{"type":"object","properties":{"document":{"type":"string"},"status":{"type":"string","enum":["VERIFIED","GOD_MODE","PENDING","EXCEPTION","ENQUEUED","DELETED"]},"tguid":{"type":"string"}}}}}}
```

## The OperatorEnrollRequest object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"OperatorEnrollRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OperatorEnrollPayload"}}},"OperatorEnrollPayload":{"type":"object","properties":{"document":{"type":"string"},"biometrics":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"status":{"type":"string","enum":["VERIFIED","GOD_MODE","PENDING","EXCEPTION","ENQUEUED","DELETED"]},"tguid":{"type":"string"}}},"Biometric":{"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 PsbioResult object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"PsbioResult":{"type":"object","properties":{"tcn":{"type":"string"},"message":{"type":"string"},"status":{"type":"string","enum":["OK","DELETE_OK","DELETE_NOT_OK","DELETE_PENDING","ENROLL_OK","ENROLL_CACHE_OK","ENROLL_ANOMALY","ENROLL_ANOMALY_BLACKLIST","ENROLL_IN_PROGRESS","ENROLL_FAILED","UPDATE_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"]}}}}}}
```

## The RemoteCaptureRequest object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"RemoteCaptureRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TransactionIdentifier"}}},"TransactionIdentifier":{"type":"object","properties":{"clientID":{"type":"string"},"operatorID":{"type":"string"},"clientEmail":{"type":"string"}}}}}}
```

## The TransactionIdentifier object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"TransactionIdentifier":{"type":"object","properties":{"clientID":{"type":"string"},"operatorID":{"type":"string"},"clientEmail":{"type":"string"}}}}}}
```

## The RemoteCaptureResponse object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"RemoteCaptureResponse":{"type":"object","properties":{"tguid":{"type":"string"},"dynamicLink":{"type":"string"}}}}}}
```

## The RemoteCaptureApprovalRequest object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"RemoteCaptureApprovalRequest":{"title":"RemoteCaptureApprovalRequest","type":"object","properties":{"approval":{"type":"boolean"}}}}}}
```

## The RemoteCaptureNotificationRequest object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"RemoteCaptureNotificationRequest":{"type":"object","properties":{"guid":{"type":"string"}}}}}}
```

## The GetStatusResponse object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"GetStatusResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SystemStatus"}}},"SystemStatus":{"type":"object","properties":{"psbioStatus":{"type":"string","enum":["INACTIVE","ACTIVE"]},"spidxStatus":{"type":"string","enum":["INACTIVE","ACTIVE"]},"gbdsStatus":{"type":"string","enum":["INACTIVE","ACTIVE"]},"idnStatus":{"type":"string","enum":["INACTIVE","ACTIVE"]}}}}}}
```

## The SystemStatus object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"SystemStatus":{"type":"object","properties":{"psbioStatus":{"type":"string","enum":["INACTIVE","ACTIVE"]},"spidxStatus":{"type":"string","enum":["INACTIVE","ACTIVE"]},"gbdsStatus":{"type":"string","enum":["INACTIVE","ACTIVE"]},"idnStatus":{"type":"string","enum":["INACTIVE","ACTIVE"]}}}}}}
```

## The Anomaly object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"Anomaly":{"type":"object","properties":{"status":{"type":"string","enum":["ANALYSIS","DIFFERENT_FINGERS","SAME_FINGERS","INCORRECT_ENROLL","RECOLLECT","MERGE_TRANSACTIONS","ERROR"]},"user":{"type":"string"},"comments":{"type":"string"},"date":{"type":"string","format":"date-time"}}}}}}
```

## The AudioProperties object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"AudioProperties":{"type":"object","properties":{"codec":{"type":"string","enum":["PCM","FLAC","AC3","DTS","MP3","AAC","WMA","VOX","DSS","OTHER"]},"channels":{"type":"integer","format":"int32"},"sample-size":{"type":"integer","format":"int32"},"sample-rate":{"type":"integer","format":"int32"},"bit-rate":{"type":"integer","format":"int32"}}}}}}
```

## The BiographicData object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"BiographicData":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The Candidate object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"Candidate":{"type":"object","properties":{"anomaly":{"$ref":"#/components/schemas/Anomaly"},"person-guid":{"type":"string"},"transaction-guid":{"type":"string"},"match-info":{"type":"array","items":{"$ref":"#/components/schemas/MatchInfo"}},"biometric-count":{"type":"integer","format":"int64"}}},"Anomaly":{"type":"object","properties":{"status":{"type":"string","enum":["ANALYSIS","DIFFERENT_FINGERS","SAME_FINGERS","INCORRECT_ENROLL","RECOLLECT","MERGE_TRANSACTIONS","ERROR"]},"user":{"type":"string"},"comments":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"MatchInfo":{"type":"object","properties":{"score":{"type":"integer","format":"int32"},"matches":{"type":"array","items":{"$ref":"#/components/schemas/Match"}},"query-index":{"type":"integer","format":"int32"},"reference-index":{"type":"integer","format":"int32"}}},"Match":{"type":"object","properties":{"query":{"type":"integer","format":"int32"},"reference":{"type":"integer","format":"int32"}}}}}}
```

## The ContentData object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"ContentData":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"content":{"type":"string"},"properties":{"$ref":"#/components/schemas/ContentProperties"},"source":{"type":"string","enum":["ORIGINAL","TEMPLATE","CONSOLIDATED_TEMPLATE"]},"type":{"type":"string","enum":["FINGERPRINT","PALMPRINT","FOOTPRINT","FACE","IRIS","VOICE","SIGNATURE","SEQUENCE_CONTROL","PLAIN_TEXT","IMAGE","AUDIO","VIDEO","NONE","OTHER","UNKNOWN"]},"format":{"type":"string","enum":["ASCII","BASE64","RAW","WSQ","PNG","JPEG","JPEG2000","TIFF","GIF","BMP","_3GP","AAC","AIFF","M4A","MP3","OGG","PCM","WAV","WMA","MKV","FLV","AVI","MOV","WMV","MP4","MPEG","MPG","M4V","PRIVATE","ISO","ANSI","NONE","OTHER","UNKNOWN"]}}},"ContentProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32","deprecated":true},"height":{"type":"integer","format":"int32","deprecated":true},"resolution":{"type":"integer","format":"int32","deprecated":true},"ratio":{"type":"number","format":"double","deprecated":true},"latent":{"type":"boolean","deprecated":true},"description":{"type":"string"},"quality":{"type":"integer","format":"int32"},"index":{"type":"string","enum":["NONE","OTHER","UNKNOWN","LEFT_LITTLE","LEFT_RING","LEFT_MIDDLE","LEFT_INDEX","LEFT_THUMB","RIGHT_THUMB","RIGHT_INDEX","RIGHT_MIDDLE","RIGHT_RING","RIGHT_LITTLE","LEFT_TOPS_CTRL","RIGHT_TOPS_CTRL","LEFT_THUMB_CTRL","RIGHT_THUMB_CTRL","LEFT_TOP","LEFT_BOTTOM","LEFT_WRITER","RIGHT_TOP","RIGHT_BOTTOM","RIGHT_WRITER","LEFT_IRIS","RIGHT_IRIS","FACE_FRONTAL","LEFT_SIDE","RIGHT_SIDE","MUGSHOT_FRONTAL","MUGSHOT_LEFT_SIDE","MUGSHOT_RIGHT_SIDE","TATOO","SCAR","MARK","SIGNATURE"]},"location":{"type":"string","enum":["NONE","OTHER","UNKNOWN","FINGERPRINT","PALM","FOOT","FACE","BACK_HEAD","LEFT_FRONT_NECK","RIGHT_FRONT_NECK","LEFT_SHOLDER","RIGHT_SHOLDER","LEFT_CHEST","RIGHT_CHEST","LEFT_ARM","RIGHT_ARM","LEFT_FOREARM","RIGHT_FOREARM","LEFT_WRIST","RIGHT_WRIST","LEFT_HAND","RIGHT_HAND","STOMACH","ABDOMEN","LEFT_RIB","RIGHT_RIB","LEFT_WAIST","RIGHT_WAIST","GROIN","LEFT_THIGH","RIGHT_THIGH","LEFT_KNEE","RIGHT_KNEE","LEFT_LOWER_LEG","RIGHT_LOWER_LEG","LEFT_FOOT","RIGHT_FOOT","LEFT_BACK_NECK","RIGHT_BACK_NECK","LEFT_BACK_SHOLDER","RIGHT_BACK_SHOLDER","LEFT_UPPER_BACK","RIGHT_UPPER_BACK","LEFT_LOWER_BACK","RIGHT_LOWER_BACK","LEFT_GLUTEUS","RIGHT_GLUTEUS","LEFT_REAR_ARM","RIGHT_REAR_ARM","LEFT_ELBOW","RIGHT_ELBOW","LEFT_REAR_FOREARM","RIGHT_REAR_FOREARM","LEFT_REAR_LEG","RIGHT_REAR_LEG","LEFT_CALF","RIGHT_CALF","LEFT_ANKLE","RIGHT_ANKLE","LEFT_HEEL","RIGHT_HEEL"]},"anomaly":{"type":"string","enum":["NONE","ADACTILY","ANKYLOSIS","ECTRODACTILY","HIPERFALANGIA","POLYDACTILY","MICRODACTILY","MACRODACTILY","SINDATILY","DAMAGED","BANDAGED","IGNORED","AMPUTATED"]},"metadata":{"type":"array","items":{"type":"string","format":"byte"}},"capture-date":{"type":"string","format":"date-time"},"capture-type":{"type":"string","enum":["FLAT","FLAT_TWO_FINGERS","ROLLED","LEFT_TOP","LEFT_BOTTOM","LEFT_WRITER","RIGHT_TOP","RIGHT_BOTTOM","RIGHT_WRITER","LIVE","FILE"]},"template-properties":{"$ref":"#/components/schemas/TemplateProperties"},"image-properties":{"$ref":"#/components/schemas/ImageProperties"},"audio-properties":{"$ref":"#/components/schemas/AudioProperties"},"video-properties":{"$ref":"#/components/schemas/VideoProperties"},"fingerprint-properties":{"$ref":"#/components/schemas/FingerprintProperties"},"face-properties":{"$ref":"#/components/schemas/FaceProperties"},"signature-properties":{"$ref":"#/components/schemas/SignatureProperties"}}},"TemplateProperties":{"type":"object","properties":{"resolution":{"type":"integer","format":"int32"}}},"ImageProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"},"ratio":{"type":"number","format":"double"}}},"AudioProperties":{"type":"object","properties":{"codec":{"type":"string","enum":["PCM","FLAC","AC3","DTS","MP3","AAC","WMA","VOX","DSS","OTHER"]},"channels":{"type":"integer","format":"int32"},"sample-size":{"type":"integer","format":"int32"},"sample-rate":{"type":"integer","format":"int32"},"bit-rate":{"type":"integer","format":"int32"}}},"VideoProperties":{"type":"object","properties":{"audio-codec":{"type":"string","enum":["PCM","FLAC","AC3","DTS","MP3","AAC","WMA","VOX","DSS","OTHER"]},"video-codec":{"type":"string","enum":["X265","X264","XVID","MPEG4","_3IVX","WMV"]},"audio-bit-rate":{"type":"integer","format":"int32"},"video-bit-rate":{"type":"integer","format":"int32"},"total-bit-rate":{"type":"integer","format":"int32"},"frame-width":{"type":"integer","format":"int32"},"frame-height":{"type":"integer","format":"int32"},"frame-rate":{"type":"integer","format":"int32"}}},"FingerprintProperties":{"type":"object","properties":{"type":{"type":"string","enum":["MAIN","SEQUENCE_CONTROL"]},"nfiq":{"type":"integer","format":"int32"},"contrast":{"type":"integer","format":"int32"},"direction":{"type":"string","enum":["LEFT_TO_RIGHT","RIGHT_TO_LEFT"]},"reversions":{"type":"integer","format":"int32"},"slips":{"type":"integer","format":"int32"},"frames":{"type":"integer","format":"int32"},"latent":{"type":"boolean"},"dirty-start":{"type":"boolean"},"dirty-latter":{"type":"boolean"}}},"FaceProperties":{"type":"object","properties":{"icao":{"type":"boolean"},"glasses":{"type":"boolean"},"shoulder":{"type":"boolean"},"smiling":{"type":"boolean"},"mouth":{"$ref":"#/components/schemas/Position"},"busy-background":{"type":"boolean"},"saturated-picture":{"type":"boolean"},"blurred-picture":{"type":"boolean"},"crop-out-of-picture":{"type":"boolean"},"skin-color":{"type":"boolean"},"face-position":{"type":"boolean"},"face-right":{"type":"boolean"},"face-left":{"type":"boolean"},"face-up":{"type":"boolean"},"face-down":{"type":"boolean"},"heavy-glasses":{"type":"boolean"},"shoulder-left":{"type":"boolean"},"shoulder-right":{"type":"boolean"},"eyes-obstruction":{"type":"boolean"},"looking-down":{"type":"boolean"},"looking-up":{"type":"boolean"},"looking-right":{"type":"boolean"},"looking-left":{"type":"boolean"},"too-open-eyes":{"type":"boolean"},"too-closed-eyes":{"type":"boolean"},"red-eyes":{"type":"boolean"},"open-mouth":{"type":"boolean"},"showing-teeth":{"type":"boolean"},"left-eye":{"$ref":"#/components/schemas/Position"},"right-eye":{"$ref":"#/components/schemas/Position"},"recomended-brightness":{"type":"number","format":"float"},"recomended-contrast":{"type":"number","format":"float"},"number-of-faces":{"type":"integer","format":"int32"}}},"Position":{"type":"object","properties":{"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"}}},"SignatureProperties":{"type":"object","properties":{"notSignable":{"type":"boolean"}}}}}}
```

## The ContentProperties object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"ContentProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32","deprecated":true},"height":{"type":"integer","format":"int32","deprecated":true},"resolution":{"type":"integer","format":"int32","deprecated":true},"ratio":{"type":"number","format":"double","deprecated":true},"latent":{"type":"boolean","deprecated":true},"description":{"type":"string"},"quality":{"type":"integer","format":"int32"},"index":{"type":"string","enum":["NONE","OTHER","UNKNOWN","LEFT_LITTLE","LEFT_RING","LEFT_MIDDLE","LEFT_INDEX","LEFT_THUMB","RIGHT_THUMB","RIGHT_INDEX","RIGHT_MIDDLE","RIGHT_RING","RIGHT_LITTLE","LEFT_TOPS_CTRL","RIGHT_TOPS_CTRL","LEFT_THUMB_CTRL","RIGHT_THUMB_CTRL","LEFT_TOP","LEFT_BOTTOM","LEFT_WRITER","RIGHT_TOP","RIGHT_BOTTOM","RIGHT_WRITER","LEFT_IRIS","RIGHT_IRIS","FACE_FRONTAL","LEFT_SIDE","RIGHT_SIDE","MUGSHOT_FRONTAL","MUGSHOT_LEFT_SIDE","MUGSHOT_RIGHT_SIDE","TATOO","SCAR","MARK","SIGNATURE"]},"location":{"type":"string","enum":["NONE","OTHER","UNKNOWN","FINGERPRINT","PALM","FOOT","FACE","BACK_HEAD","LEFT_FRONT_NECK","RIGHT_FRONT_NECK","LEFT_SHOLDER","RIGHT_SHOLDER","LEFT_CHEST","RIGHT_CHEST","LEFT_ARM","RIGHT_ARM","LEFT_FOREARM","RIGHT_FOREARM","LEFT_WRIST","RIGHT_WRIST","LEFT_HAND","RIGHT_HAND","STOMACH","ABDOMEN","LEFT_RIB","RIGHT_RIB","LEFT_WAIST","RIGHT_WAIST","GROIN","LEFT_THIGH","RIGHT_THIGH","LEFT_KNEE","RIGHT_KNEE","LEFT_LOWER_LEG","RIGHT_LOWER_LEG","LEFT_FOOT","RIGHT_FOOT","LEFT_BACK_NECK","RIGHT_BACK_NECK","LEFT_BACK_SHOLDER","RIGHT_BACK_SHOLDER","LEFT_UPPER_BACK","RIGHT_UPPER_BACK","LEFT_LOWER_BACK","RIGHT_LOWER_BACK","LEFT_GLUTEUS","RIGHT_GLUTEUS","LEFT_REAR_ARM","RIGHT_REAR_ARM","LEFT_ELBOW","RIGHT_ELBOW","LEFT_REAR_FOREARM","RIGHT_REAR_FOREARM","LEFT_REAR_LEG","RIGHT_REAR_LEG","LEFT_CALF","RIGHT_CALF","LEFT_ANKLE","RIGHT_ANKLE","LEFT_HEEL","RIGHT_HEEL"]},"anomaly":{"type":"string","enum":["NONE","ADACTILY","ANKYLOSIS","ECTRODACTILY","HIPERFALANGIA","POLYDACTILY","MICRODACTILY","MACRODACTILY","SINDATILY","DAMAGED","BANDAGED","IGNORED","AMPUTATED"]},"metadata":{"type":"array","items":{"type":"string","format":"byte"}},"capture-date":{"type":"string","format":"date-time"},"capture-type":{"type":"string","enum":["FLAT","FLAT_TWO_FINGERS","ROLLED","LEFT_TOP","LEFT_BOTTOM","LEFT_WRITER","RIGHT_TOP","RIGHT_BOTTOM","RIGHT_WRITER","LIVE","FILE"]},"template-properties":{"$ref":"#/components/schemas/TemplateProperties"},"image-properties":{"$ref":"#/components/schemas/ImageProperties"},"audio-properties":{"$ref":"#/components/schemas/AudioProperties"},"video-properties":{"$ref":"#/components/schemas/VideoProperties"},"fingerprint-properties":{"$ref":"#/components/schemas/FingerprintProperties"},"face-properties":{"$ref":"#/components/schemas/FaceProperties"},"signature-properties":{"$ref":"#/components/schemas/SignatureProperties"}}},"TemplateProperties":{"type":"object","properties":{"resolution":{"type":"integer","format":"int32"}}},"ImageProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"},"ratio":{"type":"number","format":"double"}}},"AudioProperties":{"type":"object","properties":{"codec":{"type":"string","enum":["PCM","FLAC","AC3","DTS","MP3","AAC","WMA","VOX","DSS","OTHER"]},"channels":{"type":"integer","format":"int32"},"sample-size":{"type":"integer","format":"int32"},"sample-rate":{"type":"integer","format":"int32"},"bit-rate":{"type":"integer","format":"int32"}}},"VideoProperties":{"type":"object","properties":{"audio-codec":{"type":"string","enum":["PCM","FLAC","AC3","DTS","MP3","AAC","WMA","VOX","DSS","OTHER"]},"video-codec":{"type":"string","enum":["X265","X264","XVID","MPEG4","_3IVX","WMV"]},"audio-bit-rate":{"type":"integer","format":"int32"},"video-bit-rate":{"type":"integer","format":"int32"},"total-bit-rate":{"type":"integer","format":"int32"},"frame-width":{"type":"integer","format":"int32"},"frame-height":{"type":"integer","format":"int32"},"frame-rate":{"type":"integer","format":"int32"}}},"FingerprintProperties":{"type":"object","properties":{"type":{"type":"string","enum":["MAIN","SEQUENCE_CONTROL"]},"nfiq":{"type":"integer","format":"int32"},"contrast":{"type":"integer","format":"int32"},"direction":{"type":"string","enum":["LEFT_TO_RIGHT","RIGHT_TO_LEFT"]},"reversions":{"type":"integer","format":"int32"},"slips":{"type":"integer","format":"int32"},"frames":{"type":"integer","format":"int32"},"latent":{"type":"boolean"},"dirty-start":{"type":"boolean"},"dirty-latter":{"type":"boolean"}}},"FaceProperties":{"type":"object","properties":{"icao":{"type":"boolean"},"glasses":{"type":"boolean"},"shoulder":{"type":"boolean"},"smiling":{"type":"boolean"},"mouth":{"$ref":"#/components/schemas/Position"},"busy-background":{"type":"boolean"},"saturated-picture":{"type":"boolean"},"blurred-picture":{"type":"boolean"},"crop-out-of-picture":{"type":"boolean"},"skin-color":{"type":"boolean"},"face-position":{"type":"boolean"},"face-right":{"type":"boolean"},"face-left":{"type":"boolean"},"face-up":{"type":"boolean"},"face-down":{"type":"boolean"},"heavy-glasses":{"type":"boolean"},"shoulder-left":{"type":"boolean"},"shoulder-right":{"type":"boolean"},"eyes-obstruction":{"type":"boolean"},"looking-down":{"type":"boolean"},"looking-up":{"type":"boolean"},"looking-right":{"type":"boolean"},"looking-left":{"type":"boolean"},"too-open-eyes":{"type":"boolean"},"too-closed-eyes":{"type":"boolean"},"red-eyes":{"type":"boolean"},"open-mouth":{"type":"boolean"},"showing-teeth":{"type":"boolean"},"left-eye":{"$ref":"#/components/schemas/Position"},"right-eye":{"$ref":"#/components/schemas/Position"},"recomended-brightness":{"type":"number","format":"float"},"recomended-contrast":{"type":"number","format":"float"},"number-of-faces":{"type":"integer","format":"int32"}}},"Position":{"type":"object","properties":{"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"}}},"SignatureProperties":{"type":"object","properties":{"notSignable":{"type":"boolean"}}}}}}
```

## The FaceProperties object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"FaceProperties":{"type":"object","properties":{"icao":{"type":"boolean"},"glasses":{"type":"boolean"},"shoulder":{"type":"boolean"},"smiling":{"type":"boolean"},"mouth":{"$ref":"#/components/schemas/Position"},"busy-background":{"type":"boolean"},"saturated-picture":{"type":"boolean"},"blurred-picture":{"type":"boolean"},"crop-out-of-picture":{"type":"boolean"},"skin-color":{"type":"boolean"},"face-position":{"type":"boolean"},"face-right":{"type":"boolean"},"face-left":{"type":"boolean"},"face-up":{"type":"boolean"},"face-down":{"type":"boolean"},"heavy-glasses":{"type":"boolean"},"shoulder-left":{"type":"boolean"},"shoulder-right":{"type":"boolean"},"eyes-obstruction":{"type":"boolean"},"looking-down":{"type":"boolean"},"looking-up":{"type":"boolean"},"looking-right":{"type":"boolean"},"looking-left":{"type":"boolean"},"too-open-eyes":{"type":"boolean"},"too-closed-eyes":{"type":"boolean"},"red-eyes":{"type":"boolean"},"open-mouth":{"type":"boolean"},"showing-teeth":{"type":"boolean"},"left-eye":{"$ref":"#/components/schemas/Position"},"right-eye":{"$ref":"#/components/schemas/Position"},"recomended-brightness":{"type":"number","format":"float"},"recomended-contrast":{"type":"number","format":"float"},"number-of-faces":{"type":"integer","format":"int32"}}},"Position":{"type":"object","properties":{"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"}}}}}}
```

## The FingerprintProperties object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"FingerprintProperties":{"type":"object","properties":{"type":{"type":"string","enum":["MAIN","SEQUENCE_CONTROL"]},"nfiq":{"type":"integer","format":"int32"},"contrast":{"type":"integer","format":"int32"},"direction":{"type":"string","enum":["LEFT_TO_RIGHT","RIGHT_TO_LEFT"]},"reversions":{"type":"integer","format":"int32"},"slips":{"type":"integer","format":"int32"},"frames":{"type":"integer","format":"int32"},"latent":{"type":"boolean"},"dirty-start":{"type":"boolean"},"dirty-latter":{"type":"boolean"}}}}}}
```

## The ImageProperties object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"ImageProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"},"ratio":{"type":"number","format":"double"}}}}}}
```

## The Key object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"Key":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The Match object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"Match":{"type":"object","properties":{"query":{"type":"integer","format":"int32"},"reference":{"type":"integer","format":"int32"}}}}}}
```

## The MatchInfo object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"MatchInfo":{"type":"object","properties":{"score":{"type":"integer","format":"int32"},"matches":{"type":"array","items":{"$ref":"#/components/schemas/Match"}},"query-index":{"type":"integer","format":"int32"},"reference-index":{"type":"integer","format":"int32"}}},"Match":{"type":"object","properties":{"query":{"type":"integer","format":"int32"},"reference":{"type":"integer","format":"int32"}}}}}}
```

## The Position object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"Position":{"type":"object","properties":{"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"}}}}}}
```

## The ServiceResult object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"ServiceResult":{"type":"object","properties":{"status":{"type":"string","enum":["OK","ERROR","AUTHENTICATION_OK","AUTHENTICATION_FAILED","INVALID_SESSION_GUID","PERSON_NOT_FOUND","NO_PERSON_FOUND","ENROLL_ENQUEUED","ENROLL_IN_PROGRESS","ENROLL_OK","ENROLL_ANOMALY","ENROLL_FAILED","ENROLL_PENDING","ENROLL_CACHE_OK","ENROLL_CONTINGENCY_OK","SEARCH_ENQUEUED","SEARCH_IN_PROGRESS","SEARCH_FAILED","SEARCH_MATCH","SEARCH_NOT_MATCH","DELETE_OK","DELETE_FAILED","OPERATOR_OK","OPERATOR_FAILED","OPERATOR_PENDING","REMOVE_FROM_REFERENCE_OK","REMOVE_FROM_REFERENCE_FAILED","ADD_TO_REFERENCE_OK","ADD_TO_REFERENCE_FAILED","REMOVE_KEYS_OK","ENQUEUED"]},"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"candidates":{"type":"array","items":{"$ref":"#/components/schemas/Candidate"}},"persons":{"type":"array","items":{"$ref":"#/components/schemas/LegacyPerson"}},"person":{"$ref":"#/components/schemas/LegacyPerson"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/LegacyTransaction"}},"progress":{"type":"number","format":"float"},"count":{"type":"integer","format":"int32"},"session-guid":{"type":"string"},"transaction-guid":{"type":"string"},"person-guid":{"type":"string"},"enroll-transactions":{"type":"array","items":{"$ref":"#/components/schemas/LegacyPerson"}},"anomalies-status":{"type":"string","enum":["ANALYSIS","DIFFERENT_FINGERS","SAME_FINGERS","INCORRECT_ENROLL","RECOLLECT","MERGE_TRANSACTIONS","ERROR"]}}},"Candidate":{"type":"object","properties":{"anomaly":{"$ref":"#/components/schemas/Anomaly"},"person-guid":{"type":"string"},"transaction-guid":{"type":"string"},"match-info":{"type":"array","items":{"$ref":"#/components/schemas/MatchInfo"}},"biometric-count":{"type":"integer","format":"int64"}}},"Anomaly":{"type":"object","properties":{"status":{"type":"string","enum":["ANALYSIS","DIFFERENT_FINGERS","SAME_FINGERS","INCORRECT_ENROLL","RECOLLECT","MERGE_TRANSACTIONS","ERROR"]},"user":{"type":"string"},"comments":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"MatchInfo":{"type":"object","properties":{"score":{"type":"integer","format":"int32"},"matches":{"type":"array","items":{"$ref":"#/components/schemas/Match"}},"query-index":{"type":"integer","format":"int32"},"reference-index":{"type":"integer","format":"int32"}}},"Match":{"type":"object","properties":{"query":{"type":"integer","format":"int32"},"reference":{"type":"integer","format":"int32"}}},"LegacyPerson":{"type":"object","properties":{"biometrics":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"missingBiometrics":{"type":"array","items":{"$ref":"#/components/schemas/MissingBiometric"}},"userId":{"type":"string"},"idn":{"type":"string"}}},"Biometric":{"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"}}},"MissingBiometric":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["AMPUTATED","UNAVAILABLE"]},"reason":{"type":"string"}}},"LegacyTransaction":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"operatorId":{"type":"string"},"type":{"type":"string","enum":["ENROLL","UPDATE","SEARCH","VERIFY","DELETE"]},"status":{"type":"string","enum":["OK","SEARCH_PENDING","SEARCH_ENQUEUED","SEARCH_MATCH","SEARCH_NOT_MATCH","SEARCH_FAILED","ENROLL_PENDING","ENROLL_ENQUEUED","ENROLL_CACHE_OK","ENROLL_OK","ENROLL_FAILED","ENROLL_EXCEPTION","DELETE_OK","DELETE_FAILED","DELETE_PENDING","REMOTE_CAPTURE_PENDING","FRAUD","ERROR","ENROLL_REJECTED","PERSON_NOT_FOUND"]},"timestamp":{"type":"integer","format":"int64"},"gbdsTguid":{"type":"string"},"spidxTguid":{"type":"string"},"psbioTcn":{"type":"string"},"biometrics":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"missingBiometrics":{"type":"array","items":{"$ref":"#/components/schemas/MissingBiometric"}}}}}}}
```

## The SignatureProperties object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"SignatureProperties":{"type":"object","properties":{"notSignable":{"type":"boolean"}}}}}}
```

## The TemplateProperties object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"TemplateProperties":{"type":"object","properties":{"resolution":{"type":"integer","format":"int32"}}}}}}
```

## The VideoProperties object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"VideoProperties":{"type":"object","properties":{"audio-codec":{"type":"string","enum":["PCM","FLAC","AC3","DTS","MP3","AAC","WMA","VOX","DSS","OTHER"]},"video-codec":{"type":"string","enum":["X265","X264","XVID","MPEG4","_3IVX","WMV"]},"audio-bit-rate":{"type":"integer","format":"int32"},"video-bit-rate":{"type":"integer","format":"int32"},"total-bit-rate":{"type":"integer","format":"int32"},"frame-width":{"type":"integer","format":"int32"},"frame-height":{"type":"integer","format":"int32"},"frame-rate":{"type":"integer","format":"int32"}}}}}}
```

## The LegacySearchRequest object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"LegacySearchRequest":{"type":"object","properties":{"operator":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"keys":{"type":"array","items":{"$ref":"#/components/schemas/Key"}},"biometrics":{"type":"array","items":{"$ref":"#/components/schemas/ContentData"}}}},"Key":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"ContentData":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"content":{"type":"string"},"properties":{"$ref":"#/components/schemas/ContentProperties"},"source":{"type":"string","enum":["ORIGINAL","TEMPLATE","CONSOLIDATED_TEMPLATE"]},"type":{"type":"string","enum":["FINGERPRINT","PALMPRINT","FOOTPRINT","FACE","IRIS","VOICE","SIGNATURE","SEQUENCE_CONTROL","PLAIN_TEXT","IMAGE","AUDIO","VIDEO","NONE","OTHER","UNKNOWN"]},"format":{"type":"string","enum":["ASCII","BASE64","RAW","WSQ","PNG","JPEG","JPEG2000","TIFF","GIF","BMP","_3GP","AAC","AIFF","M4A","MP3","OGG","PCM","WAV","WMA","MKV","FLV","AVI","MOV","WMV","MP4","MPEG","MPG","M4V","PRIVATE","ISO","ANSI","NONE","OTHER","UNKNOWN"]}}},"ContentProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32","deprecated":true},"height":{"type":"integer","format":"int32","deprecated":true},"resolution":{"type":"integer","format":"int32","deprecated":true},"ratio":{"type":"number","format":"double","deprecated":true},"latent":{"type":"boolean","deprecated":true},"description":{"type":"string"},"quality":{"type":"integer","format":"int32"},"index":{"type":"string","enum":["NONE","OTHER","UNKNOWN","LEFT_LITTLE","LEFT_RING","LEFT_MIDDLE","LEFT_INDEX","LEFT_THUMB","RIGHT_THUMB","RIGHT_INDEX","RIGHT_MIDDLE","RIGHT_RING","RIGHT_LITTLE","LEFT_TOPS_CTRL","RIGHT_TOPS_CTRL","LEFT_THUMB_CTRL","RIGHT_THUMB_CTRL","LEFT_TOP","LEFT_BOTTOM","LEFT_WRITER","RIGHT_TOP","RIGHT_BOTTOM","RIGHT_WRITER","LEFT_IRIS","RIGHT_IRIS","FACE_FRONTAL","LEFT_SIDE","RIGHT_SIDE","MUGSHOT_FRONTAL","MUGSHOT_LEFT_SIDE","MUGSHOT_RIGHT_SIDE","TATOO","SCAR","MARK","SIGNATURE"]},"location":{"type":"string","enum":["NONE","OTHER","UNKNOWN","FINGERPRINT","PALM","FOOT","FACE","BACK_HEAD","LEFT_FRONT_NECK","RIGHT_FRONT_NECK","LEFT_SHOLDER","RIGHT_SHOLDER","LEFT_CHEST","RIGHT_CHEST","LEFT_ARM","RIGHT_ARM","LEFT_FOREARM","RIGHT_FOREARM","LEFT_WRIST","RIGHT_WRIST","LEFT_HAND","RIGHT_HAND","STOMACH","ABDOMEN","LEFT_RIB","RIGHT_RIB","LEFT_WAIST","RIGHT_WAIST","GROIN","LEFT_THIGH","RIGHT_THIGH","LEFT_KNEE","RIGHT_KNEE","LEFT_LOWER_LEG","RIGHT_LOWER_LEG","LEFT_FOOT","RIGHT_FOOT","LEFT_BACK_NECK","RIGHT_BACK_NECK","LEFT_BACK_SHOLDER","RIGHT_BACK_SHOLDER","LEFT_UPPER_BACK","RIGHT_UPPER_BACK","LEFT_LOWER_BACK","RIGHT_LOWER_BACK","LEFT_GLUTEUS","RIGHT_GLUTEUS","LEFT_REAR_ARM","RIGHT_REAR_ARM","LEFT_ELBOW","RIGHT_ELBOW","LEFT_REAR_FOREARM","RIGHT_REAR_FOREARM","LEFT_REAR_LEG","RIGHT_REAR_LEG","LEFT_CALF","RIGHT_CALF","LEFT_ANKLE","RIGHT_ANKLE","LEFT_HEEL","RIGHT_HEEL"]},"anomaly":{"type":"string","enum":["NONE","ADACTILY","ANKYLOSIS","ECTRODACTILY","HIPERFALANGIA","POLYDACTILY","MICRODACTILY","MACRODACTILY","SINDATILY","DAMAGED","BANDAGED","IGNORED","AMPUTATED"]},"metadata":{"type":"array","items":{"type":"string","format":"byte"}},"capture-date":{"type":"string","format":"date-time"},"capture-type":{"type":"string","enum":["FLAT","FLAT_TWO_FINGERS","ROLLED","LEFT_TOP","LEFT_BOTTOM","LEFT_WRITER","RIGHT_TOP","RIGHT_BOTTOM","RIGHT_WRITER","LIVE","FILE"]},"template-properties":{"$ref":"#/components/schemas/TemplateProperties"},"image-properties":{"$ref":"#/components/schemas/ImageProperties"},"audio-properties":{"$ref":"#/components/schemas/AudioProperties"},"video-properties":{"$ref":"#/components/schemas/VideoProperties"},"fingerprint-properties":{"$ref":"#/components/schemas/FingerprintProperties"},"face-properties":{"$ref":"#/components/schemas/FaceProperties"},"signature-properties":{"$ref":"#/components/schemas/SignatureProperties"}}},"TemplateProperties":{"type":"object","properties":{"resolution":{"type":"integer","format":"int32"}}},"ImageProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"},"ratio":{"type":"number","format":"double"}}},"AudioProperties":{"type":"object","properties":{"codec":{"type":"string","enum":["PCM","FLAC","AC3","DTS","MP3","AAC","WMA","VOX","DSS","OTHER"]},"channels":{"type":"integer","format":"int32"},"sample-size":{"type":"integer","format":"int32"},"sample-rate":{"type":"integer","format":"int32"},"bit-rate":{"type":"integer","format":"int32"}}},"VideoProperties":{"type":"object","properties":{"audio-codec":{"type":"string","enum":["PCM","FLAC","AC3","DTS","MP3","AAC","WMA","VOX","DSS","OTHER"]},"video-codec":{"type":"string","enum":["X265","X264","XVID","MPEG4","_3IVX","WMV"]},"audio-bit-rate":{"type":"integer","format":"int32"},"video-bit-rate":{"type":"integer","format":"int32"},"total-bit-rate":{"type":"integer","format":"int32"},"frame-width":{"type":"integer","format":"int32"},"frame-height":{"type":"integer","format":"int32"},"frame-rate":{"type":"integer","format":"int32"}}},"FingerprintProperties":{"type":"object","properties":{"type":{"type":"string","enum":["MAIN","SEQUENCE_CONTROL"]},"nfiq":{"type":"integer","format":"int32"},"contrast":{"type":"integer","format":"int32"},"direction":{"type":"string","enum":["LEFT_TO_RIGHT","RIGHT_TO_LEFT"]},"reversions":{"type":"integer","format":"int32"},"slips":{"type":"integer","format":"int32"},"frames":{"type":"integer","format":"int32"},"latent":{"type":"boolean"},"dirty-start":{"type":"boolean"},"dirty-latter":{"type":"boolean"}}},"FaceProperties":{"type":"object","properties":{"icao":{"type":"boolean"},"glasses":{"type":"boolean"},"shoulder":{"type":"boolean"},"smiling":{"type":"boolean"},"mouth":{"$ref":"#/components/schemas/Position"},"busy-background":{"type":"boolean"},"saturated-picture":{"type":"boolean"},"blurred-picture":{"type":"boolean"},"crop-out-of-picture":{"type":"boolean"},"skin-color":{"type":"boolean"},"face-position":{"type":"boolean"},"face-right":{"type":"boolean"},"face-left":{"type":"boolean"},"face-up":{"type":"boolean"},"face-down":{"type":"boolean"},"heavy-glasses":{"type":"boolean"},"shoulder-left":{"type":"boolean"},"shoulder-right":{"type":"boolean"},"eyes-obstruction":{"type":"boolean"},"looking-down":{"type":"boolean"},"looking-up":{"type":"boolean"},"looking-right":{"type":"boolean"},"looking-left":{"type":"boolean"},"too-open-eyes":{"type":"boolean"},"too-closed-eyes":{"type":"boolean"},"red-eyes":{"type":"boolean"},"open-mouth":{"type":"boolean"},"showing-teeth":{"type":"boolean"},"left-eye":{"$ref":"#/components/schemas/Position"},"right-eye":{"$ref":"#/components/schemas/Position"},"recomended-brightness":{"type":"number","format":"float"},"recomended-contrast":{"type":"number","format":"float"},"number-of-faces":{"type":"integer","format":"int32"}}},"Position":{"type":"object","properties":{"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"}}},"SignatureProperties":{"type":"object","properties":{"notSignable":{"type":"boolean"}}}}}}
```

## The CryptedData object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"CryptedData":{"type":"object","properties":{"data":{"type":"string"},"key":{"type":"string"},"sessionGuid":{"type":"string"}}}}}}
```

## The Enroll object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"Enroll":{"type":"object","properties":{"metadata":{"type":"array","items":{"type":"string","format":"byte"}},"timeout":{"type":"integer","format":"int32"},"labels":{"type":"array","items":{"type":"string"}},"filters":{"type":"array","items":{"type":"string"}},"priority":{"type":"string","enum":["LOWEST_PRIORITY","LOWER_PRIORITY","LOW_PRIORITY","DEFAULT_PRIORITY","HIGH_PRIORITY","HIGHER_PRIORITY","HIGHEST_PRIORITY"]},"session-guid":{"type":"string"},"person-guid":{"type":"string"},"keys":{"type":"array","items":{"$ref":"#/components/schemas/Key"}},"biographics":{"type":"array","items":{"$ref":"#/components/schemas/BiographicData"}},"biometrics":{"type":"array","items":{"$ref":"#/components/schemas/ContentData"}},"auxiliaries":{"type":"array","items":{"$ref":"#/components/schemas/ContentData"}},"matching-index":{"type":"string","enum":["SAME_FINGERS","ALL_FINGERS","CROSSED_WINDOW_TWEEZERS"]},"force-face-search":{"type":"boolean"}}},"Key":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"BiographicData":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"ContentData":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"content":{"type":"string"},"properties":{"$ref":"#/components/schemas/ContentProperties"},"source":{"type":"string","enum":["ORIGINAL","TEMPLATE","CONSOLIDATED_TEMPLATE"]},"type":{"type":"string","enum":["FINGERPRINT","PALMPRINT","FOOTPRINT","FACE","IRIS","VOICE","SIGNATURE","SEQUENCE_CONTROL","PLAIN_TEXT","IMAGE","AUDIO","VIDEO","NONE","OTHER","UNKNOWN"]},"format":{"type":"string","enum":["ASCII","BASE64","RAW","WSQ","PNG","JPEG","JPEG2000","TIFF","GIF","BMP","_3GP","AAC","AIFF","M4A","MP3","OGG","PCM","WAV","WMA","MKV","FLV","AVI","MOV","WMV","MP4","MPEG","MPG","M4V","PRIVATE","ISO","ANSI","NONE","OTHER","UNKNOWN"]}}},"ContentProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32","deprecated":true},"height":{"type":"integer","format":"int32","deprecated":true},"resolution":{"type":"integer","format":"int32","deprecated":true},"ratio":{"type":"number","format":"double","deprecated":true},"latent":{"type":"boolean","deprecated":true},"description":{"type":"string"},"quality":{"type":"integer","format":"int32"},"index":{"type":"string","enum":["NONE","OTHER","UNKNOWN","LEFT_LITTLE","LEFT_RING","LEFT_MIDDLE","LEFT_INDEX","LEFT_THUMB","RIGHT_THUMB","RIGHT_INDEX","RIGHT_MIDDLE","RIGHT_RING","RIGHT_LITTLE","LEFT_TOPS_CTRL","RIGHT_TOPS_CTRL","LEFT_THUMB_CTRL","RIGHT_THUMB_CTRL","LEFT_TOP","LEFT_BOTTOM","LEFT_WRITER","RIGHT_TOP","RIGHT_BOTTOM","RIGHT_WRITER","LEFT_IRIS","RIGHT_IRIS","FACE_FRONTAL","LEFT_SIDE","RIGHT_SIDE","MUGSHOT_FRONTAL","MUGSHOT_LEFT_SIDE","MUGSHOT_RIGHT_SIDE","TATOO","SCAR","MARK","SIGNATURE"]},"location":{"type":"string","enum":["NONE","OTHER","UNKNOWN","FINGERPRINT","PALM","FOOT","FACE","BACK_HEAD","LEFT_FRONT_NECK","RIGHT_FRONT_NECK","LEFT_SHOLDER","RIGHT_SHOLDER","LEFT_CHEST","RIGHT_CHEST","LEFT_ARM","RIGHT_ARM","LEFT_FOREARM","RIGHT_FOREARM","LEFT_WRIST","RIGHT_WRIST","LEFT_HAND","RIGHT_HAND","STOMACH","ABDOMEN","LEFT_RIB","RIGHT_RIB","LEFT_WAIST","RIGHT_WAIST","GROIN","LEFT_THIGH","RIGHT_THIGH","LEFT_KNEE","RIGHT_KNEE","LEFT_LOWER_LEG","RIGHT_LOWER_LEG","LEFT_FOOT","RIGHT_FOOT","LEFT_BACK_NECK","RIGHT_BACK_NECK","LEFT_BACK_SHOLDER","RIGHT_BACK_SHOLDER","LEFT_UPPER_BACK","RIGHT_UPPER_BACK","LEFT_LOWER_BACK","RIGHT_LOWER_BACK","LEFT_GLUTEUS","RIGHT_GLUTEUS","LEFT_REAR_ARM","RIGHT_REAR_ARM","LEFT_ELBOW","RIGHT_ELBOW","LEFT_REAR_FOREARM","RIGHT_REAR_FOREARM","LEFT_REAR_LEG","RIGHT_REAR_LEG","LEFT_CALF","RIGHT_CALF","LEFT_ANKLE","RIGHT_ANKLE","LEFT_HEEL","RIGHT_HEEL"]},"anomaly":{"type":"string","enum":["NONE","ADACTILY","ANKYLOSIS","ECTRODACTILY","HIPERFALANGIA","POLYDACTILY","MICRODACTILY","MACRODACTILY","SINDATILY","DAMAGED","BANDAGED","IGNORED","AMPUTATED"]},"metadata":{"type":"array","items":{"type":"string","format":"byte"}},"capture-date":{"type":"string","format":"date-time"},"capture-type":{"type":"string","enum":["FLAT","FLAT_TWO_FINGERS","ROLLED","LEFT_TOP","LEFT_BOTTOM","LEFT_WRITER","RIGHT_TOP","RIGHT_BOTTOM","RIGHT_WRITER","LIVE","FILE"]},"template-properties":{"$ref":"#/components/schemas/TemplateProperties"},"image-properties":{"$ref":"#/components/schemas/ImageProperties"},"audio-properties":{"$ref":"#/components/schemas/AudioProperties"},"video-properties":{"$ref":"#/components/schemas/VideoProperties"},"fingerprint-properties":{"$ref":"#/components/schemas/FingerprintProperties"},"face-properties":{"$ref":"#/components/schemas/FaceProperties"},"signature-properties":{"$ref":"#/components/schemas/SignatureProperties"}}},"TemplateProperties":{"type":"object","properties":{"resolution":{"type":"integer","format":"int32"}}},"ImageProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"},"ratio":{"type":"number","format":"double"}}},"AudioProperties":{"type":"object","properties":{"codec":{"type":"string","enum":["PCM","FLAC","AC3","DTS","MP3","AAC","WMA","VOX","DSS","OTHER"]},"channels":{"type":"integer","format":"int32"},"sample-size":{"type":"integer","format":"int32"},"sample-rate":{"type":"integer","format":"int32"},"bit-rate":{"type":"integer","format":"int32"}}},"VideoProperties":{"type":"object","properties":{"audio-codec":{"type":"string","enum":["PCM","FLAC","AC3","DTS","MP3","AAC","WMA","VOX","DSS","OTHER"]},"video-codec":{"type":"string","enum":["X265","X264","XVID","MPEG4","_3IVX","WMV"]},"audio-bit-rate":{"type":"integer","format":"int32"},"video-bit-rate":{"type":"integer","format":"int32"},"total-bit-rate":{"type":"integer","format":"int32"},"frame-width":{"type":"integer","format":"int32"},"frame-height":{"type":"integer","format":"int32"},"frame-rate":{"type":"integer","format":"int32"}}},"FingerprintProperties":{"type":"object","properties":{"type":{"type":"string","enum":["MAIN","SEQUENCE_CONTROL"]},"nfiq":{"type":"integer","format":"int32"},"contrast":{"type":"integer","format":"int32"},"direction":{"type":"string","enum":["LEFT_TO_RIGHT","RIGHT_TO_LEFT"]},"reversions":{"type":"integer","format":"int32"},"slips":{"type":"integer","format":"int32"},"frames":{"type":"integer","format":"int32"},"latent":{"type":"boolean"},"dirty-start":{"type":"boolean"},"dirty-latter":{"type":"boolean"}}},"FaceProperties":{"type":"object","properties":{"icao":{"type":"boolean"},"glasses":{"type":"boolean"},"shoulder":{"type":"boolean"},"smiling":{"type":"boolean"},"mouth":{"$ref":"#/components/schemas/Position"},"busy-background":{"type":"boolean"},"saturated-picture":{"type":"boolean"},"blurred-picture":{"type":"boolean"},"crop-out-of-picture":{"type":"boolean"},"skin-color":{"type":"boolean"},"face-position":{"type":"boolean"},"face-right":{"type":"boolean"},"face-left":{"type":"boolean"},"face-up":{"type":"boolean"},"face-down":{"type":"boolean"},"heavy-glasses":{"type":"boolean"},"shoulder-left":{"type":"boolean"},"shoulder-right":{"type":"boolean"},"eyes-obstruction":{"type":"boolean"},"looking-down":{"type":"boolean"},"looking-up":{"type":"boolean"},"looking-right":{"type":"boolean"},"looking-left":{"type":"boolean"},"too-open-eyes":{"type":"boolean"},"too-closed-eyes":{"type":"boolean"},"red-eyes":{"type":"boolean"},"open-mouth":{"type":"boolean"},"showing-teeth":{"type":"boolean"},"left-eye":{"$ref":"#/components/schemas/Position"},"right-eye":{"$ref":"#/components/schemas/Position"},"recomended-brightness":{"type":"number","format":"float"},"recomended-contrast":{"type":"number","format":"float"},"number-of-faces":{"type":"integer","format":"int32"}}},"Position":{"type":"object","properties":{"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"}}},"SignatureProperties":{"type":"object","properties":{"notSignable":{"type":"boolean"}}}}}}
```

## The LegacyNotification object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"LegacyNotification":{"type":"object","properties":{"tguid":{"type":"string"},"status":{"type":"string"}}}}}}
```

## The LegacyEnrollRequest object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"LegacyEnrollRequest":{"type":"object","properties":{"metadata":{"type":"array","items":{"type":"string","format":"byte"}},"timeout":{"type":"integer","format":"int32"},"labels":{"type":"array","items":{"type":"string"}},"filters":{"type":"array","items":{"type":"string"}},"priority":{"type":"string","enum":["LOWEST_PRIORITY","LOWER_PRIORITY","LOW_PRIORITY","DEFAULT_PRIORITY","HIGH_PRIORITY","HIGHER_PRIORITY","HIGHEST_PRIORITY"]},"operator":{"type":"string"},"session-guid":{"type":"string"},"person-guid":{"type":"string"},"keys":{"type":"array","items":{"$ref":"#/components/schemas/Key"}},"biographics":{"type":"array","items":{"$ref":"#/components/schemas/BiographicData"}},"biometrics":{"type":"array","items":{"$ref":"#/components/schemas/ContentData"}},"auxiliaries":{"type":"array","items":{"$ref":"#/components/schemas/ContentData"}},"matching-index":{"type":"string","enum":["SAME_FINGERS","ALL_FINGERS","CROSSED_WINDOW_TWEEZERS"]},"force-face-search":{"type":"boolean"}}},"Key":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"BiographicData":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"ContentData":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"content":{"type":"string"},"properties":{"$ref":"#/components/schemas/ContentProperties"},"source":{"type":"string","enum":["ORIGINAL","TEMPLATE","CONSOLIDATED_TEMPLATE"]},"type":{"type":"string","enum":["FINGERPRINT","PALMPRINT","FOOTPRINT","FACE","IRIS","VOICE","SIGNATURE","SEQUENCE_CONTROL","PLAIN_TEXT","IMAGE","AUDIO","VIDEO","NONE","OTHER","UNKNOWN"]},"format":{"type":"string","enum":["ASCII","BASE64","RAW","WSQ","PNG","JPEG","JPEG2000","TIFF","GIF","BMP","_3GP","AAC","AIFF","M4A","MP3","OGG","PCM","WAV","WMA","MKV","FLV","AVI","MOV","WMV","MP4","MPEG","MPG","M4V","PRIVATE","ISO","ANSI","NONE","OTHER","UNKNOWN"]}}},"ContentProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32","deprecated":true},"height":{"type":"integer","format":"int32","deprecated":true},"resolution":{"type":"integer","format":"int32","deprecated":true},"ratio":{"type":"number","format":"double","deprecated":true},"latent":{"type":"boolean","deprecated":true},"description":{"type":"string"},"quality":{"type":"integer","format":"int32"},"index":{"type":"string","enum":["NONE","OTHER","UNKNOWN","LEFT_LITTLE","LEFT_RING","LEFT_MIDDLE","LEFT_INDEX","LEFT_THUMB","RIGHT_THUMB","RIGHT_INDEX","RIGHT_MIDDLE","RIGHT_RING","RIGHT_LITTLE","LEFT_TOPS_CTRL","RIGHT_TOPS_CTRL","LEFT_THUMB_CTRL","RIGHT_THUMB_CTRL","LEFT_TOP","LEFT_BOTTOM","LEFT_WRITER","RIGHT_TOP","RIGHT_BOTTOM","RIGHT_WRITER","LEFT_IRIS","RIGHT_IRIS","FACE_FRONTAL","LEFT_SIDE","RIGHT_SIDE","MUGSHOT_FRONTAL","MUGSHOT_LEFT_SIDE","MUGSHOT_RIGHT_SIDE","TATOO","SCAR","MARK","SIGNATURE"]},"location":{"type":"string","enum":["NONE","OTHER","UNKNOWN","FINGERPRINT","PALM","FOOT","FACE","BACK_HEAD","LEFT_FRONT_NECK","RIGHT_FRONT_NECK","LEFT_SHOLDER","RIGHT_SHOLDER","LEFT_CHEST","RIGHT_CHEST","LEFT_ARM","RIGHT_ARM","LEFT_FOREARM","RIGHT_FOREARM","LEFT_WRIST","RIGHT_WRIST","LEFT_HAND","RIGHT_HAND","STOMACH","ABDOMEN","LEFT_RIB","RIGHT_RIB","LEFT_WAIST","RIGHT_WAIST","GROIN","LEFT_THIGH","RIGHT_THIGH","LEFT_KNEE","RIGHT_KNEE","LEFT_LOWER_LEG","RIGHT_LOWER_LEG","LEFT_FOOT","RIGHT_FOOT","LEFT_BACK_NECK","RIGHT_BACK_NECK","LEFT_BACK_SHOLDER","RIGHT_BACK_SHOLDER","LEFT_UPPER_BACK","RIGHT_UPPER_BACK","LEFT_LOWER_BACK","RIGHT_LOWER_BACK","LEFT_GLUTEUS","RIGHT_GLUTEUS","LEFT_REAR_ARM","RIGHT_REAR_ARM","LEFT_ELBOW","RIGHT_ELBOW","LEFT_REAR_FOREARM","RIGHT_REAR_FOREARM","LEFT_REAR_LEG","RIGHT_REAR_LEG","LEFT_CALF","RIGHT_CALF","LEFT_ANKLE","RIGHT_ANKLE","LEFT_HEEL","RIGHT_HEEL"]},"anomaly":{"type":"string","enum":["NONE","ADACTILY","ANKYLOSIS","ECTRODACTILY","HIPERFALANGIA","POLYDACTILY","MICRODACTILY","MACRODACTILY","SINDATILY","DAMAGED","BANDAGED","IGNORED","AMPUTATED"]},"metadata":{"type":"array","items":{"type":"string","format":"byte"}},"capture-date":{"type":"string","format":"date-time"},"capture-type":{"type":"string","enum":["FLAT","FLAT_TWO_FINGERS","ROLLED","LEFT_TOP","LEFT_BOTTOM","LEFT_WRITER","RIGHT_TOP","RIGHT_BOTTOM","RIGHT_WRITER","LIVE","FILE"]},"template-properties":{"$ref":"#/components/schemas/TemplateProperties"},"image-properties":{"$ref":"#/components/schemas/ImageProperties"},"audio-properties":{"$ref":"#/components/schemas/AudioProperties"},"video-properties":{"$ref":"#/components/schemas/VideoProperties"},"fingerprint-properties":{"$ref":"#/components/schemas/FingerprintProperties"},"face-properties":{"$ref":"#/components/schemas/FaceProperties"},"signature-properties":{"$ref":"#/components/schemas/SignatureProperties"}}},"TemplateProperties":{"type":"object","properties":{"resolution":{"type":"integer","format":"int32"}}},"ImageProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"},"ratio":{"type":"number","format":"double"}}},"AudioProperties":{"type":"object","properties":{"codec":{"type":"string","enum":["PCM","FLAC","AC3","DTS","MP3","AAC","WMA","VOX","DSS","OTHER"]},"channels":{"type":"integer","format":"int32"},"sample-size":{"type":"integer","format":"int32"},"sample-rate":{"type":"integer","format":"int32"},"bit-rate":{"type":"integer","format":"int32"}}},"VideoProperties":{"type":"object","properties":{"audio-codec":{"type":"string","enum":["PCM","FLAC","AC3","DTS","MP3","AAC","WMA","VOX","DSS","OTHER"]},"video-codec":{"type":"string","enum":["X265","X264","XVID","MPEG4","_3IVX","WMV"]},"audio-bit-rate":{"type":"integer","format":"int32"},"video-bit-rate":{"type":"integer","format":"int32"},"total-bit-rate":{"type":"integer","format":"int32"},"frame-width":{"type":"integer","format":"int32"},"frame-height":{"type":"integer","format":"int32"},"frame-rate":{"type":"integer","format":"int32"}}},"FingerprintProperties":{"type":"object","properties":{"type":{"type":"string","enum":["MAIN","SEQUENCE_CONTROL"]},"nfiq":{"type":"integer","format":"int32"},"contrast":{"type":"integer","format":"int32"},"direction":{"type":"string","enum":["LEFT_TO_RIGHT","RIGHT_TO_LEFT"]},"reversions":{"type":"integer","format":"int32"},"slips":{"type":"integer","format":"int32"},"frames":{"type":"integer","format":"int32"},"latent":{"type":"boolean"},"dirty-start":{"type":"boolean"},"dirty-latter":{"type":"boolean"}}},"FaceProperties":{"type":"object","properties":{"icao":{"type":"boolean"},"glasses":{"type":"boolean"},"shoulder":{"type":"boolean"},"smiling":{"type":"boolean"},"mouth":{"$ref":"#/components/schemas/Position"},"busy-background":{"type":"boolean"},"saturated-picture":{"type":"boolean"},"blurred-picture":{"type":"boolean"},"crop-out-of-picture":{"type":"boolean"},"skin-color":{"type":"boolean"},"face-position":{"type":"boolean"},"face-right":{"type":"boolean"},"face-left":{"type":"boolean"},"face-up":{"type":"boolean"},"face-down":{"type":"boolean"},"heavy-glasses":{"type":"boolean"},"shoulder-left":{"type":"boolean"},"shoulder-right":{"type":"boolean"},"eyes-obstruction":{"type":"boolean"},"looking-down":{"type":"boolean"},"looking-up":{"type":"boolean"},"looking-right":{"type":"boolean"},"looking-left":{"type":"boolean"},"too-open-eyes":{"type":"boolean"},"too-closed-eyes":{"type":"boolean"},"red-eyes":{"type":"boolean"},"open-mouth":{"type":"boolean"},"showing-teeth":{"type":"boolean"},"left-eye":{"$ref":"#/components/schemas/Position"},"right-eye":{"$ref":"#/components/schemas/Position"},"recomended-brightness":{"type":"number","format":"float"},"recomended-contrast":{"type":"number","format":"float"},"number-of-faces":{"type":"integer","format":"int32"}}},"Position":{"type":"object","properties":{"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"}}},"SignatureProperties":{"type":"object","properties":{"notSignable":{"type":"boolean"}}}}}}
```

## The Approvement object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"Approvement":{"type":"object","properties":{"comments":{"type":"string"},"status":{"type":"string","enum":["PENDING","APPROVED","REJECTED"]},"timestamp":{"type":"string","format":"date-time"},"user":{"type":"string"}}}}}}
```

## The File object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"File":{"type":"object","properties":{"absolute":{"type":"boolean"},"absoluteFile":{"$ref":"#/components/schemas/File"},"absolutePath":{"type":"string"},"canonicalFile":{"$ref":"#/components/schemas/File"},"canonicalPath":{"type":"string"},"directory":{"type":"boolean"},"file":{"type":"boolean"},"freeSpace":{"type":"integer","format":"int64"},"hidden":{"type":"boolean"},"name":{"type":"string"},"parent":{"type":"string"},"parentFile":{"$ref":"#/components/schemas/File"},"path":{"type":"string"},"totalSpace":{"type":"integer","format":"int64"},"usableSpace":{"type":"integer","format":"int64"}}}}}}
```

## The FileSystemResource object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"FileSystemResource":{"type":"object","properties":{"description":{"type":"string"},"file":{"$ref":"#/components/schemas/File"},"filename":{"type":"string"},"inputStream":{"$ref":"#/components/schemas/InputStream"},"open":{"type":"boolean"},"outputStream":{"$ref":"#/components/schemas/OutputStream"},"path":{"type":"string"},"readable":{"type":"boolean"},"uri":{"$ref":"#/components/schemas/URI"},"url":{"$ref":"#/components/schemas/URL"},"writable":{"type":"boolean"}}},"File":{"type":"object","properties":{"absolute":{"type":"boolean"},"absoluteFile":{"$ref":"#/components/schemas/File"},"absolutePath":{"type":"string"},"canonicalFile":{"$ref":"#/components/schemas/File"},"canonicalPath":{"type":"string"},"directory":{"type":"boolean"},"file":{"type":"boolean"},"freeSpace":{"type":"integer","format":"int64"},"hidden":{"type":"boolean"},"name":{"type":"string"},"parent":{"type":"string"},"parentFile":{"$ref":"#/components/schemas/File"},"path":{"type":"string"},"totalSpace":{"type":"integer","format":"int64"},"usableSpace":{"type":"integer","format":"int64"}}},"InputStream":{"type":"object"},"OutputStream":{"type":"object"},"URI":{"type":"object","properties":{"absolute":{"type":"boolean"},"authority":{"type":"string"},"fragment":{"type":"string"},"host":{"type":"string"},"opaque":{"type":"boolean"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"query":{"type":"string"},"rawAuthority":{"type":"string"},"rawFragment":{"type":"string"},"rawPath":{"type":"string"},"rawQuery":{"type":"string"},"rawSchemeSpecificPart":{"type":"string"},"rawUserInfo":{"type":"string"},"scheme":{"type":"string"},"schemeSpecificPart":{"type":"string"},"userInfo":{"type":"string"}}},"URL":{"type":"object","properties":{"authority":{"type":"string"},"content":{"type":"object"},"defaultPort":{"type":"integer","format":"int32"},"file":{"type":"string"},"host":{"type":"string"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"protocol":{"type":"string"},"query":{"type":"string"},"ref":{"type":"string"},"userInfo":{"type":"string"}}}}}}
```

## The InputStream object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"InputStream":{"type":"object"}}}}
```

## The LatentFilter object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"LatentFilter":{"type":"object","properties":{"advanced-search":{"type":"boolean"},"candidates":{"type":"integer","format":"int32"},"latent":{"type":"boolean"},"rotation-angle":{"type":"integer","format":"int32"},"threshold":{"type":"integer","format":"int32"},"use-classification":{"type":"array","items":{"type":"string","enum":["PLAIN_ARCH","LEFT_LOOP","RIGHT_LOOP","WHORL","UNKNOWN","AMPUTATION","OTHER"]}},"use-core-delta":{"type":"string","enum":["NONE","NO_DELTA_ALL_CORES","ONE_DELTA_NO_CORES","ONE_DELTA_ALL_CORES"]}}}}}}
```

## The LegacyACServiceResult object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"LegacyACServiceResult":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"idn":{"type":"string"},"message":{"type":"string"},"status":{"type":"string","enum":["OK","AUTHENTICATION_FAILED","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","SEARCH_ANOMALY","CHANGE_STATUS_OK","CHANGE_STATUS_FAILED","CHANGE_IDN_OK","CHANGE_IDN_FAILED","PERSON_FRAUD","RECOLLECT","INCORRECT_ENROLL","FRAUD","ERROR"]},"tcn":{"type":"string"}},"xml":{"name":"LegacyACServiceResult","attribute":false,"wrapped":false}}}}}
```

## The LegacySearchClient object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"LegacySearchClient":{"type":"object","properties":{"biometrics":{"type":"array","items":{"$ref":"#/components/schemas/ContentData"}},"filters":{"type":"array","items":{"type":"string"}},"keys":{"type":"array","items":{"$ref":"#/components/schemas/Key"}},"latent":{"$ref":"#/components/schemas/LatentFilter"},"matcher-id":{"type":"string","enum":["REGULAR","LATENT","PASCHOAL"]},"matching-index":{"type":"string","enum":["SAME_FINGERS","ALL_FINGERS","CROSSED_WINDOW_TWEEZERS"]},"operator":{"type":"string"},"person-guid":{"type":"string"},"priority":{"type":"string","enum":["LOWEST_PRIORITY","LOWER_PRIORITY","LOW_PRIORITY","DEFAULT_PRIORITY","HIGH_PRIORITY","HIGHER_PRIORITY","HIGHEST_PRIORITY"]},"session-guid":{"type":"string"},"timeout":{"type":"integer","format":"int32"}}},"ContentData":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"content":{"type":"string"},"properties":{"$ref":"#/components/schemas/ContentProperties"},"source":{"type":"string","enum":["ORIGINAL","TEMPLATE","CONSOLIDATED_TEMPLATE"]},"type":{"type":"string","enum":["FINGERPRINT","PALMPRINT","FOOTPRINT","FACE","IRIS","VOICE","SIGNATURE","SEQUENCE_CONTROL","PLAIN_TEXT","IMAGE","AUDIO","VIDEO","NONE","OTHER","UNKNOWN"]},"format":{"type":"string","enum":["ASCII","BASE64","RAW","WSQ","PNG","JPEG","JPEG2000","TIFF","GIF","BMP","_3GP","AAC","AIFF","M4A","MP3","OGG","PCM","WAV","WMA","MKV","FLV","AVI","MOV","WMV","MP4","MPEG","MPG","M4V","PRIVATE","ISO","ANSI","NONE","OTHER","UNKNOWN"]}}},"ContentProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32","deprecated":true},"height":{"type":"integer","format":"int32","deprecated":true},"resolution":{"type":"integer","format":"int32","deprecated":true},"ratio":{"type":"number","format":"double","deprecated":true},"latent":{"type":"boolean","deprecated":true},"description":{"type":"string"},"quality":{"type":"integer","format":"int32"},"index":{"type":"string","enum":["NONE","OTHER","UNKNOWN","LEFT_LITTLE","LEFT_RING","LEFT_MIDDLE","LEFT_INDEX","LEFT_THUMB","RIGHT_THUMB","RIGHT_INDEX","RIGHT_MIDDLE","RIGHT_RING","RIGHT_LITTLE","LEFT_TOPS_CTRL","RIGHT_TOPS_CTRL","LEFT_THUMB_CTRL","RIGHT_THUMB_CTRL","LEFT_TOP","LEFT_BOTTOM","LEFT_WRITER","RIGHT_TOP","RIGHT_BOTTOM","RIGHT_WRITER","LEFT_IRIS","RIGHT_IRIS","FACE_FRONTAL","LEFT_SIDE","RIGHT_SIDE","MUGSHOT_FRONTAL","MUGSHOT_LEFT_SIDE","MUGSHOT_RIGHT_SIDE","TATOO","SCAR","MARK","SIGNATURE"]},"location":{"type":"string","enum":["NONE","OTHER","UNKNOWN","FINGERPRINT","PALM","FOOT","FACE","BACK_HEAD","LEFT_FRONT_NECK","RIGHT_FRONT_NECK","LEFT_SHOLDER","RIGHT_SHOLDER","LEFT_CHEST","RIGHT_CHEST","LEFT_ARM","RIGHT_ARM","LEFT_FOREARM","RIGHT_FOREARM","LEFT_WRIST","RIGHT_WRIST","LEFT_HAND","RIGHT_HAND","STOMACH","ABDOMEN","LEFT_RIB","RIGHT_RIB","LEFT_WAIST","RIGHT_WAIST","GROIN","LEFT_THIGH","RIGHT_THIGH","LEFT_KNEE","RIGHT_KNEE","LEFT_LOWER_LEG","RIGHT_LOWER_LEG","LEFT_FOOT","RIGHT_FOOT","LEFT_BACK_NECK","RIGHT_BACK_NECK","LEFT_BACK_SHOLDER","RIGHT_BACK_SHOLDER","LEFT_UPPER_BACK","RIGHT_UPPER_BACK","LEFT_LOWER_BACK","RIGHT_LOWER_BACK","LEFT_GLUTEUS","RIGHT_GLUTEUS","LEFT_REAR_ARM","RIGHT_REAR_ARM","LEFT_ELBOW","RIGHT_ELBOW","LEFT_REAR_FOREARM","RIGHT_REAR_FOREARM","LEFT_REAR_LEG","RIGHT_REAR_LEG","LEFT_CALF","RIGHT_CALF","LEFT_ANKLE","RIGHT_ANKLE","LEFT_HEEL","RIGHT_HEEL"]},"anomaly":{"type":"string","enum":["NONE","ADACTILY","ANKYLOSIS","ECTRODACTILY","HIPERFALANGIA","POLYDACTILY","MICRODACTILY","MACRODACTILY","SINDATILY","DAMAGED","BANDAGED","IGNORED","AMPUTATED"]},"metadata":{"type":"array","items":{"type":"string","format":"byte"}},"capture-date":{"type":"string","format":"date-time"},"capture-type":{"type":"string","enum":["FLAT","FLAT_TWO_FINGERS","ROLLED","LEFT_TOP","LEFT_BOTTOM","LEFT_WRITER","RIGHT_TOP","RIGHT_BOTTOM","RIGHT_WRITER","LIVE","FILE"]},"template-properties":{"$ref":"#/components/schemas/TemplateProperties"},"image-properties":{"$ref":"#/components/schemas/ImageProperties"},"audio-properties":{"$ref":"#/components/schemas/AudioProperties"},"video-properties":{"$ref":"#/components/schemas/VideoProperties"},"fingerprint-properties":{"$ref":"#/components/schemas/FingerprintProperties"},"face-properties":{"$ref":"#/components/schemas/FaceProperties"},"signature-properties":{"$ref":"#/components/schemas/SignatureProperties"}}},"TemplateProperties":{"type":"object","properties":{"resolution":{"type":"integer","format":"int32"}}},"ImageProperties":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"resolution":{"type":"integer","format":"int32"},"ratio":{"type":"number","format":"double"}}},"AudioProperties":{"type":"object","properties":{"codec":{"type":"string","enum":["PCM","FLAC","AC3","DTS","MP3","AAC","WMA","VOX","DSS","OTHER"]},"channels":{"type":"integer","format":"int32"},"sample-size":{"type":"integer","format":"int32"},"sample-rate":{"type":"integer","format":"int32"},"bit-rate":{"type":"integer","format":"int32"}}},"VideoProperties":{"type":"object","properties":{"audio-codec":{"type":"string","enum":["PCM","FLAC","AC3","DTS","MP3","AAC","WMA","VOX","DSS","OTHER"]},"video-codec":{"type":"string","enum":["X265","X264","XVID","MPEG4","_3IVX","WMV"]},"audio-bit-rate":{"type":"integer","format":"int32"},"video-bit-rate":{"type":"integer","format":"int32"},"total-bit-rate":{"type":"integer","format":"int32"},"frame-width":{"type":"integer","format":"int32"},"frame-height":{"type":"integer","format":"int32"},"frame-rate":{"type":"integer","format":"int32"}}},"FingerprintProperties":{"type":"object","properties":{"type":{"type":"string","enum":["MAIN","SEQUENCE_CONTROL"]},"nfiq":{"type":"integer","format":"int32"},"contrast":{"type":"integer","format":"int32"},"direction":{"type":"string","enum":["LEFT_TO_RIGHT","RIGHT_TO_LEFT"]},"reversions":{"type":"integer","format":"int32"},"slips":{"type":"integer","format":"int32"},"frames":{"type":"integer","format":"int32"},"latent":{"type":"boolean"},"dirty-start":{"type":"boolean"},"dirty-latter":{"type":"boolean"}}},"FaceProperties":{"type":"object","properties":{"icao":{"type":"boolean"},"glasses":{"type":"boolean"},"shoulder":{"type":"boolean"},"smiling":{"type":"boolean"},"mouth":{"$ref":"#/components/schemas/Position"},"busy-background":{"type":"boolean"},"saturated-picture":{"type":"boolean"},"blurred-picture":{"type":"boolean"},"crop-out-of-picture":{"type":"boolean"},"skin-color":{"type":"boolean"},"face-position":{"type":"boolean"},"face-right":{"type":"boolean"},"face-left":{"type":"boolean"},"face-up":{"type":"boolean"},"face-down":{"type":"boolean"},"heavy-glasses":{"type":"boolean"},"shoulder-left":{"type":"boolean"},"shoulder-right":{"type":"boolean"},"eyes-obstruction":{"type":"boolean"},"looking-down":{"type":"boolean"},"looking-up":{"type":"boolean"},"looking-right":{"type":"boolean"},"looking-left":{"type":"boolean"},"too-open-eyes":{"type":"boolean"},"too-closed-eyes":{"type":"boolean"},"red-eyes":{"type":"boolean"},"open-mouth":{"type":"boolean"},"showing-teeth":{"type":"boolean"},"left-eye":{"$ref":"#/components/schemas/Position"},"right-eye":{"$ref":"#/components/schemas/Position"},"recomended-brightness":{"type":"number","format":"float"},"recomended-contrast":{"type":"number","format":"float"},"number-of-faces":{"type":"integer","format":"int32"}}},"Position":{"type":"object","properties":{"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"}}},"SignatureProperties":{"type":"object","properties":{"notSignable":{"type":"boolean"}}},"Key":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"LatentFilter":{"type":"object","properties":{"advanced-search":{"type":"boolean"},"candidates":{"type":"integer","format":"int32"},"latent":{"type":"boolean"},"rotation-angle":{"type":"integer","format":"int32"},"threshold":{"type":"integer","format":"int32"},"use-classification":{"type":"array","items":{"type":"string","enum":["PLAIN_ARCH","LEFT_LOOP","RIGHT_LOOP","WHORL","UNKNOWN","AMPUTATION","OTHER"]}},"use-core-delta":{"type":"string","enum":["NONE","NO_DELTA_ALL_CORES","ONE_DELTA_NO_CORES","ONE_DELTA_ALL_CORES"]}}}}}}
```

## The ModelAndView object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"ModelAndView":{"type":"object","properties":{"empty":{"type":"boolean"},"model":{"type":"object"},"modelMap":{"type":"object","additionalProperties":{"type":"object"}},"reference":{"type":"boolean"},"status":{"type":"string","enum":["100","101","102","103","200","201","202","203","204","205","206","207","208","226","300","301","302","303","304","305","307","308","400","401","402","403","404","405","406","407","408","409","410","411","412","413","414","415","416","417","418","419","420","421","422","423","424","426","428","429","431","451","500","501","502","503","504","505","506","507","508","509","510","511"]},"view":{"$ref":"#/components/schemas/View"},"viewName":{"type":"string"}}},"View":{"type":"object","properties":{"contentType":{"type":"string"}}}}}}
```

## The OutputStream object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"OutputStream":{"type":"object"}}}}
```

## The ResponseEntity object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"ResponseEntity":{"type":"object","properties":{"body":{"type":"object"},"statusCode":{"type":"string","enum":["100","101","102","103","200","201","202","203","204","205","206","207","208","226","300","301","302","303","304","305","307","308","400","401","402","403","404","405","406","407","408","409","410","411","412","413","414","415","416","417","418","419","420","421","422","423","424","426","428","429","431","451","500","501","502","503","504","505","506","507","508","509","510","511"]},"statusCodeValue":{"type":"integer","format":"int32"}}}}}}
```

## The URI object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"URI":{"type":"object","properties":{"absolute":{"type":"boolean"},"authority":{"type":"string"},"fragment":{"type":"string"},"host":{"type":"string"},"opaque":{"type":"boolean"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"query":{"type":"string"},"rawAuthority":{"type":"string"},"rawFragment":{"type":"string"},"rawPath":{"type":"string"},"rawQuery":{"type":"string"},"rawSchemeSpecificPart":{"type":"string"},"rawUserInfo":{"type":"string"},"scheme":{"type":"string"},"schemeSpecificPart":{"type":"string"},"userInfo":{"type":"string"}}}}}}
```

## The URL object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"URL":{"type":"object","properties":{"authority":{"type":"string"},"content":{"type":"object"},"defaultPort":{"type":"integer","format":"int32"},"file":{"type":"string"},"host":{"type":"string"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"protocol":{"type":"string"},"query":{"type":"string"},"ref":{"type":"string"},"userInfo":{"type":"string"}}}}}}
```

## The UserTransactionRequest object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"UserTransactionRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserTransaction"}}},"UserTransaction":{"type":"object","properties":{"biometrics":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}},"missingBiometrics":{"type":"array","items":{"$ref":"#/components/schemas/MissingBiometric"}},"userId":{"type":"string"},"operatorId":{"type":"string"},"timestamp":{"type":"integer","format":"int64"}}},"Biometric":{"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"}}},"MissingBiometric":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["AMPUTATED","UNAVAILABLE"]},"reason":{"type":"string"}}}}}}
```

## The View object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"View":{"type":"object","properties":{"contentType":{"type":"string"}}}}}}
```

## The TokenUpdate object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"TokenUpdate":{"type":"object","properties":{"externalBaseID":{"type":"string"},"token":{"type":"string"}}}}}}
```

## The OperatorInsertPayload object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"OperatorInsertPayload":{"title":"OperatorInsertPayload","type":"object","properties":{"document":{"type":"string"}}}}}}
```

## The OperatorInsertRequest object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"OperatorInsertRequest":{"title":"OperatorInsertRequest","type":"object","properties":{"data":{"$ref":"#/components/schemas/OperatorInsertPayload"}}},"OperatorInsertPayload":{"title":"OperatorInsertPayload","type":"object","properties":{"document":{"type":"string"}}}}}}
```

## The RedirectEnrollResponse object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"RedirectEnrollResponse":{"title":"RedirectVerifyResponse","type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["SEARCH_PENDING","SEARCH_ENQUEUED","SEARCH_MATCH","SEARCH_NOT_MATCH","SEARCH_FAILED","ERROR"]}}}}}}
```

## The FaceDetectRequest object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"FaceDetectRequest":{"type":"object","properties":{"userId":{"type":"string"},"operatorId":{"type":"string"},"image":{"type":"string"}}}}}}
```

## The FaceDetectResponse object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"FaceDetectResponse":{"type":"object","properties":{"id":{"type":"string"}}}}}}
```

## The GetTransactionDataResponse object

```json
{"openapi":"3.0.1","info":{"title":"SPID Server API Specification","version":"4.2.12"},"components":{"schemas":{"GetTransactionDataResponse":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"operatorId":{"type":"string"},"type":{"type":"string"},"status":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"psbioTcn":{"type":"string"},"biometrics":{"type":"array","items":{"$ref":"#/components/schemas/Biometric"}}}},"Biometric":{"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"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.griaule.com/apis/spid/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.