API reference · Proof of address capture

Finalize document processing

POST/omni/finalize/document

Base URL: https://demo-api.incodesmile.com — Incode demo environment

Finalize document processing for multi-page documents with optional page capture

Path & query parameters

Name In Type Required Description
api-version header string yes

Request body

Field Type Required Description
type string yes Type of document image for which processing is being finalized. Enum: selfie, authenticationSelfie, sorSelfie, videoSelfie, croppedFace, croppedAuthenticationSelfie, croppedFrameAnalysisSelfie, croppedIDFace, croppedNfcFace, document, originalSignature, signature, initials, fullFrameFrontID, fullFrameBackID, croppedFrontID, refCroppedFrontID, croppedBackID, refCroppedBackID, croppedOriginalFrontID, croppedOriginalBackID, confSelfie, confFrontID, confBackID, confPoa, addressStatement, medicalDoc, secondId, thirdId, contract, signedContract, videoSelfieCompareID, videoSelfieCompareOcr, videoSelfieCompareBackID, videoSelfieCompareBackOcr, otherDocument1, otherDocument2, otherDocument3, paymentProof, consent, annotationImg, externalScreen, eSignDocument, sessionExport, zoomedFrontId, zoomedBackId, zoomedSelfie, regionBasedTemplate, renaperCropped, voiceConsentSelfie, v5cLogbook, v5cMultiPageLogbook, carInvoice, circulationCard, financeSettlement, faceRecordingFrame, signatureImageID, ghostSignatureImageID, ghostPortraitImageID, fingerprintImageID, documentNumberCropImageID, ineMexScan

Responses

200

OK

Response body (application/json):

Field Type Required Description
status string AddDocumentStatus Enum: SUCCESS, PROCESS_DOC_ERROR, SESSION_ERROR, ADD_NEXT_PAGE, OPTIONAL_PAGE_CAPTURE, CLASSIFICATION_ERROR, MULTI_PAGE_CLASSIFICATION_ERROR, V5C_REGISTRATION_NUMBER_MISMATCH, V5C_REFERENCE_NUMBER_MISMATCH, V5C_NUMBER_MISMATCH, FSL_AGREEMENT_REFERENCE_MISMATCH, FSL_NAME_MISMATCH, MANDATORY_FIELD_MISSING, UNSUPPORTED_PAGE_NUMBERS, VALIDATION_ERROR, UNEXPECTED_ERROR, FINALIZE_ERROR_NO_PAGES, UNSUPPORTED_MP_DOCUMENT_TYPE
Was this page helpful?