Skip to content

Add Travel Rule documentation#248

Open
Prado wants to merge 1 commit intomasterfrom
feature/add-travel-rule
Open

Add Travel Rule documentation#248
Prado wants to merge 1 commit intomasterfrom
feature/add-travel-rule

Conversation

@Prado
Copy link
Copy Markdown

@Prado Prado commented Apr 15, 2026

@Prado Prado self-assigned this Apr 15, 2026
Copilot AI review requested due to automatic review settings April 15, 2026 09:54
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds documentation for the Travel Rule API so integrators can retrieve pending request details and submit the required information to proceed with withdrawals.

Changes:

  • Added a new Travel Rule documentation page with endpoint descriptions.
  • Included example curl requests and example JSON response including formSchema.
  • Documented request/response expectations and basic authorization/ownership notes.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread _travelrule.md
Comment on lines +56 to +61
<aside class="notice">
Requires a valid user authentication token.
</aside>
<aside class="notice">
The <code>:requestForInformationId</code> must be owned by the authenticated user. A <a href="#errors">404 HTTP error</a> is returned otherwise.
</aside>
Copy link

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both notices mention authentication/authorization but the docs don’t specify the expected error codes for common failure modes (e.g., missing/invalid token likely 401, valid token but not owner likely 404 as stated). Consider explicitly documenting the expected status codes per case to reduce integration ambiguity (and keep it consistent between GET and POST sections).

Copilot uses AI. Check for mistakes.
Comment thread _travelrule.md
-X POST \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{ "beneficiaryAccountNumber": "0x1234abcd", "beneficiaryAddress": "123 Main St", "beneficiaryCountry": "US", "beneficiaryName": "Jane Doe" }'
Copy link

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The POST example uses a beneficiaryAccountNumber value that looks like a crypto address (0x...), which may confuse integrators if the field is meant to be an account number distinct from an address (especially since there is also beneficiaryAddress). Consider adjusting the example values to clearly differentiate these fields (e.g., a numeric/IBAN-style account number vs. a postal address), or rename/clarify the field meaning in the schema description if beneficiaryAccountNumber can indeed be an on-chain address.

Suggested change
-d '{ "beneficiaryAccountNumber": "0x1234abcd", "beneficiaryAddress": "123 Main St", "beneficiaryCountry": "US", "beneficiaryName": "Jane Doe" }'
-d '{ "beneficiaryAccountNumber": "ACC-123456789", "beneficiaryAddress": "123 Main St", "beneficiaryCountry": "US", "beneficiaryName": "Jane Doe" }'

Copilot uses AI. Check for mistakes.
Comment thread _travelrule.md
------------- | -----------
amount | The transaction amount that triggered the travel rule requirement.
currency | The currency of the transaction.
formSchema | A JSON Schema object describing the fields the user must provide via the [Submit Travel Rule Information](#submit-travel-rule-information) endpoint.
Copy link

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It’s unclear which JSON Schema dialect/version formSchema follows (draft-04/draft-07/2019-09, etc.). Since validators and tooling differ by draft, consider stating the schema version used (e.g., via $schema or in prose) or explicitly noting that the returned schema is compatible with a specific draft.

Copilot uses AI. Check for mistakes.
@Prado Prado force-pushed the feature/add-travel-rule branch 2 times, most recently from a061307 to b696cc8 Compare April 15, 2026 10:47
@Prado Prado force-pushed the feature/add-travel-rule branch from b696cc8 to 0589c9e Compare April 17, 2026 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants