Skip to main content

Data blocks

Unit of information produced and consumed by flow steps

As described Core Concept, a data block is a unit of information that is produced and consumed by flow steps. Each data block has a specific type, and each type defines a unique set of attributes.

The system ensures consistent data flow by:

  • Identifying which data blocks are available at each step
  • Verifying that all required input data blocks are present
  • Confirming that all data dependencies are satisfied before executing a step

The following section provides a comprehensive summary of all available data blocks, including the attributes associated with each type.


AuthenticationResult

The AuthenticationResult data block contains the result of a biometric authentication process and uses a discriminated union based on the result field to represent either a successful or failed authentication.

Attributes

AttributeDescriptionMandatory
resultDiscriminator that determines the result type ("success" or "failure").Yes
providerAuthentication service provider.Yes
credentialIdUnique identifier of the credential used (or attempted).Yes
credentialTypeType of credential (e.g., "FACE", "FINGERPRINT", "FIDO_KEY").Yes
subjectIdIdentifier of the authenticated (or attempted) subject.Yes
requestIdUnique identifier of the authentication request.Yes
authenticatedAtISO 8601 timestamp of successful authentication (success variant).Yes (success)
attemptedAtISO 8601 timestamp of the authentication attempt (failure variant).Yes (failure)
reasonError information object (failure variant only).Yes (failure)
reason.codeDefined by the third‑party Web SDK for the "error" event. Full list: Error Explanations.Yes
reason.detailsIDnow concatenates the error code with the reason before returning it. The result contains the code and a reason prefixed with the same code (e.g., SERVER_USER_NOT_FOUND - <detailed message>).Optional

AuthenticatorCredential

The AuthenticatorCredential data block represents a concrete authentication credential that has been issued, enrolled or created and is associated with a subject.

Attributes

AttributeDescriptionMandatory
credentialIdUnique identifier returned by the provider.Yes
credentialTypeTechnology / modality (e.g. FACE, FINGERPRINT, FIDO_KEY, PASSWORD).Yes
subjectIdInternal immutable identifier of the entity (links the credential to a subject).Yes
providerSystem that manages the credential (e.g. KEYLESS, PLATFORM, CUSTOM, INTERNAL_CA).Yes
statusLifecycle status of the credential (e.g. active, revoked, suspended, expired).Yes
createdAtISO 8601 timestamp of initial creation.Yes
updatedAtISO 8601 timestamp of last modification (equals createdAt if never updated).Yes

BasicIdentity

The BasicIdentity data block contains fundamental identity information extracted from documents.

Attributes

AttributeDescriptionMandatory
familyNameFamily name.Yes
nameName.No
givenNameGiven name.Yes
birthDateBirth date.No
birthPlaceBirth place.No

BiometricSamples

The BiometricSamples data block contains references to biometric data captured from the end-user and is used as input or output of biometric processes. Biometric artifacts (e.g., face image/selfie) are referenced via the Vault.

Attributes

AttributeDescriptionMandatory
faceVault reference to the captured face image (selfie).Yes
face.$refReference namespace. Currently: vault.Mandatory (if face is present)
face.$idVault object identifier (UUID) for the face image.Mandatory (if face is present)
consentWhether the user has given consent for biometric data processing.Optional

Example

{
"datablockId": "b5e60a3b-b553-4160-ae8d-baa42a595eaa",
"type": "biometricSamples",
"createdByStep": "DOC_ID",
"createdAt": "2026-02-10T14:00:01.899Z",
"face": {
"$ref": "vault",
"$id": "5e8de376-caa3-40a8-a998-8627a7d4d009"
}
}

ComparisonResults

The ComparisonResults data block contains the output of a comparison between two sets of data, including verdict and attribute-level details.

Attributes

AttributeDescriptionMandatory
verdictOverall result of the comparison (match / noMatch / inconclusive).Yes
leftOperandId of the step whose data was used as left operand.Yes
rightOperandId of the step whose data was used as right operand.Yes
attributesComparedList of attributes that were checked.Yes
mismatchedAttributesList of attributes that failed to match (empty if verdict is match or inconclusive).Yes
missingAttributesList of attributes that could not be compared because data was missing.Yes

DeviceInfo

The DeviceInfo data block captures basic information about the end-user's device, browser, and network environment.

Attributes

AttributeDescriptionMandatory
browserNameBrowser name.Optional
browserVersionBrowser version.Optional
osNameOperating system name.Optional
osVersionOperating system version.Optional
deviceTypeDevice type.Optional
timezoneTimezone information object.Optional
timezone.timezoneIANA timezone name (e.g. "Europe/Berlin").Optional
timezone.timezoneOffsetTimezone offset from UTC in minutes.Optional
timezone.languagePreferred language of the user (e.g. "en-US").Optional
timezone.languagesArray of accepted languages.Optional
ipAddressClient's IP address.Optional

DeviceSignals

