Neynar · Schema
RegisterUserOnChainReqBody
Neynar Farcaster API schema for RegisterUserOnChainReqBody
FarcasterSocialDecentralizedWeb3BlockchainSocial GraphCastsChannelsFeedsReactionsNotificationsWebhooksOnchain
Properties
| Name | Type | Description |
|---|---|---|
| idem | string | An Idempotency key is a unique identifier for the request. **Note:** 1) Pre-registration calls must be idempotent when using idempotency keys. 2) This is used to prevent duplicate requests. Use the sa |
| pre_registration_calls | array | |
| registration | object | |
| signers | array | |
| storage_units | integer |
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://neynar.com/schemas/RegisterUserOnChainReqBody",
"title": "RegisterUserOnChainReqBody",
"description": "Neynar Farcaster API schema for RegisterUserOnChainReqBody",
"properties": {
"idem": {
"description": "An Idempotency key is a unique identifier for the request.\n**Note:** \n1) Pre-registration calls must be idempotent when using idempotency keys.\n2) This is used to prevent duplicate requests. Use the same idem key on retry attempts.\n3) This should be a unique identifier for each request.\n4) Recommended format is a 16-character string generated by the developer at the time of making this request.",
"type": "string"
},
"pre_registration_calls": {
"items": {
"properties": {
"allow_failure": {
"default": false,
"description": "Set it to true if you want to ignore the failure of this call. If set to false, the registration will fail if this call fails.",
"type": "boolean"
},
"data": {
"description": "Call data payload (hex-encoded)",
"pattern": "^0x[a-fA-F0-9]+$",
"type": "string"
},
"target": {
"description": "Must be on the allowed contract allowlist. Contact support for more details.",
"example": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"pattern": "^0x[a-fA-F0-9]{40}$",
"type": "string"
},
"value": {
"default": 0,
"description": "Value in wei to send with the transaction. This is not the amount of ETH that will be sent, but rather the value of the transaction.",
"minimum": 0,
"type": "integer"
}
},
"required": [
"data",
"target"
],
"type": "object"
},
"type": "array"
},
"registration": {
"properties": {
"custody_address": {
"$ref": "#/components/schemas/EthAddress"
},
"deadline": {
"example": 1715190000,
"minimum": 0,
"type": "integer"
},
"recovery_address": {
"$ref": "#/components/schemas/EthAddress"
},
"signature": {
"$ref": "#/components/schemas/PrefixedHexString"
}
},
"required": [
"deadline",
"signature",
"custody_address",
"recovery_address"
],
"type": "object"
},
"signers": {
"items": {
"properties": {
"deadline": {
"example": 1715190000,
"minimum": 0,
"type": "integer"
},
"key_type": {
"default": 1,
"minimum": 1,
"type": "integer"
},
"metadata": {
"$ref": "#/components/schemas/PrefixedHexString"
},
"metadata_type": {
"default": 1,
"minimum": 1,
"type": "integer"
},
"public_key": {
"$ref": "#/components/schemas/Ed25519PublicKey"
},
"signature": {
"$ref": "#/components/schemas/PrefixedHexString"
}
},
"required": [
"signature",
"metadata",
"public_key",
"deadline"
],
"type": "object"
},
"type": "array"
},
"storage_units": {
"example": 2,
"minimum": 0,
"type": "integer"
}
},
"required": [
"registration"
],
"type": "object"
}