Skip to content

MIGRATION.md

Latest commit

 

History

History
143 lines (112 loc) · 5.47 KB

MIGRATION.md

File metadata and controls

143 lines (112 loc) · 5.47 KB

Migration Guide

This guide provides detailed instructions on how to upgrade between different major versions of the client library.

It covers changes in core resources, other endpoints, and the OpenAPI generator, ensuring a smooth transition between versions.

Upgrading from 6.x to 7.x

Core Resources

  • All API methods: All API method calls now use request builder pattern with .execute()

    • This change enables backward compatibility when new optional parameters are added

    • Example migration:

      // Before (v6.x)
List<WorkflowRun> runs = api.listWorkflowRuns(applicantId, status, page, perPage);

// After (v7.x)
List<WorkflowRun> runs = api.listWorkflowRuns()
    .applicantId(applicantId)
    .status(status)
    .page(page)
    .perPage(perPage)
    .execute();

  • Documents

    • Driving licence information properties removed from general DocumentProperties and moved to new DocumentPropertiesWithDrivingLicenceInformation class

  • Workflow Runs

    • createdAtGt and createdAtLt parameters in listWorkflowRuns changed from date-time format to date format (YYYY-MM-DD)

Other Endpoints

  • Reports

    • ReportShared object removed: The ReportShared object has been dropped. Convenience accessors for common fields (getName(), getStatus(), getId()) have been added to the parent Report object. Other properties are now accessed via specific report type accessors

      • Example migration:

        // Before (v6.x)
ReportName name = report.getReportShared().getName();
ReportStatus status = report.getReportShared().getStatus();
String checkId = report.getReportShared().getCheckId();
String result = report.getReportShared().getResult();

// After (v7.x)
ReportName name = report.getName(); // Convenience accessor on parent Report object
ReportStatus status = report.getStatus(); // Convenience accessor on parent Report object
String checkId = report.getDocumentReport().getCheckId(); // E.g. for document report
String result = report.getDocumentReport().getResult(); // E.g. for document report

    • Device Intelligence: Removed deprecated breakdown property and related breakdown classes:

      • DeviceIntelligenceBreakdownProperties removed
      • DeviceIntelligenceBreakdownPropertiesDevice → DeviceIntelligencePropertiesDevice
      • DeviceIntelligenceBreakdownPropertiesGeolocation → DeviceIntelligencePropertiesGeolocation
      • DeviceIntelligenceBreakdownPropertiesIp → DeviceIntelligencePropertiesIp

    • Identity Enhanced: Changed totalNumberOfSources and numberOfMatches from number to string type

Security

  • SSL certificate validation: Removed support for self-signed certificates unless explicitly configured via setSslCaCert()

OpenAPI generator

  • Version upgraded from 7.11.0 to 7.16.0

Upgrading from 5.x to 6.x

Core Resources

  • Workflow Runs
    • Add applicantId parameter to listWorkflowRuns method to filter workflow runs by applicant ID
  • Documents
    • Suppress DocumentFileTypeEnum, allowing any string as file type

Other Endpoints

  • Webhooks
    • Drop WORKFLOW_SIGNED_EVIDENCE_FILE_CREATED enum value from WebhookEventType enum
    • Allow readPayload function for webhook event verification to also throw JsonParseException exception.
    • Make href property in WebhookEventPayloadObject optional
  • Reports
    • Allow the deprecated records property in WatchlistAml and WatchlistStandard reports to be any object, and not just a string
    • Remove documents property (incl. getDocuments() accessors) from all reports except Document and Facial Similarity reports

OpenAPI generator

  • Version upgraded from 7.9.0 to 7.11.0
    • All properties got annotated with @javax.annotation.Nullable or @javax.annotation.Nonnull depending on their OpenAPI definition

Upgrading from 4.x to 5.x

Core Resources

  • Applicants
    • Replace ConsentsBuilder object with a list of ApplicantConsentBuilder ones
  • Workflow Runs
    • Rename WorkflowRunSharedLink object into WorkflowRunLink
    • Merge and rename WorkflowRun.StatusEnum and WorkflowRunResponse.StatusEnum enum into WorkflowRunStatus enum for storing status information
    • Rename WorkflowRunResponseError object into WorkflowRunError
  • Documents
    • Reuse already existent DocumentTypes enum when uploading documents

Other Endpoints

  • Webhooks
    • Define WebhookEventObjectStatus enum to collect webhook event object's status
    • Define WebhookEventResourceType enum to collect webhook event resource's type
    • Define WebhookEventPayloadResource object to store webhook payload's contents
  • Checks
    • Rename Check.StatusEnum enum into CheckStatus for accessing checks status
  • Reports
    • Remove deprecated properties from DeviceIntelligenceBreakdownPropertiesDevice object: trueOs, osAnomaly, rooted and remoteSoftware
    • Remove deprecated properties from DeviceIntelligenceBreakdownPropertiesIp object: vpnDetection, proxyDetection and type
    • Deprecate records object from WatchlistStandardProperties and WatchlistAmlProperties objects (includes WatchlistPepsOnly and WatchlistSanctionsOnly ones)

OpenAPI generator

  • Version upgraded from 7.6.0 to 7.9.0
    • Some dependencies were update, notably jakarta.* replaced javax.* ones
    • Use ISO8601Utils library instead of sdf for date and time parsing