Sign in

v1

latestOpenAPI 3.0.42026-07-26159287356.1 KB
AuthAddress

Register Signed Key

Allow apps to register an Ethereum addresses as authorized "auth addresses" for a user's Farcaster account, enabling seamless Sign-In With Farcaster (SIWF) across applications without repeated custody wallet authorizations.

post/v2/farcaster/auth_address/developer_managed/signed_key/

Request body

addressstring required

Ethereum address

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, 32 bytes padded auth address. Refer guide for more details.

Example request

{
  "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
  "app_fid": 3,
  "signature": "0x16161933625ac90b7201625bfea0d816de0449ea1802d97a38c53eef3c9c0c424fefbc5c6fb5eabe3d4f161a36d18cda585cff7e77c677c5d34a9c87e68ede011c",
  "sponsor": {
    "fid": 3
  }
}

Response

Success

addressstring required

Ethereum address

auth_address_approval_urlstring uri
fidinteger

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

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

Example response

{
  "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
  "fid": 3
}