Skip to content

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.

Gear icon

Configuration – Environment configuration by Treezor

Contact Treezor to use the video conference feature.

Process

Documents upload QES verification
  1. You initiate video conference verification for the User:
    /v1/users/{userId}/videoconference
  2. Treezor answers with the video conference URL (identificationURL).
  3. You redirect the User to the identificationURL
  4. The User follows the step-by-step process, hence uploading the document (ID) while online with the expert.
  5. Treezor informs you of the documents processing with the Video Conference webhooks.
  6. Once the videoConference.finalized webhook returns a success Result, you may request a KYC review:
    /v1/users/{userId}/Kycreview
  7. 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:

AttributeTypeDescription
resultstringIndicates 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.
reasonobjectDetails 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.

CodeMessageDescription
4001USER_CANCELLATION_DOCUMENT_NOT_ACCEPTEDUser's ID document is not accepted for the verification process.
4002USER_CANCELLATION_DOCUMENT_EXPIREDUser cannot continue the verification process due to an expired ID document.
4003USER_CANCELLATION_UNDERAGEUser is underage and is not allowed to continue the verification process.
4004USER_CANCELLATION_CAMERA_ACCESS_DENIEDUser does not allow camera permission in the app.
4005USER_CANCELLATION_TERMS_DENIEDUser does not accept the terms and conditions.
4006USER_CANCELLATION_SELFIE_NOT_READYUser is not ready for a selfie.
4007USER_CANCELLATION_APP_NOT_SCANNINGUser aborts as the app is not scanning the document.
4008USER_CANCELLATION_INCORRECT_PHONE_NUMBERUser cancels as the phone number is specified incorrectly.
4009USER_CANCELLATION_IDENTIFY_LATERUser wants to identify later.
4010USER_CANCELLATION_USER_NOT_INTERESTEDUser is not interested in performing the identity verification.
4011USER_CANCELLATION_APP_NOT_RESPONDINGUser aborts because the app is not responding.
4012USER_CANCELLATION_PRIVACY_CONCERNSUser aborts due to privacy concerns.
4013USER_CANCELLATION_DOCUMENT_NOT_AVAILABLEUser does not have the ID document available and aborts.
4014APP_CANCELLATION_OTP_MATCH_LIMIT_REACHEDUser has reached the allowed limit for number of OTP entries and cannot try again.
4015USER_CANCELLATION_AGENT_BEHAVIOURUser 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.

CodeMessageDescription
4101ID_BLURRYDocument is blurry and mandatory data cannot be read due to the blur.
4102ID_GLAREDocument has glare and mandatory data cannot be read due to the glare.
4103ID_DARKNESSPictures of the document are dark and it is not possible to read the mandatory data or verify the authenticity of the document.
4104ID_DATA_COVEREDMandatory data is covered by the user while taking the picture.
4105ID_PERSPECTIVEDocument is positioned at such an angle that mandatory data cannot be read or document cannot be verified.
4106ID_DATA_OTHERAny other reason due to which mandatory data cannot be read.
4107ID_NOT_SUPPORTEDDocument used during the identification is not supported for the customer's use case.
4108ID_EXPIREDDocument used during the identification is expired.
4109ID_WRONG_SIDEWrong side of the document is scanned during the process.
4110ID_OUTWORNDocument is worn out. Either data cannot be read out or the document cannot be verified.
4111ID_HAS_STICKERDocument has such stickers which are not acceptable and the document used is considered as damaged document.
4112ID_WRITTEN_ONDocument 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.
4113ID_BROKENDocument used during the identification is broken.
4114ID_DAMAGED_OTHERAny other reason for a damaged document.
4115ID_SECURITY_FEATURE_NOT_VISIBLE_NOT_FRAUDSecurity features of the document are not visible because user did not move the document correctly.
4116ID_SECURITY_FEATURE_VIDEO_SHORTSecurity feature video is too short to detect if there are holograms in the document.
4117ID_SECURITY_FEATURE_VIDEO_CANNOT_BE_PLAYEDSecurity feature video cannot be played for the agent to review holograms.
4118ID_SECURITY_FEATURE_OTHERAny other issues with the security feature video.
4119ID_SECOND_DOCUMENT_BAD_PHOTO_QUALITYPhoto quality of the additional document in the process is not acceptable.
4120ID_SECOND_DOCUMENT_DAMAGEDAdditional document used in the identification process is severely outworn, written or drawn on, ripped or broken.
4121ID_SECOND_DOCUMENT_EXPIREDAdditional document used in the identification process is an expired document.
4122ID_NEED_ADDITIONAL_DOCUMENTAdditional document like Driver's License is missing in the identification process but it was required.
4123ID_SECOND_DOCUMENT_OTHERAny other issues with the additional document used in the identification process.
4124ID_OTHERAny other issues with the document used in the identification process.
4125USER_INVOICE_MISSINGCustomer needs proof of address from the user as the additional document but user did not provide it in the identification process.
4126USER_OBSCUREDUser has covered the face during the face comparison process unintentionally like wearing the face mask.
4127SELFIE_BLURRYSelfie taken by the user is blurry and cannot be used to compare the face with the identification document.
4128SELFIE_GLAREPhoto of the user on the ID document has glares and selfie cannot be compared with it.
4129SELFIE_DARKNESSSelfie taken by the user is too dark to compare the face of the person with the photo on the identification document.
4130SELFIE_PERSPECTIVESelfie 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.

CodeMessageDescription
4201WARNING_SELFIE_REAL_PERSONUser that performed the identification is a real person but the selfie does not match with the face on the document.
4202WARNING_SELFIE_NO_REAL_PERSONSelfie taken in the identification process is not of a real person. For example, the selfie taken is a photo of a picture.
4203WARNING_SELFIE_DISGUISEDUser intentionally disguised the face by wearing a mask or in some other way.
4204WARNING_MANIPULATED_DATAData is manipulated on the Identification document.
4205WARNING_MANIPULATED_PHOTOPhoto of the person is manipulated on the Identification document.
4206WARNING_FAKED_SECURITY_FEATURESSecurity features like holograms on the Identification document are not real.
4207WARNING_PAPER_PRINTThe Identification document is not real but a printout taken on a paper.
4208WARNING_DIGITAL_DOCUMENTIdentification document image is taken from a digital screen (from laptop, from mobile or from any other screen).
4209WARNING_FAKED_SPECIMENIdentification document is a specimen document and not a real document.
4210WARNING_USER_UNDERAGEUser is below the age required to access the customer's service.
4211WARNING_DIGITAL_SELFIESelfie is taken from a digital screen (from laptop, from mobile or from any other screen).
4212WARNING_MONEY_MULEUser is duped by fraudster to perform identification on fraudster's behalf.
4213WARNING_NAME_COMPARISONConsiderable inconsistency between user's name and document.
4214WARNING_SCANIdentification document is a facsimile.
4215WARNING_FRAUD_OTHERAny 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.

AttributeTypeDescription
redirectUrlstringThe 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.

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
{
   "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.

Gear icon

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:

  1. Request the download URL
  2. 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).

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
{
    "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.

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:

Warning icon

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

EndpointScope
/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