> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/docs.facephi-pt-br/sdks/backend-sdk/selphid/technical_documentation/api_reference/models.md).

# Models

## The ImageBuffer object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ImageBuffer":{"type":"string","description":"Raw image buffer in .png, .jpg or .bmp format, base64-encoded."}}}}
```

## The ImageToken object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ImageToken":{"type":"string","description":"Tokenized image, base64-encoded."}}}}
```

## The Token object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"Token":{"type":"string","description":"Raw image buffer in .png, .jpg or .bmp format, base64-encoded, or tokenized image, base64-encoded."}}}}
```

## The FacialTemplate object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialTemplate":{"type":"string","description":"Biometric template buffer, obtained through GetFacialTemplate(), base64-encoded."}}}}
```

## The FacialTemplateRaw object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialTemplateRaw":{"type":"string","description":"Biometric template buffer, obtained through GetFacialTemplateRaw(), base64-encoded."}}}}
```

## The UpdatedTemplateRaw object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"UpdatedTemplateRaw":{"type":"boolean","description":"The templateRaw has been updated in the extraction operation."}}}}
```

## The FacialTemplateId object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialTemplateId":{"type":"string","description":"The name of a facial template in a gallery."}}}}
```

## The DocumentToken object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"DocumentToken":{"type":"string","description":"Tokenized document data (OCR, faceImage, frontImage, backImage), base64-encoded."}}}}
```

## The AudioBuffer object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"AudioBuffer":{"type":"string","description":"Raw audio buffer in WAV, OPUS/OGG, MP3 or AAC format, base64-encoded. The audio may or may not be encrypted."}}}}
```

## The ExtraData object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ExtraData":{"type":"string","description":"Tokenized data used to call the Api Tracking service after the operation, base64-encoded."}}}}
```

## The PersonalDataInfo object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"PersonalDataInfo":{"type":"object","description":"Key/value dictionary with the user's personal data, to be sent to the Api Tracking service. It is only taken into account if the _extraData_ field is not empty.","properties":{"name":{"type":"string"},"surname":{"type":"string"},"nationality":{"type":"string"},"documentNumber":{"type":"string"},"birthDate":{"type":"string"},"birthPlace":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"issuer":{"type":"string"},"issueDate":{"type":"string"},"expiryDate":{"type":"string"},"fullName":{"type":"string"},"gender":{"type":"string"},"nfcKey":{"type":"string"},"numSupport":{"type":"string"},"mrz":{"type":"string"}}}}}}
```

## The TimeStamp object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"TimeStamp":{"type":"string","description":"A date and time value in \"%Y-%m-%dT%H:%M:%SZ\" format."}}}}
```

## The TokenTimeStamp object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"TokenTimeStamp":{"type":"string","description":"The token's internal date and time value in \"%Y-%m-%dT%H:%M:%SZ\" format."}}}}
```

## The XCoord object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"XCoord":{"type":"number","description":"X coordinate."}}}}
```

## The YCoord object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"YCoord":{"type":"number","description":"Y coordinate."}}}}
```

## The MinFaceSize object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"MinFaceSize":{"type":"integer","description":"Minimum size, in pixels, that a face must have to be detected."}}}}
```

## The MinIOD object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"MinIOD":{"type":"integer","description":"Minimum interocular distance, in pixels, that a face must have to be detected."}}}}
```

## The MinFaceRel object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"MinFaceRel":{"type":"number","description":"Minimum size, relative to the image size, that a face must have to be detected.","minimum":0,"maximum":1}}}}
```

## The MaxPoseDegrees object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"MaxPoseDegrees":{"type":"number","description":"Maximum angle difference (in degrees) between two poses to be considered valid in authentication processes.","minimum":0,"maximum":180}}}}
```

## The FalseDetectRate object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FalseDetectRate":{"type":"number","description":"False rejection tolerance level in the extraction engine. Using this value is not recommended unless you are sure of its effects.","minimum":0,"maximum":1}}}}
```

## The IOD object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"IOD":{"type":"number","description":"Interocular distance."}}}}
```

## The Rectangle object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"Rectangle":{"type":"object","description":"A bounded area of an image.","properties":{"x":{"type":"number","description":"X coordinate of the top-left corner."},"y":{"type":"number","description":"Y coordinate of the top-left corner."},"width":{"type":"number","description":"Width of the area."},"height":{"type":"number","description":"Height of the area."}}}}}}
```

## The Analytics object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"Analytics":{"type":"boolean","description":"Gets additional analytics in the extraction engine."}}}}
```

## The TemplateRawExtraction object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"TemplateRawExtraction":{"type":"boolean","description":"The extraction engine will generate the raw template."}}}}
```

## The Similarity object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"Similarity":{"type":"number","description":"Similarity between two facial templates (0-None, 1-Identical)."}}}}
```

## The MinSimilarity object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"MinSimilarity":{"type":"number","description":"Minimum tolerable similarity in 1:N searches.","minimum":0,"maximum":1}}}}
```

## The AuthThreshold object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"AuthThreshold":{"type":"number","description":"Minimum value in an authentication for it to be considered positive.","minimum":0,"maximum":100}}}}
```

## The Age object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"Age":{"type":"number","description":"Approximate age of the person."}}}}
```

## The Succeed object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"Succeed":{"type":"boolean","description":"Indicates whether the operation was successful or not."}}}}
```

## The ValidTimeStamp object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ValidTimeStamp":{"type":"boolean","description":"In authentication, liveness and extraction operations that involve templateRaws, indicates whether the template's lifetime is valid. See \"options:elapsedAllowedSeconds\". In operations that do not involve raw templates, it is always true."}}}}
```

## The MaxCandidates object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"MaxCandidates":{"type":"integer","description":"Maximum number of candidates required in 1:N searches."}}}}
```

## The GalleryIndex object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"GalleryIndex":{"type":"integer","description":"The index of a facial template in a gallery.","minimum":0}}}}
```

## The GalleryId object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"GalleryId":{"type":"string","description":"The name of a facial template gallery."}}}}
```

## The LongDetail object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"LongDetail":{"type":"boolean","description":"If true, the endpoint result will include additional information. If omitted, the default value is false."}}}}
```

## The ElapsedSeconds object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ElapsedSeconds":{"type":"integer","description":"Maximum lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. If 0 (default), there is no limit.","minimum":0}}}}
```

## The FutureSeconds object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FutureSeconds":{"type":"integer","description":"Maximum future lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. The template may have been created on a device with a date in the future relative to the device that consumes it. If 0 (default), no templateRaw with a future date is accepted.","minimum":0}}}}
```

## The IntervalSeconds object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"IntervalSeconds":{"type":"integer","description":"Time interval in seconds, normally used to check templateRaw timestamps.","minimum":0}}}}
```

## The VoiceProbability object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"VoiceProbability":{"type":"number","description":"Voice match probability","minimum":0,"maximum":1}}}}
```

## The EventSource object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"EventSource":{"type":"string","description":"The source of an event in the Api Tracking service."}}}}
```

## The TrackingStatus object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"TrackingStatus":{"type":"number","description":"Status returned by the Api Tracking service, or -1 if tracking is not required."}}}}
```

## The TrackingMessage object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"TrackingMessage":{"type":"string","description":"Message returned by the Api Tracking service, or empty if tracking is not required."}}}}
```

## The FacialDetectionType object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialDetectionType":{"type":"string","description":"Facial detection types in the extraction engine.","enum":["Frontal","FrontalFast"]}}}}
```

## The FacialAuthenticationStatus object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialAuthenticationStatus":{"type":"string","description":"Possible results of an authentication operation.","enum":["None","Negative","Uncertain","Positive","NoneBecausePoseExceed","NoneBecauseInvalidExtractions"]}}}}
```

## The FacialAuthenticationDetail object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialAuthenticationDetail":{"type":"string","description":"Quality detail of an authentication operation.","enum":["None","PositiveLowSecurityLevel","PositiveMediumSecurityLevel","PositiveHighSecurityLevel"]}}}}
```

## The LivenessDepth object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"LivenessDepth":{"type":"string","description":"Which liveness pipelines must be used.","enum":["None","Partial","Full"]}}}}
```

## The NoLiveMainCause object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"NoLiveMainCause":{"type":"string","description":"High-level main cause of the NoLive diagnostic.","enum":["FPadFailed","FMadFailed","MultipleFailed","Unknown"]}}}}
```

## The FPadStatus object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FPadStatus":{"type":"string","description":"Status of facial presentation attack detection (fPAD).","enum":["NotEvaluated","Passed","Failed","Error"]}}}}
```

## The FMadStatus object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FMadStatus":{"type":"string","description":"Status of facial manipulation attack detection (fMAD).","enum":["NotEvaluated","Passed","Failed","Error"]}}}}
```

## The FPadScore object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FPadScore":{"type":"number","description":"Normalized fPAD score, if available","minimum":0,"maximum":1}}}}
```

## The FMadScore object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FMadScore":{"type":"number","description":"Normalized fMAD score, if available","minimum":0,"maximum":1}}}}
```

## The CoercionScore object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"CoercionScore":{"type":"number","description":"Normalized coercion score, if available","minimum":0,"maximum":1}}}}
```

## The NoLiveReasonMessage object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"NoLiveReasonMessage":{"type":"string","description":"Human-readable reason message, for logs/backoffice."}}}}
```

## The FacialLivenessDiagnostic object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialLivenessDiagnostic":{"type":"string","description":"Possible results of a liveness operation.","enum":["None","Spoof","Uncertain","Live","NoneBecauseBadQuality","NoneBecauseFaceTooClose","NoneBecauseFaceNotFound","NoneBecauseFaceTooSmall","NoneBecauseAngleTooLarge","NoneBecauseImageDataError","NoneBecauseInternalError","NoneBecauseImagePreprocessError","NoneBecauseTooManyFaces","NoneBecauseFaceTooCloseToBorder","NoneBecauseFaceCropped","NoneBecauseLicenseError","NoneBecauseFaceOccluded","NoLive","NoneBecauseEyesClosed","NoneBecauseEyesOccluded","NoneBecauseTokenDataError","NoneBecauseTokenSecurity"]}}}}
```

## The NoLiveDetails object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"NoLiveDetails":{"type":"object","description":"Details for the FacialLivenessDiagnostic::NoLive case","properties":{"mainCause":{"$ref":"#/components/schemas/NoLiveMainCause"},"fPadStatus":{"$ref":"#/components/schemas/FPadStatus"},"fPadScore":{"$ref":"#/components/schemas/FPadScore"},"fMadStatus":{"$ref":"#/components/schemas/FMadStatus"},"fMadScore":{"$ref":"#/components/schemas/FMadScore"},"coercionScore":{"$ref":"#/components/schemas/CoercionScore"},"reasonMessage":{"$ref":"#/components/schemas/NoLiveReasonMessage"}}},"NoLiveMainCause":{"type":"string","description":"High-level main cause of the NoLive diagnostic.","enum":["FPadFailed","FMadFailed","MultipleFailed","Unknown"]},"FPadStatus":{"type":"string","description":"Status of facial presentation attack detection (fPAD).","enum":["NotEvaluated","Passed","Failed","Error"]},"FPadScore":{"type":"number","description":"Normalized fPAD score, if available","minimum":0,"maximum":1},"FMadStatus":{"type":"string","description":"Status of facial manipulation attack detection (fMAD).","enum":["NotEvaluated","Passed","Failed","Error"]},"FMadScore":{"type":"number","description":"Normalized fMAD score, if available","minimum":0,"maximum":1},"CoercionScore":{"type":"number","description":"Normalized coercion score, if available","minimum":0,"maximum":1},"NoLiveReasonMessage":{"type":"string","description":"Human-readable reason message, for logs/backoffice."}}}}
```

