Skip to main content
POST
/
v2
/
farcaster
/
signer
/
signed_key
Register Signed Key
curl --request POST \
  --url https://api.neynar.com/v2/farcaster/signer/signed_key/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
  "signature": "<string>",
  "app_fid": 3,
  "deadline": 123,
  "redirect_url": "<string>",
  "sponsor": {
    "fid": 3,
    "signature": "<string>",
    "sponsored_by_neynar": true
  }
}
'
{
  "signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
  "public_key": "0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22",
  "status": "generated",
  "object": "signer",
  "signer_approval_url": "<string>",
  "fid": 3,
  "permissions": [
    "WRITE_ALL"
  ]
}

​
Easiest way to start with Neynar-managed signers

Read more about how writes to Farcaster work with Neynar managed signers

Authorizations

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

API key to authorize requests

Body

application/json
​
signer_uuid
string
required

UUID of the signer. signer_uuid is paired with API key, can't use a uuid made with a different API key.

Example:

"19d0c5fd-9b33-4a48-a0e2-bc7b0555baec"

​
signature
string
required

Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer's public key

​
app_fid
integer<int32>
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)

​
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
SignedKeyRequestSponsor · object

Response

Success

​
signer_uuid
string
required

UUID of the signer. signer_uuid is paired with API key, can't use a uuid made with a different API key.

Example:

"19d0c5fd-9b33-4a48-a0e2-bc7b0555baec"

​
public_key
string
required

Ed25519 public key

Example:

"0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22"

​
status
enum<string>
required
Available options:
generated,
pending_approval,
approved,
revoked
​
object
enum<string>
Available options:
signer
​
signer_approval_url
string
​
fid
integer<int32>

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

Required range: x >= 0
Example:

3

​
permissions
enum<string>[]
Available options:
WRITE_ALL,
READ_ONLY,
NONE,
PUBLISH_CAST,
DELETE_CAST,
PUBLISH_REACTION,
DELETE_REACTION,
UPDATE_PROFILE,
FOLLOW_USER,
UNFOLLOW_USER,
FOLLOW_CHANNEL,
UNFOLLOW_CHANNEL,
ADD_VERIFICATION,
REMOVE_VERIFICATION,
WRITE_FRAME_ACTION