Neynar · Example Payload

Hub Fetch Username Proof By Name

Fetch a proof for a username.

Usernames

Hub Fetch Username Proof By Name is an example object payload from Neynar, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses

Example Payload

Raw ↑ 
{
  "operationId": "hub-fetch-username-proof-by-name",
  "method": "GET",
  "path": "/v1/userNameProofByName",
  "summary": "Proof for a username",
  "description": "Fetch a proof for a username.",
  "tags": [
    "Usernames"
  ],
  "parameters": [
    {
      "name": "name",
      "in": "query",
      "required": true,
      "description": "The Farcaster username or ENS address",
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "A successful response.",
      "schema": {
        "$ref": "#/components/schemas/UserNameProof"
      },
      "example": null
    }
  }
}