Skip to main content
POST
/
api
/
compliance
/
v1
/
entities
cURL
curl --request POST \
  --url https://grid.squads.xyz/api/compliance/v1/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-grid-environment: <x-grid-environment>' \
  --data '
{
  "name": "<string>",
  "type": "individual",
  "email": "<string>",
  "external_id": "<string>"
}
'
{
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "type": "individual",
    "updated_at": "2023-11-07T05:31:56Z",
    "compliance_status": "<unknown>",
    "compliance_submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "external_id": "<string>",
    "providers": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "provider": "<string>",
        "status": "not_started",
        "tos_accepted": true,
        "tos_outdated": true,
        "tos_required": true,
        "updated_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "status_code": "<string>",
        "status_message": "<string>",
        "submitted_at": "2023-11-07T05:31:56Z",
        "tos_accepted_at": "2023-11-07T05:31:56Z",
        "tos_version": "<string>",
        "tos_version_current": "<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)

Query Parameters

include
string

Comma-separated list of related resources to include (e.g. providers)

Body

application/json
name
string
required

Entity name (max 255 characters)

type
enum<string>
required

Entity type: individual or business

Available options:
individual,
business
email
string | null

Contact email address

external_id
string | null

Your external identifier for this entity

Response

Entity created successfully

data
object
required
metadata
object
required