## The FacialGlasses object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialGlasses":{"type":"string","description":"Whether the person in the image wears glasses (and of which type).","enum":["None","Eye","Sun"]}}}}
```

## The FacialGender object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialGender":{"type":"string","description":"The facial gender of the person in the image.","enum":["None","Male","Female"]}}}}
```

## The FacialMask object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialMask":{"type":"number","description":"The probability of a face mask.","minimum":0,"maximum":1}}}}
```

## The FaceConfidence object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FaceConfidence":{"type":"number","description":"Predicted face confidence.","minimum":0,"maximum":1}}}}
```

## The FacialQuality object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialQuality":{"type":"string","description":"A metric indicating how accurately a template will perform in recognition.","enum":["None","Bad","Regular","Good"]}}}}
```

## The TrackingFamily object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"TrackingFamily":{"type":"string","description":"Family under which to register the Api Tracking events.","enum":["OnBoarding","Authentication"]}}}}
```

## The OperationResultStatus object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"OperationResultStatus":{"type":"string","description":"Result of a client-side operation, for registration in Api Tracking.","enum":["Succeeded","Denied","Error","Live","Cancelled"]}}}}
```

## The OperationResultReason object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"OperationResultReason":{"type":"string","description":"Detail of the result of a client-side operation, for registration in Api Tracking.","enum":["None","InternalError","CancelledByUser","Timeout","DocumentValidationNotPassed","DocumentValidationError","AuthenticationNotPassed","AuthenticationError","LivenessNotPassed","LivenessError"]}}}}
```

## The TokenType object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"TokenType":{"type":"string","description":"Possible results for an input token buffer.","enum":["jpg","png","bmp","templateRaw","tokenImage","tokenGeneric","unknown","unsupported"]}}}}
```

## The HealthStatus object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"HealthStatus":{"type":"string","description":"Result of the health service (indicates whether the SDK is alive or not).","enum":["Healthy","No healthy"]}}}}
```

## The SdkDuration object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"SdkDuration":{"type":"number","description":"Duration of the operation in milliseconds."}}}}
```

## The OCRData object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"OCRData":{"type":"string","description":"String containing a JSON key/value dictionary with the OCR fields detected in a document."}}}}
```

## The SecurityData object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"SecurityData":{"type":"string","description":"String containing a key/value dictionary with security information."}}}}
```

## The TokenBuffer object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"TokenBuffer":{"type":"object","description":"A raw image or token buffer.","properties":{"tokenBuffer":{"$ref":"#/components/schemas/Token"}},"required":["tokenBuffer"]},"Token":{"type":"string","description":"Raw image buffer in .png, .jpg or .bmp format, base64-encoded, or tokenized image, base64-encoded."}}}}
```

## The ExtractImage object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ExtractImage":{"type":"object","description":"A raw image, used for extraction.","properties":{"image":{"$ref":"#/components/schemas/ImageBuffer"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["image"]},"ImageBuffer":{"type":"string","description":"Raw image buffer in .png, .jpg or .bmp format, base64-encoded."},"SdkOptions":{"type":"object","description":"Options to customize the use of the extraction and identification engines. Their use is optional and no option is mandatory. If omitted, the default values are used.","properties":{"longDetail":{"$ref":"#/components/schemas/LongDetail"},"elapsedAllowedSeconds":{"$ref":"#/components/schemas/ElapsedSeconds"},"futureAllowedSeconds":{"$ref":"#/components/schemas/FutureSeconds"},"facialDetection":{"$ref":"#/components/schemas/FacialDetectionType"},"minFaceAbsPx":{"$ref":"#/components/schemas/MinFaceSize"},"minFaceRel":{"$ref":"#/components/schemas/MinFaceRel"},"minIodPx":{"$ref":"#/components/schemas/MinIOD"},"maxPoseDegrees":{"$ref":"#/components/schemas/MaxPoseDegrees"},"minFacialQuality":{"$ref":"#/components/schemas/FacialQuality"},"analyticsDetection":{"$ref":"#/components/schemas/Analytics"},"templateRawExtraction":{"$ref":"#/components/schemas/TemplateRawExtraction"},"falseDetectRate":{"$ref":"#/components/schemas/FalseDetectRate"},"maxCantidates":{"$ref":"#/components/schemas/MaxCandidates"},"minSimilarity":{"$ref":"#/components/schemas/MinSimilarity"},"authThreshold":{"$ref":"#/components/schemas/AuthThreshold"},"livenessDepth":{"$ref":"#/components/schemas/LivenessDepth"}}},"LongDetail":{"type":"boolean","description":"If true, the endpoint result will include additional information. If omitted, the default value is false."},"ElapsedSeconds":{"type":"integer","description":"Maximum lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. If 0 (default), there is no limit.","minimum":0},"FutureSeconds":{"type":"integer","description":"Maximum future lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. The template may have been created on a device with a date in the future relative to the device that consumes it. If 0 (default), no templateRaw with a future date is accepted.","minimum":0},"FacialDetectionType":{"type":"string","description":"Facial detection types in the extraction engine.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Minimum size, in pixels, that a face must have to be detected."},"MinFaceRel":{"type":"number","description":"Minimum size, relative to the image size, that a face must have to be detected.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Minimum interocular distance, in pixels, that a face must have to be detected."},"MaxPoseDegrees":{"type":"number","description":"Maximum angle difference (in degrees) between two poses to be considered valid in authentication processes.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"A metric indicating how accurately a template will perform in recognition.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Gets additional analytics in the extraction engine."},"TemplateRawExtraction":{"type":"boolean","description":"The extraction engine will generate the raw template."},"FalseDetectRate":{"type":"number","description":"False rejection tolerance level in the extraction engine. Using this value is not recommended unless you are sure of its effects.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Maximum number of candidates required in 1:N searches."},"MinSimilarity":{"type":"number","description":"Minimum tolerable similarity in 1:N searches.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Minimum value in an authentication for it to be considered positive.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Which liveness pipelines must be used.","enum":["None","Partial","Full"]}}}}
```

## The ExtractTemplate object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ExtractTemplate":{"type":"object","description":"A raw template, used for extraction.","properties":{"faceTemplate":{"$ref":"#/components/schemas/FacialTemplate"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["faceTemplate"]},"FacialTemplate":{"type":"string","description":"Biometric template buffer, obtained through GetFacialTemplate(), base64-encoded."},"SdkOptions":{"type":"object","description":"Options to customize the use of the extraction and identification engines. Their use is optional and no option is mandatory. If omitted, the default values are used.","properties":{"longDetail":{"$ref":"#/components/schemas/LongDetail"},"elapsedAllowedSeconds":{"$ref":"#/components/schemas/ElapsedSeconds"},"futureAllowedSeconds":{"$ref":"#/components/schemas/FutureSeconds"},"facialDetection":{"$ref":"#/components/schemas/FacialDetectionType"},"minFaceAbsPx":{"$ref":"#/components/schemas/MinFaceSize"},"minFaceRel":{"$ref":"#/components/schemas/MinFaceRel"},"minIodPx":{"$ref":"#/components/schemas/MinIOD"},"maxPoseDegrees":{"$ref":"#/components/schemas/MaxPoseDegrees"},"minFacialQuality":{"$ref":"#/components/schemas/FacialQuality"},"analyticsDetection":{"$ref":"#/components/schemas/Analytics"},"templateRawExtraction":{"$ref":"#/components/schemas/TemplateRawExtraction"},"falseDetectRate":{"$ref":"#/components/schemas/FalseDetectRate"},"maxCantidates":{"$ref":"#/components/schemas/MaxCandidates"},"minSimilarity":{"$ref":"#/components/schemas/MinSimilarity"},"authThreshold":{"$ref":"#/components/schemas/AuthThreshold"},"livenessDepth":{"$ref":"#/components/schemas/LivenessDepth"}}},"LongDetail":{"type":"boolean","description":"If true, the endpoint result will include additional information. If omitted, the default value is false."},"ElapsedSeconds":{"type":"integer","description":"Maximum lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. If 0 (default), there is no limit.","minimum":0},"FutureSeconds":{"type":"integer","description":"Maximum future lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. The template may have been created on a device with a date in the future relative to the device that consumes it. If 0 (default), no templateRaw with a future date is accepted.","minimum":0},"FacialDetectionType":{"type":"string","description":"Facial detection types in the extraction engine.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Minimum size, in pixels, that a face must have to be detected."},"MinFaceRel":{"type":"number","description":"Minimum size, relative to the image size, that a face must have to be detected.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Minimum interocular distance, in pixels, that a face must have to be detected."},"MaxPoseDegrees":{"type":"number","description":"Maximum angle difference (in degrees) between two poses to be considered valid in authentication processes.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"A metric indicating how accurately a template will perform in recognition.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Gets additional analytics in the extraction engine."},"TemplateRawExtraction":{"type":"boolean","description":"The extraction engine will generate the raw template."},"FalseDetectRate":{"type":"number","description":"False rejection tolerance level in the extraction engine. Using this value is not recommended unless you are sure of its effects.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Maximum number of candidates required in 1:N searches."},"MinSimilarity":{"type":"number","description":"Minimum tolerable similarity in 1:N searches.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Minimum value in an authentication for it to be considered positive.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Which liveness pipelines must be used.","enum":["None","Partial","Full"]}}}}
```

## The ExtractTemplateImage object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ExtractTemplateImage":{"type":"object","description":"A raw template, used for image extraction.","properties":{"faceTemplate":{"$ref":"#/components/schemas/FacialTemplate"}},"required":["faceTemplate"]},"FacialTemplate":{"type":"string","description":"Biometric template buffer, obtained through GetFacialTemplate(), base64-encoded."}}}}
```

## The FacialAuthenticationImages object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialAuthenticationImages":{"type":"object","description":"Two raw images, used for authentication.","properties":{"image1":{"$ref":"#/components/schemas/ImageBuffer"},"image2":{"$ref":"#/components/schemas/ImageBuffer"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["image1","image2"]},"ImageBuffer":{"type":"string","description":"Raw image buffer in .png, .jpg or .bmp format, base64-encoded."},"SdkOptions":{"type":"object","description":"Options to customize the use of the extraction and identification engines. Their use is optional and no option is mandatory. If omitted, the default values are used.","properties":{"longDetail":{"$ref":"#/components/schemas/LongDetail"},"elapsedAllowedSeconds":{"$ref":"#/components/schemas/ElapsedSeconds"},"futureAllowedSeconds":{"$ref":"#/components/schemas/FutureSeconds"},"facialDetection":{"$ref":"#/components/schemas/FacialDetectionType"},"minFaceAbsPx":{"$ref":"#/components/schemas/MinFaceSize"},"minFaceRel":{"$ref":"#/components/schemas/MinFaceRel"},"minIodPx":{"$ref":"#/components/schemas/MinIOD"},"maxPoseDegrees":{"$ref":"#/components/schemas/MaxPoseDegrees"},"minFacialQuality":{"$ref":"#/components/schemas/FacialQuality"},"analyticsDetection":{"$ref":"#/components/schemas/Analytics"},"templateRawExtraction":{"$ref":"#/components/schemas/TemplateRawExtraction"},"falseDetectRate":{"$ref":"#/components/schemas/FalseDetectRate"},"maxCantidates":{"$ref":"#/components/schemas/MaxCandidates"},"minSimilarity":{"$ref":"#/components/schemas/MinSimilarity"},"authThreshold":{"$ref":"#/components/schemas/AuthThreshold"},"livenessDepth":{"$ref":"#/components/schemas/LivenessDepth"}}},"LongDetail":{"type":"boolean","description":"If true, the endpoint result will include additional information. If omitted, the default value is false."},"ElapsedSeconds":{"type":"integer","description":"Maximum lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. If 0 (default), there is no limit.","minimum":0},"FutureSeconds":{"type":"integer","description":"Maximum future lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. The template may have been created on a device with a date in the future relative to the device that consumes it. If 0 (default), no templateRaw with a future date is accepted.","minimum":0},"FacialDetectionType":{"type":"string","description":"Facial detection types in the extraction engine.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Minimum size, in pixels, that a face must have to be detected."},"MinFaceRel":{"type":"number","description":"Minimum size, relative to the image size, that a face must have to be detected.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Minimum interocular distance, in pixels, that a face must have to be detected."},"MaxPoseDegrees":{"type":"number","description":"Maximum angle difference (in degrees) between two poses to be considered valid in authentication processes.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"A metric indicating how accurately a template will perform in recognition.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Gets additional analytics in the extraction engine."},"TemplateRawExtraction":{"type":"boolean","description":"The extraction engine will generate the raw template."},"FalseDetectRate":{"type":"number","description":"False rejection tolerance level in the extraction engine. Using this value is not recommended unless you are sure of its effects.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Maximum number of candidates required in 1:N searches."},"MinSimilarity":{"type":"number","description":"Minimum tolerable similarity in 1:N searches.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Minimum value in an authentication for it to be considered positive.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Which liveness pipelines must be used.","enum":["None","Partial","Full"]}}}}
```

