> 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":"Búfer en bruto de imagen en .png, .jpg o .bmp, codificado en base64."}}}} ``` ## The ImageToken object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ImageToken":{"type":"string","description":"Imagen tokenizada, codificada en base64."}}}} ``` ## The Token object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"Token":{"type":"string","description":"Búfer en bruto de imagen en .png, .jpg o .bmp, codificado en base64, o imagen tokenizada, codificada en base64."}}}} ``` ## The FacialTemplate object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialTemplate":{"type":"string","description":"Búfer de plantilla biométrica, obtenido mediante GetFacialTemplate(), codificado en base64."}}}} ``` ## The FacialTemplateRaw object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialTemplateRaw":{"type":"string","description":"Búfer de plantilla biométrica, obtenido mediante GetFacialTemplateRaw(), codificado en base64."}}}} ``` ## The UpdatedTemplateRaw object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"UpdatedTemplateRaw":{"type":"boolean","description":"El templateRaw se ha actualizado en la operación de extracción."}}}} ``` ## The FacialTemplateId object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialTemplateId":{"type":"string","description":"El nombre de una plantilla facial en una galería."}}}} ``` ## The DocumentToken object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"DocumentToken":{"type":"string","description":"Datos de documento tokenizados (OCR, faceImage, frontImage, backImage), codificados en base64."}}}} ``` ## The AudioBuffer object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"AudioBuffer":{"type":"string","description":"Búfer en bruto de audio en WAV, OPUS/OGG, MP3 o AAC, codificado en base64. El audio puede estar cifrado o no."}}}} ``` ## The ExtraData object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ExtraData":{"type":"string","description":"Datos tokenizados para llamar al servicio Api Tracking tras la operación, codificados en base64."}}}} ``` ## The PersonalDataInfo object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"PersonalDataInfo":{"type":"object","description":"Diccionario clave/valor con los datos personales del usuario, para su envío al servicio Api Tracking. Solo se tendrá en cuenta si el campo _extraData_ no está vacío.","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":"Un valor de fecha y hora en formato \"%Y-%m-%dT%H:%M:%SZ\"."}}}} ``` ## The TokenTimeStamp object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"TokenTimeStamp":{"type":"string","description":"El valor interno de fecha y hora del token en formato \"%Y-%m-%dT%H:%M:%SZ\"."}}}} ``` ## The XCoord object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"XCoord":{"type":"number","description":"Coordenada X."}}}} ``` ## The YCoord object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"YCoord":{"type":"number","description":"Coordenada Y."}}}} ``` ## The MinFaceSize object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"MinFaceSize":{"type":"integer","description":"Tamaño mínimo en píxeles que debe tener un rostro para ser detectado."}}}} ``` ## The MinIOD object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"MinIOD":{"type":"integer","description":"Distancia interocular mínima en píxeles que debe tener un rostro para ser detectado."}}}} ``` ## The MinFaceRel object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"MinFaceRel":{"type":"number","description":"Tamaño mínimo, en proporción al tamaño de la imagen, que debe tener un rostro para ser detectado.","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":"Diferencia máxima de ángulo (en grados) entre dos poses para considerarse válida en procesos de autenticación.","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":"Nivel de tolerancia de falso rechazo en el motor de extracción. No se recomienda usar este valor si no está seguro de sus efectos.","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":"Distancia interocular."}}}} ``` ## The Rectangle object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"Rectangle":{"type":"object","description":"Un área delimitada de una imagen.","properties":{"x":{"type":"number","description":"Coordenada X de la esquina superior izquierda."},"y":{"type":"number","description":"Coordenada Y de la esquina superior izquierda."},"width":{"type":"number","description":"Anchura del área."},"height":{"type":"number","description":"Altura del área."}}}}}} ``` ## The Analytics object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"Analytics":{"type":"boolean","description":"Obtiene analíticas adicionales en el motor de extracción."}}}} ``` ## The TemplateRawExtraction object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"TemplateRawExtraction":{"type":"boolean","description":"El motor de extracción generará la plantilla en bruto."}}}} ``` ## The Similarity object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"Similarity":{"type":"number","description":"Similitud entre dos plantillas faciales (0-Ninguna, 1-Idéntica)."}}}} ``` ## The MinSimilarity object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"MinSimilarity":{"type":"number","description":"Similitud mínima tolerable en búsquedas 1:N.","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":"Valor mínimo en una autenticación para considerarla positiva.","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":"Aproximación de la edad de la persona."}}}} ``` ## The Succeed object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"Succeed":{"type":"boolean","description":"Indica si la operación se ha realizado correctamente o no."}}}} ``` ## The ValidTimeStamp object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ValidTimeStamp":{"type":"boolean","description":"En las operaciones de autenticación, prueba de vida y extracción que implican templateRaws, indica si el tiempo de vida de la plantilla es válido. Véase \"options:elapsedAllowedSeconds\". En las operaciones que no implican plantillas en bruto, siempre será 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":"Número máximo de candidatos requeridos en búsquedas 1:N."}}}} ``` ## The GalleryIndex object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"GalleryIndex":{"type":"integer","description":"El índice de una plantilla facial en una galería.","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":"El nombre de una galería de plantillas faciales."}}}} ``` ## The LongDetail object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"LongDetail":{"type":"boolean","description":"Si es true, el resultado del endpoint incluirá información adicional. Si se omite, el valor por defecto será 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":"Tiempo de vida máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. Si es 0 (por defecto), no hay límite.","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":"Tiempo de vida futuro máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. La plantilla puede haberse creado en un dispositivo con una fecha futura respecto al dispositivo que la consume. Si es 0 (por defecto), no se aceptará ningún templateRaw con una fecha futura.","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":"Intervalo de tiempo en segundos, utilizado normalmente para comprobar las marcas de tiempo de templateRaw.","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":"Probabilidad de coincidencia de voz","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":"El origen de un evento en el servicio Api Tracking."}}}} ``` ## The TrackingStatus object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"TrackingStatus":{"type":"number","description":"Estado devuelto por el servicio Api Tracking, o -1 si no se requiere seguimiento."}}}} ``` ## The TrackingMessage object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"TrackingMessage":{"type":"string","description":"Mensaje devuelto por el servicio Api Tracking, o vacío si no se requiere seguimiento."}}}} ``` ## The FacialDetectionType object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialDetectionType":{"type":"string","description":"Tipos de detección facial en el motor de extracción.","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":"Posibles resultados de una operación de autenticación.","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":"Detalle de la calidad de una operación de autenticación.","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":"Qué pipelines de prueba de vida deben utilizarse.","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":"Causa principal de alto nivel del diagnóstico NoLive.","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":"Estado de la detección facial de ataques de presentación (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":"Estado de la detección facial de ataques de manipulación (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":"Puntuación fPAD normalizada, si está disponible","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":"Puntuación fMAD normalizada, si está disponible","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":"Puntuación de coerción normalizada, si está disponible","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":"Mensaje del motivo legible por humanos, para registros/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":"Posibles resultados de una operación de prueba de vida.","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":"Detalles para el caso FacialLivenessDiagnostic::NoLive","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":"Causa principal de alto nivel del diagnóstico NoLive.","enum":["FPadFailed","FMadFailed","MultipleFailed","Unknown"]},"FPadStatus":{"type":"string","description":"Estado de la detección facial de ataques de presentación (fPAD).","enum":["NotEvaluated","Passed","Failed","Error"]},"FPadScore":{"type":"number","description":"Puntuación fPAD normalizada, si está disponible","minimum":0,"maximum":1},"FMadStatus":{"type":"string","description":"Estado de la detección facial de ataques de manipulación (fMAD).","enum":["NotEvaluated","Passed","Failed","Error"]},"FMadScore":{"type":"number","description":"Puntuación fMAD normalizada, si está disponible","minimum":0,"maximum":1},"CoercionScore":{"type":"number","description":"Puntuación de coerción normalizada, si está disponible","minimum":0,"maximum":1},"NoLiveReasonMessage":{"type":"string","description":"Mensaje del motivo legible por humanos, para registros/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":"La persona de la imagen lleva gafas (y de qué tipo).","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":"El género facial de la persona en la imagen.","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":"La probabilidad de mascarilla facial.","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":"Confianza predicha del rostro.","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":"Una métrica que indica con qué precisión se comportará una plantilla en el reconocimiento.","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":"Familia con la que registrar los eventos de Api Tracking.","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":"Resultado de una operación en el lado del cliente, para el registro en 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":"Detalle del resultado de una operación en el lado del cliente, para el registro en 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":"Posibles resultados de un búfer de token de entrada.","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":"Resultado del servicio de estado (indica si el SDK está activo o no).","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":"Duración de la operación en milisegundos."}}}} ``` ## The OCRData object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"OCRData":{"type":"string","description":"Cadena con un diccionario Json clave/valor con los campos de OCR detectados en un documento."}}}} ``` ## The SecurityData object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"SecurityData":{"type":"string","description":"Cadena con un diccionario clave/valor con información de seguridad."}}}} ``` ## The TokenBuffer object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"TokenBuffer":{"type":"object","description":"Un búfer en bruto de imagen o token.","properties":{"tokenBuffer":{"$ref":"#/components/schemas/Token"}},"required":["tokenBuffer"]},"Token":{"type":"string","description":"Búfer en bruto de imagen en .png, .jpg o .bmp, codificado en base64, o imagen tokenizada, codificada en base64."}}}} ``` ## The ExtractImage object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ExtractImage":{"type":"object","description":"Una imagen en bruto, utilizada para la extracción.","properties":{"image":{"$ref":"#/components/schemas/ImageBuffer"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["image"]},"ImageBuffer":{"type":"string","description":"Búfer en bruto de imagen en .png, .jpg o .bmp, codificado en base64."},"SdkOptions":{"type":"object","description":"Opciones para personalizar el uso de los motores de extracción e identificación. Su uso es opcional y ninguna opción es obligatoria. Si se omiten, se usarán los valores por defecto.","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":"Si es true, el resultado del endpoint incluirá información adicional. Si se omite, el valor por defecto será false."},"ElapsedSeconds":{"type":"integer","description":"Tiempo de vida máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. Si es 0 (por defecto), no hay límite.","minimum":0},"FutureSeconds":{"type":"integer","description":"Tiempo de vida futuro máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. La plantilla puede haberse creado en un dispositivo con una fecha futura respecto al dispositivo que la consume. Si es 0 (por defecto), no se aceptará ningún templateRaw con una fecha futura.","minimum":0},"FacialDetectionType":{"type":"string","description":"Tipos de detección facial en el motor de extracción.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Tamaño mínimo en píxeles que debe tener un rostro para ser detectado."},"MinFaceRel":{"type":"number","description":"Tamaño mínimo, en proporción al tamaño de la imagen, que debe tener un rostro para ser detectado.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Distancia interocular mínima en píxeles que debe tener un rostro para ser detectado."},"MaxPoseDegrees":{"type":"number","description":"Diferencia máxima de ángulo (en grados) entre dos poses para considerarse válida en procesos de autenticación.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"Una métrica que indica con qué precisión se comportará una plantilla en el reconocimiento.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Obtiene analíticas adicionales en el motor de extracción."},"TemplateRawExtraction":{"type":"boolean","description":"El motor de extracción generará la plantilla en bruto."},"FalseDetectRate":{"type":"number","description":"Nivel de tolerancia de falso rechazo en el motor de extracción. No se recomienda usar este valor si no está seguro de sus efectos.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Número máximo de candidatos requeridos en búsquedas 1:N."},"MinSimilarity":{"type":"number","description":"Similitud mínima tolerable en búsquedas 1:N.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Valor mínimo en una autenticación para considerarla positiva.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Qué pipelines de prueba de vida deben utilizarse.","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":"Una plantilla en bruto, utilizada para la extracción.","properties":{"faceTemplate":{"$ref":"#/components/schemas/FacialTemplate"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["faceTemplate"]},"FacialTemplate":{"type":"string","description":"Búfer de plantilla biométrica, obtenido mediante GetFacialTemplate(), codificado en base64."},"SdkOptions":{"type":"object","description":"Opciones para personalizar el uso de los motores de extracción e identificación. Su uso es opcional y ninguna opción es obligatoria. Si se omiten, se usarán los valores por defecto.","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":"Si es true, el resultado del endpoint incluirá información adicional. Si se omite, el valor por defecto será false."},"ElapsedSeconds":{"type":"integer","description":"Tiempo de vida máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. Si es 0 (por defecto), no hay límite.","minimum":0},"FutureSeconds":{"type":"integer","description":"Tiempo de vida futuro máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. La plantilla puede haberse creado en un dispositivo con una fecha futura respecto al dispositivo que la consume. Si es 0 (por defecto), no se aceptará ningún templateRaw con una fecha futura.","minimum":0},"FacialDetectionType":{"type":"string","description":"Tipos de detección facial en el motor de extracción.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Tamaño mínimo en píxeles que debe tener un rostro para ser detectado."},"MinFaceRel":{"type":"number","description":"Tamaño mínimo, en proporción al tamaño de la imagen, que debe tener un rostro para ser detectado.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Distancia interocular mínima en píxeles que debe tener un rostro para ser detectado."},"MaxPoseDegrees":{"type":"number","description":"Diferencia máxima de ángulo (en grados) entre dos poses para considerarse válida en procesos de autenticación.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"Una métrica que indica con qué precisión se comportará una plantilla en el reconocimiento.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Obtiene analíticas adicionales en el motor de extracción."},"TemplateRawExtraction":{"type":"boolean","description":"El motor de extracción generará la plantilla en bruto."},"FalseDetectRate":{"type":"number","description":"Nivel de tolerancia de falso rechazo en el motor de extracción. No se recomienda usar este valor si no está seguro de sus efectos.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Número máximo de candidatos requeridos en búsquedas 1:N."},"MinSimilarity":{"type":"number","description":"Similitud mínima tolerable en búsquedas 1:N.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Valor mínimo en una autenticación para considerarla positiva.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Qué pipelines de prueba de vida deben utilizarse.","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":"Una plantilla en bruto, utilizada para la extracción de imagen.","properties":{"faceTemplate":{"$ref":"#/components/schemas/FacialTemplate"}},"required":["faceTemplate"]},"FacialTemplate":{"type":"string","description":"Búfer de plantilla biométrica, obtenido mediante GetFacialTemplate(), codificado en base64."}}}} ``` ## The FacialAuthenticationImages object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialAuthenticationImages":{"type":"object","description":"Dos imágenes en bruto, utilizadas para la autenticación.","properties":{"image1":{"$ref":"#/components/schemas/ImageBuffer"},"image2":{"$ref":"#/components/schemas/ImageBuffer"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["image1","image2"]},"ImageBuffer":{"type":"string","description":"Búfer en bruto de imagen en .png, .jpg o .bmp, codificado en base64."},"SdkOptions":{"type":"object","description":"Opciones para personalizar el uso de los motores de extracción e identificación. Su uso es opcional y ninguna opción es obligatoria. Si se omiten, se usarán los valores por defecto.","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":"Si es true, el resultado del endpoint incluirá información adicional. Si se omite, el valor por defecto será false."},"ElapsedSeconds":{"type":"integer","description":"Tiempo de vida máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. Si es 0 (por defecto), no hay límite.","minimum":0},"FutureSeconds":{"type":"integer","description":"Tiempo de vida futuro máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. La plantilla puede haberse creado en un dispositivo con una fecha futura respecto al dispositivo que la consume. Si es 0 (por defecto), no se aceptará ningún templateRaw con una fecha futura.","minimum":0},"FacialDetectionType":{"type":"string","description":"Tipos de detección facial en el motor de extracción.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Tamaño mínimo en píxeles que debe tener un rostro para ser detectado."},"MinFaceRel":{"type":"number","description":"Tamaño mínimo, en proporción al tamaño de la imagen, que debe tener un rostro para ser detectado.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Distancia interocular mínima en píxeles que debe tener un rostro para ser detectado."},"MaxPoseDegrees":{"type":"number","description":"Diferencia máxima de ángulo (en grados) entre dos poses para considerarse válida en procesos de autenticación.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"Una métrica que indica con qué precisión se comportará una plantilla en el reconocimiento.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Obtiene analíticas adicionales en el motor de extracción."},"TemplateRawExtraction":{"type":"boolean","description":"El motor de extracción generará la plantilla en bruto."},"FalseDetectRate":{"type":"number","description":"Nivel de tolerancia de falso rechazo en el motor de extracción. No se recomienda usar este valor si no está seguro de sus efectos.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Número máximo de candidatos requeridos en búsquedas 1:N."},"MinSimilarity":{"type":"number","description":"Similitud mínima tolerable en búsquedas 1:N.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Valor mínimo en una autenticación para considerarla positiva.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Qué pipelines de prueba de vida deben utilizarse.","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":"Una imagen en bruto y una plantilla facial, utilizadas para la autenticación. Además, admite _extraData_ y _personalDataInfo_, para el registro en 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":"Búfer en bruto de imagen en .png, .jpg o .bmp, codificado en base64."},"FacialTemplateRaw":{"type":"string","description":"Búfer de plantilla biométrica, obtenido mediante GetFacialTemplateRaw(), codificado en base64."},"ExtraData":{"type":"string","description":"Datos tokenizados para llamar al servicio Api Tracking tras la operación, codificados en base64."},"PersonalDataInfo":{"type":"object","description":"Diccionario clave/valor con los datos personales del usuario, para su envío al servicio Api Tracking. Solo se tendrá en cuenta si el campo _extraData_ no está vacío.","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":"Opciones para personalizar el uso de los motores de extracción e identificación. Su uso es opcional y ninguna opción es obligatoria. Si se omiten, se usarán los valores por defecto.","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":"Si es true, el resultado del endpoint incluirá información adicional. Si se omite, el valor por defecto será false."},"ElapsedSeconds":{"type":"integer","description":"Tiempo de vida máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. Si es 0 (por defecto), no hay límite.","minimum":0},"FutureSeconds":{"type":"integer","description":"Tiempo de vida futuro máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. La plantilla puede haberse creado en un dispositivo con una fecha futura respecto al dispositivo que la consume. Si es 0 (por defecto), no se aceptará ningún templateRaw con una fecha futura.","minimum":0},"FacialDetectionType":{"type":"string","description":"Tipos de detección facial en el motor de extracción.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Tamaño mínimo en píxeles que debe tener un rostro para ser detectado."},"MinFaceRel":{"type":"number","description":"Tamaño mínimo, en proporción al tamaño de la imagen, que debe tener un rostro para ser detectado.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Distancia interocular mínima en píxeles que debe tener un rostro para ser detectado."},"MaxPoseDegrees":{"type":"number","description":"Diferencia máxima de ángulo (en grados) entre dos poses para considerarse válida en procesos de autenticación.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"Una métrica que indica con qué precisión se comportará una plantilla en el reconocimiento.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Obtiene analíticas adicionales en el motor de extracción."},"TemplateRawExtraction":{"type":"boolean","description":"El motor de extracción generará la plantilla en bruto."},"FalseDetectRate":{"type":"number","description":"Nivel de tolerancia de falso rechazo en el motor de extracción. No se recomienda usar este valor si no está seguro de sus efectos.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Número máximo de candidatos requeridos en búsquedas 1:N."},"MinSimilarity":{"type":"number","description":"Similitud mínima tolerable en búsquedas 1:N.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Valor mínimo en una autenticación para considerarla positiva.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Qué pipelines de prueba de vida deben utilizarse.","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":"Dos plantillas faciales, utilizadas para la autenticación. Además, admite _extraData_ y _personalDataInfo_, para el registro en 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":"Búfer de plantilla biométrica, obtenido mediante GetFacialTemplateRaw(), codificado en base64."},"ExtraData":{"type":"string","description":"Datos tokenizados para llamar al servicio Api Tracking tras la operación, codificados en base64."},"PersonalDataInfo":{"type":"object","description":"Diccionario clave/valor con los datos personales del usuario, para su envío al servicio Api Tracking. Solo se tendrá en cuenta si el campo _extraData_ no está vacío.","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":"Opciones para personalizar el uso de los motores de extracción e identificación. Su uso es opcional y ninguna opción es obligatoria. Si se omiten, se usarán los valores por defecto.","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":"Si es true, el resultado del endpoint incluirá información adicional. Si se omite, el valor por defecto será false."},"ElapsedSeconds":{"type":"integer","description":"Tiempo de vida máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. Si es 0 (por defecto), no hay límite.","minimum":0},"FutureSeconds":{"type":"integer","description":"Tiempo de vida futuro máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. La plantilla puede haberse creado en un dispositivo con una fecha futura respecto al dispositivo que la consume. Si es 0 (por defecto), no se aceptará ningún templateRaw con una fecha futura.","minimum":0},"FacialDetectionType":{"type":"string","description":"Tipos de detección facial en el motor de extracción.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Tamaño mínimo en píxeles que debe tener un rostro para ser detectado."},"MinFaceRel":{"type":"number","description":"Tamaño mínimo, en proporción al tamaño de la imagen, que debe tener un rostro para ser detectado.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Distancia interocular mínima en píxeles que debe tener un rostro para ser detectado."},"MaxPoseDegrees":{"type":"number","description":"Diferencia máxima de ángulo (en grados) entre dos poses para considerarse válida en procesos de autenticación.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"Una métrica que indica con qué precisión se comportará una plantilla en el reconocimiento.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Obtiene analíticas adicionales en el motor de extracción."},"TemplateRawExtraction":{"type":"boolean","description":"El motor de extracción generará la plantilla en bruto."},"FalseDetectRate":{"type":"number","description":"Nivel de tolerancia de falso rechazo en el motor de extracción. No se recomienda usar este valor si no está seguro de sus efectos.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Número máximo de candidatos requeridos en búsquedas 1:N."},"MinSimilarity":{"type":"number","description":"Similitud mínima tolerable en búsquedas 1:N.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Valor mínimo en una autenticación para considerarla positiva.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Qué pipelines de prueba de vida deben utilizarse.","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":"Un documento tokenizado y, además, un _extraData_ para el registro en Api Tracking.","properties":{"token":{"$ref":"#/components/schemas/DocumentToken"},"extraData":{"$ref":"#/components/schemas/ExtraData"}},"required":["token"]},"DocumentToken":{"type":"string","description":"Datos de documento tokenizados (OCR, faceImage, frontImage, backImage), codificados en base64."},"ExtraData":{"type":"string","description":"Datos tokenizados para llamar al servicio Api Tracking tras la operación, codificados en base64."}}}} ``` ## The DocumentAuthenticationImage object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"DocumentAuthenticationImage":{"type":"object","description":"Un documento tokenizado y un búfer de imagen, utilizados para la autenticación. Además, admite _extraData_, para el registro en 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":"Datos de documento tokenizados (OCR, faceImage, frontImage, backImage), codificados en base64."},"ImageBuffer":{"type":"string","description":"Búfer en bruto de imagen en .png, .jpg o .bmp, codificado en base64."},"ExtraData":{"type":"string","description":"Datos tokenizados para llamar al servicio Api Tracking tras la operación, codificados en base64."},"SdkOptions":{"type":"object","description":"Opciones para personalizar el uso de los motores de extracción e identificación. Su uso es opcional y ninguna opción es obligatoria. Si se omiten, se usarán los valores por defecto.","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":"Si es true, el resultado del endpoint incluirá información adicional. Si se omite, el valor por defecto será false."},"ElapsedSeconds":{"type":"integer","description":"Tiempo de vida máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. Si es 0 (por defecto), no hay límite.","minimum":0},"FutureSeconds":{"type":"integer","description":"Tiempo de vida futuro máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. La plantilla puede haberse creado en un dispositivo con una fecha futura respecto al dispositivo que la consume. Si es 0 (por defecto), no se aceptará ningún templateRaw con una fecha futura.","minimum":0},"FacialDetectionType":{"type":"string","description":"Tipos de detección facial en el motor de extracción.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Tamaño mínimo en píxeles que debe tener un rostro para ser detectado."},"MinFaceRel":{"type":"number","description":"Tamaño mínimo, en proporción al tamaño de la imagen, que debe tener un rostro para ser detectado.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Distancia interocular mínima en píxeles que debe tener un rostro para ser detectado."},"MaxPoseDegrees":{"type":"number","description":"Diferencia máxima de ángulo (en grados) entre dos poses para considerarse válida en procesos de autenticación.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"Una métrica que indica con qué precisión se comportará una plantilla en el reconocimiento.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Obtiene analíticas adicionales en el motor de extracción."},"TemplateRawExtraction":{"type":"boolean","description":"El motor de extracción generará la plantilla en bruto."},"FalseDetectRate":{"type":"number","description":"Nivel de tolerancia de falso rechazo en el motor de extracción. No se recomienda usar este valor si no está seguro de sus efectos.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Número máximo de candidatos requeridos en búsquedas 1:N."},"MinSimilarity":{"type":"number","description":"Similitud mínima tolerable en búsquedas 1:N.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Valor mínimo en una autenticación para considerarla positiva.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Qué pipelines de prueba de vida deben utilizarse.","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":"Un documento tokenizado y una plantilla de imagen, utilizados para la autenticación. Además, admite _extraData_, para el registro en 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":"Datos de documento tokenizados (OCR, faceImage, frontImage, backImage), codificados en base64."},"FacialTemplateRaw":{"type":"string","description":"Búfer de plantilla biométrica, obtenido mediante GetFacialTemplateRaw(), codificado en base64."},"ExtraData":{"type":"string","description":"Datos tokenizados para llamar al servicio Api Tracking tras la operación, codificados en base64."},"SdkOptions":{"type":"object","description":"Opciones para personalizar el uso de los motores de extracción e identificación. Su uso es opcional y ninguna opción es obligatoria. Si se omiten, se usarán los valores por defecto.","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":"Si es true, el resultado del endpoint incluirá información adicional. Si se omite, el valor por defecto será false."},"ElapsedSeconds":{"type":"integer","description":"Tiempo de vida máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. Si es 0 (por defecto), no hay límite.","minimum":0},"FutureSeconds":{"type":"integer","description":"Tiempo de vida futuro máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. La plantilla puede haberse creado en un dispositivo con una fecha futura respecto al dispositivo que la consume. Si es 0 (por defecto), no se aceptará ningún templateRaw con una fecha futura.","minimum":0},"FacialDetectionType":{"type":"string","description":"Tipos de detección facial en el motor de extracción.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Tamaño mínimo en píxeles que debe tener un rostro para ser detectado."},"MinFaceRel":{"type":"number","description":"Tamaño mínimo, en proporción al tamaño de la imagen, que debe tener un rostro para ser detectado.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Distancia interocular mínima en píxeles que debe tener un rostro para ser detectado."},"MaxPoseDegrees":{"type":"number","description":"Diferencia máxima de ángulo (en grados) entre dos poses para considerarse válida en procesos de autenticación.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"Una métrica que indica con qué precisión se comportará una plantilla en el reconocimiento.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Obtiene analíticas adicionales en el motor de extracción."},"TemplateRawExtraction":{"type":"boolean","description":"El motor de extracción generará la plantilla en bruto."},"FalseDetectRate":{"type":"number","description":"Nivel de tolerancia de falso rechazo en el motor de extracción. No se recomienda usar este valor si no está seguro de sus efectos.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Número máximo de candidatos requeridos en búsquedas 1:N."},"MinSimilarity":{"type":"number","description":"Similitud mínima tolerable en búsquedas 1:N.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Valor mínimo en una autenticación para considerarla positiva.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Qué pipelines de prueba de vida deben utilizarse.","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":"Una imagen en bruto, utilizada para la prueba de vida pasiva. Además, admite _extraData_, para el registro en Api Tracking.","properties":{"image":{"$ref":"#/components/schemas/ImageBuffer"},"extraData":{"$ref":"#/components/schemas/ExtraData"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["image"]},"ImageBuffer":{"type":"string","description":"Búfer en bruto de imagen en .png, .jpg o .bmp, codificado en base64."},"ExtraData":{"type":"string","description":"Datos tokenizados para llamar al servicio Api Tracking tras la operación, codificados en base64."},"SdkOptions":{"type":"object","description":"Opciones para personalizar el uso de los motores de extracción e identificación. Su uso es opcional y ninguna opción es obligatoria. Si se omiten, se usarán los valores por defecto.","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":"Si es true, el resultado del endpoint incluirá información adicional. Si se omite, el valor por defecto será false."},"ElapsedSeconds":{"type":"integer","description":"Tiempo de vida máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. Si es 0 (por defecto), no hay límite.","minimum":0},"FutureSeconds":{"type":"integer","description":"Tiempo de vida futuro máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. La plantilla puede haberse creado en un dispositivo con una fecha futura respecto al dispositivo que la consume. Si es 0 (por defecto), no se aceptará ningún templateRaw con una fecha futura.","minimum":0},"FacialDetectionType":{"type":"string","description":"Tipos de detección facial en el motor de extracción.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Tamaño mínimo en píxeles que debe tener un rostro para ser detectado."},"MinFaceRel":{"type":"number","description":"Tamaño mínimo, en proporción al tamaño de la imagen, que debe tener un rostro para ser detectado.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Distancia interocular mínima en píxeles que debe tener un rostro para ser detectado."},"MaxPoseDegrees":{"type":"number","description":"Diferencia máxima de ángulo (en grados) entre dos poses para considerarse válida en procesos de autenticación.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"Una métrica que indica con qué precisión se comportará una plantilla en el reconocimiento.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Obtiene analíticas adicionales en el motor de extracción."},"TemplateRawExtraction":{"type":"boolean","description":"El motor de extracción generará la plantilla en bruto."},"FalseDetectRate":{"type":"number","description":"Nivel de tolerancia de falso rechazo en el motor de extracción. No se recomienda usar este valor si no está seguro de sus efectos.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Número máximo de candidatos requeridos en búsquedas 1:N."},"MinSimilarity":{"type":"number","description":"Similitud mínima tolerable en búsquedas 1:N.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Valor mínimo en una autenticación para considerarla positiva.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Qué pipelines de prueba de vida deben utilizarse.","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":"Una imagen tokenizada, utilizada para la prueba de vida pasiva. Además, admite _extraData_, para el registro en Api Tracking.","properties":{"tokenImage":{"$ref":"#/components/schemas/ImageToken"},"extraData":{"$ref":"#/components/schemas/ExtraData"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["tokenImage"]},"ImageToken":{"type":"string","description":"Imagen tokenizada, codificada en base64."},"ExtraData":{"type":"string","description":"Datos tokenizados para llamar al servicio Api Tracking tras la operación, codificados en base64."},"SdkOptions":{"type":"object","description":"Opciones para personalizar el uso de los motores de extracción e identificación. Su uso es opcional y ninguna opción es obligatoria. Si se omiten, se usarán los valores por defecto.","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":"Si es true, el resultado del endpoint incluirá información adicional. Si se omite, el valor por defecto será false."},"ElapsedSeconds":{"type":"integer","description":"Tiempo de vida máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. Si es 0 (por defecto), no hay límite.","minimum":0},"FutureSeconds":{"type":"integer","description":"Tiempo de vida futuro máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. La plantilla puede haberse creado en un dispositivo con una fecha futura respecto al dispositivo que la consume. Si es 0 (por defecto), no se aceptará ningún templateRaw con una fecha futura.","minimum":0},"FacialDetectionType":{"type":"string","description":"Tipos de detección facial en el motor de extracción.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Tamaño mínimo en píxeles que debe tener un rostro para ser detectado."},"MinFaceRel":{"type":"number","description":"Tamaño mínimo, en proporción al tamaño de la imagen, que debe tener un rostro para ser detectado.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Distancia interocular mínima en píxeles que debe tener un rostro para ser detectado."},"MaxPoseDegrees":{"type":"number","description":"Diferencia máxima de ángulo (en grados) entre dos poses para considerarse válida en procesos de autenticación.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"Una métrica que indica con qué precisión se comportará una plantilla en el reconocimiento.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Obtiene analíticas adicionales en el motor de extracción."},"TemplateRawExtraction":{"type":"boolean","description":"El motor de extracción generará la plantilla en bruto."},"FalseDetectRate":{"type":"number","description":"Nivel de tolerancia de falso rechazo en el motor de extracción. No se recomienda usar este valor si no está seguro de sus efectos.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Número máximo de candidatos requeridos en búsquedas 1:N."},"MinSimilarity":{"type":"number","description":"Similitud mínima tolerable en búsquedas 1:N.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Valor mínimo en una autenticación para considerarla positiva.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Qué pipelines de prueba de vida deben utilizarse.","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":"Una imagen en bruto, utilizada para la inscripción en una galería 1:N.","properties":{"image":{"$ref":"#/components/schemas/ImageBuffer"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["image"]},"ImageBuffer":{"type":"string","description":"Búfer en bruto de imagen en .png, .jpg o .bmp, codificado en base64."},"SdkOptions":{"type":"object","description":"Opciones para personalizar el uso de los motores de extracción e identificación. Su uso es opcional y ninguna opción es obligatoria. Si se omiten, se usarán los valores por defecto.","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":"Si es true, el resultado del endpoint incluirá información adicional. Si se omite, el valor por defecto será false."},"ElapsedSeconds":{"type":"integer","description":"Tiempo de vida máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. Si es 0 (por defecto), no hay límite.","minimum":0},"FutureSeconds":{"type":"integer","description":"Tiempo de vida futuro máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. La plantilla puede haberse creado en un dispositivo con una fecha futura respecto al dispositivo que la consume. Si es 0 (por defecto), no se aceptará ningún templateRaw con una fecha futura.","minimum":0},"FacialDetectionType":{"type":"string","description":"Tipos de detección facial en el motor de extracción.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Tamaño mínimo en píxeles que debe tener un rostro para ser detectado."},"MinFaceRel":{"type":"number","description":"Tamaño mínimo, en proporción al tamaño de la imagen, que debe tener un rostro para ser detectado.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Distancia interocular mínima en píxeles que debe tener un rostro para ser detectado."},"MaxPoseDegrees":{"type":"number","description":"Diferencia máxima de ángulo (en grados) entre dos poses para considerarse válida en procesos de autenticación.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"Una métrica que indica con qué precisión se comportará una plantilla en el reconocimiento.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Obtiene analíticas adicionales en el motor de extracción."},"TemplateRawExtraction":{"type":"boolean","description":"El motor de extracción generará la plantilla en bruto."},"FalseDetectRate":{"type":"number","description":"Nivel de tolerancia de falso rechazo en el motor de extracción. No se recomienda usar este valor si no está seguro de sus efectos.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Número máximo de candidatos requeridos en búsquedas 1:N."},"MinSimilarity":{"type":"number","description":"Similitud mínima tolerable en búsquedas 1:N.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Valor mínimo en una autenticación para considerarla positiva.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Qué pipelines de prueba de vida deben utilizarse.","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":"Una plantilla facial, utilizada para la inscripción en una galería 1:N.","properties":{"facialTemplate":{"$ref":"#/components/schemas/FacialTemplate"}},"required":["facialTemplate"]},"FacialTemplate":{"type":"string","description":"Búfer de plantilla biométrica, obtenido mediante GetFacialTemplate(), codificado en base64."}}}} ``` ## The IdentifyImage object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"IdentifyImage":{"type":"object","description":"Una imagen en bruto, utilizada para la búsqueda en una galería 1:N.","properties":{"image":{"$ref":"#/components/schemas/ImageBuffer"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["image"]},"ImageBuffer":{"type":"string","description":"Búfer en bruto de imagen en .png, .jpg o .bmp, codificado en base64."},"SdkOptions":{"type":"object","description":"Opciones para personalizar el uso de los motores de extracción e identificación. Su uso es opcional y ninguna opción es obligatoria. Si se omiten, se usarán los valores por defecto.","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":"Si es true, el resultado del endpoint incluirá información adicional. Si se omite, el valor por defecto será false."},"ElapsedSeconds":{"type":"integer","description":"Tiempo de vida máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. Si es 0 (por defecto), no hay límite.","minimum":0},"FutureSeconds":{"type":"integer","description":"Tiempo de vida futuro máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. La plantilla puede haberse creado en un dispositivo con una fecha futura respecto al dispositivo que la consume. Si es 0 (por defecto), no se aceptará ningún templateRaw con una fecha futura.","minimum":0},"FacialDetectionType":{"type":"string","description":"Tipos de detección facial en el motor de extracción.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Tamaño mínimo en píxeles que debe tener un rostro para ser detectado."},"MinFaceRel":{"type":"number","description":"Tamaño mínimo, en proporción al tamaño de la imagen, que debe tener un rostro para ser detectado.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Distancia interocular mínima en píxeles que debe tener un rostro para ser detectado."},"MaxPoseDegrees":{"type":"number","description":"Diferencia máxima de ángulo (en grados) entre dos poses para considerarse válida en procesos de autenticación.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"Una métrica que indica con qué precisión se comportará una plantilla en el reconocimiento.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Obtiene analíticas adicionales en el motor de extracción."},"TemplateRawExtraction":{"type":"boolean","description":"El motor de extracción generará la plantilla en bruto."},"FalseDetectRate":{"type":"number","description":"Nivel de tolerancia de falso rechazo en el motor de extracción. No se recomienda usar este valor si no está seguro de sus efectos.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Número máximo de candidatos requeridos en búsquedas 1:N."},"MinSimilarity":{"type":"number","description":"Similitud mínima tolerable en búsquedas 1:N.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Valor mínimo en una autenticación para considerarla positiva.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Qué pipelines de prueba de vida deben utilizarse.","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":"Una plantilla facial, utilizada para la búsqueda en una galería 1:N.","properties":{"facialTemplate":{"$ref":"#/components/schemas/FacialTemplate"},"options":{"$ref":"#/components/schemas/SdkOptions"}},"required":["facialTemplate"]},"FacialTemplate":{"type":"string","description":"Búfer de plantilla biométrica, obtenido mediante GetFacialTemplate(), codificado en base64."},"SdkOptions":{"type":"object","description":"Opciones para personalizar el uso de los motores de extracción e identificación. Su uso es opcional y ninguna opción es obligatoria. Si se omiten, se usarán los valores por defecto.","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":"Si es true, el resultado del endpoint incluirá información adicional. Si se omite, el valor por defecto será false."},"ElapsedSeconds":{"type":"integer","description":"Tiempo de vida máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. Si es 0 (por defecto), no hay límite.","minimum":0},"FutureSeconds":{"type":"integer","description":"Tiempo de vida futuro máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. La plantilla puede haberse creado en un dispositivo con una fecha futura respecto al dispositivo que la consume. Si es 0 (por defecto), no se aceptará ningún templateRaw con una fecha futura.","minimum":0},"FacialDetectionType":{"type":"string","description":"Tipos de detección facial en el motor de extracción.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Tamaño mínimo en píxeles que debe tener un rostro para ser detectado."},"MinFaceRel":{"type":"number","description":"Tamaño mínimo, en proporción al tamaño de la imagen, que debe tener un rostro para ser detectado.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Distancia interocular mínima en píxeles que debe tener un rostro para ser detectado."},"MaxPoseDegrees":{"type":"number","description":"Diferencia máxima de ángulo (en grados) entre dos poses para considerarse válida en procesos de autenticación.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"Una métrica que indica con qué precisión se comportará una plantilla en el reconocimiento.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Obtiene analíticas adicionales en el motor de extracción."},"TemplateRawExtraction":{"type":"boolean","description":"El motor de extracción generará la plantilla en bruto."},"FalseDetectRate":{"type":"number","description":"Nivel de tolerancia de falso rechazo en el motor de extracción. No se recomienda usar este valor si no está seguro de sus efectos.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Número máximo de candidatos requeridos en búsquedas 1:N."},"MinSimilarity":{"type":"number","description":"Similitud mínima tolerable en búsquedas 1:N.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Valor mínimo en una autenticación para considerarla positiva.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Qué pipelines de prueba de vida deben utilizarse.","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":"Datos para registrar un evento externo de autenticación en la plataforma Api Tracking. Además, admite búferes de imagen.","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":"Posibles resultados de una operación de autenticación.","enum":["None","Negative","Uncertain","Positive","NoneBecausePoseExceed","NoneBecauseInvalidExtractions"]},"Similarity":{"type":"number","description":"Similitud entre dos plantillas faciales (0-Ninguna, 1-Idéntica)."},"EventSource":{"type":"string","description":"El origen de un evento en el servicio Api Tracking."},"ImageBuffer":{"type":"string","description":"Búfer en bruto de imagen en .png, .jpg o .bmp, codificado en base64."},"ExtraData":{"type":"string","description":"Datos tokenizados para llamar al servicio Api Tracking tras la operación, codificados en base64."}}}} ``` ## The CustomLiveness object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"CustomLiveness":{"type":"object","description":"Datos para registrar un evento externo de prueba de vida en la plataforma Api Tracking. Además, admite el búfer de imagen.","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":"Familia con la que registrar los eventos de Api Tracking.","enum":["OnBoarding","Authentication"]},"FacialLivenessDiagnostic":{"type":"string","description":"Posibles resultados de una operación de prueba de vida.","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":"El origen de un evento en el servicio Api Tracking."},"ImageBuffer":{"type":"string","description":"Búfer en bruto de imagen en .png, .jpg o .bmp, codificado en base64."},"ExtraData":{"type":"string","description":"Datos tokenizados para llamar al servicio Api Tracking tras la operación, codificados en base64."}}}} ``` ## The CustomVoiceAuthentication object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"CustomVoiceAuthentication":{"type":"object","description":"Datos para registrar un evento externo de autenticación por voz en la plataforma Api Tracking. Además, admite los búferes de pista de audio.","properties":{"probability":{"$ref":"#/components/schemas/VoiceProbability"},"eventSource":{"$ref":"#/components/schemas/EventSource"},"extraData":{"$ref":"#/components/schemas/ExtraData"}},"required":["probability","extraData"]},"VoiceProbability":{"type":"number","description":"Probabilidad de coincidencia de voz","minimum":0,"maximum":1},"EventSource":{"type":"string","description":"El origen de un evento en el servicio Api Tracking."},"ExtraData":{"type":"string","description":"Datos tokenizados para llamar al servicio Api Tracking tras la operación, codificados en base64."}}}} ``` ## The CustomFinish object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"CustomFinish":{"type":"object","description":"Datos para registrar eventos externos de cierre y finalización de operación en la plataforma Api Tracking.","properties":{"status":{"$ref":"#/components/schemas/OperationResultStatus"},"reason":{"$ref":"#/components/schemas/OperationResultReason"},"extraData":{"$ref":"#/components/schemas/ExtraData"}},"required":["status","reason","extraData"]},"OperationResultStatus":{"type":"string","description":"Resultado de una operación en el lado del cliente, para el registro en Api Tracking.","enum":["Succeeded","Denied","Error","Live","Cancelled"]},"OperationResultReason":{"type":"string","description":"Detalle del resultado de una operación en el lado del cliente, para el registro en Api Tracking.","enum":["None","InternalError","CancelledByUser","Timeout","DocumentValidationNotPassed","DocumentValidationError","AuthenticationNotPassed","AuthenticationError","LivenessNotPassed","LivenessError"]},"ExtraData":{"type":"string","description":"Datos tokenizados para llamar al servicio Api Tracking tras la operación, codificados en base64."}}}} ``` ## The CustomFinishFamily object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"CustomFinishFamily":{"type":"object","description":"Datos para registrar eventos externos de cierre y finalización de operación en la plataforma Api Tracking.","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":"Familia con la que registrar los eventos de Api Tracking.","enum":["OnBoarding","Authentication"]},"OperationResultStatus":{"type":"string","description":"Resultado de una operación en el lado del cliente, para el registro en Api Tracking.","enum":["Succeeded","Denied","Error","Live","Cancelled"]},"OperationResultReason":{"type":"string","description":"Detalle del resultado de una operación en el lado del cliente, para el registro en Api Tracking.","enum":["None","InternalError","CancelledByUser","Timeout","DocumentValidationNotPassed","DocumentValidationError","AuthenticationNotPassed","AuthenticationError","LivenessNotPassed","LivenessError"]},"ExtraData":{"type":"string","description":"Datos tokenizados para llamar al servicio Api Tracking tras la operación, codificados en base64."}}}} ``` ## The CustomOCR object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"CustomOCR":{"type":"object","description":"Datos para registrar un evento externo de OCR en la plataforma Api Tracking.","properties":{"jsonData":{"$ref":"#/components/schemas/OCRData"},"eventSource":{"$ref":"#/components/schemas/EventSource"},"extraData":{"$ref":"#/components/schemas/ExtraData"}},"required":["jsonData","extraData"]},"OCRData":{"type":"string","description":"Cadena con un diccionario Json clave/valor con los campos de OCR detectados en un documento."},"EventSource":{"type":"string","description":"El origen de un evento en el servicio Api Tracking."},"ExtraData":{"type":"string","description":"Datos tokenizados para llamar al servicio Api Tracking tras la operación, codificados en base64."}}}} ``` ## The CustomSecurity object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"CustomSecurity":{"type":"object","description":"Datos para registrar un evento externo de seguridad en la plataforma Api Tracking.","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":"Cadena con un diccionario clave/valor con información de seguridad."},"Succeed":{"type":"boolean","description":"Indica si la operación se ha realizado correctamente o no."},"EventSource":{"type":"string","description":"El origen de un evento en el servicio Api Tracking."},"ExtraData":{"type":"string","description":"Datos tokenizados para llamar al servicio Api Tracking tras la operación, codificados en base64."}}}} ``` ## The SdkOptions object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"SdkOptions":{"type":"object","description":"Opciones para personalizar el uso de los motores de extracción e identificación. Su uso es opcional y ninguna opción es obligatoria. Si se omiten, se usarán los valores por defecto.","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":"Si es true, el resultado del endpoint incluirá información adicional. Si se omite, el valor por defecto será false."},"ElapsedSeconds":{"type":"integer","description":"Tiempo de vida máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. Si es 0 (por defecto), no hay límite.","minimum":0},"FutureSeconds":{"type":"integer","description":"Tiempo de vida futuro máximo de un templateRaw (en segundos) para considerarse válido en operaciones de autenticación o prueba de vida. La plantilla puede haberse creado en un dispositivo con una fecha futura respecto al dispositivo que la consume. Si es 0 (por defecto), no se aceptará ningún templateRaw con una fecha futura.","minimum":0},"FacialDetectionType":{"type":"string","description":"Tipos de detección facial en el motor de extracción.","enum":["Frontal","FrontalFast"]},"MinFaceSize":{"type":"integer","description":"Tamaño mínimo en píxeles que debe tener un rostro para ser detectado."},"MinFaceRel":{"type":"number","description":"Tamaño mínimo, en proporción al tamaño de la imagen, que debe tener un rostro para ser detectado.","minimum":0,"maximum":1},"MinIOD":{"type":"integer","description":"Distancia interocular mínima en píxeles que debe tener un rostro para ser detectado."},"MaxPoseDegrees":{"type":"number","description":"Diferencia máxima de ángulo (en grados) entre dos poses para considerarse válida en procesos de autenticación.","minimum":0,"maximum":180},"FacialQuality":{"type":"string","description":"Una métrica que indica con qué precisión se comportará una plantilla en el reconocimiento.","enum":["None","Bad","Regular","Good"]},"Analytics":{"type":"boolean","description":"Obtiene analíticas adicionales en el motor de extracción."},"TemplateRawExtraction":{"type":"boolean","description":"El motor de extracción generará la plantilla en bruto."},"FalseDetectRate":{"type":"number","description":"Nivel de tolerancia de falso rechazo en el motor de extracción. No se recomienda usar este valor si no está seguro de sus efectos.","minimum":0,"maximum":1},"MaxCandidates":{"type":"integer","description":"Número máximo de candidatos requeridos en búsquedas 1:N."},"MinSimilarity":{"type":"number","description":"Similitud mínima tolerable en búsquedas 1:N.","minimum":0,"maximum":1},"AuthThreshold":{"type":"number","description":"Valor mínimo en una autenticación para considerarla positiva.","minimum":0,"maximum":100},"LivenessDepth":{"type":"string","description":"Qué pipelines de prueba de vida deben utilizarse.","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":"El resultado de una operación de extracción.","properties":{"facialTemplate":{"$ref":"#/components/schemas/FacialTemplate"},"facialTemplateRaw":{"$ref":"#/components/schemas/FacialTemplateRaw"},"updatedTemplateRaw":{"$ref":"#/components/schemas/UpdatedTemplateRaw"},"face":{"$ref":"#/components/schemas/Rectangle"},"leftEye":{"description":"Ubicación del centro del ojo izquierdo.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"rightEye":{"description":"Ubicación del centro del ojo derecho.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"chin":{"description":"Ubicación de la barbilla.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"nose":{"description":"Ubicación de la nariz.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"leftMouth":{"description":"Ubicación del punto izquierdo de la boca.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"rightMouth":{"description":"Ubicación del punto derecho de la boca.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"iod":{"$ref":"#/components/schemas/IOD"},"yaw":{"description":"Ángulo facial de guiñada (yaw) en grados.","type":"number"},"pitch":{"description":"Ángulo facial de cabeceo (pitch) en grados.","type":"number"},"roll":{"description":"Ángulo facial de alabeo (roll) en grados.","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":"Búfer de plantilla biométrica, obtenido mediante GetFacialTemplate(), codificado en base64."},"FacialTemplateRaw":{"type":"string","description":"Búfer de plantilla biométrica, obtenido mediante GetFacialTemplateRaw(), codificado en base64."},"UpdatedTemplateRaw":{"type":"boolean","description":"El templateRaw se ha actualizado en la operación de extracción."},"Rectangle":{"type":"object","description":"Un área delimitada de una imagen.","properties":{"x":{"type":"number","description":"Coordenada X de la esquina superior izquierda."},"y":{"type":"number","description":"Coordenada Y de la esquina superior izquierda."},"width":{"type":"number","description":"Anchura del área."},"height":{"type":"number","description":"Altura del área."}}},"XCoord":{"type":"number","description":"Coordenada X."},"YCoord":{"type":"number","description":"Coordenada Y."},"IOD":{"type":"number","description":"Distancia interocular."},"FacialGlasses":{"type":"string","description":"La persona de la imagen lleva gafas (y de qué tipo).","enum":["None","Eye","Sun"]},"Age":{"type":"number","description":"Aproximación de la edad de la persona."},"FacialGender":{"type":"string","description":"El género facial de la persona en la imagen.","enum":["None","Male","Female"]},"FacialMask":{"type":"number","description":"La probabilidad de mascarilla facial.","minimum":0,"maximum":1},"FaceConfidence":{"type":"number","description":"Confianza predicha del rostro.","minimum":0,"maximum":1},"FacialQuality":{"type":"string","description":"Una métrica que indica con qué precisión se comportará una plantilla en el reconocimiento.","enum":["None","Bad","Regular","Good"]},"ValidTimeStamp":{"type":"boolean","description":"En las operaciones de autenticación, prueba de vida y extracción que implican templateRaws, indica si el tiempo de vida de la plantilla es válido. Véase \"options:elapsedAllowedSeconds\". En las operaciones que no implican plantillas en bruto, siempre será true."},"TokenTimeStamp":{"type":"string","description":"El valor interno de fecha y hora del token en formato \"%Y-%m-%dT%H:%M:%SZ\"."},"SdkDuration":{"type":"number","description":"Duración de la operación en milisegundos."}}}} ``` ## The ExtractionImageResult object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ExtractionImageResult":{"type":"object","description":"El resultado de una operación de extracción de imagen.","properties":{"image":{"$ref":"#/components/schemas/ImageBuffer"}}},"ImageBuffer":{"type":"string","description":"Búfer en bruto de imagen en .png, .jpg o .bmp, codificado en base64."}}}} ``` ## The FacialAuthenticationResult object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialAuthenticationResult":{"type":"object","description":"El resultado de una operación de autenticación. **extractionQuery** y **extractionTarget** solo se añadirán si **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":"Posibles resultados de una operación de autenticación.","enum":["None","Negative","Uncertain","Positive","NoneBecausePoseExceed","NoneBecauseInvalidExtractions"]},"Similarity":{"type":"number","description":"Similitud entre dos plantillas faciales (0-Ninguna, 1-Idéntica)."},"ValidTimeStamp":{"type":"boolean","description":"En las operaciones de autenticación, prueba de vida y extracción que implican templateRaws, indica si el tiempo de vida de la plantilla es válido. Véase \"options:elapsedAllowedSeconds\". En las operaciones que no implican plantillas en bruto, siempre será true."},"TokenTimeStamp":{"type":"string","description":"El valor interno de fecha y hora del token en formato \"%Y-%m-%dT%H:%M:%SZ\"."},"TrackingStatus":{"type":"number","description":"Estado devuelto por el servicio Api Tracking, o -1 si no se requiere seguimiento."},"TrackingMessage":{"type":"string","description":"Mensaje devuelto por el servicio Api Tracking, o vacío si no se requiere seguimiento."},"SdkDuration":{"type":"number","description":"Duración de la operación en milisegundos."},"FacialExtractionResult":{"type":"object","description":"El resultado de una operación de extracción.","properties":{"facialTemplate":{"$ref":"#/components/schemas/FacialTemplate"},"facialTemplateRaw":{"$ref":"#/components/schemas/FacialTemplateRaw"},"updatedTemplateRaw":{"$ref":"#/components/schemas/UpdatedTemplateRaw"},"face":{"$ref":"#/components/schemas/Rectangle"},"leftEye":{"description":"Ubicación del centro del ojo izquierdo.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"rightEye":{"description":"Ubicación del centro del ojo derecho.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"chin":{"description":"Ubicación de la barbilla.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"nose":{"description":"Ubicación de la nariz.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"leftMouth":{"description":"Ubicación del punto izquierdo de la boca.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"rightMouth":{"description":"Ubicación del punto derecho de la boca.","type":"object","properties":{"x":{"$ref":"#/components/schemas/XCoord"},"y":{"$ref":"#/components/schemas/YCoord"}}},"iod":{"$ref":"#/components/schemas/IOD"},"yaw":{"description":"Ángulo facial de guiñada (yaw) en grados.","type":"number"},"pitch":{"description":"Ángulo facial de cabeceo (pitch) en grados.","type":"number"},"roll":{"description":"Ángulo facial de alabeo (roll) en grados.","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":"Búfer de plantilla biométrica, obtenido mediante GetFacialTemplate(), codificado en base64."},"FacialTemplateRaw":{"type":"string","description":"Búfer de plantilla biométrica, obtenido mediante GetFacialTemplateRaw(), codificado en base64."},"UpdatedTemplateRaw":{"type":"boolean","description":"El templateRaw se ha actualizado en la operación de extracción."},"Rectangle":{"type":"object","description":"Un área delimitada de una imagen.","properties":{"x":{"type":"number","description":"Coordenada X de la esquina superior izquierda."},"y":{"type":"number","description":"Coordenada Y de la esquina superior izquierda."},"width":{"type":"number","description":"Anchura del área."},"height":{"type":"number","description":"Altura del área."}}},"XCoord":{"type":"number","description":"Coordenada X."},"YCoord":{"type":"number","description":"Coordenada Y."},"IOD":{"type":"number","description":"Distancia interocular."},"FacialGlasses":{"type":"string","description":"La persona de la imagen lleva gafas (y de qué tipo).","enum":["None","Eye","Sun"]},"Age":{"type":"number","description":"Aproximación de la edad de la persona."},"FacialGender":{"type":"string","description":"El género facial de la persona en la imagen.","enum":["None","Male","Female"]},"FacialMask":{"type":"number","description":"La probabilidad de mascarilla facial.","minimum":0,"maximum":1},"FaceConfidence":{"type":"number","description":"Confianza predicha del rostro.","minimum":0,"maximum":1},"FacialQuality":{"type":"string","description":"Una métrica que indica con qué precisión se comportará una plantilla en el reconocimiento.","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":"El resultado de una operación de extracción de documento.","properties":{"documentData":{"$ref":"#/components/schemas/OCRData"},"imageData":{"type":"object","properties":{"faceImage":{"type":"string","description":"Los datos en bruto de la imagen del rostro del documento, codificados en base64."},"documentFrontImage":{"type":"string","description":"Los datos en bruto de la imagen del anverso del documento, codificados en base64."},"documentBackImage":{"type":"string","description":"Los datos en bruto de la imagen del reverso del documento, codificados en base64."}},"additionalProperties":{"type":"string"},"description":"Diccionario de cadenas clave/valor con las imágenes detectadas en el documento."},"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":"Cadena con un diccionario Json clave/valor con los campos de OCR detectados en un documento."},"ValidTimeStamp":{"type":"boolean","description":"En las operaciones de autenticación, prueba de vida y extracción que implican templateRaws, indica si el tiempo de vida de la plantilla es válido. Véase \"options:elapsedAllowedSeconds\". En las operaciones que no implican plantillas en bruto, siempre será true."},"TokenTimeStamp":{"type":"string","description":"El valor interno de fecha y hora del token en formato \"%Y-%m-%dT%H:%M:%SZ\"."},"TrackingStatus":{"type":"number","description":"Estado devuelto por el servicio Api Tracking, o -1 si no se requiere seguimiento."},"TrackingMessage":{"type":"string","description":"Mensaje devuelto por el servicio Api Tracking, o vacío si no se requiere seguimiento."},"SdkDuration":{"type":"number","description":"Duración de la operación en milisegundos."}}}} ``` ## The PassiveLivenessResult object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"PassiveLivenessResult":{"type":"object","description":"El resultado de una operación de prueba de vida pasiva.","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":"Posibles resultados de una operación de prueba de vida.","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":"Detalles para el caso FacialLivenessDiagnostic::NoLive","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":"Causa principal de alto nivel del diagnóstico NoLive.","enum":["FPadFailed","FMadFailed","MultipleFailed","Unknown"]},"FPadStatus":{"type":"string","description":"Estado de la detección facial de ataques de presentación (fPAD).","enum":["NotEvaluated","Passed","Failed","Error"]},"FPadScore":{"type":"number","description":"Puntuación fPAD normalizada, si está disponible","minimum":0,"maximum":1},"FMadStatus":{"type":"string","description":"Estado de la detección facial de ataques de manipulación (fMAD).","enum":["NotEvaluated","Passed","Failed","Error"]},"FMadScore":{"type":"number","description":"Puntuación fMAD normalizada, si está disponible","minimum":0,"maximum":1},"CoercionScore":{"type":"number","description":"Puntuación de coerción normalizada, si está disponible","minimum":0,"maximum":1},"NoLiveReasonMessage":{"type":"string","description":"Mensaje del motivo legible por humanos, para registros/backoffice."},"ValidTimeStamp":{"type":"boolean","description":"En las operaciones de autenticación, prueba de vida y extracción que implican templateRaws, indica si el tiempo de vida de la plantilla es válido. Véase \"options:elapsedAllowedSeconds\". En las operaciones que no implican plantillas en bruto, siempre será true."},"TokenTimeStamp":{"type":"string","description":"El valor interno de fecha y hora del token en formato \"%Y-%m-%dT%H:%M:%SZ\"."},"TrackingStatus":{"type":"number","description":"Estado devuelto por el servicio Api Tracking, o -1 si no se requiere seguimiento."},"TrackingMessage":{"type":"string","description":"Mensaje devuelto por el servicio Api Tracking, o vacío si no se requiere seguimiento."},"SdkDuration":{"type":"number","description":"Duración de la operación en milisegundos."}}}} ``` ## The EnrollResult object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"EnrollResult":{"type":"object","description":"El resultado de la inscripción de una plantilla en una galería.","properties":{"galleryIndex":{"$ref":"#/components/schemas/GalleryIndex"},"facialTemplate":{"$ref":"#/components/schemas/FacialTemplate"},"sdkDuration":{"$ref":"#/components/schemas/SdkDuration"}}},"GalleryIndex":{"type":"integer","description":"El índice de una plantilla facial en una galería.","minimum":0},"FacialTemplate":{"type":"string","description":"Búfer de plantilla biométrica, obtenido mediante GetFacialTemplate(), codificado en base64."},"SdkDuration":{"type":"number","description":"Duración de la operación en milisegundos."}}}} ``` ## The SearchResult object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"SearchResult":{"type":"object","description":"El resultado de la búsqueda de una plantilla en una galería.","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":"El índice de una plantilla facial en una galería.","minimum":0},"FacialTemplateId":{"type":"string","description":"El nombre de una plantilla facial en una galería."},"Similarity":{"type":"number","description":"Similitud entre dos plantillas faciales (0-Ninguna, 1-Idéntica)."},"FacialAuthenticationStatus":{"type":"string","description":"Posibles resultados de una operación de autenticación.","enum":["None","Negative","Uncertain","Positive","NoneBecausePoseExceed","NoneBecauseInvalidExtractions"]},"FacialAuthenticationDetail":{"type":"string","description":"Detalle de la calidad de una operación de autenticación.","enum":["None","PositiveLowSecurityLevel","PositiveMediumSecurityLevel","PositiveHighSecurityLevel"]},"SdkDuration":{"type":"number","description":"Duración de la operación en milisegundos."}}}} ``` ## The Galleries object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"Galleries":{"type":"object","description":"El contenido de todas las galerías abiertas.","properties":{"galleries":{"type":"array","items":{"$ref":"#/components/schemas/GalleryId"}}}},"GalleryId":{"type":"string","description":"El nombre de una galería de plantillas faciales."}}}} ``` ## The FacialTemplateIds object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"FacialTemplateIds":{"type":"object","description":"Una lista de templateId.","properties":{"templateIds":{"type":"array","items":{"$ref":"#/components/schemas/FacialTemplateId"}}}},"FacialTemplateId":{"type":"string","description":"El nombre de una plantilla facial en una galería."}}}} ``` ## The HealthResult object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"HealthResult":{"type":"object","description":"El resultado de una comprobación de estado.","properties":{"message":{"$ref":"#/components/schemas/HealthStatus"}}},"HealthStatus":{"type":"string","description":"Resultado del servicio de estado (indica si el SDK está activo o no).","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":"El resultado de una operación de Api Tracking.","properties":{"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingMessage":{"$ref":"#/components/schemas/TrackingMessage"}}},"TrackingStatus":{"type":"number","description":"Estado devuelto por el servicio Api Tracking, o -1 si no se requiere seguimiento."},"TrackingMessage":{"type":"string","description":"Mensaje devuelto por el servicio Api Tracking, o vacío si no se requiere seguimiento."}}}} ``` ## The TokenTypeResult object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"TokenTypeResult":{"type":"object","description":"El resultado de la identificación del token.","properties":{"type":{"$ref":"#/components/schemas/TokenType"}}},"TokenType":{"type":"string","description":"Posibles resultados de un búfer de token de entrada.","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":"Los parámetros de configuración del SDK y del servicio. La configuración de autenticación JWT se omite intencionadamente.","properties":{"FACEPHI_SELPHID_DEBUGPATH_KEY":{"type":"string","description":"Ruta y archivo donde se escriben los registros de SelphID."},"FACEPHI_SELPHID_FACIALAUTHENTICATION_THRESHOLD":{"type":"string","description":"Umbral para la autenticación facial."},"FACEPHI_SELPHID_FACIALEXTRACTOR_NUM_THREADS":{"type":"string","description":"Número de núcleos asignados a las operaciones de extracción/autenticación."},"FACEPHI_SELPHID_FACIALLIVENESS_DEPTH":{"type":"string","description":"Modo del pipeline del motor de prueba de vida."},"FACEPHI_SELPHID_FACIALLIVENESS_IAD":{"type":"string","description":"Estado de los filtros del detector de ataques de inyección (IAD) de prueba de vida."},"FACEPHI_SELPHID_FACIALLIVENESS_PATH_KEY":{"type":"string","description":"Ruta donde se instalan los modelos y otros datos del pipeline."},"FACEPHI_SELPHID_FACIALLIVENESS_THRESHOLD":{"type":"string","description":"Umbral para las operaciones de prueba de vida."},"FACEPHI_SELPHID_FACIAL_LICPATH_KEY":{"type":"string","description":"Ruta de la licencia."},"FACEPHI_SELPHID_FUTURE_TIME_ALLOWED":{"type":"string","description":"Valor global para aceptar templateRaws con fechas futuras."},"FACEPHI_SELPHID_GALLERY_REMOVE_METHOD":{"type":"string","description":"Método de eliminación para galerías 1:N."},"FACEPHI_SELPHID_USAGEPATH_KEY":{"type":"string","description":"Ruta de la base de datos de uso."},"client_max_body_size":{"type":"integer","description":"Tamaño máximo de los datos de la solicitud (Mb)."},"connection_timeout":{"type":"integer","description":"Tiempo de espera máximo para las conexiones (0=infinito)."},"keep_alive_request_number":{"type":"integer","description":"Cómo puede usarse una conexión en términos de tiempo de espera y número máximo de solicitudes."},"logger_level":{"type":"string","description":"Nivel de registro (logger)."},"logger_max_files":{"type":"integer","description":"Número máximo de archivos utilizados en la rotación del registro."},"logger_path":{"type":"string","description":"Ruta donde se almacenan los registros del servicio."},"logger_rotation":{"type":"string","description":"Estrategia de rotación del registro (logger)."},"number_of_threads":{"type":"integer","description":"Número de núcleos asignados a las solicitudes concurrentes."},"port":{"type":"integer","description":"Puerto de escucha del servicio."}}}}}} ``` ## The BadRequestResult object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"BadRequestResult":{"type":"object","description":"Resultado cuando llegan parámetros incorrectos en la solicitud.","properties":{"status":{"type":"number"},"error":{"type":"string"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}},"TimeStamp":{"type":"string","description":"Un valor de fecha y hora en formato \"%Y-%m-%dT%H:%M:%SZ\"."}}}} ``` ## The ExceptionResult object ```json {"openapi":"3.0.0","info":{"title":"SelphID-SDK Rest API","version":"6.21.0"},"components":{"schemas":{"ExceptionResult":{"type":"object","description":"Se ha producido un error en la llamada al backend de SelphID-SDK.","properties":{"status":{"type":"number"},"error":{"type":"string"},"exception":{"type":"string"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}},"TimeStamp":{"type":"string","description":"Un valor de fecha y hora en formato \"%Y-%m-%dT%H:%M:%SZ\"."}}}} ```