Skip to content

5.6.0

Choose a tag to compare

View all tags
@github-actions github-actions released this 06 Oct 14:18
5.6.0
da5bd0d
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Release 5.6.0 (#469)

This release significantly improves the documentation and test coverage for the Platforms API integration, with a special focus on onboarding sub-entities and uploading identity documents. The changes clarify how to use the API, especially regarding the handling of representative documents, and enhance tests to ensure correct behavior for file uploads and document submission.

Documentation improvements:

  • Expanded and clarified JSDoc comments for PlatformFiles and Subentity classes, detailing required fields, API endpoints, and the handling of representative and top-level documents, including strictness and validation differences. [1] [2] [3] [4] [5] [6]

Test coverage enhancements:

  • Added comprehensive tests for representative documents (including identity verification, proof of address, proof of registration, and certified authorised signatory) in onboarding and updating sub-entities, ensuring the SDK sends the correct structure to the API unchanged.
  • Added a test to verify that the correct purpose values are sent in multipart file uploads for representative documents.

Consistency and correctness:

  • Updated test cases to use the correct purpose value (identity_verification instead of identification) for file uploads, aligning with API requirements. [1] [2] [3]

These changes ensure developers have clear guidance on how to use the API and confidence that the SDK handles documents and file uploads as required by the platform.

Assets 2
Loading