## The FacialAuthenticationImageTemplate object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialAuthenticationImageTemplate":{"type":"object","description":"A raw image and a facial template, used for authentication. It also supports _extraData_ and _personalDataInfo_, for registration in Api Tracking.","properties":{"image1":{"$ref":"#/components/schemas/ImageBuffer"},"faceTemplate1":{"$ref":"#/components/schemas/FacialTemplateRaw"},"extraData":{"$ref":"#/components/schemas/ExtraData"},"personalDataInfo":{"$ref":"#/components/schemas/PersonalDataInfo"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["image1","faceTemplate1"]},"ImageBuffer":{"type":"string","description":"Raw image buffer in .png, .jpg or .bmp format, base64-encoded."},"FacialTemplateRaw":{"type":"string","description":"Biometric template buffer, obtained through GetFacialTemplateRaw(), base64-encoded."},"ExtraData":{"type":"string","description":"Tokenized data used to call the Api Tracking service after the operation, base64-encoded."},"PersonalDataInfo":{"type":"object","description":"Key/value dictionary with the user's personal data, to be sent to the Api Tracking service. It is only taken into account if the _extraData_ field is not empty.","properties":{"name":{"type":"string"},"surname":{"type":"string"},"nationality":{"type":"string"},"documentNumber":{"type":"string"},"birthDate":{"type":"string"},"birthPlace":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"issuer":{"type":"string"},"issueDate":{"type":"string"},"expiryDate":{"type":"string"},"fullName":{"type":"string"},"gender":{"type":"string"},"nfcKey":{"type":"string"},"numSupport":{"type":"string"},"mrz":{"type":"string"}}},"SdkOptions":{"type":"object","description":"Options to customize the use of the extraction and identification engines. Their use is optional and no option is mandatory. If omitted, the default values are used.","properties":{"longDetail":{"$ref":"#/components/schemas/LongDetail"},"elapsedAllowedSeconds":{"$ref":"#/components/schemas/ElapsedSeconds"},"futureAllowedSeconds":{"$ref":"#/components/schemas/FutureSeconds"},"facialDetection":{"$ref":"#/components/schemas/FacialDetectionType"},"minFaceAbsPx":{"$ref":"#/components/schemas/MinFaceSize"},"minFaceRel":{"$ref":"#/components/schemas/MinFaceRel"},"minIodPx":{"$ref":"#/components/schemas/MinIOD"},"maxPoseDegrees":{"$ref":"#/components/schemas/MaxPoseDegrees"},"minFacialQuality":{"$ref":"#/components/schemas/FacialQuality"},"analyticsDetection":{"$ref":"#/components/schemas/Analytics"},"templateRawExtraction":{"$ref":"#/components/schemas/TemplateRawExtraction"},"falseDetectRate":{"$ref":"#/components/schemas/FalseDetectRate"},"maxCantidates":{"$ref":"#/components/schemas/MaxCandidates"},"minSimilarity":{"$ref":"#/components/schemas/MinSimilarity"},"authThreshold":{"$ref":"#/components/schemas/AuthThreshold"},"livenessDepth":{"$ref":"#/components/schemas/LivenessDepth"}}},"LongDetail":{"type":"boolean","description":"If true, the endpoint result will include additional information. If omitted, the default value is false."},"ElapsedSeconds":{"type":"integer","description":"Maximum lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. If 0 (default), there is no limit.","minimum":0},"FutureSeconds":{"type":"integer","description":"Maximum future lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. The template may have been created on a device with a date in the future relative to the device that consumes it. If 0 (default), no templateRaw with a future date is accepted.","minimum":0},"FacialDetectionType":{"type":"string","description":"Facial detection types in the extraction engine.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Minimum size, in pixels, that a face must have to be detected."},"MinFaceRel":{"type":"number","description":"Minimum size, relative to the image size, that a face must have to be detected.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Minimum interocular distance, in pixels, that a face must have to be detected."},"MaxPoseDegrees":{"type":"number","description":"Maximum angle difference (in degrees) between two poses to be considered valid in authentication processes.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"A metric indicating how accurately a template will perform in recognition.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Gets additional analytics in the extraction engine."},"TemplateRawExtraction":{"type":"boolean","description":"The extraction engine will generate the raw template."},"FalseDetectRate":{"type":"number","description":"False rejection tolerance level in the extraction engine. Using this value is not recommended unless you are sure of its effects.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Maximum number of candidates required in 1:N searches."},"MinSimilarity":{"type":"number","description":"Minimum tolerable similarity in 1:N searches.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Minimum value in an authentication for it to be considered positive.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Which liveness pipelines must be used.","enum":["None","Partial","Full"]}}}}
```

## The FacialAuthenticationTemplates object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialAuthenticationTemplates":{"type":"object","description":"Two facial templates, used for authentication. It also supports _extraData_ and _personalDataInfo_, for registration in Api Tracking.","properties":{"faceTemplate1":{"$ref":"#/components/schemas/FacialTemplateRaw"},"faceTemplate2":{"$ref":"#/components/schemas/FacialTemplateRaw"},"extraData":{"$ref":"#/components/schemas/ExtraData"},"personalDataInfo":{"$ref":"#/components/schemas/PersonalDataInfo"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["faceTemplate1","faceTemplete2"]},"FacialTemplateRaw":{"type":"string","description":"Biometric template buffer, obtained through GetFacialTemplateRaw(), base64-encoded."},"ExtraData":{"type":"string","description":"Tokenized data used to call the Api Tracking service after the operation, base64-encoded."},"PersonalDataInfo":{"type":"object","description":"Key/value dictionary with the user's personal data, to be sent to the Api Tracking service. It is only taken into account if the _extraData_ field is not empty.","properties":{"name":{"type":"string"},"surname":{"type":"string"},"nationality":{"type":"string"},"documentNumber":{"type":"string"},"birthDate":{"type":"string"},"birthPlace":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"issuer":{"type":"string"},"issueDate":{"type":"string"},"expiryDate":{"type":"string"},"fullName":{"type":"string"},"gender":{"type":"string"},"nfcKey":{"type":"string"},"numSupport":{"type":"string"},"mrz":{"type":"string"}}},"SdkOptions":{"type":"object","description":"Options to customize the use of the extraction and identification engines. Their use is optional and no option is mandatory. If omitted, the default values are used.","properties":{"longDetail":{"$ref":"#/components/schemas/LongDetail"},"elapsedAllowedSeconds":{"$ref":"#/components/schemas/ElapsedSeconds"},"futureAllowedSeconds":{"$ref":"#/components/schemas/FutureSeconds"},"facialDetection":{"$ref":"#/components/schemas/FacialDetectionType"},"minFaceAbsPx":{"$ref":"#/components/schemas/MinFaceSize"},"minFaceRel":{"$ref":"#/components/schemas/MinFaceRel"},"minIodPx":{"$ref":"#/components/schemas/MinIOD"},"maxPoseDegrees":{"$ref":"#/components/schemas/MaxPoseDegrees"},"minFacialQuality":{"$ref":"#/components/schemas/FacialQuality"},"analyticsDetection":{"$ref":"#/components/schemas/Analytics"},"templateRawExtraction":{"$ref":"#/components/schemas/TemplateRawExtraction"},"falseDetectRate":{"$ref":"#/components/schemas/FalseDetectRate"},"maxCantidates":{"$ref":"#/components/schemas/MaxCandidates"},"minSimilarity":{"$ref":"#/components/schemas/MinSimilarity"},"authThreshold":{"$ref":"#/components/schemas/AuthThreshold"},"livenessDepth":{"$ref":"#/components/schemas/LivenessDepth"}}},"LongDetail":{"type":"boolean","description":"If true, the endpoint result will include additional information. If omitted, the default value is false."},"ElapsedSeconds":{"type":"integer","description":"Maximum lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. If 0 (default), there is no limit.","minimum":0},"FutureSeconds":{"type":"integer","description":"Maximum future lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. The template may have been created on a device with a date in the future relative to the device that consumes it. If 0 (default), no templateRaw with a future date is accepted.","minimum":0},"FacialDetectionType":{"type":"string","description":"Facial detection types in the extraction engine.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Minimum size, in pixels, that a face must have to be detected."},"MinFaceRel":{"type":"number","description":"Minimum size, relative to the image size, that a face must have to be detected.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Minimum interocular distance, in pixels, that a face must have to be detected."},"MaxPoseDegrees":{"type":"number","description":"Maximum angle difference (in degrees) between two poses to be considered valid in authentication processes.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"A metric indicating how accurately a template will perform in recognition.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Gets additional analytics in the extraction engine."},"TemplateRawExtraction":{"type":"boolean","description":"The extraction engine will generate the raw template."},"FalseDetectRate":{"type":"number","description":"False rejection tolerance level in the extraction engine. Using this value is not recommended unless you are sure of its effects.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Maximum number of candidates required in 1:N searches."},"MinSimilarity":{"type":"number","description":"Minimum tolerable similarity in 1:N searches.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Minimum value in an authentication for it to be considered positive.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Which liveness pipelines must be used.","enum":["None","Partial","Full"]}}}}
```

