6.4.0

Release 6.4.0 - Add verification attempt-assets endpoints and card scheduled_activation_date (#382)

⚠️ Breaking changes (see at the bottom)

This release introduces several enhancements and structural improvements to the identity verification and face authentication modules. The main updates include adding support for pagination when listing verification attempts, introducing new fields and types for richer applicant data, and enabling retrieval of document/image assets for verification attempts. The changes also improve type annotations and documentation for better clarity and extensibility.

Pagination and Asset Retrieval Enhancements:

• Added support for optional pagination (skip and limit) when listing verification attempts in the get...Attempts methods for identity, ID document, address document, and face authentication clients, using the new AttemptsQueryFilter class. These methods now use the new query method in ApiClient to handle query parameters. [1] [2] [3] [4] [5] [6]
• Introduced new API methods to retrieve uploaded document/image assets for specific verification attempts in the ID document and address document verification clients, supporting optional pagination. [1] [2]

Applicant Data Model Improvements:

• Added new entity classes: PhoneNumber, IdvAddress, IdentityDeclaredData, and IdentityVerificationClientInformation to capture richer applicant details, including phone, email, address, document issuing country, and document type. [1] [2] [3] [4]
• Updated request objects for verification attempts to support the new applicant data fields and types, and improved property annotations for clarity and validation. [1] [2] [3]

Type and Documentation Improvements:

• Improved type annotations and documentation for fields in ClientInformation, DeclaredData, and related request/response objects, specifying formats, examples, and optionality for better developer experience and validation. [1] [2]

Dependency and Import Updates:

• Added necessary imports for new classes in client and request files to support the new features and types. [1] [2] [3] [4]

These updates make the API more flexible, extensible, and user-friendly, especially for clients needing to paginate results or capture additional applicant information.

⚠️ Breaking changes

Kind	Change
removed	$activation_date -> $scheduled_activation_date on CardRequest and UpdateCardRequest

Note: nothing else is breaking. The new getXAttempts($id, ?AttemptsQueryFilter $query = null) and updateCardDetails($cardId, $request, ?CardUpdateHeaders $headers = null) parameters default to null, and ApiClient::query() was widened to accept a nullable filter. Properties are untyped, so the IdentityDeclaredData and IdentityVerificationClientInformation subclasses are a docblock change only.