Explore

Developer Guide

API Reference

Session Management

begin/ - Session creation

https://widget.identomat.com/external-api/begin/

Parameters

company_key - The company secret key

flags - A JSON document containing session customization flags

parent_session_id - While creating child for session with multiple participants, this parameter indicates parent session ID

Example

operator-questionnaire - Operator questionnaire Step

Call example

Request parameter examples

default:

agreement:

user-questionnaire - User questionnaire step

Call example

Request parameter examples

default:

result/ - Session Results

https://widget.identomat.com/external-api/result/

Parameters

• company_key - The company secret key

• session_token - The unique session identifier

Example

curl https://widget.identomat.com/external-api/result/ \

delete/ - Session data deletion

https://widget.identomat.com/external-api/delete/

Parameters

• company_key - The company secret key

• session_token - The unique session identifier

Example

Accessing Data and More

The methods below are for accessing images and videos associated with a session:

result/card-front/ - Card front side image

https://widget.identomat.com/external-api/result/card-front/

Parameters

• company_key - The company secret key

• session_token - The unique session identifier

Example

result/card-back/ - Card back side image

https://widget.identomat.com/external-api/result/card-back/

Parameters

• company_key - The company secret key

• session_token - The unique session identifier

Example

result/passport/ - Passport photo page image

https://widget.identomat.com/external-api/result/passport/

Parameters

• company_key - The company secret key

• session_token - The unique session identifier

Example

result/face/ - Face image

https://widget.identomat.com/external-api/result/face/

Parameters

• company_key - The company secret key

• session_token - The unique session identifier

Example

result/face-video/ - Face motion video

https://widget.identomat.com/external-api/result/face-video/

Parameters

• company_key - The company secret key

• session_token - The unique session identifier

Example

result/face-document/ - Face with document image

https://widget.identomat.com/external-api/result/face-document/

Parameters

• company_key - The company secret key

• session_token - The unique session identifier

Example

result/general-document/ - General document photo page image

https://widget.identomat.com/external-api/result/general-document/

Parameters

• company_key - The company secret key

• session_token - The unique session identifier

• typeId - `bank-statement`, `utility-bill`, `vehicle-registration-certificate-front`, `vehicle-registration-certificate-back` or `drivers-license`

Example

list-session-activities - List of session activities

https://external-api.identomat.com/list-session-activities

Call example

Request parameter examples

default:

Result examples

default:

invalidAccess:

get-session-statistical-summary - Session statistical summary

https://external-api.identomat.com/get-session-statistical-summary

Call example

Request parameter examples

default:

Result examples

default:

invalidAccess:

get-session-main-document-face-photo - Get face photo from main document

https://external-api.identomat.com/get-session-main-document-face-photo

Call example

Request parameter examples

default:

Result examples

default:

invalidAccess:

notFound:

search-screening-person - Search for a person in screening databases

https://external-api.identomat.com/search-screening-person

Call example

Request parameter examples

default:

Result examples

default:

companyMissing:

paymentNeeded:

get-screening-person-details - Get a person’s details from screening databases

https://external-api.identomat.com/get-screening-person-details

Call example

Request parameter examples

default:

Result examples

default:

companyMissing:

paymentNeeded:

monitor-screening-query - Set person on monitoring

https://external-api.identomat.com/monitor-screening-query

Call example

Request parameter examples

default:

Result examples

default:

remove-screening-query-from-monitoring - Set person on monitoring

https://external-api.identomat.com/remove-screening-query-from-monitoring

Call example

Request parameter examples

default:

Result examples

default:

list-screening-monitoring-records - List screening records that are monitored

https://external-api.identomat.com/list-screening-monitoring-records

Call example

Request parameter examples

default:

Result examples

default:

get-video-call-shots - Video call shots

https://external-api.identomat.com/get-video-call-shots

Call example

Request parameter examples

default:

Result examples

default:

invalidAccess:

get-video-call-videos - Video call videos

https://external-api.identomat.com/get-video-call-videos

Call example

Request parameter examples

default:

Result examples

default:

notFound:

invalidAccess:

get-session-config-steps - Get steps configuration

https://external-api.identomat.com/get-session-config-steps

Call example

Request parameter examples

default:

Result examples

default:

wrongParameters:

export-session-as-pdf - Export session

https://external-api.identomat.com/export-session-as-pdf

Call example

Request parameter examples

default:

Result examples

default:

wrongParameters:

invalidAccess:

Processing an Image

The methods below are for manually processing an image. Each of these methods return either a string containing an error code, or an object containing the information read. The number of object fields may change depending on what can be read from the image.

card/front/ - ID card front side

https://widget.identomat.com/external-api/card/front/

Parameters

• company_key - The company secret key

• image - A JPEG image file

Example

card/back/ - ID card back side

https://widget.identomat.com/external-api/card/back/

Parameters

• company_key - The company secret key

• image - A JPEG image file

Example

license/front/ - Driver license front side

https://widget.identomat.com/external-api/license/front/

Parameters

• company_key - The company secret key

• image - A JPEG image file

Example

license/back/ - Driver license back side

https://widget.identomat.com/external-api/license/back/

Parameters

• company_key - The company secret key

• image - A JPEG image file

Example

residence/front/ - Residence permit front side

https://widget.identomat.com/external-api/residence/front/

Parameters

• company_key - The company secret key

• image - A JPEG image file

Example

residence/back/ - Residence permit back side

https://widget.identomat.com/external-api/residence/back/

Parameters

• company_key - The company secret key

• image - A JPEG image file

Example

passport/ - Passport photo page

https://widget.identomat.com/external-api/passport/

Parameters

• company_key - The company secret key

• image - A JPEG image file

Example

Extra Processing

Listed below are various methods of image processing. Each of these methods return either a string containing an error code, or an object containing the information read. The number of object fields may change depending on what can be read from the image.