# Incode Developer Hub — API Reference > The API Reference section of Incode Developer Hub. Public developer documentation and REST API reference for the Incode Omni identity platform — onboarding, SDKs, and integration guides. 201 page(s). Each link is the page's raw Markdown twin, readable without parsing HTML. Pages marked `[stub]` are placeholders that have not been written yet. ## API Reference - [`DELETE` Delete PII data for single onboarding session.](https://developer.incode.com/api-reference/interview.md): Path & query parameters - [`POST` Start onboarding](https://developer.incode.com/api-reference/start.md): This endpoint is mandatory to start any onboarding session in Incode Omni and session can be monitored on the Incode Dashboard. And it generates token which sh… - [`POST` Request new onboarding for integrations](https://developer.incode.com/api-reference/b2b-onboarding-request-new.md): This endpoint starts new onboarding session for integration and generates onboarding link. - [`POST` Fetch images](https://developer.incode.com/api-reference/get-images.md): Returns images for user - [`POST` Fetch image links](https://developer.incode.com/api-reference/get-images-v2.md): Returns images temporary links for requested images. Links are valid for one hour - [`POST` Fetch images second id](https://developer.incode.com/api-reference/get-images-second-id.md): Returns images for second id of user - [`POST` Fetch image links for second id](https://developer.incode.com/api-reference/get-images-second-id-v2.md): Returns seconnd id images temporary links for requested images. Links are valid for one hour - [`POST` Fetch concatenated images](https://developer.incode.com/api-reference/get-concatenated-images.md): Concatenates requested images from user. Resulting image keep the largest width of the requested images and preserves the order. - [`GET` Fetch scores](https://developer.incode.com/api-reference/get-score.md): Path & query parameters - [`GET` Fetch device info](https://developer.incode.com/api-reference/get-device-info.md): Fetch information about device user was using during onboarding - [`GET` Get url to download session recording](https://developer.incode.com/api-reference/generatesessionrecordingdownloadurl.md): Path & query parameters - [`DELETE` Delete PII data for multiple onboarding sessions with multiple options.](https://developer.incode.com/api-reference/interviews.md): Path & query parameters - [`GET` Fetch onboarding status](https://developer.incode.com/api-reference/get-onboarding-status.md): Check the status of onboarding session. - [`POST` Send SMS with the link for onboarding](https://developer.incode.com/api-reference/external-send-sms.md): Used by Admins or Executives to send SMS containing generated onboarding link. - [`GET` Fetch onboarding url](https://developer.incode.com/api-reference/onboarding-url.md): Fetch onboarding URL generated for specific user and specific flow. Only supply a clientId, if a redirect to mobile feature has been added to the flow configur… - [`PUT` Update manual review](https://developer.incode.com/api-reference/updatemanualreview.md): Can be used to set an interview as 'needs manual review', 'approved by manual review' or 'rejected by manual review'. In case manualReviewStatus field in reque… - [`POST` Approve customer](https://developer.incode.com/api-reference/process-approve.md): Approve customer for omnichannel program. Body is optional and used for auto approve when only specific features should be approved. It is not possible to appr… - [`DELETE` Delete PII data for single onboarding session by external ID.](https://developer.incode.com/api-reference/session-externalid.md): Deprecated — this endpoint is marked deprecated in the Omni API specification. - [`PUT` Update interview](https://developer.incode.com/api-reference/update.md): If upload of front, back side of id or selfie, was not successful after retries, use this endpoint to specify that additional manual check is needed. - [`POST` Add QR code raw text](https://developer.incode.com/api-reference/add-qr-code-text.md): Add QR code raw text to interview. It will be saved in customFields named 'qrCodeText', this fields needs to be present in organization's custom fields schema. - [`POST` Set session status](https://developer.incode.com/api-reference/session-status-set.md): Set the status of current session. Possible actions to set the status to are: Alive, Closed or Deleted. Closed status disables all of the "/add/..." calls so t… - [`GET` Get session status](https://developer.incode.com/api-reference/session-status-get.md): Path & query parameters - [`GET` Mark onboarding complete](https://developer.incode.com/api-reference/finish-status.md): Deprecated — this endpoint is marked deprecated in the Omni API specification. - [`POST` Mark onboarding complete](https://developer.incode.com/api-reference/finish-status-post.md): Path & query parameters - [`POST` Process IMSS](https://developer.incode.com/api-reference/process-imss.md): Trigger fetching of work history for curp. This will notify the results to the configured Work History Webhook. - [`POST` Process payment proof](https://developer.incode.com/api-reference/process-payment-proof.md): Note : This endpoint should be called once the Qr-code is executed. - [`GET` Fetch IMSS labor history](https://developer.incode.com/api-reference/get-imss.md): Fetch user's labor history from IMSS. Interview id is extracted from jwt token. - [`GET` Fetch interview event dictionary](https://developer.incode.com/api-reference/interview-events-dictionary.md): Returns the list of all existing interview event types - [`GET` Fetch interview events](https://developer.incode.com/api-reference/getevents.md): Returns the list of all events for given interview - [`POST` Generates single session PDF report](https://developer.incode.com/api-reference/session-downloadpdf-v2.md): This endpoint is used to generate a PDF report for a single session - [`POST` Add custom watchlist entries for child organizations](https://developer.incode.com/api-reference/b2b-v1-watchlist-integrator-batch.md): Imports custom watchlist entries from a CSV file and assigns each row to the child organization identified by clientId. - [`GET` Fetch session listing](https://developer.incode.com/api-reference/b2b-v1-sessions-listing.md): Fetch onboarding sessions listing. - [`GET` Fetch device info list](https://developer.incode.com/api-reference/b2b-v1-devices-info.md): Fetch all device information entries associated with the given onboarding Session. - [`POST` Refresh QR code value](https://developer.incode.com/api-reference/qr-refresh.md): Refresh UUID for already started onboarding with /omni/onboarding-url. Returns null if not started before this call or if start expired. Returned UUID is short… - [`POST` Validate QR code uuid](https://developer.incode.com/api-reference/qr-validate.md): Check if provided UUID value is still valid for Interview ID. If valid, response will contain UUID that is stored on Onboarding cache and have default TTL of 1… - [`POST` Import base64Video and return recordingId](https://developer.incode.com/api-reference/recordings-import.md): Path & query parameters - [`POST` Import base64Video and return recordingId](https://developer.incode.com/api-reference/recordings-import-third-party.md): Path & query parameters - [`GET` Fetch raw IDV results](https://developer.incode.com/api-reference/get-raw-idv-results.md): Returns raw id-validation-service check results with original naming preserved (no mapping to user-service key constants, no threshold-binarization), plus the… - [`GET` Process Antifraud](https://developer.incode.com/api-reference/process-antifraud.md): This endpoint should be called only after process-id and process-face both are over. This endpoint gives ability to compare current interview with existing int… - [`GET` Fetch CURP scraping results](https://developer.incode.com/api-reference/api-fetch-curp-v3.md): Fetch the results from /api/validate/curp/v3. The recommended wait time is 25 secs and retrying every 5 secs after that. - [`GET` Fetch INE scraping results](https://developer.incode.com/api-reference/api-fetch-ine.md): Fetch the results from /api/validate/ine. The recommended wait time is 20 sec and retrying every 5 sec after that. - [`POST` Validate bank statement](https://developer.incode.com/api-reference/api-validate-bank-statement.md): This endpoint is used to validate and get the information from a bank statement. - [`POST` Validate bank statement v2](https://developer.incode.com/api-reference/api-validate-bank-statement-v2.md): This endpoint is used to validate and get the information from a bank statement. - [`POST` CURP scraping validation by data](https://developer.incode.com/api-reference/api-validate-curp-by-data-v3.md): Check for valid CURP directly with an automated search in https://www.gob.mx/curp/ and return corresponding curp of that person. Parameters are the person's de… - [`POST` CURP scraping validation](https://developer.incode.com/api-reference/api-validate-curp-v3.md): Check for valid CURP directly with an automated search in https://www.gob.mx/curp/ and return corresponding values of that person. Parameter must be "curp". - [`POST` INE scraping validation](https://developer.incode.com/api-reference/api-validate-ine.md): Check for valid INE directly with an automated search in https://listanominal.ine.mx/scpln/ and return corresponding values of that ID. - [`POST` Registraduria validation - Colombian id](https://developer.incode.com/api-reference/api-validate-registraduria.md): Check for valid Colombian ID and return corresponding values of that person. Optionally, you can set isForeign flag to true to check for foreign people living… - [`POST` Colombia - Temporary Residency / PPT Validation](https://developer.incode.com/api-reference/api-validate-registraduria-ppt.md): Check for a valid Colombian temporary residency ID and return the corresponding values of that person. - [`POST` RFC validation by CURP v2](https://developer.incode.com/api-reference/api-validate-rfc-by-curp-v2.md): Check for valid CURP, use obtained data to calculate RFC and then validate the RFC. If CURP is not found then renapo valid field will be false. - [`POST` RFC validation](https://developer.incode.com/api-reference/api-validate-rfc.md): Check for valid RFC. If RFC is not found then validRFC field will be false. - [`POST` Calculate RFC](https://developer.incode.com/api-reference/api-calculate-rfc.md): Calculate and return the RFC based on a person data. - [`POST` SSN Validation](https://developer.incode.com/api-reference/api-validate-ssn.md): Validate a social security number and the person associated with it. - [`POST` Vehicle Identification Number Validation](https://developer.incode.com/api-reference/api-validate-vin.md): Validate a VIN number and obtain data related to reports about crashes, theft, etc. - [`POST` Verify authentication attempt](https://developer.incode.com/api-reference/authentication-verify.md): Verify the authenticity of an authentication attempt. Works with Admin Token . - [`POST` Fetch authentication attempts](https://developer.incode.com/api-reference/authentications-external-search.md): This API allows for searching through stored authentication records, providing insight into both 1:1 (one to one) and 1:N (one to many) authentication modes. I… - [`POST` Add curp](https://developer.incode.com/api-reference/add-curp.md): Add curp and the validation process result to interview. - [`POST` Add curp v2](https://developer.incode.com/api-reference/add-curp-v2.md): Add CURP and validation result based on a person data. - [`POST` CURP validation v4](https://developer.incode.com/api-reference/api-validate-curp-v4.md): Check for valid CURP and return corresponding values of that person. - [`POST` CURP by data validation v4](https://developer.incode.com/api-reference/api-validate-curp-by-data-v4.md): Check for valid CURP based on a person data and return corresponding values of that person including the CURP. - [`POST` CURP Validation Error Codes](https://developer.incode.com/api-reference/curp-validation-error-codes.md): Add curp and the validation process result to interview. - [`POST` Add custom fields](https://developer.incode.com/api-reference/add-custom-fields.md): This endpoint is used for adding custom fields to current onboarding session. The key must match one of the keys that are defined for the Organization, and the… - [`GET` Get custom fields](https://developer.incode.com/api-reference/get-custom-fields.md): This endpoint is used for fetching custom fields for current session. - [`POST` Add custom watchlist entry](https://developer.incode.com/api-reference/add-watchlist-single-record.md): Works with Admin Token . - [`POST` Process custom watchlist](https://developer.incode.com/api-reference/process-watchlist.md): This endpoint fetches data (photo, email, phone, document number) from onboarding session and tries to find a match in custom watchlist database. If a match on… - [`POST` Add custom watchlist entry from session](https://developer.incode.com/api-reference/add-watchlist-session.md): Works with Admin Token . - [`POST` Add custom watchlist entry from identity](https://developer.incode.com/api-reference/add-watchlist-identity.md): Works with Admin Token . - [`POST` Delete custom watchlist entry](https://developer.incode.com/api-reference/delete-watchlist-single-record.md): Works with Admin Token . - [`POST` Add document](https://developer.incode.com/api-reference/add-document.md): Upload document image and store data. - [`POST` Add document V2](https://developer.incode.com/api-reference/add-document-v2.md): Upload document image and store data. - [`POST` Add document V3](https://developer.incode.com/api-reference/add-document-v3.md): Upload document image gathered and store data. - [`POST` Add document asynchronously](https://developer.incode.com/api-reference/add-document-async.md): Upload document image and store data asynchronously. - [`POST` Attach stamp on annotation](https://developer.incode.com/api-reference/attach-stamp-on-annotation.md): Substitute stamps from interview to previously uploaded PDF contracts at all places with pdf text annotations. Annotations must contain text with preselected v… - [`GET` Get contracts links](https://developer.incode.com/api-reference/get-contracts-links.md): Fetches temporary link of the contracts uploaded for the current session. - [`POST` eKYB](https://developer.incode.com/api-reference/externalverification-ekyb.md): This endpoint performs an eKYB check for the business specified - [`GET` Get eKYB session data for the current session](https://developer.incode.com/api-reference/externalverification-ekyb-session.md): Returns stored eKYB verification request/response data for the interview associated with the caller's session token. Intended for downstream onboarding steps (… - [`GET` Get async vendor verification status/result](https://developer.incode.com/api-reference/verification-async-referenceid.md): Retrieves the status and persisted result of a previously initiated async vendor verification request. The result field is null while the request is PENDING, c… - [`POST` EkybChecks Modular Business Verification](https://developer.incode.com/api-reference/ekybchecks.md): Composable KYB endpoint. Clients specify which modules they need and Incode routes to the correct vendor for the country. Available modules: identity, address,… - [`GET` Get eKYC session data for the current session](https://developer.incode.com/api-reference/externalverification-ekyc-session.md): Returns stored eKYC verification request/response data for the interview associated with the caller's session token. - [`POST` Unified start + eKYC + finish (low-latency)](https://developer.incode.com/api-reference/externalverification-ekyc-unified.md): Runs session start and eKYC verification in parallel and fires finish-status asynchronously, returning once both the start and eKYC legs have resolved. - [`POST` External Verification (eKYC)](https://developer.incode.com/api-reference/externalverification-ekyc.md): This endpoint verifies phone, email, address, date of birth and tax numbers, specifically social security number (ssn). When making a request use "kyc" in the… - [`POST` eKYC Income verification](https://developer.incode.com/api-reference/externalverification-income.md): This endpoint performs an eKYC income check - [`GET` Get signing ceremony URL](https://developer.incode.com/api-reference/get-signing-ceremony-url.md): Fetches signing ceremony URL for the current session. - [`POST` Attach signature to multiple pdf documents](https://developer.incode.com/api-reference/attach-signature-to-pdf-v2.md): Attach signature from interview to previously uploaded PDF contracts at (x, y) coordinates with desired height to desired page on pdf. Coordinates are relative… - [`POST` Attach signature on annotation](https://developer.incode.com/api-reference/attach-signature-on-annotation.md): Attach signature from interview to previously uploaded PDF contracts at all places annotated with text from request, with desired height on pdf. Annotations mu… - [`GET` Get signed contracts links](https://developer.incode.com/api-reference/get-signed-contracts-links.md): Fetches temporary link of the signed contracts uploaded for the current session. - [`GET` Get signed documents](https://developer.incode.com/api-reference/es-documents-signed-v2.md): This endpoint is used to get signed documents for a session - [`POST` Add email](https://developer.incode.com/api-reference/add-email.md): Add email to interview. - [`GET` Get email](https://developer.incode.com/api-reference/get-email.md): Path & query parameters - [`POST` Add face/Selfie image](https://developer.incode.com/api-reference/add-face-third-party.md): Uploads selfie image for onboarding session. Response will contain data regarding liveness — if that is the photo of a real person. Number of retries is not li… - [`POST` Process face](https://developer.incode.com/api-reference/process-face.md): Note: This endpoint should be called only after selfie and front-id both are over. - [`POST` Process face vs second id](https://developer.incode.com/api-reference/process-face-vs-second-id.md): Note : This endpoint should be called only after selfie and front-second-id both are over. - [`POST` Add fiscal qr url](https://developer.incode.com/api-reference/add-fiscal-qr-url.md): Upload the url extracted from a fiscal qr code. Data from the given url will be available via the Get fiscal qr url response endpoint. (México only) - [`POST` Add fiscal qr image](https://developer.incode.com/api-reference/add-fiscal-qr-url-image.md): Upload a fiscal qr image as base64 to session. The data available in the url embedded in the qr will be available via the Get fiscal qr url response endpoint.… - [`GET` Get fiscal qr url response](https://developer.incode.com/api-reference/fiscal-qr-url-response.md): Path & query parameters - [`GET` Fetch Form Answers](https://developer.incode.com/api-reference/form-answers.md): Retrieves all questions and answers that a user has responded to during a session, regardless of the form module configurations used. - [`POST` Analysis of all faces from selfie image](https://developer.incode.com/api-reference/frame-analysis-analyze.md): Authenticate users by comparing base64 image from request and user's existing face templates. Each face from the image is analyzed, and relevant attributes are… - [`POST` Analysis of all faces from selfie image](https://developer.incode.com/api-reference/frame-analysis-analyze-third-party.md): Authenticate users by comparing base64 image from request and user's existing face templates. Each face from the image is analyzed, and relevant attributes are… - [`POST` Add geolocation](https://developer.incode.com/api-reference/add-geolocation.md): Send location to store in database, or send coordinates and fetch location and store it - [`POST` Global Watchlist result](https://developer.incode.com/api-reference/watchlist-result.md): This endpoint calls the global watchlist api (currently only Tier 2), and gets the latest gathered result. - [`GET` Updated global watchlist result](https://developer.incode.com/api-reference/updated-watchlist-result.md): This endpoint gets the latest result for a previous search created with watch-list with refId from it's response, or gathered from an update notification or wi… - [`POST` Process global watchlist](https://developer.incode.com/api-reference/process-global-watchlist.md): This endpoint processes a global watchlist search for an individual using the watchlist configuration defined in the flow (including settings for subscription… - [`POST` Process government validation](https://developer.incode.com/api-reference/process-government-validation.md): This endpoint reads the country code from the interview which can be set at the moment of calling the start endpoint or is updated based on the processed id. R… - [`POST` Add front side of ID](https://developer.incode.com/api-reference/add-front-id-v2.md): This endpoint is used for storing front side of id for further processing. Image quality check is performed during that call. Number of retries is not limited. - [`POST` Add front side of Second ID](https://developer.incode.com/api-reference/add-front-second-id-v2.md): This endpoint is used for storing front side of second id for further processing - [`POST` Add back side of ID](https://developer.incode.com/api-reference/add-back-id-v2.md): This endpoint is used for storing back side of id for further processing. Image quality check is performed during that call. Number of retries is not limited. - [`POST` Add back side of Second ID](https://developer.incode.com/api-reference/add-back-second-id-v2.md): Image quality check is performed during that call. Number of retries is not limited. Once id processing is finished, this endpoint cannot be called for retries… - [`POST` Process Id](https://developer.incode.com/api-reference/process-id.md): Note :This endpoint should be called only after the front-side and back-side is over. And in case of passports or only front sided documents, only front-side s… - [`POST` Process Second Id](https://developer.incode.com/api-reference/process-second-id.md): Note : This endpoint should be called only after the upload of front-side-secondId and back-side-secondId is over. And in case of passports or only front sided… - [`POST` Add document id](https://developer.incode.com/api-reference/add-document-id.md): Upload document identifier. For Mexican id it is cic from the back of id. - [`GET` Get ID Summary](https://developer.incode.com/api-reference/get-id-summary.md): Returns success information about addFront and addBack. Also returns onlyFront flag. - [`GET` Fetch ocr data](https://developer.incode.com/api-reference/get-ocr-data.md): Returns data about user read from id and address statement. - [`GET` Fetch ocr data v2](https://developer.incode.com/api-reference/get-ocr-data-v2.md): Returns data about user read from id and address statement wrapped in ocrData object. - [`GET` Fetch ocr data for second id](https://developer.incode.com/api-reference/get-ocr-data-second-id.md): Returns data about user read from the second id. - [`PUT` Update editable OCR data in interview](https://developer.incode.com/api-reference/update-editable-ocr-data.md): Update some of the crucial interview OCR data if needed. - [`PUT` Update editable OCR data in interview for the second Id](https://developer.incode.com/api-reference/update-editable-ocr-data-second-id.md): Update some of the crucial interview OCR data if needed. - [`POST` Add Barcode](https://developer.incode.com/api-reference/add-barcode.md): Add raw barcode and parse it to interview. - [`GET` Get cross-document comparison results](https://developer.incode.com/api-reference/cross-doc-data-check-results.md): Fetch cross-document data check results for a given interview ID. If no ID is provided, it defaults to the user's ID from the JWT. - [`POST` Add Base64 Barcode](https://developer.incode.com/api-reference/add-barcode-v2.md): Add Base64 barcode and parse it to interview. - [`POST` Add Base64 Barcode](https://developer.incode.com/api-reference/add-barcode-v3.md): Add Base64 barcode and parse it to interview. - [`GET` Get identity reuse documents](https://developer.incode.com/api-reference/identity-reuse-documents.md): Returns all found identity documents across all candidate identities - [`POST` Submit identity reuse decision](https://developer.incode.com/api-reference/identity-reuse-submit.md): Accepts or declines reuse of a previously verified identity, on another organization. - [`POST` Sign String with NOM 151](https://developer.incode.com/api-reference/sign-string-nom151.md): Sign any String with NOM 151. - [`POST` Calculate contract Nom151 signature](https://developer.incode.com/api-reference/calculate-contract-nom151-signature.md): This api endpoint calculates the Nom151 signature of an already signed contract and returns the signature. - [`POST` Sign document with NOM 151](https://developer.incode.com/api-reference/sign-document-nom151.md): Sign any base64-encoded document with NOM 151. - [`POST` Sign hash with NOM 151](https://developer.incode.com/api-reference/sign-hash-nom151.md): Sign any SHA-256 hash (64-hex) with NOM 151. - [`POST` Add device fingerprint](https://developer.incode.com/api-reference/add-device-fingerprint.md): Sends information about device from which endpoint is called - [`POST` Add device fingerprint signals](https://developer.incode.com/api-reference/add-device-fingerprint-signals.md): Records signals (device, network, behaviour, or PID) captured during an interview event - [`POST` Forward diagnostics data](https://developer.incode.com/api-reference/add-diagnostics-data.md): Accepts an encrypted TrueSight diagnostics envelope from the SDK, enriches it with server-resolved clientId and environment, and forwards it to TrueSight. - [`POST` Add fingerprints](https://developer.incode.com/api-reference/add-fingerprints.md): Add fingerprints blobs and metadata to interview. - [`POST` Add name](https://developer.incode.com/api-reference/add-name.md): This endpoint is used for adding user's name for current onboarding session. - [`GET` Send SMS with One Time Password for onboarding](https://developer.incode.com/api-reference/send-otp.md): Send SMS with an OTP (One Time Password) code to validate an onboarding. Phone number is obtained from interview data, so phone step it's required. - [`GET` Fetch](https://developer.incode.com/api-reference/api-key.md): Fetch all API keys of current user's organization. If user is super admin, parameter apiKey can be provided to specify organization for which the keys should b… - [`POST` Create](https://developer.incode.com/api-reference/api-key-post.md): Create new API key for current user's organization. If user is super admin, parameter apiKey can be provided to specify organization for which the key should b… - [`PUT` Update](https://developer.incode.com/api-reference/api-key-put.md): Validate/invalidate API key for current user's organization. If user is super admin, parameter apiKey can be provided to specify organization for which the key… - [`POST` Attach signature to pdf document](https://developer.incode.com/api-reference/attach-signature-to-pdf.md): Attach signature from interview to supplied pdf at (x, y) coordinates with desired height to desired page on pdf. Coordinates are relative to left bottom corne… - [`GET` Fetch Identity data](https://developer.incode.com/api-reference/b2b-v1-identities.md): Fetches data associated with identity, which was gathered in onboarding. Works with Admin Token . - [`POST` Insert authentications in batch](https://developer.incode.com/api-reference/batch-auth-stats.md): Inserts face authentications in batch. - [`GET` Generate interview code](https://developer.incode.com/api-reference/code-generate.md): Generate interview code for this session. - [`POST` Verify interview code](https://developer.incode.com/api-reference/code-verify.md): Verify interview code before connecting to video conference. - [`GET` Compare/Validate OTP code obtained through SMS for onboarding](https://developer.incode.com/api-reference/compare-sms-otp.md): Send OTP code obtained through SMS to validate an onboarding. Phone number is obtained from interview data, so phone step it's required. Success will be false… - [`POST` Delete Multiple onboarding sessions with multiple options.](https://developer.incode.com/api-reference/delete-interviews.md): Deprecated — this endpoint is marked deprecated in the Omni API specification. - [`POST` Update device stats](https://developer.incode.com/api-reference/device-stats.md): Sends information about collected capture frame statistics - [`POST` Expire onboarding sessions by interviewIds.](https://developer.incode.com/api-reference/expire-interviews.md): Expire onboarding sessions given by interviewIds array, and cleanerConfiguration parameter. - [`GET` Get Fingerprints](https://developer.incode.com/api-reference/get-fingerprints.md): This endpoint is used for fetching fingerprints for current session. - [`GET` Fetch processing status](https://developer.incode.com/api-reference/get-postprocess-isfinished.md): Check if session processing is done. - [`GET` Fetch random questions and answers for video selfie](https://developer.incode.com/api-reference/get-questionandanswer.md): Fetch a number random questions and answers for video selfie for given apiKey. If there are no defined QA pairs for the apiKey, a random QA pair is returned fr… - [`POST` Identity cross-check comparing account creation data with IDV data](https://developer.incode.com/api-reference/identity-crosscheck.md): Cross-checks name and date of birth from account creation against data extracted during IDV. Compares the provided data with OCR-extracted data and returns val… - [`GET` Fetch all passed onboardings ids for the same person](https://developer.incode.com/api-reference/identity-sessionids.md): Path & query parameters - [`POST` Perform MFA](https://developer.incode.com/api-reference/oneton-mfa.md): This method is used for confirming user identity by sending last four digits of his phone number. transactionId which was received in /omni/oneToN/identify res… - [`GET` Send SMS with One Time Password for onboarding](https://developer.incode.com/api-reference/send-sms-otp.md): Send SMS with an OTP (One Time Password) code to validate an onboarding. Phone number is obtained from interview data, so phone step it's required. - [`POST` Compare OCR from videoselfie against OCR from ID v2](https://developer.incode.com/api-reference/videoselfie-compare-ocr-v2.md): This endpoint is used to compare OCR from videoselfie frame against OCR from ID. - [`POST` Issue a device-bound mDL for the current interview](https://developer.incode.com/api-reference/credentials-mdl.md): Builds credential claims from the interview identified by the access token and issues a device-bound ISO/IEC 18013-5 mDL bound to the supplied device public ke… - [`POST` Add selfie to identity template](https://developer.incode.com/api-reference/b2b-v1-authentications-add-selfie-to-identity.md): Adds the selfie from the specified or latest authentication attempt to the user's identity template set. - [`POST` Authentication with face/selfie image](https://developer.incode.com/api-reference/onboarding-authentications-authenticate.md): Authenticate user by comparing base64 image from request and user's existing face template. In case of One to one authentication, user is first found in DB by… - [`POST` Authentication with face/selfie image](https://developer.incode.com/api-reference/onboarding-authentications-authenticate-third-party.md): Authenticate user by comparing base64 image from request and user's existing face template. In case of One to one authentication, user is first found in DB by… - [`POST` Provide selfie for stateless authentication](https://developer.incode.com/api-reference/stateless-authentications-provide-reference-selfie.md): A method to provide a reference selfie for stateless authentication. (A selfie of the original onboarding that was approved but later removed from Incode stora… - [`POST` Login admin token](https://developer.incode.com/api-reference/executive-log-in.md): Logs in an user and provides a token with high-privileges - [`GET` Fetch all passed onboardings for the same person](https://developer.incode.com/api-reference/identity-sessions.md): Path & query parameters - [`POST` Fetch audit logs](https://developer.incode.com/api-reference/executive-events-find.md): Use this API to retrieve records of activities performed within your organization. These logs include key events such as changes to organization settings, exec… - [`GET` Get batch processing status](https://developer.incode.com/api-reference/get-process-batch-status.md): Returns the status of the /omni/process/batch progress - [`POST` Add phone](https://developer.incode.com/api-reference/add-phone.md): Deprecated — this endpoint is marked deprecated in the Omni API specification. - [`GET` Get phone](https://developer.incode.com/api-reference/get-phone.md): Deprecated — this endpoint is marked deprecated in the Omni API specification. - [`GET` Get phone](https://developer.incode.com/api-reference/phone.md): Path & query parameters - [`POST` Add phone](https://developer.incode.com/api-reference/phone-post.md): Add phone to interview - [`POST` Finalize document processing](https://developer.incode.com/api-reference/finalize-document.md): Finalize document processing for multi-page documents with optional page capture - [`POST` Add proof of address](https://developer.incode.com/api-reference/add-address-statement.md): Add a proof of address statement as a blob. OCR data from statement will be automatically extracted - [`POST` Add proof of address v2](https://developer.incode.com/api-reference/add-address-statement-v2.md): Add a proof of address statement as a base64 string. OCR data from statement will be automatically extracted - [`POST` Sign combined consents with checkboxes.](https://developer.incode.com/api-reference/sign-combined-consent.md): Receives information about which checkboxes user signed. - [`GET` Get combined consent for requested language](https://developer.incode.com/api-reference/get-combined-consent.md): Fetches combined consent for requested language. - [`POST` Add user consent](https://developer.incode.com/api-reference/add-user-consent.md): Add user consent with title, content and status to session. - [`GET` Get user consent](https://developer.incode.com/api-reference/get-user-consent.md): Fetches user consent with title, content and status from session. - [`POST` Save user consent](https://developer.incode.com/api-reference/add-conference-consent.md): Save information indicating that user has accepted terms and conditions and other checks on conference. - [`POST` Add conference module](https://developer.incode.com/api-reference/add-conference-module.md): Add conference module with name, url and icon (base64). - [`POST` Add conference feedback](https://developer.incode.com/api-reference/add-conference-feedback.md): This endpoint is used for adding conference feedback for the interview/session. - [`POST` Add notes](https://developer.incode.com/api-reference/add-notes.md): This endpoint is used for adding notes for interview/session. - [`POST` Send conference chat](https://developer.incode.com/api-reference/chat.md): Store conference chat. The executive should send the whole chat at the end of conference call (just before finish is called). - [`POST` Add conference event](https://developer.incode.com/api-reference/conference-add-event.md): Send (OpenTok) conference event. Any connection issue caught by webapp could be reported using this call. - [`GET` Fetch conference events](https://developer.incode.com/api-reference/conference-get-events.md): Fetch conference events for given 'interviewId'. - [`POST` Store conference photos](https://developer.incode.com/api-reference/conference-photo.md): A bank executive can ask the customer to additionally capture his face or document. These will be stored in DB. - [`POST` Report conference issue](https://developer.incode.com/api-reference/conference-report-issue.md): An executive can report any issue by this call. - [`PUT` Finish interview](https://developer.incode.com/api-reference/finish.md): Finish the interview and remove customer from the queue. - [`GET` Fetch notes](https://developer.incode.com/api-reference/get-conference-notes.md): This endpoint is used for fetching conference notes for interview/session. Works with Admin Token . - [`GET` Fetch conference feedback](https://developer.incode.com/api-reference/get-conference-feedback.md): This endpoint is used for fetching conference feedback for the interview/session. Works with Admin Token . - [`GET` Fetch conference chat](https://developer.incode.com/api-reference/get-chat.md): Fetch conference chat for given 'interviewId'.Works with Admin Token . - [`GET` Fetch conference status](https://developer.incode.com/api-reference/get-conference-status.md): Returns data about conference session for given ID. - [`GET` Fetch video archive urls](https://developer.incode.com/api-reference/get-archives.md): Fetch URLs of video archives from given 'interviewId' or if omitted for given 'since' timestamp. If not provided, 'since' will be defaulted to time of first cr… - [`GET` Connect to conference call](https://developer.incode.com/api-reference/get-interviewer-info.md): Path & query parameters - [`PUT` Add user to queue](https://developer.incode.com/api-reference/queue-conference-add.md): When data collection is over, users can be added to the queue for joining conference calls with an executive. The average time for before user joins to confere… - [`GET` Get connection details](https://developer.incode.com/api-reference/queue-conference-connection-details.md): An executive can invite the user to join a conference if the connection is lost by sending uuid ID to user. Using this uuid connection details for that session… - [`POST` Disconnect user from the queue](https://developer.incode.com/api-reference/queue-conference-disconnect.md): Users can disconnect themselves while waiting in the queue at any time. - [`GET` Get user's position in queue](https://developer.incode.com/api-reference/queue-conference-index.md): Use this endpoint to check user's position in waiting queue. Once the index in the response is 0, users can connect to the conference call. Use endpoint Get po… - [`GET` Get next customer from the queue](https://developer.incode.com/api-reference/queue-conference-next.md): Fetch next customer from a conference queue. In case no customer in the queue, and empty body is returned. - [`POST` Start recording](https://developer.incode.com/api-reference/record-start.md): Start recording of the interview. - [`POST` Stop recording](https://developer.incode.com/api-reference/record-stop.md): Stop recording the interview. - [`POST` Verify face](https://developer.incode.com/api-reference/verifyface.md): A bank executive can ask the customer to additionally capture his face during an interview and do face recognition. A face can be captured from selfie or ID th… - [`POST` Add notes](https://developer.incode.com/api-reference/add-conference-notes.md): This endpoint is used for adding notes for interview/session. - [`POST` Complete multipart video selfie upload](https://developer.incode.com/api-reference/video-selfie-upload-complete.md): Signal that all chunks have been uploaded. - [`POST` Initiate multipart video selfie upload](https://developer.incode.com/api-reference/video-selfie-upload-initiate.md): Start a chunked video upload session. Returns an uploadId for subsequent part uploads and completion. The entire upload (all parts + complete) must finish with… - [`POST` Upload a video selfie chunk](https://developer.incode.com/api-reference/video-selfie-upload-part.md): Upload a single chunk of the video selfie. Chunks must be between 5MB and 10MB, except for the last chunk which can be smaller. - [`GET` Get download URL of videoselfie](https://developer.incode.com/api-reference/generatevideoselfiedownloadurl.md): Path & query parameters - [`POST` Get videoselfie hash](https://developer.incode.com/api-reference/videoselfie-hash.md): Obtain a hash of the video file of the videoselfie. The hash and hashImage fields in the response will be null if the video file is not yet ready. ## Optional - [Full text for this section](https://developer.incode.com/api-reference/llms-full.txt): every page here, in one document - [All sections (llms.txt)](https://developer.incode.com/llms.txt): the whole site index - [Search API](https://developer.incode.com/api/ai/search?q=liveness): `GET /api/ai/search?q=&k=<1-25>` — keyword search across every section