## The DocumentExtractionData object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"DocumentExtractionData":{"type":"object","description":"A tokenized document and, additionally, an _extraData_ for registration in Api Tracking.","properties":{"token":{"$ref":"#/components/schemas/DocumentToken"},"extraData":{"$ref":"#/components/schemas/ExtraData"}},"required":["token"]},"DocumentToken":{"type":"string","description":"Tokenized document data (OCR, faceImage, frontImage, backImage), base64-encoded."},"ExtraData":{"type":"string","description":"Tokenized data used to call the Api Tracking service after the operation, base64-encoded."}}}}
```

## The DocumentAuthenticationImage object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"DocumentAuthenticationImage":{"type":"object","description":"A tokenized document and an image buffer, used for authentication. It also supports _extraData_, for registration in Api Tracking.","properties":{"documentTemplate":{"$ref":"#/components/schemas/DocumentToken"},"image1":{"$ref":"#/components/schemas/ImageBuffer"},"extraData":{"$ref":"#/components/schemas/ExtraData"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["documentTemplate","image1"]},"DocumentToken":{"type":"string","description":"Tokenized document data (OCR, faceImage, frontImage, backImage), base64-encoded."},"ImageBuffer":{"type":"string","description":"Raw image buffer in .png, .jpg or .bmp format, base64-encoded."},"ExtraData":{"type":"string","description":"Tokenized data used to call the Api Tracking service after the operation, base64-encoded."},"SdkOptions":{"type":"object","description":"Options to customize the use of the extraction and identification engines. Their use is optional and no option is mandatory. If omitted, the default values are used.","properties":{"longDetail":{"$ref":"#/components/schemas/LongDetail"},"elapsedAllowedSeconds":{"$ref":"#/components/schemas/ElapsedSeconds"},"futureAllowedSeconds":{"$ref":"#/components/schemas/FutureSeconds"},"facialDetection":{"$ref":"#/components/schemas/FacialDetectionType"},"minFaceAbsPx":{"$ref":"#/components/schemas/MinFaceSize"},"minFaceRel":{"$ref":"#/components/schemas/MinFaceRel"},"minIodPx":{"$ref":"#/components/schemas/MinIOD"},"maxPoseDegrees":{"$ref":"#/components/schemas/MaxPoseDegrees"},"minFacialQuality":{"$ref":"#/components/schemas/FacialQuality"},"analyticsDetection":{"$ref":"#/components/schemas/Analytics"},"templateRawExtraction":{"$ref":"#/components/schemas/TemplateRawExtraction"},"falseDetectRate":{"$ref":"#/components/schemas/FalseDetectRate"},"maxCantidates":{"$ref":"#/components/schemas/MaxCandidates"},"minSimilarity":{"$ref":"#/components/schemas/MinSimilarity"},"authThreshold":{"$ref":"#/components/schemas/AuthThreshold"},"livenessDepth":{"$ref":"#/components/schemas/LivenessDepth"}}},"LongDetail":{"type":"boolean","description":"If true, the endpoint result will include additional information. If omitted, the default value is false."},"ElapsedSeconds":{"type":"integer","description":"Maximum lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. If 0 (default), there is no limit.","minimum":0},"FutureSeconds":{"type":"integer","description":"Maximum future lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. The template may have been created on a device with a date in the future relative to the device that consumes it. If 0 (default), no templateRaw with a future date is accepted.","minimum":0},"FacialDetectionType":{"type":"string","description":"Facial detection types in the extraction engine.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Minimum size, in pixels, that a face must have to be detected."},"MinFaceRel":{"type":"number","description":"Minimum size, relative to the image size, that a face must have to be detected.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Minimum interocular distance, in pixels, that a face must have to be detected."},"MaxPoseDegrees":{"type":"number","description":"Maximum angle difference (in degrees) between two poses to be considered valid in authentication processes.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"A metric indicating how accurately a template will perform in recognition.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Gets additional analytics in the extraction engine."},"TemplateRawExtraction":{"type":"boolean","description":"The extraction engine will generate the raw template."},"FalseDetectRate":{"type":"number","description":"False rejection tolerance level in the extraction engine. Using this value is not recommended unless you are sure of its effects.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Maximum number of candidates required in 1:N searches."},"MinSimilarity":{"type":"number","description":"Minimum tolerable similarity in 1:N searches.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Minimum value in an authentication for it to be considered positive.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Which liveness pipelines must be used.","enum":["None","Partial","Full"]}}}}
```

## The DocumentAuthenticationTemplate object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"DocumentAuthenticationTemplate":{"type":"object","description":"A tokenized document and an image template, used for authentication. It also supports _extraData_, for registration in Api Tracking.","properties":{"documentTemplate":{"$ref":"#/components/schemas/DocumentToken"},"faceTemplate1":{"$ref":"#/components/schemas/FacialTemplateRaw"},"extraData":{"$ref":"#/components/schemas/ExtraData"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["documentTemplate","faceTemplate1"]},"DocumentToken":{"type":"string","description":"Tokenized document data (OCR, faceImage, frontImage, backImage), base64-encoded."},"FacialTemplateRaw":{"type":"string","description":"Biometric template buffer, obtained through GetFacialTemplateRaw(), base64-encoded."},"ExtraData":{"type":"string","description":"Tokenized data used to call the Api Tracking service after the operation, base64-encoded."},"SdkOptions":{"type":"object","description":"Options to customize the use of the extraction and identification engines. Their use is optional and no option is mandatory. If omitted, the default values are used.","properties":{"longDetail":{"$ref":"#/components/schemas/LongDetail"},"elapsedAllowedSeconds":{"$ref":"#/components/schemas/ElapsedSeconds"},"futureAllowedSeconds":{"$ref":"#/components/schemas/FutureSeconds"},"facialDetection":{"$ref":"#/components/schemas/FacialDetectionType"},"minFaceAbsPx":{"$ref":"#/components/schemas/MinFaceSize"},"minFaceRel":{"$ref":"#/components/schemas/MinFaceRel"},"minIodPx":{"$ref":"#/components/schemas/MinIOD"},"maxPoseDegrees":{"$ref":"#/components/schemas/MaxPoseDegrees"},"minFacialQuality":{"$ref":"#/components/schemas/FacialQuality"},"analyticsDetection":{"$ref":"#/components/schemas/Analytics"},"templateRawExtraction":{"$ref":"#/components/schemas/TemplateRawExtraction"},"falseDetectRate":{"$ref":"#/components/schemas/FalseDetectRate"},"maxCantidates":{"$ref":"#/components/schemas/MaxCandidates"},"minSimilarity":{"$ref":"#/components/schemas/MinSimilarity"},"authThreshold":{"$ref":"#/components/schemas/AuthThreshold"},"livenessDepth":{"$ref":"#/components/schemas/LivenessDepth"}}},"LongDetail":{"type":"boolean","description":"If true, the endpoint result will include additional information. If omitted, the default value is false."},"ElapsedSeconds":{"type":"integer","description":"Maximum lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. If 0 (default), there is no limit.","minimum":0},"FutureSeconds":{"type":"integer","description":"Maximum future lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. The template may have been created on a device with a date in the future relative to the device that consumes it. If 0 (default), no templateRaw with a future date is accepted.","minimum":0},"FacialDetectionType":{"type":"string","description":"Facial detection types in the extraction engine.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Minimum size, in pixels, that a face must have to be detected."},"MinFaceRel":{"type":"number","description":"Minimum size, relative to the image size, that a face must have to be detected.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Minimum interocular distance, in pixels, that a face must have to be detected."},"MaxPoseDegrees":{"type":"number","description":"Maximum angle difference (in degrees) between two poses to be considered valid in authentication processes.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"A metric indicating how accurately a template will perform in recognition.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Gets additional analytics in the extraction engine."},"TemplateRawExtraction":{"type":"boolean","description":"The extraction engine will generate the raw template."},"FalseDetectRate":{"type":"number","description":"False rejection tolerance level in the extraction engine. Using this value is not recommended unless you are sure of its effects.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Maximum number of candidates required in 1:N searches."},"MinSimilarity":{"type":"number","description":"Minimum tolerable similarity in 1:N searches.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Minimum value in an authentication for it to be considered positive.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Which liveness pipelines must be used.","enum":["None","Partial","Full"]}}}}
```

## The PassiveLivenessImage object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"PassiveLivenessImage":{"type":"object","description":"A raw image, used for passive liveness. It also supports _extraData_, for registration in Api Tracking.","properties":{"image":{"$ref":"#/components/schemas/ImageBuffer"},"extraData":{"$ref":"#/components/schemas/ExtraData"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["image"]},"ImageBuffer":{"type":"string","description":"Raw image buffer in .png, .jpg or .bmp format, base64-encoded."},"ExtraData":{"type":"string","description":"Tokenized data used to call the Api Tracking service after the operation, base64-encoded."},"SdkOptions":{"type":"object","description":"Options to customize the use of the extraction and identification engines. Their use is optional and no option is mandatory. If omitted, the default values are used.","properties":{"longDetail":{"$ref":"#/components/schemas/LongDetail"},"elapsedAllowedSeconds":{"$ref":"#/components/schemas/ElapsedSeconds"},"futureAllowedSeconds":{"$ref":"#/components/schemas/FutureSeconds"},"facialDetection":{"$ref":"#/components/schemas/FacialDetectionType"},"minFaceAbsPx":{"$ref":"#/components/schemas/MinFaceSize"},"minFaceRel":{"$ref":"#/components/schemas/MinFaceRel"},"minIodPx":{"$ref":"#/components/schemas/MinIOD"},"maxPoseDegrees":{"$ref":"#/components/schemas/MaxPoseDegrees"},"minFacialQuality":{"$ref":"#/components/schemas/FacialQuality"},"analyticsDetection":{"$ref":"#/components/schemas/Analytics"},"templateRawExtraction":{"$ref":"#/components/schemas/TemplateRawExtraction"},"falseDetectRate":{"$ref":"#/components/schemas/FalseDetectRate"},"maxCantidates":{"$ref":"#/components/schemas/MaxCandidates"},"minSimilarity":{"$ref":"#/components/schemas/MinSimilarity"},"authThreshold":{"$ref":"#/components/schemas/AuthThreshold"},"livenessDepth":{"$ref":"#/components/schemas/LivenessDepth"}}},"LongDetail":{"type":"boolean","description":"If true, the endpoint result will include additional information. If omitted, the default value is false."},"ElapsedSeconds":{"type":"integer","description":"Maximum lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. If 0 (default), there is no limit.","minimum":0},"FutureSeconds":{"type":"integer","description":"Maximum future lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. The template may have been created on a device with a date in the future relative to the device that consumes it. If 0 (default), no templateRaw with a future date is accepted.","minimum":0},"FacialDetectionType":{"type":"string","description":"Facial detection types in the extraction engine.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Minimum size, in pixels, that a face must have to be detected."},"MinFaceRel":{"type":"number","description":"Minimum size, relative to the image size, that a face must have to be detected.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Minimum interocular distance, in pixels, that a face must have to be detected."},"MaxPoseDegrees":{"type":"number","description":"Maximum angle difference (in degrees) between two poses to be considered valid in authentication processes.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"A metric indicating how accurately a template will perform in recognition.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Gets additional analytics in the extraction engine."},"TemplateRawExtraction":{"type":"boolean","description":"The extraction engine will generate the raw template."},"FalseDetectRate":{"type":"number","description":"False rejection tolerance level in the extraction engine. Using this value is not recommended unless you are sure of its effects.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Maximum number of candidates required in 1:N searches."},"MinSimilarity":{"type":"number","description":"Minimum tolerable similarity in 1:N searches.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Minimum value in an authentication for it to be considered positive.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Which liveness pipelines must be used.","enum":["None","Partial","Full"]}}}}
```

