Skip to main content

Retrieve terms-of-service state

GET 
/merchants/:merchant_id/tos

Returns the merchant's terms-of-service state. When the merchant must accept terms (e.g. before a crypto wallet can be provisioned), terms_of_service_url is the hosted page to redirect them to and required is true. When no terms step applies, required is false and the URL is null.

Request​

Path Parameters

    merchant_id uuidrequired

Query Parameters

    redirect_url uri

    Optional absolute http(s) URL; the hosted flow redirects the customer back to it when finished (KYC links via Persona redirect-uri; TOS via Bridge redirect_uri, which appends signed_agreement_id).

Responses​

Terms-of-service state

Schema

    status string

    Possible values: [success]

    data

    object

    terms_of_service_url urinullable

    Hosted page where the individual accepts the terms. Null when none applies.

    accepted boolean

    Whether the terms have already been accepted.

    required boolean

    Whether a terms-of-service step applies to this individual.

    code integer

    Possible values: [200]

    message string

    Possible values: [Successful request]

Loading...