POST
/
v2
/
farcaster
/
auth_address
/
developer_managed
/
signed_key
/
Register Signed Key
curl --request POST \
  --url https://api.neynar.com/v2/farcaster/auth_address/developer_managed/signed_key/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
  "app_fid": 3,
  "deadline": 123,
  "signature": "0x16161933625ac90b7201625bfea0d816de0449ea1802d97a38c53eef3c9c0c424fefbc5c6fb5eabe3d4f161a36d18cda585cff7e77c677c5d34a9c87e68ede011c",
  "redirect_url": "<string>",
  "sponsor": {
    "fid": 3,
    "signature": "<string>",
    "sponsored_by_neynar": true
  }
}'
{
  "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
  "status": "pending_approval",
  "auth_address_approval_url": "<string>",
  "fid": 3
}

Authorizations

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

API key to authorize requests

Body

application/json
​
address
string
required

Ethereum address

Example:

"0x5a927ac639636e534b678e81768ca19e2c6280b7"

​
app_fid
integer
required

The unique identifier of a farcaster user or app (unsigned integer)

Required range: x >= 0
Example:

3

​
deadline
integer
required

unix timestamp in seconds that controls how long the signed key request is valid for. (24 hours from now is recommended)

​
signature
string
required

Signature generated by the custody address of the app. Signed data includes app_fid, deadline, 32 bytes padded auth address. Refer guide for more details.

Example:

"0x16161933625ac90b7201625bfea0d816de0449ea1802d97a38c53eef3c9c0c424fefbc5c6fb5eabe3d4f161a36d18cda585cff7e77c677c5d34a9c87e68ede011c"

​
redirect_url
string

Url to redirect to after the signer is approved. Note : This should only be used when requesting a signer from a native mobile application.

​
sponsor
object

Response

Success

​
address
string
required

Ethereum address

Example:

"0x5a927ac639636e534b678e81768ca19e2c6280b7"

​
status
enum<string>
required
Available options:
pending_approval,
approved,
revoked
​
auth_address_approval_url
string<uri>
​
fid
integer

The unique identifier of a farcaster user or app (unsigned integer)

Required range: x >= 0
Example:

3