## The PassiveLivenessToken object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"PassiveLivenessToken":{"type":"object","description":"A tokenized image, used for passive liveness. It also supports _extraData_, for registration in Api Tracking.","properties":{"tokenImage":{"$ref":"#/components/schemas/ImageToken"},"extraData":{"$ref":"#/components/schemas/ExtraData"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["tokenImage"]},"ImageToken":{"type":"string","description":"Tokenized image, base64-encoded."},"ExtraData":{"type":"string","description":"Tokenized data used to call the Api Tracking service after the operation, base64-encoded."},"SdkOptions":{"type":"object","description":"Options to customize the use of the extraction and identification engines. Their use is optional and no option is mandatory. If omitted, the default values are used.","properties":{"longDetail":{"$ref":"#/components/schemas/LongDetail"},"elapsedAllowedSeconds":{"$ref":"#/components/schemas/ElapsedSeconds"},"futureAllowedSeconds":{"$ref":"#/components/schemas/FutureSeconds"},"facialDetection":{"$ref":"#/components/schemas/FacialDetectionType"},"minFaceAbsPx":{"$ref":"#/components/schemas/MinFaceSize"},"minFaceRel":{"$ref":"#/components/schemas/MinFaceRel"},"minIodPx":{"$ref":"#/components/schemas/MinIOD"},"maxPoseDegrees":{"$ref":"#/components/schemas/MaxPoseDegrees"},"minFacialQuality":{"$ref":"#/components/schemas/FacialQuality"},"analyticsDetection":{"$ref":"#/components/schemas/Analytics"},"templateRawExtraction":{"$ref":"#/components/schemas/TemplateRawExtraction"},"falseDetectRate":{"$ref":"#/components/schemas/FalseDetectRate"},"maxCantidates":{"$ref":"#/components/schemas/MaxCandidates"},"minSimilarity":{"$ref":"#/components/schemas/MinSimilarity"},"authThreshold":{"$ref":"#/components/schemas/AuthThreshold"},"livenessDepth":{"$ref":"#/components/schemas/LivenessDepth"}}},"LongDetail":{"type":"boolean","description":"If true, the endpoint result will include additional information. If omitted, the default value is false."},"ElapsedSeconds":{"type":"integer","description":"Maximum lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. If 0 (default), there is no limit.","minimum":0},"FutureSeconds":{"type":"integer","description":"Maximum future lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. The template may have been created on a device with a date in the future relative to the device that consumes it. If 0 (default), no templateRaw with a future date is accepted.","minimum":0},"FacialDetectionType":{"type":"string","description":"Facial detection types in the extraction engine.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Minimum size, in pixels, that a face must have to be detected."},"MinFaceRel":{"type":"number","description":"Minimum size, relative to the image size, that a face must have to be detected.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Minimum interocular distance, in pixels, that a face must have to be detected."},"MaxPoseDegrees":{"type":"number","description":"Maximum angle difference (in degrees) between two poses to be considered valid in authentication processes.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"A metric indicating how accurately a template will perform in recognition.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Gets additional analytics in the extraction engine."},"TemplateRawExtraction":{"type":"boolean","description":"The extraction engine will generate the raw template."},"FalseDetectRate":{"type":"number","description":"False rejection tolerance level in the extraction engine. Using this value is not recommended unless you are sure of its effects.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Maximum number of candidates required in 1:N searches."},"MinSimilarity":{"type":"number","description":"Minimum tolerable similarity in 1:N searches.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Minimum value in an authentication for it to be considered positive.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Which liveness pipelines must be used.","enum":["None","Partial","Full"]}}}}
```

## The GalleryImage object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"GalleryImage":{"type":"object","description":"A raw image, used for enrollment in a 1:N gallery.","properties":{"image":{"$ref":"#/components/schemas/ImageBuffer"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["image"]},"ImageBuffer":{"type":"string","description":"Raw image buffer in .png, .jpg or .bmp format, base64-encoded."},"SdkOptions":{"type":"object","description":"Options to customize the use of the extraction and identification engines. Their use is optional and no option is mandatory. If omitted, the default values are used.","properties":{"longDetail":{"$ref":"#/components/schemas/LongDetail"},"elapsedAllowedSeconds":{"$ref":"#/components/schemas/ElapsedSeconds"},"futureAllowedSeconds":{"$ref":"#/components/schemas/FutureSeconds"},"facialDetection":{"$ref":"#/components/schemas/FacialDetectionType"},"minFaceAbsPx":{"$ref":"#/components/schemas/MinFaceSize"},"minFaceRel":{"$ref":"#/components/schemas/MinFaceRel"},"minIodPx":{"$ref":"#/components/schemas/MinIOD"},"maxPoseDegrees":{"$ref":"#/components/schemas/MaxPoseDegrees"},"minFacialQuality":{"$ref":"#/components/schemas/FacialQuality"},"analyticsDetection":{"$ref":"#/components/schemas/Analytics"},"templateRawExtraction":{"$ref":"#/components/schemas/TemplateRawExtraction"},"falseDetectRate":{"$ref":"#/components/schemas/FalseDetectRate"},"maxCantidates":{"$ref":"#/components/schemas/MaxCandidates"},"minSimilarity":{"$ref":"#/components/schemas/MinSimilarity"},"authThreshold":{"$ref":"#/components/schemas/AuthThreshold"},"livenessDepth":{"$ref":"#/components/schemas/LivenessDepth"}}},"LongDetail":{"type":"boolean","description":"If true, the endpoint result will include additional information. If omitted, the default value is false."},"ElapsedSeconds":{"type":"integer","description":"Maximum lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. If 0 (default), there is no limit.","minimum":0},"FutureSeconds":{"type":"integer","description":"Maximum future lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. The template may have been created on a device with a date in the future relative to the device that consumes it. If 0 (default), no templateRaw with a future date is accepted.","minimum":0},"FacialDetectionType":{"type":"string","description":"Facial detection types in the extraction engine.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Minimum size, in pixels, that a face must have to be detected."},"MinFaceRel":{"type":"number","description":"Minimum size, relative to the image size, that a face must have to be detected.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Minimum interocular distance, in pixels, that a face must have to be detected."},"MaxPoseDegrees":{"type":"number","description":"Maximum angle difference (in degrees) between two poses to be considered valid in authentication processes.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"A metric indicating how accurately a template will perform in recognition.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Gets additional analytics in the extraction engine."},"TemplateRawExtraction":{"type":"boolean","description":"The extraction engine will generate the raw template."},"FalseDetectRate":{"type":"number","description":"False rejection tolerance level in the extraction engine. Using this value is not recommended unless you are sure of its effects.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Maximum number of candidates required in 1:N searches."},"MinSimilarity":{"type":"number","description":"Minimum tolerable similarity in 1:N searches.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Minimum value in an authentication for it to be considered positive.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Which liveness pipelines must be used.","enum":["None","Partial","Full"]}}}}
```

## The GalleryTemplate object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"GalleryTemplate":{"type":"object","description":"A facial template, used for enrollment in a 1:N gallery.","properties":{"facialTemplate":{"$ref":"#/components/schemas/FacialTemplate"}},"required":["facialTemplate"]},"FacialTemplate":{"type":"string","description":"Biometric template buffer, obtained through GetFacialTemplate(), base64-encoded."}}}}
```

## The IdentifyImage object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"IdentifyImage":{"type":"object","description":"A raw image, used for searching a 1:N gallery.","properties":{"image":{"$ref":"#/components/schemas/ImageBuffer"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["image"]},"ImageBuffer":{"type":"string","description":"Raw image buffer in .png, .jpg or .bmp format, base64-encoded."},"SdkOptions":{"type":"object","description":"Options to customize the use of the extraction and identification engines. Their use is optional and no option is mandatory. If omitted, the default values are used.","properties":{"longDetail":{"$ref":"#/components/schemas/LongDetail"},"elapsedAllowedSeconds":{"$ref":"#/components/schemas/ElapsedSeconds"},"futureAllowedSeconds":{"$ref":"#/components/schemas/FutureSeconds"},"facialDetection":{"$ref":"#/components/schemas/FacialDetectionType"},"minFaceAbsPx":{"$ref":"#/components/schemas/MinFaceSize"},"minFaceRel":{"$ref":"#/components/schemas/MinFaceRel"},"minIodPx":{"$ref":"#/components/schemas/MinIOD"},"maxPoseDegrees":{"$ref":"#/components/schemas/MaxPoseDegrees"},"minFacialQuality":{"$ref":"#/components/schemas/FacialQuality"},"analyticsDetection":{"$ref":"#/components/schemas/Analytics"},"templateRawExtraction":{"$ref":"#/components/schemas/TemplateRawExtraction"},"falseDetectRate":{"$ref":"#/components/schemas/FalseDetectRate"},"maxCantidates":{"$ref":"#/components/schemas/MaxCandidates"},"minSimilarity":{"$ref":"#/components/schemas/MinSimilarity"},"authThreshold":{"$ref":"#/components/schemas/AuthThreshold"},"livenessDepth":{"$ref":"#/components/schemas/LivenessDepth"}}},"LongDetail":{"type":"boolean","description":"If true, the endpoint result will include additional information. If omitted, the default value is false."},"ElapsedSeconds":{"type":"integer","description":"Maximum lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. If 0 (default), there is no limit.","minimum":0},"FutureSeconds":{"type":"integer","description":"Maximum future lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. The template may have been created on a device with a date in the future relative to the device that consumes it. If 0 (default), no templateRaw with a future date is accepted.","minimum":0},"FacialDetectionType":{"type":"string","description":"Facial detection types in the extraction engine.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Minimum size, in pixels, that a face must have to be detected."},"MinFaceRel":{"type":"number","description":"Minimum size, relative to the image size, that a face must have to be detected.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Minimum interocular distance, in pixels, that a face must have to be detected."},"MaxPoseDegrees":{"type":"number","description":"Maximum angle difference (in degrees) between two poses to be considered valid in authentication processes.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"A metric indicating how accurately a template will perform in recognition.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Gets additional analytics in the extraction engine."},"TemplateRawExtraction":{"type":"boolean","description":"The extraction engine will generate the raw template."},"FalseDetectRate":{"type":"number","description":"False rejection tolerance level in the extraction engine. Using this value is not recommended unless you are sure of its effects.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Maximum number of candidates required in 1:N searches."},"MinSimilarity":{"type":"number","description":"Minimum tolerable similarity in 1:N searches.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Minimum value in an authentication for it to be considered positive.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Which liveness pipelines must be used.","enum":["None","Partial","Full"]}}}}
```

