Neynar · Example Payload

Get Account Association

Retrieves the account-association.json file from a miniapp deployment, which contains the JFS-signed domain association. Requires API key authentication.

studio

Get Account Association 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": "get-account-association",
  "method": "GET",
  "path": "/v2/studio/deployment/account-association",
  "summary": "Get account association of a miniapp",
  "description": "Retrieves the account-association.json file from a miniapp deployment, which contains the JFS-signed domain association. Requires API key authentication.",
  "tags": [
    "studio"
  ],
  "parameters": [
    {
      "name": "deployment_id",
      "in": "query",
      "required": false,
      "description": "Deployment ID",
      "schema": {
        "format": "uuid",
        "type": "string"
      }
    },
    {
      "name": "namespace",
      "in": "query",
      "required": false,
      "description": "Kubernetes namespace name",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "name",
      "in": "query",
      "required": false,
      "description": "Kubernetes deployment name",
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "Success",
      "schema": {
        "properties": {
          "header": {
            "description": "Base64URL encoded JFS header",
            "type": "string"
          },
          "payload": {
            "description": "Base64URL encoded JFS payload",
            "type": "string"
          },
          "signature": {
            "description": "Base64URL encoded JFS signature",
            "type": "string"
          }
        },
        "required": [
          "header",
          "payload",
          "signature"
        ],
        "type": "object"
      },
      "example": null
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "properties": {
          "error": {
            "type": "string"
          }
        },
        "required": [
          "error"
        ],
        "type": "object"
      },
      "example": null
    },
    "404": {
      "description": "Resource not found",
      "schema": {
        "properties": {
          "error": {
            "type": "string"
          }
        },
        "required": [
          "error"
        ],
        "type": "object"
      },
      "example": null
    },
    "500": {
      "description": "Server Error",
      "schema": {
        "properties": {
          "error": {
            "type": "string"
          }
        },
        "required": [
          "error"
        ],
        "type": "object"
      },
      "example": null
    }
  }
}