Events

This page describes the event types produced by the Enrollment Server Onboarding.

List of event types:

• DOCUMENT_VERIFICATION_FINISHED
• FINAL_DOCUMENT_VERIFICATION_FINISHED
• PRESENCE_CHECK_FINISHED
• PROCESS_FINISHED

Structure

This is the generic part of the event, which is common to all event types.

{
    "id": "8f0d649e-a688-4ead-8581-fc2b67e88be4",
    "timestamp": "2026-04-23T14:30:00Z",
    "type": "PROCESS_FINISHED",
    "userId": "40405309-6406-4d6b-b4ef-642e52ac44f4",
    "externalUserId": "629199e8-aa0d-4fc0-911c-089d53e0f608",
    "processId": "8b2dfae4-d955-4d8f-a95b-2d9c5a4b0e26",
    "processType": "onboarding",
    "identityVerificationId": "d3827099-3b6c-4df9-887d-4eac402fc4f9",
    "eventData": {}
}

Event data for different event types

Different event types have different structures in eventData.

Event data for DOCUMENT_VERIFICATION_FINISHED

This contains the results from the verification provider. Each document is sent separately. A two-sided document (e.g. an ID card with front and back side) is sent as a single event. The event is represented by the side with the worst outcome (FAILED, then REJECTED, then ACCEPTED); the front side is used when both sides have the same outcome. documentVerificationResult.images contain images of both sides.

For example, an ID card where the front is ACCEPTED but the back is REJECTED produces a single REJECTED event. An ID card where both the front and back are ACCEPTED produces a single ACCEPTED event.

{
    "documentVerification": {
        "documentVerificationId": "String",
        "documentId": "String",
        "status": "String",
        "rejectReason": null,
        "errorDetail": null,
        "provider": "String",
        "score": Number,
        "documentVerificationResult": {
            "type": "String",
            "country": "String",
            "data": {
                "surname": "String",
                "givenNames": "String",
                "dateOfBirth": "String",
                "placeOfBirth": "String",
                "sex": "String",
                "nationality": "String",
                "personalNumber": "String",
                "documentNumber": "String",
                "dateOfIssue": "String",
                "dateOfExpiry": "String",
                "authority": "String"
            },
            "images": [
                {
                    "type": "String",
                    "data": "String"
                }
            ],
            "rawData": Object
        }       
    }
}

Reject Reason Format - Microblink

The value of the field rejectReason for the Microblink provider has the following format:

Rejected by provider [{code} {messages}, {code} {messages}...] # there can be more messages

Example response:

Rejected by provider [W002 The image quality was insufficient, please try again., I001 We've extracted and completed all feasible actions. If the result is inadequate, review the process indicators.]

All code and message values are described in the section Reject Reasons for Microblink

Event data for FINAL_DOCUMENT_VERIFICATION_FINISHED

This contains the overall document check result for all documents combined.

Bear in mind that even if the individual documents were verified by the verification provider, the overall document check result could still be negative due to the additional checks performed.

Additional checks:

• document type - checks whether the required document type matches the uploaded document type
• document crosscheck - the first name, surname and date of birth, in case the user has uploaded multiple documents

{
    "finalDocumentVerification": {
        "documentVerificationId": "String",
        "status": "String",
        "rejectReason": null,
        "errorDetail": null,
        "provider": "String",
        "documentIds": ["String","String"]
    }
}

The documentVerificationId is selected from the documents used for the verification using the same rules as for DOCUMENT_VERIFICATION_FINISHED. The document with the worst outcome (FAILED, then REJECTED, then ACCEPTED) is used, the front side wins a tie, and remaining ties are resolved by the document type order (ID_CARD, PASSPORT, DRIVING_LICENSE, then other types).

Reject Reason Format - Microblink

The value of the field rejectReason for the Microblink provider has one of the following formats:

Rejected by provider [{code} {messages}, {code} {messages}...]
or
Extracted document type {extractedType} does not match claimed type {claimedType}
or
Document data crosscheck failed for fields: [{field}, {field}...]

Example responses:

Rejected by provider [W002 The image quality was insufficient, please try again., I001 We've extracted and completed all feasible actions. If the result is inadequate, review the process indicators.]
or
Extracted document type DRIVING_LICENSE does not match claimed type ID_CARD
or
Document data crosscheck failed for fields: [firstName, lastName, dateOfBirth]

• All code and message values are described in the section Reject Reasons for Microblink
• All extractedType and claimedType values are based on currently supported document types ID_CARD, PASSPORT and DRIVING_LICENSE
• All field values are firstName, lastName and dateOfBirth

Event data for PRESENCE_CHECK_FINISHED

This contains the results of the verification provider.

{
    "presenceCheck": {
        "status": "ACCEPTED",
        "rejectReason": null,
        "errorDetail": null,
        "provider": "iProov",
        "score": Number,
        "presenceCheckResult": {
          "frame": "String"
        }
    }
}

Event data for PROCESS_FINISHED

This contains final process data.

{
    "process": {
        "status": "FINISHED",
        "errorDetail": null,
        "deviceData": {
            "locale": "EN",
            "ipAddress": null,
            "httpUserAgent": null,
            "fdsData": Object
        }
    }
}

Verification Providers Reject Reasons

Reject Reasons for Microblink

The table below shows all possible values for the code and message attributes in the rejectReason field.

Reject Reasons for iProov

The table below shows all possible values in the rejectReason field.