Skip to main content
POST
/
api
/
compliance
/
v1
/
entities
/
{id}
/
distribute
cURL
curl --request POST \
  --url https://grid.squads.xyz/api/compliance/v1/entities/{id}/distribute \
  --header 'Authorization: Bearer <token>' \
  --header 'x-grid-environment: <x-grid-environment>'
import requests

url = "https://grid.squads.xyz/api/compliance/v1/entities/{id}/distribute"

headers = {
"x-grid-environment": "<x-grid-environment>",
"Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-grid-environment': '<x-grid-environment>', Authorization: 'Bearer <token>'}
};

fetch('https://grid.squads.xyz/api/compliance/v1/entities/{id}/distribute', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://grid.squads.xyz/api/compliance/v1/entities/{id}/distribute",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"x-grid-environment: <x-grid-environment>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://grid.squads.xyz/api/compliance/v1/entities/{id}/distribute"

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("x-grid-environment", "<x-grid-environment>")
req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://grid.squads.xyz/api/compliance/v1/entities/{id}/distribute")
.header("x-grid-environment", "<x-grid-environment>")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://grid.squads.xyz/api/compliance/v1/entities/{id}/distribute")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-grid-environment"] = '<x-grid-environment>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "data": {
    "applicant_id": "<string>",
    "distributed_to": [
      {
        "id": "<string>",
        "provider": "<string>",
        "provider_id": "<string>",
        "provider_submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "requires_tos": true,
        "external_url": "<string>"
      }
    ],
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "failures": [
      {
        "error": "<string>",
        "error_type": "<string>",
        "failure_stage": "<string>",
        "provider": "<string>",
        "provider_error_fields": [
          "<string>"
        ],
        "provider_submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "failure_class": "<string>",
        "field_lineage": [
          {
            "field_key": "<string>",
            "rejection_reasons": [
              "<string>"
            ],
            "source_paths_tried": [
              "<string>"
            ],
            "selected_path": "<string>",
            "suggested_fix": "<string>"
          }
        ],
        "provider_error_code": "<string>",
        "rfi_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "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

Query Parameters

provider
string

Optional provider override (distribute only to this provider)

Response

Distribution attempt completed

data
object
required
metadata
object
required