Video Conference Beta

The Video Conference feature verifies the user through an online video call with an expert. The expert reviews the ID card and asks key questions to the end user to ensure they are who they claim to be.

Treezor relies on a user verification provider for Video Conference services. In this process, you redirect end users to a URL where they follow verification steps, including a video conference with an agent.

Configuration – Environment configuration by Treezor

Contact Treezor to use the video conference feature.

Process

You initiate video conference verification for the User:
/v1/users/{userId}/videoconference
Treezor answers with the video conference URL (identificationURL).
You redirect the User to the identificationURL
The User follows the step-by-step process, hence uploading the document (ID) while online with the expert.
Treezor informs you of the documents processing with the Video Conference webhooks.
Once the videoConference.finalized webhook returns a success Result, you may request a KYC review:
/v1/users/{userId}/Kycreview
Treezor sends you the user.kycreview webhook upon validation or refusal.

Key attributes (webhooks)

Video conference relies on webhooks to provide you with information regarding the process:

videoConference.created – Received when the user completes the video conference verification process.
videoConference.processing – Received when the video conference verification process is under review on the verification provider side.
videoConference.aborted – Received when the user abandons the video conference process (see Aborted reasons list for more details).
videoConference.finalized – Received when the verification process is done on the verification provider side, either successful or canceled (see Canceled reasons list for more details).

Attribute	Type	Description
`result`	string	Indicates whether or not the user was successfully verified on the provider side. Can be: `START` – The verification process has started. `REVIEW_PENDING` – The user is currently being verified. `FRAUD_SUSPICION_PENDING` – Further verifications are made due to fraud suspicions. `ABORTED` – The end user abandoned the verification process. `SUCCESS` – The end user's identity is verified. `SUCCESS_DATA_CHANGE` – The end user's identity is verified with data adjustments from provider. `FRAUD_SUSPICION_CONFIRMED` – The user identity is verified and is suspected of committing fraud. `CANCELED` – The verification couldn't be carried out by the provider.
`reason`	object	Details about the result when necessary. See Reasons list below.

Reasons

The reason object of the webhook contains a reasonCode and a reasonMessage for you to better understand the result of the Video Conference verification.

Aborted reasons

Here are the reasons you may find for aborted video conference.

Code	Message	Description
`4001`	`USER_CANCELLATION_DOCUMENT_NOT_ACCEPTED`	User's ID document is not accepted for the verification process.
`4002`	`USER_CANCELLATION_DOCUMENT_EXPIRED`	User cannot continue the verification process due to an expired ID document.
`4003`	`USER_CANCELLATION_UNDERAGE`	User is underage and is not allowed to continue the verification process.
`4004`	`USER_CANCELLATION_CAMERA_ACCESS_DENIED`	User does not allow camera permission in the app.
`4005`	`USER_CANCELLATION_TERMS_DENIED`	User does not accept the terms and conditions.
`4006`	`USER_CANCELLATION_SELFIE_NOT_READY`	User is not ready for a selfie.
`4007`	`USER_CANCELLATION_APP_NOT_SCANNING`	User aborts as the app is not scanning the document.
`4008`	`USER_CANCELLATION_INCORRECT_PHONE_NUMBER`	User cancels as the phone number is specified incorrectly.
`4009`	`USER_CANCELLATION_IDENTIFY_LATER`	User wants to identify later.
`4010`	`USER_CANCELLATION_USER_NOT_INTERESTED`	User is not interested in performing the identity verification.
`4011`	`USER_CANCELLATION_APP_NOT_RESPONDING`	User aborts because the app is not responding.
`4012`	`USER_CANCELLATION_PRIVACY_CONCERNS`	User aborts due to privacy concerns.
`4013`	`USER_CANCELLATION_DOCUMENT_NOT_AVAILABLE`	User does not have the ID document available and aborts.
`4014`	`APP_CANCELLATION_OTP_MATCH_LIMIT_REACHED`	User has reached the allowed limit for number of OTP entries and cannot try again.
`4015`	`USER_CANCELLATION_AGENT_BEHAVIOUR`	User does not feel comfortable to continue identification due to the agent's behaviour.

Canceled reasons

Here are the reasons you may find for canceled video conference.

