POST
/
accounts
/
{address}
/
kyc
Request KYC link
curl --request POST \
  --url https://grid.squads.xyz/api/grid/v1/accounts/{address}/kyc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-grid-environment: <api-key>' \
  --data '{
  "grid_user_id": "123e4567-e89b-12d3-a456-426614174003",
  "type": "individual",
  "email": "user@example.com",
  "full_name": "John Doe",
  "endorsements": [
    "ach"
  ],
  "redirect_uri": "https://myapp.com/kyc/success"
}'
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174020",
    "full_name": "John Doe",
    "email": "user@example.com",
    "type": "individual",
    "kyc_link": "https://kyc.provider.com/verify/123e4567",
    "tos_link": "https://kyc.provider.com/tos/123e4567",
    "kyc_status": "incomplete",
    "tos_status": "pending",
    "created_at": "2023-07-15T14:30:00.000Z",
    "customer_id": "bridge_customer_123",
    "persona_inquiry_type": "individual"
  },
  "metadata": {
    "request_id": "123e4567-e89b-12d3-a456-426614174021",
    "timestamp": "2023-07-15T14:30:00.000Z"
  }
}
KYC (Know Your Customer) verification establishes compliance status for your account. This is a direct operation that doesn’t require intents.

​
Verification Flow

​
Customer Types

Grid supports two types of customer verification:
Customer TypeVerification Requirements
Individual (KYC)• Personal identification
• Address verification
• Basic information collection
Business (KYB)• Business registration
• Beneficial ownership
• Business address verification

​
Important Notes

  • KYC verification is required for fiat payment rails
  • The verification link expires after 24 hours
  • Verification typically takes 1-3 business days
  • You can check status using the returned KYC ID

Authorizations

​
Authorization
string
header
required

API key authentication with Bearer token. Include the API key in the Authorization header as 'Bearer YOUR_API_KEY'

​
x-grid-environment
string
header
required

Environment identifier for the Grid API. Use 'sandbox' for testing on devnet or 'production' for production on mainnet.

Path Parameters

​
address
string
required

Account address

Example:

"11111111111111111111111111111112"

Body

application/json

Response

201
application/json

KYC link created successfully

The response is of type object.