Get the customer's terms-of-service acceptance status.

Returns the terms of service the customer must accept before payouts execute, with the hosted link and the current acceptance state.

Partner-facing projection of the internal sender TOS status: the link, status, version
and timestamps only. The provider code, sender and agreement ids, session token and the
raw upstream payload are not exposed.

404 when no terms step applies to this customer — either no sender is registered yet, or
the corridor has no terms gate. That is a normal state, not an error to retry.

Prerequisites: none, but a 404 is expected (not an error) until the customer has a sender registered with the relevant provider.

Important: orders will be rejected until isAccepted is true for corridors that gate on terms. Check this before submitting an order for a new customer/corridor combination.

Related: enable the currency section that triggers a terms requirement via POST or PUT onboarding/currencies.

📤 Response Fields

200 response:

Field	Type	Nullable	Description
`data`	object	No	The terms of service the customer must accept before payouts can be executed, and where they stand with them. External projection of the aggregator's TosStatusResult. Only the fields a partner acts on are carried across: the provider code, sender id, agreement id, session token, sender name and email, the raw provider response and the provider's error text all stay internal. The raw response in particular is the provider's own payload — returning it would disclose which provider serves the customer and would break the moment that routing changed.
`data.tosLink`	string	Yes	The hosted link the customer opens to read and accept the terms. Present while acceptance is outstanding; may be null once the terms are accepted or the link expired. Show it to the customer — it is not for server-to-server use.
`data.status`	string	Yes	Acceptance status as reported upstream, e.g. "pending" or "accepted".
`data.isAccepted`	boolean	Yes	True once the customer has accepted. The authoritative flag to branch on.
`data.isExpired`	boolean	Yes	True when the link has lapsed and a fresh one must be requested.
`data.tosVersion`	string	Yes	Version of the terms the link refers to.
`data.acceptedAt`	string (date-time)	Yes	When the customer accepted, if they have.
`data.generatedAt`	string (date-time)	Yes	When the current link was issued.
`data.expiresAt`	string (date-time)	Yes	When the current link lapses.
`requestId`	string	Yes	—
`timestamp`	string (date-time)	No	—

curl --location '/api/external/v1/onboarding/terms?customerId=c1f4a9d2-6b3e-4a7c-9f1d-2e8b5c0a7d31' \ --header 'X-API-Key: ak_live_8f3a9b2c7e1d4f6a9b0c2d5e8f1a3b6c' \ --header 'X-Signature: kZ3fQeT2m7xVvC9pR1sLdY8bN0hU4jK6oW5aE2gI7cQ=' \ --header 'X-Timestamp: 1758556800' \ --header 'X-Nonce: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \ --header 'X-Body-Hash: 47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU='

{ "data": { "tosLink": "https://terms.provider.example.com/session/8f3a2c7e1b9d4f6a", "status": "pending", "isAccepted": false, "isExpired": false, "tosVersion": "2026-01", "acceptedAt": null, "generatedAt": "2026-09-20T09:12:00Z", "expiresAt": "2026-09-27T09:12:00Z" }, "requestId": "req_4f9a2c7e1b8d3f6a9c2e0b7d1f8a3c6e", "timestamp": "2026-09-22T14:03:11Z" }

Get the customer's terms-of-service acceptance status.

📤 Response Fields

Request

Responses

Get the customer's terms-of-service acceptance status.

📤 Response Fields#

Request

Responses

📤 Response Fields