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

# Identity Lookup

> Retrieve user identity information by email address

Retrieve user identity information based on an email address using the `identity_get_by_email_address` method.


## OpenAPI

````yaml POST /v1#identity_get_by_email_address
openapi: 3.0.0
info:
  title: SHARE Protocol API
  description: Micropayments, revenue sharing and distribution.
  version: 1.0.0
  contact:
    name: Formless
    url: https://www.formless.xyz
servers:
  - url: https://share-ddn.formless.xyz
    description: Production server
security: []
paths:
  /v1#identity_get_by_email_address:
    post:
      tags:
        - Account Management
      summary: Identity Lookup
      description: Retrieve user identity information by email address
      operationId: identity_get_by_email_address
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - jsonrpc
                - id
                - method
                - params
              properties:
                jsonrpc:
                  type: string
                  enum:
                    - '2.0'
                  default: '2.0'
                id:
                  type: string
                  default: '1'
                method:
                  type: string
                  enum:
                    - identity_get_by_email_address
                  default: identity_get_by_email_address
                params:
                  type: object
                  required:
                    - email_address
                  properties:
                    email_address:
                      type: string
                      format: email
                      default: user@example.com
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityGetByEmailResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    IdentityGetByEmailResponse:
      type: object
      required:
        - jsonrpc
        - id
        - result
      properties:
        jsonrpc:
          type: string
          enum:
            - '2.0'
        id:
          type: string
        result:
          oneOf:
            - $ref: '#/components/schemas/IdentitySuccess'
            - $ref: '#/components/schemas/IdentityError'
    IdentitySuccess:
      type: object
      required:
        - success
        - user_unique_id
        - email_address
      properties:
        success:
          type: boolean
          enum:
            - true
          description: Indicates if the request was successful
        user_unique_id:
          type: string
          description: The Unique ID of the user
        email_address:
          type: string
          format: email
          description: The user's email address
        display_name:
          type: string
          description: The user's display name
        verified_identity:
          type: boolean
          description: Whether the user's identity has been verified
        financial_accounts:
          type: array
          items:
            type: object
          description: Array of the user's linked financial accounts
        verifications:
          type: array
          items:
            type: object
          description: Array of verification records for the user
    IdentityError:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          enum:
            - false
          description: Indicates the request failed
        message:
          type: string
          description: Error message describing why the request failed
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token with Unique ID identification

````