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

# Get KYB verification status

> Returns the overall KYB verification status for an entity, including per-provider status breakdowns and Sumsub approval details.



## OpenAPI

````yaml https://grid.squads.xyz/api-docs/openapi.json get /api/compliance/v1/entities/{id}/kyb
openapi: 3.1.0
info:
  title: Grid v1 API
  description: Grid v1 REST API for Solana-based smart account system
  contact:
    name: Grid API Support
    url: https://squads.so
    email: support@squads.so
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://grid.squads.xyz
    description: Production server
security:
  - bearer_auth: []
tags:
  - name: accounts
    description: Smart account management operations
  - name: spending-limits
    description: Spending limit management
  - name: standing-orders
    description: Standing order operations
  - name: transactions
    description: Transaction management
  - name: trade
    description: Trade operations and management
  - name: payments
    description: Payment intent operations
  - name: passkeys
    description: Passkey management
  - name: kyc
    description: Know Your Customer operations
  - name: external-accounts
    description: External bank account management
  - name: virtual-accounts
    description: Virtual account management
  - name: auth
    description: Authentication operations
  - name: proposals
    description: Proposal management for multi-sig operations
  - name: compliance
    description: Compliance entity management and KYB/KYC operations
paths:
  /api/compliance/v1/entities/{id}/kyb:
    get:
      tags:
        - compliance
      summary: Get KYB verification status
      description: >-
        Returns the overall KYB verification status for an entity, including
        per-provider status breakdowns and Sumsub approval details.
      operationId: handler
      parameters:
        - name: id
          in: path
          description: Entity ID
          required: true
          schema:
            type: string
            format: uuid
        - name: x-grid-environment
          in: header
          description: Solana network environment (sandbox, devnet, mainnet)
          required: true
          schema:
            type: string
      responses:
        '200':
          description: KYB status for entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GridApiResponse_GetKybResponsePayload'
        '401':
          description: Unauthorized
        '404':
          description: Entity not found
        '500':
          description: Internal server error
      security:
        - bearer_auth: []
components:
  schemas:
    GridApiResponse_GetKybResponsePayload:
      type: object
      required:
        - data
        - metadata
      properties:
        data:
          type: object
          required:
            - entity_id
            - status
            - sumsub_approved
          properties:
            applicant_id:
              type:
                - string
                - 'null'
              description: |-
                Identifier for the KYB application.
                Deprecated for external consumers; internal correlation key.
              deprecated: true
            entity_id:
              type: string
              format: uuid
              description: Entity identifier
            level_name:
              type:
                - string
                - 'null'
              description: Verification level applied to this entity
            provider_statuses:
              type: array
              items:
                $ref: '#/components/schemas/ConsumerProviderStatus'
              description: Verification status broken down by provider
            status:
              $ref: '#/components/schemas/ConsumerComplianceStatus'
              description: Overall KYB verification status
            status_code:
              type:
                - string
                - 'null'
              description: Detailed status code from the verification provider
            status_message:
              type:
                - string
                - 'null'
              description: Human-readable status message
            status_updated_at:
              type:
                - string
                - 'null'
              format: date-time
              description: When the status was last updated
            sumsub_approved:
              type: boolean
              description: Whether identity verification is approved
            sumsub_approved_at:
              type:
                - string
                - 'null'
              format: date-time
              description: When identity verification was approved
        metadata:
          $ref: '#/components/schemas/Metadata'
    ConsumerProviderStatus:
      type: object
      description: Verification status for a specific provider.
      required:
        - provider
        - status
      properties:
        external_id:
          type:
            - string
            - 'null'
          description: Legacy alias for provider-assigned identifier
        provider:
          type: string
          description: Provider identifier
        provider_id:
          type:
            - string
            - 'null'
          description: Provider-assigned identifier
        status:
          $ref: '#/components/schemas/ConsumerComplianceStatus'
          description: Verification status for this provider
    ConsumerComplianceStatus:
      type: string
      description: Verification status of the entity.
      enum:
        - not_started
        - pending
        - in_progress
        - in_review
        - action_required
        - approved
        - rejected
        - suspended
    Metadata:
      type: object
      required:
        - request_id
        - timestamp
      properties:
        request_id:
          type: string
        timestamp:
          type: string
          format: date-time
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      description: Your Grid API key from the Grid Dashboard

````