Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

API Key for authentication

Headers

X-Grid-Environment
string
required

The environment you’re using. Can be sandbox or production.

Path Parameters

smart_account_address
string
required

The address of the smart account to request KYC link for

Body

application/json
email
string
required
Example:

"john.doe@example.com"

endorsements
string[]
required
Example:

"[\"ach\", \"sepa\"]"

full_name
string
required
Example:

"John Doe"

grid_user_id
string<uuid>
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

type
enum<string>
required
Available options:
individual,
business
redirect_uri
string | null
Example:

"https://example.com/redirect"

Response

Successfully requested KYC link

created_at
string<date-time>
required
Example:

"2025-04-01T16:51:23.773Z"

customer_id
string
required
email
string
required
full_name
string
required
id
string
required
kyc_status
enum<string>
required
Available options:
not_started,
under_review,
incomplete,
approved,
rejected
persona_inquiry_type
string
required
tos_status
enum<string>
required
Available options:
pending,
approved
type
enum<string>
required
Available options:
individual,
business
rejection_reasons
any