> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentcard.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Get verification status

> Polls the current verification status — the alternative to the `identity.verification.updated` webhook.

## Status values

Every KYC response carries exactly one status.

| Status                  | Meaning                             | What to do                                                                             |
| ----------------------- | ----------------------------------- | -------------------------------------------------------------------------------------- |
| `awaiting_documents`    | Waiting for the ID images.          | Upload the front and back — or hand the user the `iframe_url`.                         |
| `needs_information`     | The review asked for typed details. | Submit the `required_fields` — or hand the user the `iframe_url`, which collects them. |
| `requires_verification` | Ready for the face scan.            | Show the user the `iframe_url`.                                                        |
| `pending`               | Under review.                       | Wait — no action needed.                                                               |
| `approved`              | Verified.                           | Done.                                                                                  |
| `rejected`              | Not verified.                       | The user did not pass.                                                                 |

## Fully hosted, or fully custom

Every **actionable** status (`awaiting_documents`, `needs_information`, `requires_verification`) carries an `iframe_url` — a hosted page that walks the user through whatever the verification still needs: document capture, any typed details the review asks for, and the face scan. That gives you two integration styles with the same API:

* **Fully hosted**: ignore the upload and submit endpoints entirely. Whenever the status is actionable, hand the user the `iframe_url` (new tab or embedded) — the flow completes end to end on the hosted page, and no identity documents or personal details ever pass through your servers.
* **Fully custom**: drive the [document upload](/api-reference/identity-verification/upload-front) and [information submit](/api-reference/identity-verification/submit-information) endpoints from your own UI, and use the `iframe_url` only at `requires_verification` for the scan.

The link is short-lived: always surface the one from your freshest status read or `identity.verification.updated` event rather than storing it.

**Test mode reports a smaller status set.** A sandbox verification never asks for identity: it reports only `requires_verification` (the `iframe_url` is the test-mode chooser), `pending`, `approved`, or `rejected`, so `awaiting_documents` and `needs_information` never appear. Complete it with [simulate](/api-reference/identity-verification/simulate) or the chooser; rehearse the full collection state machine against live with a real document.


## OpenAPI

````yaml openapi.json GET /api/v2/kyc
openapi: 3.1.0
info:
  title: Agentcard API
  version: 2.0.0
  description: >-
    The Agentcard v2 API — connect your users and verify their identity from
    your own backend. Every call is authenticated with a platform access token
    minted from your `client_id` + `client_secret`.
servers:
  - url: https://api.agentcard.sh
    description: >-
      There is one base URL. Sandbox vs production is decided by the client
      credential you use, never by the host.
security:
  - platformToken: []
tags:
  - name: Authentication
    description: >-
      Exchange your client credentials for a platform access token, and
      introspect what a token acts as.
  - name: Connect
    description: >-
      Connect a user to your platform: send a one-time code, verify it, record
      consent, and keep the connection alive.
  - name: Identity verification
    description: >-
      Verify a connected user's identity: upload their ID, submit any extra
      fields we ask for, then show a short face scan.
  - name: Wallet funding
    description: >-
      Fund a connected user's wallet from your own UI — request a payment link,
      relay the phone verification code, and poll until the funds land.
  - name: Withdrawals
    description: >-
      Move money out of a connected user's wallet — to a saved bank account or a
      crypto address on Base. Transfers are processed manually by the Agentcard
      team, usually within 1-3 business days.
paths:
  /api/v2/kyc:
    get:
      tags:
        - Identity verification
      summary: Get verification status
      description: >-
        Polls the current verification status — the alternative to the
        `identity.verification.updated` webhook.
      operationId: kycGetStatus
      parameters:
        - name: user_id
          in: query
          required: true
          schema:
            type: string
          description: The connected user's id.
      responses:
        '200':
          description: The current status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycState'
              example:
                object: kyc
                status: approved
        '400':
          description: '`invalid_request` — missing `user_id`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/ConnectionNotFound'
        '409':
          $ref: '#/components/responses/UserConflict'
