[TRNF-8322] Docs(v2): Document entity onboardings and the type/data create shape - #130
Merged
Merged
Conversation
The public API now requires a `type` on entity onboarding creation (`account_holder` or `settlement_recipient`) and takes the company information, legal representatives, transactional profile and shareholders nested under `data` instead of at the top level. The README had no entity onboarding section at all, and the integration tests still built the old flat body and omitted `type` from the onboarding payload.
tlarrain
approved these changes
Aug 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The v2 API changed the entity onboarding create contract: it now requires a
type(
account_holderorsettlement_recipient) and takes the payload nested underdata, instead of the structures at the top level. The SDK still documented andtested the old flat shape, which the API now rejects.
create with
type+data, the three document uploads, and submit.onboardings.createintegration test to the current request shape,and asserts on
typeand the nesteddata.typeto the onboarding objetization test payload and assertions.No client code changed: the manager forwards keyword arguments to the API as-is, so
createalready supported the new shape.Requirements
None.
Additional changes
Test fixtures moved from the CL placeholders (
nationality: "CL", RUT-shapedholder_id) to valid MX values and the real enum values the API accepts, sinceentity onboardings are MX-only today.
Related
remaining schema delta.