Skip to main content
POST
/
api
/
grid
/
v1
/
accounts
/
{address}
/
kyc
cURL
curl --request POST \
  --url https://grid.squads.xyz/api/grid/v1/accounts/{address}/kyc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "endorsements": [
    "<string>"
  ],
  "full_name": "<string>",
  "type": "<string>",
  "redirect_uri": "<string>"
}
'
import requests

url = "https://grid.squads.xyz/api/grid/v1/accounts/{address}/kyc"

payload = {
"email": "<string>",
"endorsements": ["<string>"],
"full_name": "<string>",
"type": "<string>",
"redirect_uri": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '<string>',
endorsements: ['<string>'],
full_name: '<string>',
type: '<string>',
redirect_uri: '<string>'
})
};

fetch('https://grid.squads.xyz/api/grid/v1/accounts/{address}/kyc', 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/grid/v1/accounts/{address}/kyc",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'endorsements' => [
'<string>'
],
'full_name' => '<string>',
'type' => '<string>',
'redirect_uri' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://grid.squads.xyz/api/grid/v1/accounts/{address}/kyc"

payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"endorsements\": [\n \"<string>\"\n ],\n \"full_name\": \"<string>\",\n \"type\": \"<string>\",\n \"redirect_uri\": \"<string>\"\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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/grid/v1/accounts/{address}/kyc")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"endorsements\": [\n \"<string>\"\n ],\n \"full_name\": \"<string>\",\n \"type\": \"<string>\",\n \"redirect_uri\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://grid.squads.xyz/api/grid/v1/accounts/{address}/kyc")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"endorsements\": [\n \"<string>\"\n ],\n \"full_name\": \"<string>\",\n \"type\": \"<string>\",\n \"redirect_uri\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "customer_id": "<string>",
    "email": "<string>",
    "full_name": "<string>",
    "id": "<string>",
    "kyc_link": "<string>",
    "kyc_status": "<string>",
    "persona_inquiry_type": "<string>",
    "tos_link": "<string>",
    "tos_status": "<string>",
    "type": "<string>",
    "rejection_reasons": "<unknown>"
  },
  "metadata": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Your Grid API key from the Grid Dashboard

Path Parameters

address
string
required

Smart account address (Solana public key)

Body

application/json
email
string
required
endorsements
string[]
required
full_name
string
required
type
string
required
redirect_uri
string | null

Response

KYC link created successfully

data
object
required
metadata
object
required