## The IdentifyTemplate object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"IdentifyTemplate":{"type":"object","description":"A facial template, used for searching a 1:N gallery.","properties":{"facialTemplate":{"$ref":"#/components/schemas/FacialTemplate"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["facialTemplate"]},"FacialTemplate":{"type":"string","description":"Biometric template buffer, obtained through GetFacialTemplate(), base64-encoded."},"SdkOptions":{"type":"object","description":"Options to customize the use of the extraction and identification engines. Their use is optional and no option is mandatory. If omitted, the default values are used.","properties":{"longDetail":{"$ref":"#/components/schemas/LongDetail"},"elapsedAllowedSeconds":{"$ref":"#/components/schemas/ElapsedSeconds"},"futureAllowedSeconds":{"$ref":"#/components/schemas/FutureSeconds"},"facialDetection":{"$ref":"#/components/schemas/FacialDetectionType"},"minFaceAbsPx":{"$ref":"#/components/schemas/MinFaceSize"},"minFaceRel":{"$ref":"#/components/schemas/MinFaceRel"},"minIodPx":{"$ref":"#/components/schemas/MinIOD"},"maxPoseDegrees":{"$ref":"#/components/schemas/MaxPoseDegrees"},"minFacialQuality":{"$ref":"#/components/schemas/FacialQuality"},"analyticsDetection":{"$ref":"#/components/schemas/Analytics"},"templateRawExtraction":{"$ref":"#/components/schemas/TemplateRawExtraction"},"falseDetectRate":{"$ref":"#/components/schemas/FalseDetectRate"},"maxCantidates":{"$ref":"#/components/schemas/MaxCandidates"},"minSimilarity":{"$ref":"#/components/schemas/MinSimilarity"},"authThreshold":{"$ref":"#/components/schemas/AuthThreshold"},"livenessDepth":{"$ref":"#/components/schemas/LivenessDepth"}}},"LongDetail":{"type":"boolean","description":"If true, the endpoint result will include additional information. If omitted, the default value is false."},"ElapsedSeconds":{"type":"integer","description":"Maximum lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. If 0 (default), there is no limit.","minimum":0},"FutureSeconds":{"type":"integer","description":"Maximum future lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. The template may have been created on a device with a date in the future relative to the device that consumes it. If 0 (default), no templateRaw with a future date is accepted.","minimum":0},"FacialDetectionType":{"type":"string","description":"Facial detection types in the extraction engine.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Minimum size, in pixels, that a face must have to be detected."},"MinFaceRel":{"type":"number","description":"Minimum size, relative to the image size, that a face must have to be detected.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Minimum interocular distance, in pixels, that a face must have to be detected."},"MaxPoseDegrees":{"type":"number","description":"Maximum angle difference (in degrees) between two poses to be considered valid in authentication processes.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"A metric indicating how accurately a template will perform in recognition.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Gets additional analytics in the extraction engine."},"TemplateRawExtraction":{"type":"boolean","description":"The extraction engine will generate the raw template."},"FalseDetectRate":{"type":"number","description":"False rejection tolerance level in the extraction engine. Using this value is not recommended unless you are sure of its effects.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Maximum number of candidates required in 1:N searches."},"MinSimilarity":{"type":"number","description":"Minimum tolerable similarity in 1:N searches.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Minimum value in an authentication for it to be considered positive.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Which liveness pipelines must be used.","enum":["None","Partial","Full"]}}}}
```

## The CustomAuthentication object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"CustomAuthentication":{"type":"object","description":"Data to register an external authentication event in the Api Tracking platform. It also supports image buffers.","properties":{"authStatus":{"$ref":"#/components/schemas/FacialAuthenticationStatus"},"similarity":{"$ref":"#/components/schemas/Similarity"},"eventSource":{"$ref":"#/components/schemas/EventSource"},"image1":{"$ref":"#/components/schemas/ImageBuffer"},"image2":{"$ref":"#/components/schemas/ImageBuffer"},"extraData":{"$ref":"#/components/schemas/ExtraData"}},"required":["authStatus","similarity","extraData"]},"FacialAuthenticationStatus":{"type":"string","description":"Possible results of an authentication operation.","enum":["None","Negative","Uncertain","Positive","NoneBecausePoseExceed","NoneBecauseInvalidExtractions"]},"Similarity":{"type":"number","description":"Similarity between two facial templates (0-None, 1-Identical)."},"EventSource":{"type":"string","description":"The source of an event in the Api Tracking service."},"ImageBuffer":{"type":"string","description":"Raw image buffer in .png, .jpg or .bmp format, base64-encoded."},"ExtraData":{"type":"string","description":"Tokenized data used to call the Api Tracking service after the operation, base64-encoded."}}}}
```

## The CustomLiveness object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"CustomLiveness":{"type":"object","description":"Data to register an external liveness event in the Api Tracking platform. It also supports the image buffer.","properties":{"family":{"$ref":"#/components/schemas/TrackingFamily"},"diagnostic":{"$ref":"#/components/schemas/FacialLivenessDiagnostic"},"eventSource":{"$ref":"#/components/schemas/EventSource"},"image":{"$ref":"#/components/schemas/ImageBuffer"},"extraData":{"$ref":"#/components/schemas/ExtraData"}},"required":["family","diagnostic","extraData"]},"TrackingFamily":{"type":"string","description":"Family under which to register the Api Tracking events.","enum":["OnBoarding","Authentication"]},"FacialLivenessDiagnostic":{"type":"string","description":"Possible results of a liveness operation.","enum":["None","Spoof","Uncertain","Live","NoneBecauseBadQuality","NoneBecauseFaceTooClose","NoneBecauseFaceNotFound","NoneBecauseFaceTooSmall","NoneBecauseAngleTooLarge","NoneBecauseImageDataError","NoneBecauseInternalError","NoneBecauseImagePreprocessError","NoneBecauseTooManyFaces","NoneBecauseFaceTooCloseToBorder","NoneBecauseFaceCropped","NoneBecauseLicenseError","NoneBecauseFaceOccluded","NoLive","NoneBecauseEyesClosed","NoneBecauseEyesOccluded","NoneBecauseTokenDataError","NoneBecauseTokenSecurity"]},"EventSource":{"type":"string","description":"The source of an event in the Api Tracking service."},"ImageBuffer":{"type":"string","description":"Raw image buffer in .png, .jpg or .bmp format, base64-encoded."},"ExtraData":{"type":"string","description":"Tokenized data used to call the Api Tracking service after the operation, base64-encoded."}}}}
```

## The CustomVoiceAuthentication object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"CustomVoiceAuthentication":{"type":"object","description":"Data to register an external voice authentication event in the Api Tracking platform. It also supports audio track buffers.","properties":{"probability":{"$ref":"#/components/schemas/VoiceProbability"},"eventSource":{"$ref":"#/components/schemas/EventSource"},"extraData":{"$ref":"#/components/schemas/ExtraData"}},"required":["probability","extraData"]},"VoiceProbability":{"type":"number","description":"Voice match probability","minimum":0,"maximum":1},"EventSource":{"type":"string","description":"The source of an event in the Api Tracking service."},"ExtraData":{"type":"string","description":"Tokenized data used to call the Api Tracking service after the operation, base64-encoded."}}}}
```

## The CustomFinish object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"CustomFinish":{"type":"object","description":"Data to register external operation closing and completion events in the Api Tracking platform.","properties":{"status":{"$ref":"#/components/schemas/OperationResultStatus"},"reason":{"$ref":"#/components/schemas/OperationResultReason"},"extraData":{"$ref":"#/components/schemas/ExtraData"}},"required":["status","reason","extraData"]},"OperationResultStatus":{"type":"string","description":"Result of a client-side operation, for registration in Api Tracking.","enum":["Succeeded","Denied","Error","Live","Cancelled"]},"OperationResultReason":{"type":"string","description":"Detail of the result of a client-side operation, for registration in Api Tracking.","enum":["None","InternalError","CancelledByUser","Timeout","DocumentValidationNotPassed","DocumentValidationError","AuthenticationNotPassed","AuthenticationError","LivenessNotPassed","LivenessError"]},"ExtraData":{"type":"string","description":"Tokenized data used to call the Api Tracking service after the operation, base64-encoded."}}}}
```

## The CustomFinishFamily object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"CustomFinishFamily":{"type":"object","description":"Data to register external operation closing and completion events in the Api Tracking platform.","properties":{"family":{"$ref":"#/components/schemas/TrackingFamily"},"status":{"$ref":"#/components/schemas/OperationResultStatus"},"reason":{"$ref":"#/components/schemas/OperationResultReason"},"extraData":{"$ref":"#/components/schemas/ExtraData"}},"required":["status","reason","extraData"]},"TrackingFamily":{"type":"string","description":"Family under which to register the Api Tracking events.","enum":["OnBoarding","Authentication"]},"OperationResultStatus":{"type":"string","description":"Result of a client-side operation, for registration in Api Tracking.","enum":["Succeeded","Denied","Error","Live","Cancelled"]},"OperationResultReason":{"type":"string","description":"Detail of the result of a client-side operation, for registration in Api Tracking.","enum":["None","InternalError","CancelledByUser","Timeout","DocumentValidationNotPassed","DocumentValidationError","AuthenticationNotPassed","AuthenticationError","LivenessNotPassed","LivenessError"]},"ExtraData":{"type":"string","description":"Tokenized data used to call the Api Tracking service after the operation, base64-encoded."}}}}
```

## The CustomOCR object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"CustomOCR":{"type":"object","description":"Data to register an external OCR event in the Api Tracking platform.","properties":{"jsonData":{"$ref":"#/components/schemas/OCRData"},"eventSource":{"$ref":"#/components/schemas/EventSource"},"extraData":{"$ref":"#/components/schemas/ExtraData"}},"required":["jsonData","extraData"]},"OCRData":{"type":"string","description":"String containing a JSON key/value dictionary with the OCR fields detected in a document."},"EventSource":{"type":"string","description":"The source of an event in the Api Tracking service."},"ExtraData":{"type":"string","description":"Tokenized data used to call the Api Tracking service after the operation, base64-encoded."}}}}
```

## The CustomSecurity object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"CustomSecurity":{"type":"object","description":"Data to register an external security event in the Api Tracking platform.","properties":{"jsonData":{"$ref":"#/components/schemas/SecurityData"},"succeed":{"$ref":"#/components/schemas/Succeed"},"eventSource":{"$ref":"#/components/schemas/EventSource"},"extraData":{"$ref":"#/components/schemas/ExtraData"}},"required":["jsonData","succeed","eventSource","extraData"]},"SecurityData":{"type":"string","description":"String containing a key/value dictionary with security information."},"Succeed":{"type":"boolean","description":"Indicates whether the operation was successful or not."},"EventSource":{"type":"string","description":"The source of an event in the Api Tracking service."},"ExtraData":{"type":"string","description":"Tokenized data used to call the Api Tracking service after the operation, base64-encoded."}}}}
```

