Accept Terms of Service

📘
Note
In order to perform any operations with the API, Terms of Service must be accepted by your end user. All endpoints in the API will throw a typed error if Terms of Service have not been accepted.

After creating an Organization, you can check the status of the Terms of Service acceptance.

Example request

curl --request GET \
     --url https://api.muralpay.com/api/organizations/807742f0-e76c-44cd-bbe9-30b02e0060f4 \
     --header 'accept: application/json' \
     --header 'authorization: Bearer $API-KEY'

Example response

{
    "type": "business",
    "name": "Sun Tree Capital Llc",
    "id": "807742f0-e76c-44cd-bbe9-30b02e0060f4",
    "createdAt": "2025-04-04T16:32:17.074Z",
    "updatedAt": "2025-04-04T16:36:00.592Z",
    "kycStatus": {
      "type": "pending"
    },
    "tosStatus": NOT_ACCEPTED,
    "currencyCapabilities": [
        {
            "fiatAndRailCode": "usd",
            "currencyCode": "USD",
            "depositStatus": {
                "type": "enabled"
            },
            "payOutStatus": {
                "type": "enabled"
            }
        },
        ...
    ]
}

{
    "type": "business",
    "name": "Sun Tree Capital Llc",
    "id": "807742f0-e76c-44cd-bbe9-30b02e0060f4",
    "createdAt": "2025-04-04T16:32:17.074Z",
    "updatedAt": "2025-04-04T16:36:00.592Z",
    "kycStatus": {
      "type": "pending"
    },
    "tosStatus": ACCEPTED,
    "currencyCapabilities": [
        {
            "fiatAndRailCode": "usd",
            "currencyCode": "USD",
            "depositStatus": {
                "type": "enabled"
            },
            "payOutStatus": {
                "type": "enabled"
            }
        },
        ...
    ]
}

To have your user accept the Terms of Service, use the getTosLink endpoint to retrieve a link which your users can use to accept the Terms of Service. Upon signing, the tosStatusfor their Organization will be ACCEPTED.

Organization Terms of Service Acceptance Statuses

NOT_ACCEPTED: The Terms of Service must be accepted by your user. You should prompt your user to accept the Terms of Service via the link retrieved from the getTosLink endpoint.
ACCEPTED: The Terms of Service have been accepted by your user
NEEDS_REVIEW: The Terms of Service have been updated and your user must re-accept the new terms.