components:
  schemas:
    KycState:
      type: object
      description: The single status contract every KYC response carries.
      properties:
        object:
          type: string
          enum:
            - kyc
        status:
          type: string
          enum:
            - awaiting_documents
            - needs_information
            - requires_verification
            - pending
            - approved
            - rejected
          description: >-
            `awaiting_documents` — upload the front and back.
            `needs_information` — collect the `required_fields` and submit them.
            `requires_verification` — show the user the `iframe_url`. `pending`
            — under review, no action needed. `approved` — verified, done.
            `rejected` — the user did not pass. Statuses are not one-way: a
            review can send a user back — `pending` may return to
            `needs_information` (a detail didn't match the document; re-collect
            the listed fields and resubmit, the check re-runs automatically) or
            to `awaiting_documents` (the images were unusable; upload both sides
            again). Always branch on the current status.
        required_fields:
          type: array
          items:
            type: string
          description: >-
            Only on `needs_information` — exactly the fields to collect and post
            to `/kyc/information`.
        iframe_url:
          type: string
          description: >-
            On every actionable status (`awaiting_documents`,
            `needs_information`, `requires_verification`): the hosted page that
            collects whatever the verification still needs, and the face scan at
            `requires_verification`. Embed it in an iframe with `allow="camera;
            microphone"`. Short-lived: always use the most recent one from a
            poll or webhook, never a stored copy.
        warnings:
          type: array
          items:
            type: string
          description: >-
            Optional, on document uploads — actionable feedback safe to show the
            user (for example, that the other side of the document is still
            needed).
        extracted:
          type: object
          description: >-
            Optional, on document uploads — what the document reader pulled off
            the uploaded image(s), so you can prefill your details form instead
            of asking the user to re-type what the ID already says. Keys match
            the `/kyc/information` request fields (`first_name`, `last_name`,
            `date_of_birth`, `address_line1`, `address_city`, `address_region`,
            `address_postal_code`, `address_country`) plus `document_type`,
            `issuing_country`, and `document_number` (the number printed on the
            document — for US documents this is NOT the SSN, so never prefill it
            into `national_id_number` when `issuing_country` is `US`). Fields
            appear as they become readable: the front usually carries the name
            and date of birth; a US back adds the barcode address. Always let
            the user confirm or correct prefilled values.
          additionalProperties:
            type: string
        reason:
          type: string
          description: >-
            Optional, on `needs_information`, `awaiting_documents`,
            `requires_verification`, and `rejected` — a short, end-user-safe
            explanation of what the review asked for (for example, “Enter your
            full name exactly as it appears on your identity document.”). Safe
            to show the user verbatim.
    Error:
      type: object
      description: Every v2 error uses the same envelope.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: A stable, machine-readable string (snake_case). Branch on this.
            message:
              type: string
              description: A human-readable explanation, safe to log.
            docs:
              type: string
              description: A link back to the reference.
            field_errors:
              type: object
              additionalProperties:
                type: string
              description: Only on `invalid_fields` — names each field to fix.
            warnings:
              type: array
              items:
                type: string
              description: >-
                Only on document upload errors — actionable feedback safe to
                show the user.
  responses:
    Unauthorized:
      description: >-
        `unauthorized` — the platform access token is missing or expired.
        Exchange your client credentials for a fresh one.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ConnectionNotFound:
      description: >-
        `connection_not_found` — no connection exists for that user under your
        client.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    UserConflict:
      description: >-
        `user_conflict` — the email on file in your organization belongs to a
        different account. Contact support.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    platformToken:
      type: http
      scheme: bearer
      description: >-
        A platform access token. Get one on the **Create an access token**
        endpoint by exchanging your `client_id` + `client_secret`, then send it
        as `Authorization: Bearer <token>`. Tokens live one hour.

````