Code	Message	Description
`4101`	`ID_BLURRY`	Document is blurry and mandatory data cannot be read due to the blur.
`4102`	`ID_GLARE`	Document has glare and mandatory data cannot be read due to the glare.
`4103`	`ID_DARKNESS`	Pictures of the document are dark and it is not possible to read the mandatory data or verify the authenticity of the document.
`4104`	`ID_DATA_COVERED`	Mandatory data is covered by the user while taking the picture.
`4105`	`ID_PERSPECTIVE`	Document is positioned at such an angle that mandatory data cannot be read or document cannot be verified.
`4106`	`ID_DATA_OTHER`	Any other reason due to which mandatory data cannot be read.
`4107`	`ID_NOT_SUPPORTED`	Document used during the identification is not supported for the customer's use case.
`4108`	`ID_EXPIRED`	Document used during the identification is expired.
`4109`	`ID_WRONG_SIDE`	Wrong side of the document is scanned during the process.
`4110`	`ID_OUTWORN`	Document is worn out. Either data cannot be read out or the document cannot be verified.
`4111`	`ID_HAS_STICKER`	Document has such stickers which are not acceptable and the document used is considered as damaged document.
`4112`	`ID_WRITTEN_ON`	Document has text written over it which makes the document not readable or not verifiable. If the sticker is legit one and added by the authorities while issuing the document then the document will be acceptable and not cancelled due to this reason.
`4113`	`ID_BROKEN`	Document used during the identification is broken.
`4114`	`ID_DAMAGED_OTHER`	Any other reason for a damaged document.
`4115`	`ID_SECURITY_FEATURE_NOT_VISIBLE_NOT_FRAUD`	Security features of the document are not visible because user did not move the document correctly.
`4116`	`ID_SECURITY_FEATURE_VIDEO_SHORT`	Security feature video is too short to detect if there are holograms in the document.
`4117`	`ID_SECURITY_FEATURE_VIDEO_CANNOT_BE_PLAYED`	Security feature video cannot be played for the agent to review holograms.
`4118`	`ID_SECURITY_FEATURE_OTHER`	Any other issues with the security feature video.
`4119`	`ID_SECOND_DOCUMENT_BAD_PHOTO_QUALITY`	Photo quality of the additional document in the process is not acceptable.
`4120`	`ID_SECOND_DOCUMENT_DAMAGED`	Additional document used in the identification process is severely outworn, written or drawn on, ripped or broken.
`4121`	`ID_SECOND_DOCUMENT_EXPIRED`	Additional document used in the identification process is an expired document.
`4122`	`ID_NEED_ADDITIONAL_DOCUMENT`	Additional document like Driver's License is missing in the identification process but it was required.
`4123`	`ID_SECOND_DOCUMENT_OTHER`	Any other issues with the additional document used in the identification process.
`4124`	`ID_OTHER`	Any other issues with the document used in the identification process.
`4125`	`USER_INVOICE_MISSING`	Customer needs proof of address from the user as the additional document but user did not provide it in the identification process.
`4126`	`USER_OBSCURED`	User has covered the face during the face comparison process unintentionally like wearing the face mask.
`4127`	`SELFIE_BLURRY`	Selfie taken by the user is blurry and cannot be used to compare the face with the identification document.
`4128`	`SELFIE_GLARE`	Photo of the user on the ID document has glares and selfie cannot be compared with it.
`4129`	`SELFIE_DARKNESS`	Selfie taken by the user is too dark to compare the face of the person with the photo on the identification document.
`4130`	`SELFIE_PERSPECTIVE`	Selfie taken by the user is on such an angle that it is not possible to compare it

Final reasons

Here are the reasons you may find for finalized video conference.

Code	Message	Description
`4201`	`WARNING_SELFIE_REAL_PERSON`	User that performed the identification is a real person but the selfie does not match with the face on the document.
`4202`	`WARNING_SELFIE_NO_REAL_PERSON`	Selfie taken in the identification process is not of a real person. For example, the selfie taken is a photo of a picture.
`4203`	`WARNING_SELFIE_DISGUISED`	User intentionally disguised the face by wearing a mask or in some other way.
`4204`	`WARNING_MANIPULATED_DATA`	Data is manipulated on the Identification document.
`4205`	`WARNING_MANIPULATED_PHOTO`	Photo of the person is manipulated on the Identification document.
`4206`	`WARNING_FAKED_SECURITY_FEATURES`	Security features like holograms on the Identification document are not real.
`4207`	`WARNING_PAPER_PRINT`	The Identification document is not real but a printout taken on a paper.
`4208`	`WARNING_DIGITAL_DOCUMENT`	Identification document image is taken from a digital screen (from laptop, from mobile or from any other screen).
`4209`	`WARNING_FAKED_SPECIMEN`	Identification document is a specimen document and not a real document.
`4210`	`WARNING_USER_UNDERAGE`	User is below the age required to access the customer's service.
`4211`	`WARNING_DIGITAL_SELFIE`	Selfie is taken from a digital screen (from laptop, from mobile or from any other screen).
`4212`	`WARNING_MONEY_MULE`	User is duped by fraudster to perform identification on fraudster's behalf.
`4213`	`WARNING_NAME_COMPARISON`	Considerable inconsistency between user's name and document.
`4214`	`WARNING_SCAN`	Identification document is a facsimile.
`4215`	`WARNING_FRAUD_OTHER`	Any other type of fraud identified during the verification process by Ident specialist.

Initiate Video conference verification

Before initiating the video conference verification process, the User must be created with the relevant attributes (as required by Treezor Compliance).

At least the firstname, lastname, email, country, and phone fields of the user must be populated, otherwise, the API call returns an HTTP 428 error.

Parameters

You can optionally override the default URL to which the user will be redirected after the video conference verification.

Attribute	Type	Description
`redirectUrl`	string	The URL to which the User will be redirected after the video conference verification.

Request

You can use the following request to initiate the video conference verification process.

CURL

bash

curl -X POST {baseUrl}/v1/users/{userId}/videoconference \
	--header 'Authorization: Bearer {accessToken}' \
	--header 'Content-Type: application/json' \
	-d '{"redirectUrl": "https://www.my-domain.tld"}'

Answers with a 201 HTTP Status Code and returns the identifier of the verification process and the identificationURL. The latter is where the end user is to be redirected to go through the video conference verification process.

JSON

json

{
   "identification": {
       "identificationId": {{identification-id}},
       "identificationURL": "https://go.idnow.de/app/treezoramlauto/identifications/{{identification-id}}/identification/routing/start",
   }
}

End user verification

Once redirected, end users are guided through the video conference verification steps, in which they present a verification document while talking online with the expert.

Download the documents

If you're eligible, you may be able to collect some of the uploaded documents whose documentTypeId allows for it.

Configuration – Download is not enabled by default

Please contact Treezor to request access to this feature.

Downloading a document is a 2-step process, in which you:

Request the download URL
Download the document within 30 seconds

Request the download URL

To request the download URL, you need the corresponding documentId (available in the document.create webhook for instance).

CURL

bash

curl -X GET {baseUrl}/v1/documents/{documentId}/download \
	--header 'Authorization: Bearer {accessToken}' \

Returns the URL to download the document, with all the necessary query parameters for the next step.

JSON

json

{
    "url": "{documentDownloadUrl}"
}

Download the document

You have 30 seconds to download the document from the moment the presigned URL has been generated in the previous step.

CURL

bash

curl -X GET {documentDownloadUrl}

The document is returned in its initial format.

Request a KYC Review for the User

Before requesting a KYC review from Treezor, please make sure all the information and documents are properly updated for the user.

You can use the dedicated endpoint:

/v1/users/{userId}/Kycreview

Alert – Documents must be uploaded for children users too

When there are parent-children hierarchical relationship, in most cases, the KYC Review must only be requested for the parent user. But you may need to upload Documents for the children before that. Please abide by the Treezor Compliance team recommendation for a smooth experience.

Learn more in the KYC Request article.

Endpoints

Endpoint	Scope
`/v1/users/{userId}/videoconference` Initiate the user Video Conference verification process	`read_write`
`/v1/documents/{documentId}/download` Retrieve a document download URL	`read_only`
`/v1/users/{userId}/Kycreview` Initiate the user KYC review process	`read_write`

Video Conference Beta ​

Process ​

Key attributes (webhooks) ​

Reasons ​

Aborted reasons ​

Canceled reasons ​

Final reasons ​

Initiate Video conference verification ​

Parameters ​

Request ​

End user verification ​

Download the documents ​

Request the download URL ​

Download the document ​

Request a KYC Review for the User ​

Endpoints ​

Video Conference Beta

Process

Key attributes (webhooks)

Reasons

Aborted reasons

Canceled reasons

Final reasons

Initiate Video conference verification

Parameters

Request

End user verification

Download the documents

Request the download URL

Download the document

Request a KYC Review for the User

Endpoints