Skip to main content
POST
/
api
/
compliance
/
v1
/
entities
/
{id}
/
tos
cURL
curl --request POST \
  --url https://grid.squads.xyz/api/compliance/v1/entities/{id}/tos \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-grid-environment: <x-grid-environment>' \
  --data '
{
  "acceptance_method": "<string>",
  "client_ip": "<string>",
  "client_user_agent": "<string>"
}
'
{
  "data": {
    "accepted": true,
    "accepted_at": "2023-11-07T05:31:56Z",
    "providers": [
      {
        "provider": "<string>",
        "signed_agreement_id": "<string>",
        "version": "<string>"
      }
    ]
  },
  "metadata": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Your Grid API key from the Grid Dashboard

Headers

x-grid-environment
string
required

Solana network environment (sandbox, devnet, mainnet)

Path Parameters

id
string<uuid>
required

Entity ID

Body

application/json
acceptance_method
string
required

How the user accepted: checkbox, click, link, or api

client_ip
string
required

End user's IP address (captured by your frontend)

client_user_agent
string | null

End user's browser user agent

Response

TOS accepted successfully

data
object
required
metadata
object
required