getting started

Introduction
How to get an access token

Incode Omni API

Interview
Organization
Id capture
Face capture
Geolocation
- Add geolocationpost
Curp validation
Government validation
- Process government validationpost
Custom watchlist
Global watchlist
- Global Watchlist resultpost
- Updated global watchlist resultget
Document capture
Proof of address capture
- Add proof of addresspost
- Add proof of address v2post
Phone number input
Email input
- Add emailpost
- Get emailget
Fiscal qr url
Custom fields
- Add custom fieldspost
- Get custom fieldsget
Ekyb
- eKYBpost
Ekyc
- External Verification (eKYC)post
- eKYC Income verificationpost
Forms and data entry
- Fetch Form Answersget
Antifraud
- Process Antifraudget
Shared consent
- Sign combined consents with checkboxes.post
- Get combined consent for requested languageget
User consent
- Add user consentpost
- Get user consentget
Videoselfie
- Get download URL of videoselfieget
- Get videoselfie hashpost
Electronic signature
Nom151
- Sign String with NOM 151post
- Calculate contract Nom151 signaturepost
Video conference
API validations
Authentications
- Fetch authentication attemptspost
- Verify authentication attemptpost
Electronic signature advanced
- Get signed documentsget

Start onboarding

post https://demo-api.incodesmile.com/omni/start

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 should be used for the authentication of future subsequent calls.

URL Expired

The URL for this request expired after 30 days.

📘
The interviewId parameter is deprecated
Since January 1, 2024, the parameter interviewId is deprecated and shouldn't be used

Body Params

language

string

Language code to be used when doing speech to text. Possible values: en-US, es-ES, pt-BR.

externalCustomerId

string

Id that identifies user in clients external system.

uuid

string

uuid key used in redis, can be used as an alternative to sending interviewId.

configurationId

string

Id of the flow to be used for this onboarding.

redirectionUrl

string

Url the user will be redirected to after finishing the onboarding successfully.

customFields

object

Used to send any additional information in key value pair format.

Show Deprecated

Headers

api-version

string

required

Defaults to 1.0

Responses

Response body

object

interviewId

string

length between 24 and 24

Identifies the onboarding session that is initialized. Can be used for fetching data about that session in future calls.

token

string

length ≤ 2048

Internal JWT token used for the future subsequent calls. It is the value for X-Incode-Hardware-Id header in all other calls.

interviewCode

string

length between 6 and 6

This value is used for connecting to conference call.

flowType

string

(only if configurationId is sent in request). Type of the flow used. Could be flow (in most cases), or legacy type configuration (not used anymore).

configuration flow workflow

idCaptureTimeout

int32

Number of seconds after which manual capture button should be shown to the user, while capturing ID when ID is detected.

idDetectionTimeout

int32

Number of seconds after which manual capture button should be shown to the user, if ID is not detected.

selfieCaptureTimeout

int32

Number of seconds after which manual capture button should be shown to the user, while capturing selfie.

idCaptureRetries

int32

Number of ID captures after which user should be taken to next screen.

selfieCaptureRetries

int32

Number of selfie captures after which user should be taken to next screen.

curpValidationRetries

int32

Number of curp validations after which user should be taken to next screen. (only for Mexico)

clientId

string

Customer specific clientId that corresponds to api key.

env

string

Server environment. Could be one of: stage, demo, saas.

existingSession

boolean

It's true if interviewId corresponds to an existing Onboarding Session.

Response body

object

timestamp

int64

UTC timestamp in milliseconds

status

int32

Custom error code or HTTP status code

error

string

HTTP status error

message

string

Custom error message

path

string

Endpoint path

details

object

Custom error details

Has additional fields

Updated 4 days ago

How to get an access token

Fetch images

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://demo-api.incodesmile.com/omni/start \
3
     --header 'accept: application/json' \
4
     --header 'api-version: 1.0' \
5
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 4 days ago

How to get an access token

Fetch images

getting started
Introduction
How to get an access token

Incode Omni API
Interview
Fetch IMSS labor historyget
Process payment proofpost
Process IMSSpost
Mark onboarding completeget
Get session statusget
Set session statuspost
Add QR code raw textpost
Update interviewput
Delete PII data for single onboarding session by external ID.delete
Approve customerpost
Update manual reviewput
Fetch onboarding urlget
Send SMS with the link for onboardingpost
Fetch onboarding statusget
Delete PII data for multiple onboarding sessions with multiple options.delete
Delete PII data for single onboarding session.delete
Get url to download session recordingget
Fetch device infoget
Fetch scoresget
Fetch concatenated imagespost
Fetch image links for second idpost
Fetch images second idpost
Fetch image linkspost
Fetch imagespost
Start onboardingpost
Organization
Get batch processing statusget
Fetch audit logspost
Fetch all passed onboardings for the same personget
Login admin tokenpost
Id capture
Add Base64 Barcodepost
Get cross-document comparison resultsget
Add Barcodepost
Update editable OCR data in interview for the second Idput
Update editable OCR data in interviewput
Fetch ocr data for second idget
Fetch ocr data v2get
Fetch ocr dataget
Get ID Summaryget
Add document idpost
Process Second Idpost
Process Idpost
Add back side of Second IDpost
Add back side of IDpost
Add front side of Second IDpost
Add front side of IDpost
Face capture
Process face vs second idpost
Process facepost
Add face/Selfie imagepost
Geolocation
Add geolocationpost
Curp validation
CURP by data validation v4post
CURP validation v4post
Add curp v2post
Add curppost
CURP Validation - Error Codes
Government validation
Process government validationpost
Custom watchlist
Delete custom watchlist entrypost
Add custom watchlist entry from identitypost
Add custom watchlist entry from sessionpost
Process custom watchlistpost
Add custom watchlist entrypost
Global watchlist
Updated global watchlist resultget
Global Watchlist resultpost
Document capture
Get contracts linksget
Attach stamp on annotationpost
Add document asynchronouslypost
Add document V2post
Add documentpost
Proof of address capture
Add proof of address v2post
Add proof of addresspost
Phone number input
Add phonepost
Get phoneget
Get phoneget
Add phonepost
Email input
Get emailget
Add emailpost
Fiscal qr url
Get fiscal qr url responseget
Add fiscal qr imagepost
Add fiscal qr urlpost
Custom fields
Get custom fieldsget
Add custom fieldspost
Ekyb
eKYBpost
Ekyc
eKYC Income verificationpost
External Verification (eKYC)post
Forms and data entry
Fetch Form Answersget
Antifraud
Process Antifraudget
Shared consent
Get combined consent for requested languageget
Sign combined consents with checkboxes.post
User consent
Get user consentget
Add user consentpost
Videoselfie
Get videoselfie hashpost
Get download URL of videoselfieget
Electronic signature
Get signed contracts linksget
Attach signature on annotationpost
Attach signature to multiple pdf documentspost
Nom151
Calculate contract Nom151 signaturepost
Sign String with NOM 151post
Video conference
Fetch video archive urlsget
Fetch conference statusget
Fetch conference chatget
Fetch conference feedbackget
Fetch notesget
API validations
Calculate RFCpost
RFC validationpost
RFC validation by CURP v2post
Authentications
Verify authentication attemptpost
Fetch authentication attemptspost
Electronic signature advanced
Get signed documentsget

📘The interviewId parameter is deprecated

200OK

400Custom error statuses: 4026: Invalid uuid parameter 4027: Invalid configurationId 4028: Flow is not activated

📘
The `interviewId` parameter is deprecated