Models

IdentityDocument

Identity document (e.g. ID card, passport) required by the EFL API.

Namespace and purpose

Imoli\EflLeasingSdk\Model\Customer\IdentityDocument models an identity document for a person, such as an ID card or passport. It is nested inside Person in customer data.

Class definition

Namespace: Imoli\EflLeasingSdk\Model\Customer
Class: final IdentityDocument

final class IdentityDocument
{
    public static function builder(): IdentityDocumentBuilder;

    public function __construct(
        string $guid,
        string $number,
        string $issuer,
        string $issuedOn,
        string $typeId,
        ?string $validTo = null
    );

    public function toRequestPayload(): array;
}

Properties

Name	Type	Required	Description
`guid`	`string`	Yes	Identifier of the identity document.
`number`	`string`	Yes	Document number.
`issuer`	`string`	Yes	Issuing authority.
`issuedOn`	`string`	Yes	Issue date.
`typeId`	`string`	Yes	Document type identifier (e.g. ID card, passport).
`validTo`	`string\|null`	No	Optional expiry date.

Methods

Method	Kind	Return type	Description
`builder()`	static	`IdentityDocumentBuilder`	Returns a fluent builder for constructing `IdentityDocument` instances.
`toRequestPayload()`	instance	`array<string,mixed>`	Serialises the document into the structure expected by the API.

toRequestPayload() returns an array with the following shape:

guid, number, issuer, issuedOn – maps to the respective properties,
type – nested object with ['id' => typeId],
validTo – included only if not null.

Usage in the SDK

Included in the identityDocuments array of Person.
Indirectly used when preparing data for EflClient::submitCustomerData.

CustomerDataStatement

Represents a single customer statement or consent associated with company or person data.

ContactData

Payload for /Lead/SendContactForm containing prospect data and lead statements.