Get id validation, liveness and face recognition results for given interviewId.
API reference, Interview
Fetch scores
GET
https://demo-api.incodesmile.com/omni/get/scoreQuery parameters
Id of onboarding for which score is requests. If not present, it will be extracted from token.
Headers
Responses
Response body (application/json)
The result of authentication containing overall score and list of executed checks.
Composite result for authentication score.
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGSpecific rule from rule engine
Name of the rule.
A logical expression of the rule.
enum
idValidationsecondIdValidationfaceValidationlivenessdeepsighteKycvideoselfiefaceAuthenticationtotalphoneRiskemailRiskgovernmentValidationenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGId validation of its overall score and two lists of executed tests and checks
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGSpecific rule from rule engine
Name of the rule.
A logical expression of the rule.
enum
idValidationsecondIdValidationfaceValidationlivenessdeepsighteKycvideoselfiefaceAuthenticationtotalphoneRiskemailRiskgovernmentValidationenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGThe result of antifraud check where we compare the current interview with existing interviews and customers and detect anomalies than could be signs of fraud
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGSame as idValidation only applicable if onboarding is configured to capture a second id
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGSpecific rule from rule engine
Name of the rule.
A logical expression of the rule.
enum
idValidationsecondIdValidationfaceValidationlivenessdeepsighteKycvideoselfiefaceAuthenticationtotalphoneRiskemailRiskgovernmentValidationenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if the hat/cap is detected on the image. Only if hats detected option is configured
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if closed eyes is detected on the image. Only if hats detected option is configured
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if physical attack is detected. Only if this option is configured
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if digital attack is detected. Only if this option is configured
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if evasion attack is detected. Only if this option is configured
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if deepfake attack is detected. Only if digital attack is configured
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if digital manipulation attack is detected. Only if digital attack is configured
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGInformation about applied rule
Name of the rule.
A logical expression of the rule.
enum
idValidationsecondIdValidationfaceValidationlivenessdeepsighteKycvideoselfiefaceAuthenticationtotalphoneRiskemailRiskgovernmentValidationenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGInformation about method used
enum
SFSF_MMSF_MM_VComposite result for liveness score.
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if physical attack is detected. Only if this option is configured. Deprecated, use 'physicalAttack' instead.
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
SFSF_MMSF_MM_Venum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGSpecific rule from rule engine
Name of the rule.
A logical expression of the rule.
enum
idValidationsecondIdValidationfaceValidationlivenessdeepsighteKycvideoselfiefaceAuthenticationtotalphoneRiskemailRiskgovernmentValidationenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGContains face attributes
Shows info if the user was wearing a mask during selfie capture
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGShows info if the user was wearing lenses during selfie capture
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if the hat/cap is detected on the image. Only if hats detected option is configured
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if closed eyes is detected on the image. Only if hats detected option is configured
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if captured face is occluded on the image. Only if hats detected option is configured
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGContains quality checks
Shows status of brightness during selfie capture
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGShows status of image quality check
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGFlag indicating if a user is already enrolled
Id of enrolled user
Session ID, in case the user is approved in another session
External ID, in case the user is approved in another session
Shows info if the user was wearing a mask during selfie capture
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGShows info if the user was wearing lenses during selfie capture
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGShows status and level of brightness during selfie capture
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGShows image quality during selfie capture
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGShows if the name matches the previously used (only in case the user is already approved in another session)
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGSpecific rule from rule engine for faceValidation
Name of the rule.
A logical expression of the rule.
enum
idValidationsecondIdValidationfaceValidationlivenessdeepsighteKycvideoselfiefaceAuthenticationtotalphoneRiskemailRiskgovernmentValidationenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGShows how much face from ID matches the selfie
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if the hat/cap is detected on the image. Only if hats detected option is configured
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if closed eyes is detected on the image. Only if hats detected option is configured
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if captured face is occluded on the image. Only if hats detected option is configured
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGSame as faceRecognition only applicable if onboarding is configured to capture a second id
Flag indicating if a user is already enrolled
Id of enrolled user
Session ID, in case the user is approved in another session
External ID, in case the user is approved in another session
Shows info if the user was wearing a mask during selfie capture
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGShows info if the user was wearing lenses during selfie capture
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGShows status and level of brightness during selfie capture
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGShows image quality during selfie capture
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGShows if the name matches the previously used (only in case the user is already approved in another session)
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGSpecific rule from rule engine for faceValidation
Name of the rule.
A logical expression of the rule.
enum
idValidationsecondIdValidationfaceValidationlivenessdeepsighteKycvideoselfiefaceAuthenticationtotalphoneRiskemailRiskgovernmentValidationenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGShows how much face from ID matches the selfie
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if the hat/cap is detected on the image. Only if hats detected option is configured
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if closed eyes is detected on the image. Only if hats detected option is configured
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGReturns flag if captured face is occluded on the image. Only if hats detected option is configured
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDING- recognitionConfidence: Only present in case face validation is performed as a part of government check - fingerprintConfidence: Only present in case fingerprint validation is performed as a part of government check - minimumPassingFingerprints: Only present in case fingerprint validation is performed. Maps to configured number of minimum fingerprints configured at the time of score calculation. - validationStatus: Possible values: processingIne, ok, validationError, ineConnectionError, ineInfrastructureError, moduleNotSupported, missingDocumentId, missingSelfie, userNotFound, userNotFoundInIneDb, notEnoughData, livenessFail, ineNotCurrent, ineReportedLost, ineReportedStolen, ineSignaturError, transactionLimitReached, geographicRegionNotSupported Key-value mapping: - -1: processingIne - 0: ok - 1: validationError - 2: ineConnectionError - 3: ineInfrastructureError - 4: moduleNotSupported - 5: missingDocumentId - 6: missingSelfie - 7: userNotFound - 8: userNotFoundInIneDb - 9: notEnoughData - 10: livenessFail - 11: ineNotCurrent - 12: ineReportedLost - 13: ineReportedStolen - 14: ineSignaturError - 99: geographicRegionNotSupported - 205: transactionLimitReached - ocrValidation: List of value, status, key objects. Not all of the following keys are always present: issueDate firstName, maternalLastName, paternalLastName, ocr, personalId, electorsKey, emissionNumber, registrationDate - ocrValidationOverall: Composite result for ocrValidation score - overall
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGSpecific rule from rule engine
Name of the rule.
A logical expression of the rule.
enum
idValidationsecondIdValidationfaceValidationlivenessdeepsighteKycvideoselfiefaceAuthenticationtotalphoneRiskemailRiskgovernmentValidationenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDING- speechTranscript: Extracted text from speech, during video recording - videoSelfieLiveness: Shows liveness confidence that the person is real based on video conference - videoSelfieFaceRecognition: Shows how much face from id matches the video conference capture - speechRecognition: This shows how much the recognized speech matches the expected result - score: Overall video recording score
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGSpecific rule from rule engine
Name of the rule.
A logical expression of the rule.
enum
idValidationsecondIdValidationfaceValidationlivenessdeepsighteKycvideoselfiefaceAuthenticationtotalphoneRiskemailRiskgovernmentValidationenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGOnly for Mex documents, in case CURP validation was performed
Flag indicating request passed successfully.
Curp
Sex
enum
MujerHombreXNationality
Flag indicating if CURP validation passed - tipoError present in response
Names
Paternal surname
Mother maiden name
Birth Date in format DD/MM/YYYY
Birth State
Probation Document
Key/Value structure. All keys are type of string. Available Key values: - anioReg - foja - tomo - libro - numActa - CRIP - numEntidadReg - cveMunicipioReg - NumRegExtranjeros - FolioCarta - cveEntidadNac - cveEntidadEmisora
Status Curp
Deceased Status
Only for Mex documents in case INE scraping was performed
Scraping status
enum
IN_PROGRESSFINISHEDERRORFlag indicating if the process finished successfully.
Result
enum
successerrorCic value.
Clave de elector.
Emission number.
Ocr number.
Registration year.
Emission year.
Confidence level for read ocr data from ID
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGSame as idOcrConfidence only applicable if onboarding is configured to capture a second id
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGIncode watchlist score
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGInfo about failed onboarding attempts (only if 'Onboarding flow attempts' > 0 in ID Capture module)
Object with counter of failed attempts per step
enum
frontIdbackIdselfiepoagovernmentValidationInfo about image alignment characteristic (if is on the image edge)
Specific rule from rule engine for total
Name of the rule.
A logical expression of the rule.
enum
idValidationsecondIdValidationfaceValidationlivenessdeepsighteKycvideoselfiefaceAuthenticationtotalphoneRiskemailRiskgovernmentValidationenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGIn case the overall score status is MANUAL (Needs Review), returns reason
enum
MANUAL_CAPTURERULE_APPLIEDOLD_IDFLOW_CONFIGURATIONFRONT_ID_CAPTURE_ATTEMPTSBACK_ID_CAPTURE_ATTEMPTSSELFIE_CAPTURE_ATTEMPTSANTIFRAUDMISSING_DEPTH_DATACUSTOMenum
PRESENTNOT_PRESENTUNKNOWNenum
YESNOUNKNOWNenum
YESNOUNKNOWNenum
NOT_EMPTYEMPTYUNKNOWNenum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGAnalysis of trust relationships and signals detected during onboarding, such as connections between devices and identities, used to assess the overall trustworthiness of the onboarding attempt.
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGSimple identity crosscheck that compare names and dates of birth from different sources
Overall validation result
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGIndividual validation checks
Risk level assessment
Analysis of invoice data
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGAsynchronous secondary ID validation deep check
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGAutopilot is a machine learning based score
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGDeprecated; use failedFeatureDetails.
Deprecated; use legitFeatureDetails.
Composite result for previous sections
enum
OKWARNFAILUNKNOWNMANUALMANUAL_OKMANUAL_FAILMANUAL_PENDINGResponse body (application/json)
UTC timestamp in milliseconds
Custom error code or HTTP status code
HTTP status error
Custom error message
Endpoint path
Custom error details
Response body (application/json)
UTC timestamp in milliseconds
Custom error code or HTTP status code
HTTP status error
Custom error message
Endpoint path
Custom error details