Skip to content

Data Objects

This document describes the data structures and validation rules for objects used in the Lean Disposable API.


DisposableHolder

Represents the certificate holder's personal information.

The identificationCode, identificationType, and identificationCountry compose the serial number in the certificate.

FieldDescriptionRequiredValidation Rules
firstNameFirst name of the holder (UTF-8, max 64 characters)YesSee allowed characters rules
lastNameLast name of the holder (UTF-8, max 64 characters)YesSee allowed characters rules
identificationTypeType of identification documentYesSee DisposableHolderIdentificationType
identificationCodeUnique code of the identification documentYesSee allowed characters rules
identificationCountryCountry where identification was issuedYesISO 3166-1 alpha-2
birthDateDate of birthNoISO 8601 yyyy-MM-dd (e.g. 1980-01-01). Other formats are not accepted.
birthCityCity of birthNoSee allowed characters rules
citizenShipCitizenship countryNoISO 3166-1 alpha-2

DisposableContacts

Contact information for OTP delivery.

FieldDescriptionRequiredValidation Rules
emailEmail address of the holderYes, if otpType=EMAILValid email format
mobileMobile phone numberYes, if otpType=SMS or otpType=WHATSAPPE.164 format with + prefix (e.g. +390000000000)

DisposableDoc

Identity document information.

The entire object is not required:

The documentNr, documentType, and documentIssuerCountry identify the type of document that the user shows at the time of recognition.

FieldDescriptionRequiredValidation Rules
documentTypeIdentity document typeYesSee values below
documentNrDocument numberYes
documentIssuerEntity that issued the documentNo
documentIssuerDateDate on which the document was issuedYesYYYY-MM-DD
documentExpirationDateDate on which the document expiresYesYYYY-MM-DD
documentIssuerCountryCountry where document was issuedYesISO 3166-1 alpha-2

documentType values

ValueDescription
CINational identity card
PASSPassport
PADriving license
RPResidence permit
CIENational Electronic Identity Card
RTTemporary residence permit
DCDocuments for embassy/consulate personnel
ATOther

DisposableCertificate

Certificate configuration and credentials.

FieldDescriptionRequiredValidation Rules
passwordCertificate PINYes8–32 characters, [A-Za-z0-9]
securityCodeCertificate security codeYes8–32 characters, [A-Za-z0-9]
typeDisposable certificate typeYesSee DisposableType
otpTypeOTP delivery methodNoSee DisposableOtpType. Default: SMS
fullDataEnroll with full profileNoBoolean. Default: false
withoutUsageLimitLRAOmit LRA limitation of use (LoU)NoBoolean. Default: false
transactionLimitTransaction value limits for which the certificate can be usedNoSee transactionLimit object
limitationOfUseLanguage of the LoU textNolanguage: ISO 639-1 alpha-2. If not specified, the default text is used.

In some enroll methods the type value may be overridden by the method itself.

transactionLimit object

FieldDescriptionRequired
valueTransaction limit amountYes
currencyCurrency codeYes

DisposableIdentification

Identification method.

FieldDescriptionRequiredValidation Rules
identificationTypeIdentification method typeYesSee DisposableIdentificationType

DisposableAddress

Address information for the certificate holder.

FieldDescriptionRequired
countryCountryYes
provinceProvinceYes
cityCityYes
ccatCadastral codeNo
streetStreet addressYes
zipZip/Postal codeYes

DisposableeIDAssertionHolder

eID assertion information for eID-based enrollment.

FieldDescriptionRequiredValidation Rules
countryCountry of eIDYesISO 3166-1 alpha-2
eIDTypeType of eIDYesSee authorized eID types
assertionAssertion stringYesBase64 encoded

DisposableIssued

Response object returned by enrollment methods.

FieldDescription
certThe issued certificate
certIdOtpOTP identifier associated with the certificate
certTypeType of certificate issued. See DisposableType
certSerialNumberSerial number of the issued certificate
certUsageLimitLimitation of use (LoU) in the certificate
deviceCodeDevice code of the issued certificate