Skip to main content
POST
/
v2
/
farcaster
/
user
/
register
Register Farcaster account onchain
curl --request POST \
  --url https://api.neynar.com/v2/farcaster/user/register/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-wallet-id: <x-wallet-id>' \
  --data '
{
  "registration": {
    "deadline": 1715190000,
    "signature": "<string>",
    "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
    "recovery_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
  },
  "idem": "<string>",
  "pre_registration_calls": [
    {
      "data": "<string>",
      "target": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
      "allow_failure": false,
      "value": 0
    }
  ],
  "storage_units": 2,
  "signers": [
    {
      "signature": "<string>",
      "metadata": "<string>",
      "public_key": "0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22",
      "deadline": 1715190000,
      "key_type": 1,
      "metadata_type": 1
    }
  ]
}
'
{
  "message": "Account registered successfully",
  "transaction_hash": "0x2e276b4d014334797d9951ce2d3b7a11a4a58855cb07b3761de36785c618220a",
  "user": {
    "object": "user",
    "fid": 3,
    "username": "<string>",
    "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
    "registered_at": "2023-11-07T05:31:56Z",
    "profile": {
      "bio": {
        "text": "<string>",
        "mentioned_profiles": [
          {
            "object": "user_dehydrated",
            "fid": 3,
            "username": "<string>",
            "display_name": "<string>",
            "pfp_url": "<string>",
            "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "score": 123
          }
        ],
        "mentioned_profiles_ranges": [
          {
            "start": 1,
            "end": 1
          }
        ],
        "mentioned_channels": [
          {
            "id": "<string>",
            "name": "<string>",
            "object": "channel_dehydrated",
            "image_url": "<string>",
            "viewer_context": {
              "following": true,
              "role": "member"
            }
          }
        ],
        "mentioned_channels_ranges": [
          {
            "start": 1,
            "end": 1
          }
        ]
      },
      "location": {
        "latitude": 0,
        "longitude": 0,
        "address": {
          "city": "<string>",
          "country": "<string>",
          "state": "<string>",
          "state_code": "<string>",
          "country_code": "<string>"
        },
        "radius": 1
      },
      "banner": {
        "url": "<string>"
      }
    },
    "follower_count": 123,
    "following_count": 123,
    "verifications": [
      "0x5a927ac639636e534b678e81768ca19e2c6280b7"
    ],
    "auth_addresses": [
      {
        "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "app": {
          "object": "user_dehydrated",
          "fid": 3,
          "username": "<string>",
          "display_name": "<string>",
          "pfp_url": "<string>",
          "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "score": 123
        }
      }
    ],
    "verified_addresses": {
      "eth_addresses": [
        "0x5a927ac639636e534b678e81768ca19e2c6280b7"
      ],
      "sol_addresses": [
        "<string>"
      ],
      "primary": {
        "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "sol_address": "<string>"
      }
    },
    "verified_accounts": [
      {
        "platform": "x",
        "username": "<string>"
      }
    ],
    "display_name": "<string>",
    "pro": {
      "status": "subscribed",
      "subscribed_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z"
    },
    "pfp_url": "<string>",
    "experimental": {
      "neynar_user_score": 123,
      "deprecation_notice": "<string>"
    },
    "viewer_context": {
      "following": true,
      "followed_by": true,
      "blocking": true,
      "blocked_by": true
    },
    "score": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.neynar.com/llms.txt

Use this file to discover all available pages before exploring further.

​
This API uses developer_managed signers

  • If not using developer_managed signers, use this API to create new Farcaster accounts.
  • If unsure whether you’re using developer_managed signers, you’re probably not using them and should use the other API.

​
Node.js SDK

🔗 SDK Method: registerAccountOnchain Use this API endpoint with the Neynar Node.js SDK for typed responses and better developer experience.

Authorizations

​
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Headers

​
x-wallet-id
string
required

Wallet ID to use for transactions

Body

application/json
​
registration
object
required
​
idem
string

An Idempotency key is a unique identifier for the request. Note:

  1. Pre-registration calls must be idempotent when using idempotency keys.
  2. This is used to prevent duplicate requests. Use the same idem key on retry attempts.
  3. This should be a unique identifier for each request.
  4. Recommended format is a 16-character string generated by the developer at the time of making this request.
​
pre_registration_calls
object[]
​
storage_units
integer
Required range: x >= 0
Example:

2

​
signers
object[]

Response

Success

​
message
string
Example:

"Account registered successfully"

​
transaction_hash
string
Example:

"0x2e276b4d014334797d9951ce2d3b7a11a4a58855cb07b3761de36785c618220a"

​
user
User · object