## The SdkOptions object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"SdkOptions":{"type":"object","description":"Options to customize the use of the extraction and identification engines. Their use is optional and no option is mandatory. If omitted, the default values are used.","properties":{"longDetail":{"$ref":"#/components/schemas/LongDetail"},"elapsedAllowedSeconds":{"$ref":"#/components/schemas/ElapsedSeconds"},"futureAllowedSeconds":{"$ref":"#/components/schemas/FutureSeconds"},"facialDetection":{"$ref":"#/components/schemas/FacialDetectionType"},"minFaceAbsPx":{"$ref":"#/components/schemas/MinFaceSize"},"minFaceRel":{"$ref":"#/components/schemas/MinFaceRel"},"minIodPx":{"$ref":"#/components/schemas/MinIOD"},"maxPoseDegrees":{"$ref":"#/components/schemas/MaxPoseDegrees"},"minFacialQuality":{"$ref":"#/components/schemas/FacialQuality"},"analyticsDetection":{"$ref":"#/components/schemas/Analytics"},"templateRawExtraction":{"$ref":"#/components/schemas/TemplateRawExtraction"},"falseDetectRate":{"$ref":"#/components/schemas/FalseDetectRate"},"maxCantidates":{"$ref":"#/components/schemas/MaxCandidates"},"minSimilarity":{"$ref":"#/components/schemas/MinSimilarity"},"authThreshold":{"$ref":"#/components/schemas/AuthThreshold"},"livenessDepth":{"$ref":"#/components/schemas/LivenessDepth"}}},"LongDetail":{"type":"boolean","description":"If true, the endpoint result will include additional information. If omitted, the default value is false."},"ElapsedSeconds":{"type":"integer","description":"Maximum lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. If 0 (default), there is no limit.","minimum":0},"FutureSeconds":{"type":"integer","description":"Maximum future lifetime of a templateRaw (in seconds) to be considered valid in authentication or liveness operations. The template may have been created on a device with a date in the future relative to the device that consumes it. If 0 (default), no templateRaw with a future date is accepted.","minimum":0},"FacialDetectionType":{"type":"string","description":"Facial detection types in the extraction engine.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Minimum size, in pixels, that a face must have to be detected."},"MinFaceRel":{"type":"number","description":"Minimum size, relative to the image size, that a face must have to be detected.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Minimum interocular distance, in pixels, that a face must have to be detected."},"MaxPoseDegrees":{"type":"number","description":"Maximum angle difference (in degrees) between two poses to be considered valid in authentication processes.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"A metric indicating how accurately a template will perform in recognition.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Gets additional analytics in the extraction engine."},"TemplateRawExtraction":{"type":"boolean","description":"The extraction engine will generate the raw template."},"FalseDetectRate":{"type":"number","description":"False rejection tolerance level in the extraction engine. Using this value is not recommended unless you are sure of its effects.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Maximum number of candidates required in 1:N searches."},"MinSimilarity":{"type":"number","description":"Minimum tolerable similarity in 1:N searches.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Minimum value in an authentication for it to be considered positive.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Which liveness pipelines must be used.","enum":["None","Partial","Full"]}}}}
```

## The FacialExtractionResult object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialExtractionResult":{"type":"object","description":"The result of an extraction operation.","properties":{"facialTemplate":{"$ref":"#/components/schemas/FacialTemplate"},"facialTemplateRaw":{"$ref":"#/components/schemas/FacialTemplateRaw"},"updatedTemplateRaw":{"$ref":"#/components/schemas/UpdatedTemplateRaw"},"face":{"$ref":"#/components/schemas/Rectangle"},"leftEye":{"description":"Location of the center of the left eye.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"rightEye":{"description":"Location of the center of the right eye.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"chin":{"description":"Location of the chin.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"nose":{"description":"Location of the nose.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"leftMouth":{"description":"Location of the left point of the mouth.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"rightMouth":{"description":"Location of the right point of the mouth.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"iod":{"$ref":"#/components/schemas/IOD"},"yaw":{"description":"Facial yaw angle in degrees.","type":"number"},"pitch":{"description":"Facial pitch angle in degrees.","type":"number"},"roll":{"description":"Facial roll angle in degrees.","type":"number"},"glasses":{"$ref":"#/components/schemas/FacialGlasses"},"age":{"$ref":"#/components/schemas/Age"},"gender":{"$ref":"#/components/schemas/FacialGender"},"mask":{"$ref":"#/components/schemas/FacialMask"},"faceConfidence":{"$ref":"#/components/schemas/FaceConfidence"},"facialQuality":{"$ref":"#/components/schemas/FacialQuality"},"validTimeStamp":{"$ref":"#/components/schemas/ValidTimeStamp"},"tokenTimeStamp":{"$ref":"#/components/schemas/TokenTimeStamp"},"sdkDuration":{"$ref":"#/components/schemas/SdkDuration"}}},"FacialTemplate":{"type":"string","description":"Biometric template buffer, obtained through GetFacialTemplate(), base64-encoded."},"FacialTemplateRaw":{"type":"string","description":"Biometric template buffer, obtained through GetFacialTemplateRaw(), base64-encoded."},"UpdatedTemplateRaw":{"type":"boolean","description":"The templateRaw has been updated in the extraction operation."},"Rectangle":{"type":"object","description":"A bounded area of an image.","properties":{"x":{"type":"number","description":"X coordinate of the top-left corner."},"y":{"type":"number","description":"Y coordinate of the top-left corner."},"width":{"type":"number","description":"Width of the area."},"height":{"type":"number","description":"Height of the area."}}},"XCoord":{"type":"number","description":"X coordinate."},"YCoord":{"type":"number","description":"Y coordinate."},"IOD":{"type":"number","description":"Interocular distance."},"FacialGlasses":{"type":"string","description":"Whether the person in the image wears glasses (and of which type).","enum":["None","Eye","Sun"]},"Age":{"type":"number","description":"Approximate age of the person."},"FacialGender":{"type":"string","description":"The facial gender of the person in the image.","enum":["None","Male","Female"]},"FacialMask":{"type":"number","description":"The probability of a face mask.","minimum":0,"maximum":1},"FaceConfidence":{"type":"number","description":"Predicted face confidence.","minimum":0,"maximum":1},"FacialQuality":{"type":"string","description":"A metric indicating how accurately a template will perform in recognition.","enum":["None","Bad","Regular","Good"]},"ValidTimeStamp":{"type":"boolean","description":"In authentication, liveness and extraction operations that involve templateRaws, indicates whether the template's lifetime is valid. See \"options:elapsedAllowedSeconds\". In operations that do not involve raw templates, it is always true."},"TokenTimeStamp":{"type":"string","description":"The token's internal date and time value in \"%Y-%m-%dT%H:%M:%SZ\" format."},"SdkDuration":{"type":"number","description":"Duration of the operation in milliseconds."}}}}
```

## The ExtractionImageResult object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ExtractionImageResult":{"type":"object","description":"The result of an image extraction operation.","properties":{"image":{"$ref":"#/components/schemas/ImageBuffer"}}},"ImageBuffer":{"type":"string","description":"Raw image buffer in .png, .jpg or .bmp format, base64-encoded."}}}}
```

## The FacialAuthenticationResult object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialAuthenticationResult":{"type":"object","description":"The result of an authentication operation. **extractionQuery** and **extractionTarget** are only added if **options:longDetail=true**.","properties":{"authStatus":{"$ref":"#/components/schemas/FacialAuthenticationStatus"},"similarity":{"$ref":"#/components/schemas/Similarity"},"validTimeStamp":{"$ref":"#/components/schemas/ValidTimeStamp"},"tokenTimeStamp":{"$ref":"#/components/schemas/TokenTimeStamp"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingMessage":{"$ref":"#/components/schemas/TrackingMessage"},"sdkDuration":{"$ref":"#/components/schemas/SdkDuration"},"extractionQuery":{"$ref":"#/components/schemas/FacialExtractionResult"},"extractionTarget":{"$ref":"#/components/schemas/FacialExtractionResult"}}},"FacialAuthenticationStatus":{"type":"string","description":"Possible results of an authentication operation.","enum":["None","Negative","Uncertain","Positive","NoneBecausePoseExceed","NoneBecauseInvalidExtractions"]},"Similarity":{"type":"number","description":"Similarity between two facial templates (0-None, 1-Identical)."},"ValidTimeStamp":{"type":"boolean","description":"In authentication, liveness and extraction operations that involve templateRaws, indicates whether the template's lifetime is valid. See \"options:elapsedAllowedSeconds\". In operations that do not involve raw templates, it is always true."},"TokenTimeStamp":{"type":"string","description":"The token's internal date and time value in \"%Y-%m-%dT%H:%M:%SZ\" format."},"TrackingStatus":{"type":"number","description":"Status returned by the Api Tracking service, or -1 if tracking is not required."},"TrackingMessage":{"type":"string","description":"Message returned by the Api Tracking service, or empty if tracking is not required."},"SdkDuration":{"type":"number","description":"Duration of the operation in milliseconds."},"FacialExtractionResult":{"type":"object","description":"The result of an extraction operation.","properties":{"facialTemplate":{"$ref":"#/components/schemas/FacialTemplate"},"facialTemplateRaw":{"$ref":"#/components/schemas/FacialTemplateRaw"},"updatedTemplateRaw":{"$ref":"#/components/schemas/UpdatedTemplateRaw"},"face":{"$ref":"#/components/schemas/Rectangle"},"leftEye":{"description":"Location of the center of the left eye.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"rightEye":{"description":"Location of the center of the right eye.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"chin":{"description":"Location of the chin.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"nose":{"description":"Location of the nose.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"leftMouth":{"description":"Location of the left point of the mouth.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"rightMouth":{"description":"Location of the right point of the mouth.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"iod":{"$ref":"#/components/schemas/IOD"},"yaw":{"description":"Facial yaw angle in degrees.","type":"number"},"pitch":{"description":"Facial pitch angle in degrees.","type":"number"},"roll":{"description":"Facial roll angle in degrees.","type":"number"},"glasses":{"$ref":"#/components/schemas/FacialGlasses"},"age":{"$ref":"#/components/schemas/Age"},"gender":{"$ref":"#/components/schemas/FacialGender"},"mask":{"$ref":"#/components/schemas/FacialMask"},"faceConfidence":{"$ref":"#/components/schemas/FaceConfidence"},"facialQuality":{"$ref":"#/components/schemas/FacialQuality"},"validTimeStamp":{"$ref":"#/components/schemas/ValidTimeStamp"},"tokenTimeStamp":{"$ref":"#/components/schemas/TokenTimeStamp"},"sdkDuration":{"$ref":"#/components/schemas/SdkDuration"}}},"FacialTemplate":{"type":"string","description":"Biometric template buffer, obtained through GetFacialTemplate(), base64-encoded."},"FacialTemplateRaw":{"type":"string","description":"Biometric template buffer, obtained through GetFacialTemplateRaw(), base64-encoded."},"UpdatedTemplateRaw":{"type":"boolean","description":"The templateRaw has been updated in the extraction operation."},"Rectangle":{"type":"object","description":"A bounded area of an image.","properties":{"x":{"type":"number","description":"X coordinate of the top-left corner."},"y":{"type":"number","description":"Y coordinate of the top-left corner."},"width":{"type":"number","description":"Width of the area."},"height":{"type":"number","description":"Height of the area."}}},"XCoord":{"type":"number","description":"X coordinate."},"YCoord":{"type":"number","description":"Y coordinate."},"IOD":{"type":"number","description":"Interocular distance."},"FacialGlasses":{"type":"string","description":"Whether the person in the image wears glasses (and of which type).","enum":["None","Eye","Sun"]},"Age":{"type":"number","description":"Approximate age of the person."},"FacialGender":{"type":"string","description":"The facial gender of the person in the image.","enum":["None","Male","Female"]},"FacialMask":{"type":"number","description":"The probability of a face mask.","minimum":0,"maximum":1},"FaceConfidence":{"type":"number","description":"Predicted face confidence.","minimum":0,"maximum":1},"FacialQuality":{"type":"string","description":"A metric indicating how accurately a template will perform in recognition.","enum":["None","Bad","Regular","Good"]}}}}
```

