Flows
Agreements
Capture and audit a trader's acceptance of your terms — trading agreements, risk disclosures, or payout policies — with an immutable signature trail.
Sign an agreement
POST
/v2/agreements/signUser session
Request body
agreement_version | string | required | Version the user accepted |
signature_name | string | required | Typed legal name |
document_url | string | optional | Link to the signed document |
document_sha256 | string | optional | Hash of the document bytes |
200 OK
{ "signed": true, "signed_at": "2026-06-22T18:04:11Z", "agreement_version": "2026-06-01" }Check status
GET
/v2/agreements/statusUser session
200 OK
{ "signed": true, "signed_at": "2026-06-22T18:04:11Z", "agreement_version": "2026-06-01" }GET
/v2/agreements/statusRuns live against your environment using the app's server-side credentials and your session. Sign in to the dashboard first for authenticated reads.
Audit history
Every signature is retained for compliance.
GET
/v2/agreements/auditsUser session
200 OK
[
{
"id": "agr_...",
"agreement_version": "2026-06-01",
"signature_name": "Ada Lovelace",
"signed_at": "2026-06-22T18:04:11Z",
"document_url": "https://yourapp.com/terms-2026-06-01.pdf"
}
]GET
/v2/agreements/auditsRuns live against your environment using the app's server-side credentials and your session. Sign in to the dashboard first for authenticated reads.
Gate trading on acceptance
Check
signed before allowing a user to fund or trade, and re-prompt whenever you publish a new agreement_version.