Sign in

v1

latestOpenAPI 3.0.42026-07-26159287356.1 KB
Signer

Register Signed Key

Registers an app FID, deadline and a signature. Returns the signer status with an approval url.

post/v2/farcaster/signer/signed_key/

Request body

app_fidinteger required

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

deadlineinteger required

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

redirect_urlstring

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

signaturestring required

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

signer_uuidstring required

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

Example request

{
  "app_fid": 3,
  "signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
  "sponsor": {
    "fid": 3
  }
}

Response

Success

fidinteger

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

object'signer'
permissionsSharedSignerPermission[]
public_keystring required

Ed25519 public key

signer_approval_urlstring
signer_uuidstring required

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

status'generated' | 'pending_approval' | 'approved' | 'revoked' required

Example response

{
  "fid": 3,
  "public_key": "0x3daa8f99c5f760688a3c9f95716ed93dee5ed5d7722d776b7c4deac957755f22",
  "signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec"
}