---
updatedAt: 2025-06-09T22:53:45.000Z
agentTools:
  projectIndex: https://docs.metakeep.xyz/llms.txt
---

# Get User Identity (API)

> 👍 ".. and boy, have we patented it" -Steve Jobs
>
> User Experiences, Processes, Workflows, Systems, and Methods are Protected by US 63/392,720;  US 63/392,718; US 63/392,717 and several more. Enforced internationally under Patent Cooperation Treaty (PCT).

```json Sample Response
{
    "status": "SUCCESS",
    "wallet": {
        "did": "did:polygonid:polygon:mumbai:2qNAQNPcJquc2azoGfUyu68WXe662qP8NvjwreWcvi"
    }
}
```

## Identity format

The identity follows the [Polygon ID DID format](https://github.com/0xPolygonID/did-polygonid/blob/main/did-polygonid-method.md).

> 🚧 API Error Status
>
> You can find error status returned by the api [here](https://docs.metakeep.xyz/reference/api-error-status#v3getwallet).

© Copyright 2024, Passbird Research Inc.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "identity-services",
    "version": "3.4"
  },
  "servers": [
    {
      "url": "https://api.metakeep.xyz/"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v3/getWallet": {
      "post": {
        "summary": "Get User Identity (API)",
        "description": "",
        "operationId": "identity-v3getidentity",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "user"
                ],
                "properties": {
                  "user": {
                    "type": "object",
                    "description": "User identifier. This is the ID against which the identity would be generated.",
                    "required": [
                      "email"
                    ],
                    "properties": {
                      "email": {
                        "type": "string",
                        "description": "Email address of the user",
                        "default": "dave@example.com"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"SUCCESS\",\n    \"wallet\": {\n        \"did\": \"did:polygonid:polygon:mumbai:2qNAQNPcJquc2azoGfUyu68WXe662qP8NvjwreWcvi\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "SUCCESS"
                    },
                    "wallet": {
                      "type": "object",
                      "properties": {
                        "did": {
                          "type": "string",
                          "example": "did:polygonid:polygon:mumbai:2qNAQNPcJquc2azoGfUyu68WXe662qP8NvjwreWcvi"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"status\": \"INVALID_EMAIL\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "INVALID_EMAIL"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"status\": \"FORBIDDEN\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "FORBIDDEN"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```