The DeviceSignals data block encapsulates information about the end-user's device, browser, and network environment for risk assessment and fraud detection.

Attributes

AttributeDescriptionMandatory
userReferenceIdentifier to link the assessment to a specific user or session.Optional
providerService that performed the assessment.Yes
timestampISO 8601 timestamp of when the assessment was completed.Yes
resultTrust assessment result (trusted, suspicious, not_trusted, inconclusive).Yes
browser.userAgentFull user-agent string reported by the browser.Yes
browser.incognitoWhether the browser is in incognito/private mode.Optional
browser.nameBrowser name.Yes
browser.versionBrowser version.Yes
browser.osOperating system.Yes
browser.deviceTypeDevice type.Yes
network.ipClient's IP address.Yes
network.locationGeolocation object with country, city, latitude, longitude.Yes
network.timezoneTimezone identifier.Optional
signalsJSON object containing the complete, raw, unaltered response from the external provider. More info: API reference.Yes

DigitalSignals

The DigitalSignals data block is the structured output generated by the DIGITAL_SIGNALS:v1 step and acts as a detailed receipt of the trust assessment based on email, phone and IP.

Attributes

AttributeDescriptionMandatory
providerService that performed the assessment.Yes
timestampISO 8601 timestamp of when the assessment was completed.Yes
servicesList of services/signals analyzed (e.g. ["ip", "emails", "phone", "name"]).Yes
inputSources.basicIdentityStep ID that provided core identity data (e.g. name).Optional
inputSources.extendedIdentityStep ID that provided additional identity data (e.g. phone, email).Optional
inputSources.deviceSignalsStep ID that provided device signal data (e.g. IP address).Optional
resultTrust assessment result (trusted, suspicious, not_trusted, inconclusive).Yes
scoreNumerical trust score (0–100) computed by IDnow. See also: Trustfull Digital Score.Yes
reasonsArray of reason objects, each containing code and details.Yes
reasons[].codeMachine‑readable reason code defined by the third‑party provider. Full list: Reason Codes.Yes
reasons[].detailsHuman‑readable explanation for the reason code, defined by the third‑party provider. Full list: Reason Codes.Yes
signalsMandatory JSON object containing the complete, raw, unaltered response from the Trustfull Onboarding API.Yes

DocumentData

The DocumentData data block contains information about processed documents.

Attributes

AttributeDescriptionMandatory
documentTypeDocument type.Yes
documentNumberDocument number.Optional
expiryDateExpiry date of the document.Optional
issuanceDateIssuance date of the document.Optional
issuingAuthorityIssuing authority.Optional
issuingCountryIssuing country.Optional

DocumentImages

The DocumentImages data block contains references to document image files stored in the Vault. Each side (front/back) is represented as a Vault reference object.

Attributes

AttributeDescriptionMandatory
documentTypeDocument category for the images (e.g., ID).Optional
frontSideVault reference to the front side image.Yes
frontSide.$refReference namespace. Currently: vault.Mandatory (if frontSide is present)
frontSide.$idVault object identifier (UUID) for the front side image.Mandatory (if frontSide is present)
backSideVault reference to the back side image.Optional
backSide.$refReference namespace. Currently: vault.Mandatory (if backSide is present)
backSide.$idVault object identifier (UUID) for the back side image.Mandatory (if backSide is present)

Example

{
"createdAt": "2026-02-10T14:00:01.899Z",
"documentType": "ID",
"frontSide": {
"$ref": "vault",
"$id": "4d293362-9738-4a37-8d74-eb3acbc35749"
},
"backSide": {
"$ref": "vault",
"$id": "fd9bbe6e-61f8-41d3-9a18-efa4bd997bb4"
}
}

DocumentsToSign

The DocumentsToSign data block references the documents uploaded by the customer that the end-user needs to sign, and the corresponding template ID.

Each document source is referenced via the Vault as an external reference object ({ $ref: "vault", $id: "<uuid>" }).

Attributes

AttributeDescriptionMandatory
documentsArray of document objects to be included in the signing process (must contain at least one).Yes
documents.templateIdIdentifier linking the runtime document to a document template / definition.Yes
documents.sourceVault reference to the source PDF to be signed ({ $ref: "vault", $id: "<uuid>" }).Yes

DocumentVerification

The DocumentVerification data block contains the results of document verification processes. The overall result is provided in verdict, detailed findings may be listed in issues, and the full verification report can be referenced via the Vault.

Attributes

AttributeDescriptionMandatory
verdictOverall verification verdict object (see verdict.status).Yes
verdict.statusVerdict status (e.g., VERIFIED).Yes
issuesArray of issues returned by the verification (can be empty).Optional
reportVault reference to the verification report artifact.Optional
report.$refReference namespace. Currently: vault.Mandatory (if report is present)
report.$idVault object identifier (UUID) for the report.Mandatory (if report is present)

Example

