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

Add face/Selfie image

post https://demo-api.incodesmile.com/omni/add/face/third-party

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 limited.

Note: After selfie and front-id are uploaded, endpoint for comparing faces process-face on those two images can be called.

It is required that person is alone on the photo.

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Query Params

imageType

string

Image type. Default is selfie

captureType

string

externalCaptureId

string

recordingId

string

Body Params

base64Image

string

Image of user's face represented in base64.

imageUrl

string

URL of face image, required to belong to a whitelisted domain

faceCoordinates

object

Face coordinates

Headers

api-version

string

required

Defaults to 1.0

Responses

Response body

object

age

int32

Age of th person in the photo.

isBright

boolean

We recommend capturing another photo if value is false.

confidence

float

0 to 1

Value 0 means that person on photo is alive. We recommend capturing another photo if value is 1.

hasLenses

boolean

We recommend capturing another photo if value is true.

hasFaceMask

boolean

Checked only if configured in the session flow. We recommend capturing another photo if value is true.

hasClosedEyes

boolean

Checked only if configured in the session flow. We recommend capturing another photo if value is true.

hasHeadCover

boolean

Checked only if configured in the session flow. We recommend capturing another photo if value is true.

sessionStatus

string

SessionStatus

Alive Closed Deleted

captureAttemptsLimit

object

Checked only if configured in the session flow.

max

int32

Maximum number of attempts to capture a photo.

remaining

int32

Number of remaining attempts to capture a photo.

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 2 days ago

Add Base64 Barcode

Process face

Did this page help you?

Language

Credentials


xxxxxxxxxx
1
curl --request POST \
2
     --url https://demo-api.incodesmile.com/omni/add/face/third-party \
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 2 days ago

Add Base64 Barcode

Process face

Did this page help you?

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

200OK