Sign in

v1

latestOpenAPI 3.0.42026-07-26159287356.1 KB
Onchain

Register Farcaster account onchain

Register a new farcaster account onchain. Optionally you can pass in signers to register a new account and create multiple signers in a single transaction. Requires x-wallet-id header.

post/v2/farcaster/user/register/

Headers

x-wallet-idstring required

Wallet ID to use for transactions

Request body

idemstring

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.
storage_unitsinteger

Example request

{
  "pre_registration_calls": [
    {
      "target": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
    }
  ],
  "registration": {
    "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
    "deadline": 1715190000,
    "recovery_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
  },
  "signers": [
    {
      "deadline": 1715190000,
      "public_key": "0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22"
    }
  ],
  "storage_units": 2
}

Response

Success

messagestring
transaction_hashstring

Example response

{
  "message": "Account registered successfully",
  "transaction_hash": "0x2e276b4d014334797d9951ce2d3b7a11a4a58855cb07b3761de36785c618220a",
  "user": {
    "auth_addresses": [
      {
        "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "app": {
          "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
          "fid": 3
        }
      }
    ],
    "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
    "fid": 3,
    "profile": {
      "bio": {
        "mentioned_profiles": [
          {
            "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "fid": 3
          }
        ]
      }
    },
    "verifications": [
      "0x5a927ac639636e534b678e81768ca19e2c6280b7"
    ],
    "verified_addresses": {
      "eth_addresses": [
        "0x5a927ac639636e534b678e81768ca19e2c6280b7"
      ],
      "primary": {
        "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
      }
    }
  }
}