POST
/
farcaster
/
signer
/
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",
  "app_fid": 18949,
  "deadline": 1693627665,
  "signature": "0xe5d95c391e165dac8efea373efe301d3ea823e1f41713f8943713cbe2850566672e33ff3e17e19abb89703f650a2597f62b4fda0ce28ca15d59eb6d4e971ee531b"
}'
{
  "object": "signer",
  "signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
  "public_key": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "status": "generated",
  "signer_approval_url": "<string>",
  "fid": 3,
  "permissions": [
    "WRITE_ALL"
  ]
}

​
Public key should be unique, do not reuse the public key on the same account or across accounts

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
required

Application FID

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
object

Response

200
application/json
Successful operation
​
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:

"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"

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

The unique identifier of a farcaster user (unsigned integer)

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

Was this page helpful?