{
"datablockId": "6688a3d7-f1f7-42bf-bc11-4712395b41b6",
"type": "documentVerification",
"createdByStep": "DOC_ID",
"createdAt": "2026-02-10T14:00:01.633Z",
"verdict": {
"status": "VERIFIED"
},
"issues": [],
"report": {
"$ref": "vault",
"$id": "d16dc58a-a939-4e15-afea-28efb9f87f3f"
}
}

ExtendedIdentity

The ExtendedIdentity data block contains additional identity information beyond basic fields. Image artifacts (e.g., portrait) are referenced via the Vault.

Attributes

AttributeDescriptionMandatory
portraitVault reference to the portrait image for EUDI requirement.Optional
portrait.$refReference namespace. Currently: vault.Mandatory (if portrait is present)
portrait.$idVault object identifier (UUID) for the portrait image.Mandatory (if portrait is present)
nationalityNationality information.Optional
personalAdministrativeNumberPersonal administrative number.Optional
residentAddressThe full address of the place (string).Optional
residentStreetStreet of residence.Optional
residentHouseNumberHouse number of residence.Optional
residentCountryAlpha-2 country code as specified in ISO 3166-1.Optional
residentStateState or province of residence.Optional
residentCityCity of residence.Optional
residentPostalCodePostal code of residence.Optional
familyNameBirthFamily name at birth.Optional
givenNameBirthGiven name at birth.Optional
sexSex (ISO 5218 sex codes: 0/1/2/9; renamed from gender).Optional
emailAddressEmail address.Optional
mobilePhoneNumberMobile phone number (E.164 format: +[country code][number]).Optional

Example

{
"datablockId": "a93e5fb3-8053-49bc-9071-44a0d297fb6f",
"type": "extendedIdentity",
"createdByStep": "DOC_ID",
"createdAt": "2026-02-10T14:00:01.917Z",
"portrait": {
"$ref": "vault",
"$id": "020ff369-43d8-4b8a-94e7-6814c0bdc35a"
},
"nationality": "FRA",
"sex": 1,
"residentAddress": "24 RUE DANTON 35700 RENNES FRANCE"
}

OutcomeStatus

The OutcomeStatus data block carries the final outcome of a flow execution as determined by the End node.

Attributes

AttributeDescriptionMandatory
statusOutcome status (accepted or rejected).Yes

PepAndSanctionsResults

The PepAndSanctionsResults data block contains the results of a PEP (Politically Exposed Person) and sanctions screening check.

Attributes

AttributeDescriptionMandatory
isPEPWhether the subject is a Politically Exposed Person.Yes
isSanctionedWhether the subject appears on a sanctions list.Yes

PresentationResult

The PresentationResult data block encapsulates the complete outcome of an EUDI Wallet credential presentation session, including metadata, presented credentials and error information in case of failure.

Attributes (common)

AttributeDescriptionMandatory
sessionIdUnique identifier for the presentation session.Yes
resultDiscriminator ("success" or "failure").Yes

Attributes (success variant)

AttributeDescriptionMandatory
presentedAtISO 8601 timestamp of the presentation by the user.Yes
presentedCredentialsList of credentials presented by the user.Yes
presentedCredentials.typeType of the presented credential.Yes
presentedCredentials.issuerIdentifier of the credential issuer.Yes
presentedCredentials.presentedClaims.claimNameName of the claim shared by the user.Yes
presentedCredentials.presentedClaims.claimValueValue of the claim shared by the user.Yes

Attributes (failure variant)

AttributeDescriptionMandatory
attemptedAtISO 8601 timestamp of the presentation attempt.Yes
reasonError information object.Yes
reason.codeDefined by the third‑party Web SDK. Contact your Account Manager for more information.Yes
reason.detailsIDnow concatenates the error code with the reason before returning it as part of the data block. Contact your Account Manager for more information.Optional

SignedDocumentsPackage

The SignedDocumentsPackage data block is the successful output of the ELECTRONIC_SIGNATURE:v1 step and contains information about the signature process and signed documents.

Attributes

AttributeDescriptionMandatory
signatureProcessIdIdentifier of the signature process (transaction number).Yes
signedDocuments.modeDelivery mode: "archive", "items", or "both".Yes
signedDocuments.archiveVault reference to the ZIP archive containing signed documents (depending on mode).Optional
signedDocuments.documentsArray of signed document objects (depending on mode).Optional
signedDocuments.documents.templateIdIdentifier for the template used for the electronic signature.Yes (per document, when present)
signedDocuments.documents.signedVault reference to the signed PDF file.Yes (per document, when present)
createdAtISO 8601 timestamp of initial creation.Yes

UserReference

The UserReference data block carries a reference to a user and contains the subject identifier provided by the customer.

Attributes

AttributeDescriptionMandatory
subjectIdIdentifier of the subject provided by the customer (identifier generated by the Trust Platform is provided with the AuthenticatorCredential).Yes