## The DocumentExtractionResult object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"DocumentExtractionResult":{"type":"object","description":"The result of a document extraction operation.","properties":{"documentData":{"$ref":"#/components/schemas/OCRData"},"imageData":{"type":"object","properties":{"faceImage":{"type":"string","description":"The raw data of the document's face image, base64-encoded."},"documentFrontImage":{"type":"string","description":"The raw data of the document's front image, base64-encoded."},"documentBackImage":{"type":"string","description":"The raw data of the document's back image, base64-encoded."}},"additionalProperties":{"type":"string"},"description":"Key/value string dictionary with the images detected in the document."},"validTimeStamp":{"$ref":"#/components/schemas/ValidTimeStamp"},"tokenTimeStamp":{"$ref":"#/components/schemas/TokenTimeStamp"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingMessage":{"$ref":"#/components/schemas/TrackingMessage"},"sdkDuration":{"$ref":"#/components/schemas/SdkDuration"}}},"OCRData":{"type":"string","description":"String containing a JSON key/value dictionary with the OCR fields detected in a document."},"ValidTimeStamp":{"type":"boolean","description":"In authentication, liveness and extraction operations that involve templateRaws, indicates whether the template's lifetime is valid. See \"options:elapsedAllowedSeconds\". In operations that do not involve raw templates, it is always true."},"TokenTimeStamp":{"type":"string","description":"The token's internal date and time value in \"%Y-%m-%dT%H:%M:%SZ\" format."},"TrackingStatus":{"type":"number","description":"Status returned by the Api Tracking service, or -1 if tracking is not required."},"TrackingMessage":{"type":"string","description":"Message returned by the Api Tracking service, or empty if tracking is not required."},"SdkDuration":{"type":"number","description":"Duration of the operation in milliseconds."}}}}
```

## The PassiveLivenessResult object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"PassiveLivenessResult":{"type":"object","description":"The result of a passive liveness operation.","properties":{"diagnostic":{"$ref":"#/components/schemas/FacialLivenessDiagnostic"},"noLiveDetails":{"$ref":"#/components/schemas/NoLiveDetails"},"validTimeStamp":{"$ref":"#/components/schemas/ValidTimeStamp"},"tokenTimeStamp":{"$ref":"#/components/schemas/TokenTimeStamp"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingMessage":{"$ref":"#/components/schemas/TrackingMessage"},"sdkDuration":{"$ref":"#/components/schemas/SdkDuration"}}},"FacialLivenessDiagnostic":{"type":"string","description":"Possible results of a liveness operation.","enum":["None","Spoof","Uncertain","Live","NoneBecauseBadQuality","NoneBecauseFaceTooClose","NoneBecauseFaceNotFound","NoneBecauseFaceTooSmall","NoneBecauseAngleTooLarge","NoneBecauseImageDataError","NoneBecauseInternalError","NoneBecauseImagePreprocessError","NoneBecauseTooManyFaces","NoneBecauseFaceTooCloseToBorder","NoneBecauseFaceCropped","NoneBecauseLicenseError","NoneBecauseFaceOccluded","NoLive","NoneBecauseEyesClosed","NoneBecauseEyesOccluded","NoneBecauseTokenDataError","NoneBecauseTokenSecurity"]},"NoLiveDetails":{"type":"object","description":"Details for the FacialLivenessDiagnostic::NoLive case","properties":{"mainCause":{"$ref":"#/components/schemas/NoLiveMainCause"},"fPadStatus":{"$ref":"#/components/schemas/FPadStatus"},"fPadScore":{"$ref":"#/components/schemas/FPadScore"},"fMadStatus":{"$ref":"#/components/schemas/FMadStatus"},"fMadScore":{"$ref":"#/components/schemas/FMadScore"},"coercionScore":{"$ref":"#/components/schemas/CoercionScore"},"reasonMessage":{"$ref":"#/components/schemas/NoLiveReasonMessage"}}},"NoLiveMainCause":{"type":"string","description":"High-level main cause of the NoLive diagnostic.","enum":["FPadFailed","FMadFailed","MultipleFailed","Unknown"]},"FPadStatus":{"type":"string","description":"Status of facial presentation attack detection (fPAD).","enum":["NotEvaluated","Passed","Failed","Error"]},"FPadScore":{"type":"number","description":"Normalized fPAD score, if available","minimum":0,"maximum":1},"FMadStatus":{"type":"string","description":"Status of facial manipulation attack detection (fMAD).","enum":["NotEvaluated","Passed","Failed","Error"]},"FMadScore":{"type":"number","description":"Normalized fMAD score, if available","minimum":0,"maximum":1},"CoercionScore":{"type":"number","description":"Normalized coercion score, if available","minimum":0,"maximum":1},"NoLiveReasonMessage":{"type":"string","description":"Human-readable reason message, for logs/backoffice."},"ValidTimeStamp":{"type":"boolean","description":"In authentication, liveness and extraction operations that involve templateRaws, indicates whether the template's lifetime is valid. See \"options:elapsedAllowedSeconds\". In operations that do not involve raw templates, it is always true."},"TokenTimeStamp":{"type":"string","description":"The token's internal date and time value in \"%Y-%m-%dT%H:%M:%SZ\" format."},"TrackingStatus":{"type":"number","description":"Status returned by the Api Tracking service, or -1 if tracking is not required."},"TrackingMessage":{"type":"string","description":"Message returned by the Api Tracking service, or empty if tracking is not required."},"SdkDuration":{"type":"number","description":"Duration of the operation in milliseconds."}}}}
```

## The EnrollResult object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"EnrollResult":{"type":"object","description":"The result of enrolling a template in a gallery.","properties":{"galleryIndex":{"$ref":"#/components/schemas/GalleryIndex"},"facialTemplate":{"$ref":"#/components/schemas/FacialTemplate"},"sdkDuration":{"$ref":"#/components/schemas/SdkDuration"}}},"GalleryIndex":{"type":"integer","description":"The index of a facial template in a gallery.","minimum":0},"FacialTemplate":{"type":"string","description":"Biometric template buffer, obtained through GetFacialTemplate(), base64-encoded."},"SdkDuration":{"type":"number","description":"Duration of the operation in milliseconds."}}}}
```

## The SearchResult object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"SearchResult":{"type":"object","description":"The result of searching for a template in a gallery.","properties":{"galleryIndex":{"$ref":"#/components/schemas/GalleryIndex"},"templateId":{"$ref":"#/components/schemas/FacialTemplateId"},"similarity":{"$ref":"#/components/schemas/Similarity"},"facialAuthenticationStatus":{"$ref":"#/components/schemas/FacialAuthenticationStatus"},"facialAuthenticationDetail":{"$ref":"#/components/schemas/FacialAuthenticationDetail"},"sdkDuration":{"$ref":"#/components/schemas/SdkDuration"}}},"GalleryIndex":{"type":"integer","description":"The index of a facial template in a gallery.","minimum":0},"FacialTemplateId":{"type":"string","description":"The name of a facial template in a gallery."},"Similarity":{"type":"number","description":"Similarity between two facial templates (0-None, 1-Identical)."},"FacialAuthenticationStatus":{"type":"string","description":"Possible results of an authentication operation.","enum":["None","Negative","Uncertain","Positive","NoneBecausePoseExceed","NoneBecauseInvalidExtractions"]},"FacialAuthenticationDetail":{"type":"string","description":"Quality detail of an authentication operation.","enum":["None","PositiveLowSecurityLevel","PositiveMediumSecurityLevel","PositiveHighSecurityLevel"]},"SdkDuration":{"type":"number","description":"Duration of the operation in milliseconds."}}}}
```

## The Galleries object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"Galleries":{"type":"object","description":"The content of all open galleries.","properties":{"galleries":{"type":"array","items":{"$ref":"#/components/schemas/GalleryId"}}}},"GalleryId":{"type":"string","description":"The name of a facial template gallery."}}}}
```

## The FacialTemplateIds object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialTemplateIds":{"type":"object","description":"A list of templateIds.","properties":{"templateIds":{"type":"array","items":{"$ref":"#/components/schemas/FacialTemplateId"}}}},"FacialTemplateId":{"type":"string","description":"The name of a facial template in a gallery."}}}}
```

## The HealthResult object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"HealthResult":{"type":"object","description":"The result of a health check.","properties":{"message":{"$ref":"#/components/schemas/HealthStatus"}}},"HealthStatus":{"type":"string","description":"Result of the health service (indicates whether the SDK is alive or not).","enum":["Healthy","No healthy"]}}}}
```

## The TrackingResult object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"TrackingResult":{"type":"object","description":"The result of an Api Tracking operation.","properties":{"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingMessage":{"$ref":"#/components/schemas/TrackingMessage"}}},"TrackingStatus":{"type":"number","description":"Status returned by the Api Tracking service, or -1 if tracking is not required."},"TrackingMessage":{"type":"string","description":"Message returned by the Api Tracking service, or empty if tracking is not required."}}}}
```

## The TokenTypeResult object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"TokenTypeResult":{"type":"object","description":"The result of the token identification.","properties":{"type":{"$ref":"#/components/schemas/TokenType"}}},"TokenType":{"type":"string","description":"Possible results for an input token buffer.","enum":["jpg","png","bmp","templateRaw","tokenImage","tokenGeneric","unknown","unsupported"]}}}}
```

## The ConfigParams object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ConfigParams":{"type":"object","description":"The configuration parameters of the SDK and the service. The JWT authentication configuration is intentionally omitted.","properties":{"FACEPHI_SELPHID_DEBUGPATH_KEY":{"type":"string","description":"Path and file where the SelphID logs are written."},"FACEPHI_SELPHID_FACIALAUTHENTICATION_THRESHOLD":{"type":"string","description":"Threshold for facial authentication."},"FACEPHI_SELPHID_FACIALEXTRACTOR_NUM_THREADS":{"type":"string","description":"Number of cores assigned to extraction/authentication operations."},"FACEPHI_SELPHID_FACIALLIVENESS_DEPTH":{"type":"string","description":"Liveness engine pipeline mode."},"FACEPHI_SELPHID_FACIALLIVENESS_IAD":{"type":"string","description":"Status of the liveness injection attack detection (IAD) filters."},"FACEPHI_SELPHID_FACIALLIVENESS_PATH_KEY":{"type":"string","description":"Path where the models and other pipeline data are installed."},"FACEPHI_SELPHID_FACIALLIVENESS_THRESHOLD":{"type":"string","description":"Threshold for liveness operations."},"FACEPHI_SELPHID_FACIAL_LICPATH_KEY":{"type":"string","description":"License path."},"FACEPHI_SELPHID_FUTURE_TIME_ALLOWED":{"type":"string","description":"Global value to accept templateRaws with future dates."},"FACEPHI_SELPHID_GALLERY_REMOVE_METHOD":{"type":"string","description":"Removal method for 1:N galleries."},"FACEPHI_SELPHID_USAGEPATH_KEY":{"type":"string","description":"Path of the usage database."},"client_max_body_size":{"type":"integer","description":"Maximum size of the request data (Mb)."},"connection_timeout":{"type":"integer","description":"Maximum timeout for connections (0=infinite)."},"keep_alive_request_number":{"type":"integer","description":"How a connection can be used in terms of timeout and maximum number of requests."},"logger_level":{"type":"string","description":"Logging level (logger)."},"logger_max_files":{"type":"integer","description":"Maximum number of files used in log rotation."},"logger_path":{"type":"string","description":"Path where the service logs are stored."},"logger_rotation":{"type":"string","description":"Log rotation strategy (logger)."},"number_of_threads":{"type":"integer","description":"Number of cores assigned to concurrent requests."},"port":{"type":"integer","description":"Service listening port."}}}}}}
```

## The BadRequestResult object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"BadRequestResult":{"type":"object","description":"Result when incorrect parameters arrive in the request.","properties":{"status":{"type":"number"},"error":{"type":"string"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}},"TimeStamp":{"type":"string","description":"A date and time value in \"%Y-%m-%dT%H:%M:%SZ\" format."}}}}
```

## The ExceptionResult object

```json
{"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ExceptionResult":{"type":"object","description":"An error occurred in the call to the SelphID-SDK backend.","properties":{"status":{"type":"number"},"error":{"type":"string"},"exception":{"type":"string"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}},"TimeStamp":{"type":"string","description":"A date and time value in \"%Y-%m-%dT%H:%M:%SZ\" format."}}}}
```