Skip to main content
Glama

get_kyc_status

Read-onlyIdempotent

Get KYC verification status (optional)

KYC is optional. Most endpoints (cards, gift cards, push-to-card, account balance, withdrawals) do not require verification. It is only needed for certain features such as Venmo/PayPal payouts via /send-payment, and may be used for additional controls in the future. If you are not using those features, you can ignore the verification endpoints entirely.

Returns the calling wallet's cached KYC verification status. Use this as a free pre-flight check before paying for /send-payment: if kyc_verified is true the payout will go through. If it is false, don't call /send-payment yet — that call would not send the payout (it returns kyc_required and a kyc_url), and the USDC you paid would just land in your account balance, recoverable with POST /withdraw. To start verification when not verified, call /get-kyc-link.

This reads the cached status kept up to date by the verification webhook; it does not start verification or return a verification link.

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
user_idNo
kyc_verifiedNoWhether the wallet has completed identity verification. When true, /send-payment dispatches the payout. When false, /send-payment does not send: it returns kyc_required and the USDC paid lands in account balance (recoverable via POST /withdraw). Verify before calling /send-payment.
kyc_review_answerNoLatest review answer (e.g. GREEN for approved, RED for rejected), or null if never reviewed.
kyc_review_statusNoLatest review status from the verification provider, or null if never reviewed.
kyc_last_reviewed_atNoEpoch milliseconds of the last review, or null if never reviewed.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • removedInput schema / properties / auth_token
      Removed value: -{
      -  "description": "Laso credential. Only if the MCP connection has no Authorization header.",
      -  "type": "string"
      -}
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "kyc_last_reviewed_at": {
      +      "description": "Epoch milliseconds of the last review, or null if never reviewed.",
      +      "type": [
      +        "number",
      +        "null"
      +      ]
      +    },
      +    "kyc_review_answer": {
      +      "description": "Latest review answer (e.g. GREEN for approved, RED for rejected), or null if never reviewed.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "kyc_review_status": {
      +      "description": "Latest review status from the verification provider, or null if never reviewed.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "kyc_verified": {
      +      "description": "Whether the wallet has completed identity verification. When true, /send-payment dispatches the payout. When false, /send-payment does not send: it returns kyc_required and the USDC paid lands in account balance (recoverable via POST /withdraw). Verify before calling /send-payment.",
      +      "type": [
      +        "boolean",
      +        "null"
      +      ]
      +    },
      +    "user_id": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -{
      -  "properties": {
      -    "kyc_last_reviewed_at": {
      -      "description": "Epoch milliseconds of the last review, or null if never reviewed.",
      -      "type": [
      -        "number",
      -        "null"
      -      ]
      -    },
      -    "kyc_review_answer": {
      -      "description": "Latest review answer (e.g. GREEN for approved, RED for rejected), or null if never reviewed.",
      -      "type": [
      -        "string",
      -        "null"
      -      ]
      -    },
      -    "kyc_review_status": {
      -      "description": "Latest review status from the verification provider, or null if never reviewed.",
      -      "type": [
      -        "string",
      -        "null"
      -      ]
      -    },
      -    "kyc_verified": {
      -      "description": "Whether the wallet has completed identity verification. When true, /send-payment dispatches the payout. When false, /send-payment does not send: it returns kyc_required and the USDC paid lands in account balance (recoverable via POST /withdraw). Verify before calling /send-payment.",
      -      "type": [
      -        "boolean",
      -        "null"
      -      ]
      -    },
      -    "user_id": {
      -      "type": [
      -        "string",
      -        "null"
      -      ]
      -    }
      -  },
      -  "type": "object"
      -}New value: +null
  3. First observed

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description transparently states that the endpoint reads cached status maintained by a webhook, does not start verification, and does not return a verification link. It also communicates the important behavioral nuance that a false status would not cause /send-payment to fail destructively—the USDC would land in the account balance and be recoverable. This goes well beyond the annotations, which only declare readOnly/idempotent/destructive hints.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is somewhat long but every sentence earns its place: it explains optionality, the pre-flight use case, the failure mode, and the alternative endpoint. The opening bolded 'KYC is optional' is an effective front-loaded summary, though the paragraph could be trimmed slightly without losing key guidance.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a zero-parameter read-only tool with an output schema available, the description fully covers what an agent needs: what the tool returns, how to act on the result, what it does not do, and how it relates to other endpoints. No important operational context is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has zero parameters and 100% schema coverage, so the baseline is 4. The description adds relevant context about the returned field `kyc_verified` and its semantics, which is useful for interpreting the output, though it doesn't need to document any parameters since none exist.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool returns the calling wallet's cached KYC verification status, uses a specific verb and resource, and distinguishes this read-only status check from the related /get-kyc-link endpoint. It is not confused with any sibling tool despite many similar-looking KYC-related operations.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly says when to use the tool (as a free pre-flight check before calling /send-payment), what to do if kyc_verified is false (do not call /send-payment; call /get-kyc-link instead), and even provides nuanced fallback context about recoverable USDC. This is exemplary usage guidance with clear alternatives and conditions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources