KYC Support

Vezgo KYC Support lets your application retrieve the Know-Your-Customer (KYC) data a provider holds for a connected account — such as the account holder's name, email, and provider-specific identity details — captured during account sync.

KYC data is available for a set of supported exchanges.

info

KYC Support is an Enterprise-only, opt-in feature. Contact us to enable KYC data syncing for your team. Until it is enabled, the endpoint returns 403.

Supported exchanges

KYC data is captured only for the following exchanges:

Supported exchange
Coinbase
Coinbase Prime
Crypto.com
Gemini
Uphold

How to use

1. Email hello@vezgo.com to enable KYC data syncing for your team.

2. Once enabled, trigger an account sync (or wait for the next daily sync) for any account whose KYC data you want to capture. Snapshots are only created by syncs that complete after the feature is turned on.

3. Fetch the snapshot from the most recent qualifying sync:

   curl 'VEZGO_API_URL/accounts/ACCOUNT_ID/kyc-data' \
     -H 'Authorization: Bearer VEZGO_USER_TOKEN'

   Or via the SDK:

   const user = vezgo.login('USERNAME_FROM_YOUR_SYSTEM');
   const kycData = await user.accounts.getKYCData('ACCOUNT_ID');

A 404 means no snapshot exists yet — typically because no sync has completed since the feature was enabled, or because the provider does not expose KYC fields.

Response

A successful request returns 200 with the following JSON:

{
  "email": "user@example.com",
  "name": "John Doe",
  "misc": {
    "username": "johndoe",
    "currency": "usd",
    "country_code": "US"
  },
  "fetched_at": "2026-04-28T10:00:00.000Z"
}

Response fields

Field	Type	Description
email	String, null	The account holder's email as reported by the provider, when available.
name	String, null	The account holder's full name as reported by the provider, when available.
misc	Object	Provider-specific KYC fields. The shape varies by provider — common keys include country_code, account_type, birth_date, and address.
fetched_at	String (ISO 8601)	Timestamp of the sync that captured this KYC snapshot.

Any top-level field (email, name) may be missing if the upstream provider does not expose it.

Status codes

Status	Description
200	KYC data is available and returned in the response body.
403	The KYC data feature is not enabled for your team. Contact us to enable it.
404	No KYC snapshot has been saved yet for this account. KYC data is populated by the next successful account sync after the feature is enabled, and only for providers that expose KYC fields.

Error responses (403 and 404) carry a JSON body of the form { "message": "..." } describing the reason.

See the Vezgo API reference for full request and response details.