Fetcch
  • 🟠What is Fetcch?
  • 🚅Pull Payments Layer
    • 🔭Overview
    • ❓How it works?
      • 👮Specification
      • 🎒How is it stored?
      • 🌊Pull Payments Flow
    • 🔐Security
      • 🎒Storage
      • ⛓️Cross Chain
    • ⚔️Use Pull Payments
  • 🆔Universal Identity Layer
    • 🔭Overview
    • ❓How it works?
      • 👮Specifications
      • 🎒How is it stored?
      • 🌊Identity Flow
    • 🔐Security
      • 🎒Storage
    • ⚔️Use Fetcch Identity
  • 🏗️Data Structures
    • 📖Address Books
      • 🔭Overview
      • 🎒Storage
  • 💻How to integrate?
    • ✈️Quickstart
    • ⛷️SDK Quickstart
    • 🔓Blockchain
    • ✨Guides
      • 🙇Authentication
      • 😁Identity
        • How to resolve identity?
        • How to create identity?
        • How to update identity?
      • 🤌Transaction Requests
        • How to get transaction requests?
        • How to create transaction request?
        • How to build transaction?
        • How to resolve transaction request?
      • 🫂Address Books
        • How to get address books?
        • How to create address books?
        • How to share address book?
        • How to accept address book request?
      • ⚙️Utility
        • How to sign messages?
          • EVM
          • Solana
          • Aptos
          • EIP-6492 Compatible Signatures
        • How to generate & verify proofs for identity?
    • 📖API Reference
      • ☢️Troubleshooting Errors
      • 🟢OpenAPI Specs
  • 🐧Open Source
    • 📸@fetcch/resolve-names
  • 🥶FAQs
    • FAQs
Powered by GitBook
On this page
  1. How to integrate?
  2. Guides
  3. Address Books

How to share address book?

Sharing address books has never been easy

PreviousHow to create address books?NextHow to accept address book request?

Last updated 1 year ago

Arrange Data

Arrange data in the format

{
    "toId": "string"
    "book": number
    "access": "READ" | "READWRITE"
}

Generate & Sign Message

Call this API to get the message

Sign the above message by following signature guidelines mentioned here according to the chain you are using

Call API

Websockets & Webhooks

Coming soon...

💻
✨
🫂

Generate message for sharing address book

post

/address-books/request/message

Authorizations
Body
idinteger
bookintegerrequired
tostring
pendingboolean · default: true
acceptedboolean
createdAtstring · date-time
updatedAtstring · date-timerequired
accessstring · enumrequired
Options: READ, READWRITE
Responses
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://sandbox-api.fetcch.xyz/v1/address-books/request/message' \
  --header 'secret-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"book":1,"pending":true,"accepted":false,"updatedAt":"2025-02-23T09:36:06.668Z","access":"READ"}'
200
400
401
{
  "status": 1,
  "timestamp": "2025-02-23T09:36:06.668Z",
  "data": {
    "message": "text",
    "request": {
      "id": 1,
      "bookId": 1,
      "book": {
        "id": 1,
        "name": "text",
        "ownerId": "text",
        "owner": {
          "owner": "text",
          "ownerId": "text",
          "ownerIdentity": {
            "id": "text",
            "identifier": "text",
            "providerId": "text",
            "provider": "[Circular Reference]",
            "defaultAddress": "text",
            "default": {
              "address": "text",
              "chain": {
                "id": 1,
                "name": "text",
                "symbol": "text",
                "icon": "text",
                "shortName": "text",
                "infoURL": "text",
                "chainId": 1,
                "updatedAt": "2025-02-23T09:36:06.668Z",
                "createdAt": "2025-02-23T09:36:06.668Z",
                "type": "EVM",
                "rpc": [
                  "text"
                ]
              },
              "chainId": 1,
              "isMultisig": false,
              "isSmartContractWallet": false,
              "walletId": {
                "id": 1,
                "name": "text",
                "symbol": "text",
                "icon": "text",
                "shortName": "text",
                "infoURL": "text",
                "chainId": 1,
                "updatedAt": "2025-02-23T09:36:06.668Z",
                "createdAt": "2025-02-23T09:36:06.668Z",
                "type": "EVM",
                "rpc": [
                  "text"
                ]
              },
              "updatedAt": "2025-02-23T09:36:06.668Z",
              "createdAt": "2025-02-23T09:36:06.668Z"
            },
            "nonce": 0,
            "currentSignature": "text",
            "previousSignature": "text",
            "isContract": false,
            "syncedAt": "2025-02-23T09:36:06.668Z",
            "createdAt": "2025-02-23T09:36:06.668Z",
            "secondary": "[Circular Reference]"
          },
          "createdAt": "2025-02-23T09:36:06.668Z",
          "updatedAt": "2025-02-23T09:36:06.668Z"
        },
        "createdAt": "2025-02-23T09:36:06.668Z",
        "updatedAt": "2025-02-23T09:36:06.668Z",
        "addresses": [
          {
            "id": 1,
            "address": "text",
            "name": "text",
            "addressBookId": 1,
            "addressBook": "[Circular Reference]",
            "chainType": "EVM"
          }
        ],
        "walletIds": [
          {
            "id": 1,
            "walletId": "text",
            "wallet": "[Circular Reference]",
            "name": "text",
            "addressBookId": 1,
            "addressBook": "[Circular Reference]",
            "createdAt": "2025-02-23T09:36:06.668Z",
            "updatedAt": "2025-02-23T09:36:06.668Z"
          }
        ],
        "requests": [
          {
            "id": 1,
            "bookId": 1,
            "book": "[Circular Reference]",
            "toId": "text",
            "to": "[Circular Reference]",
            "pending": true,
            "accepted": false,
            "createdAt": "2025-02-23T09:36:06.668Z",
            "updatedAt": "2025-02-23T09:36:06.668Z",
            "access": "READ"
          }
        ]
      },
      "toId": "text",
      "to": {
        "owner": "text",
        "ownerId": "text",
        "ownerIdentity": {
          "id": "text",
          "identifier": "text",
          "providerId": "text",
          "provider": "[Circular Reference]",
          "defaultAddress": "text",
          "default": {
            "address": "text",
            "chain": {
              "id": 1,
              "name": "text",
              "symbol": "text",
              "icon": "text",
              "shortName": "text",
              "infoURL": "text",
              "chainId": 1,
              "updatedAt": "2025-02-23T09:36:06.668Z",
              "createdAt": "2025-02-23T09:36:06.668Z",
              "type": "EVM",
              "rpc": [
                "text"
              ]
            },
            "chainId": 1,
            "isMultisig": false,
            "isSmartContractWallet": false,
            "walletId": {
              "id": 1,
              "name": "text",
              "symbol": "text",
              "icon": "text",
              "shortName": "text",
              "infoURL": "text",
              "chainId": 1,
              "updatedAt": "2025-02-23T09:36:06.668Z",
              "createdAt": "2025-02-23T09:36:06.668Z",
              "type": "EVM",
              "rpc": [
                "text"
              ]
            },
            "updatedAt": "2025-02-23T09:36:06.668Z",
            "createdAt": "2025-02-23T09:36:06.668Z"
          },
          "nonce": 0,
          "currentSignature": "text",
          "previousSignature": "text",
          "isContract": false,
          "syncedAt": "2025-02-23T09:36:06.668Z",
          "createdAt": "2025-02-23T09:36:06.668Z",
          "secondary": "[Circular Reference]"
        },
        "createdAt": "2025-02-23T09:36:06.668Z",
        "updatedAt": "2025-02-23T09:36:06.668Z"
      },
      "pending": true,
      "accepted": false,
      "createdAt": "2025-02-23T09:36:06.668Z",
      "updatedAt": "2025-02-23T09:36:06.668Z",
      "access": "READ"
    }
  }
}

Successful response

Create address book request

post

/address-books/request

Authorizations
Body
idinteger
signaturestring
bookintegerrequired
tostring
pendingboolean · default: true
acceptedboolean
createdAtstring · date-time
updatedAtstring · date-timerequired
accessstring · enumrequired
Options: READ, READWRITE
Responses
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://sandbox-api.fetcch.xyz/v1/address-books/request' \
  --header 'secret-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"book":1,"pending":true,"accepted":false,"updatedAt":"2025-02-23T09:36:06.668Z","access":"READ"}'
200
400
401
{
  "status": 1,
  "timestamp": "2025-02-23T09:36:06.668Z",
  "data": {
    "message": "text",
    "request": {
      "id": 1,
      "bookId": 1,
      "book": {
        "id": 1,
        "name": "text",
        "ownerId": "text",
        "owner": {
          "owner": "text",
          "ownerId": "text",
          "ownerIdentity": {
            "id": "text",
            "identifier": "text",
            "providerId": "text",
            "provider": "[Circular Reference]",
            "defaultAddress": "text",
            "default": {
              "address": "text",
              "chain": {
                "id": 1,
                "name": "text",
                "symbol": "text",
                "icon": "text",
                "shortName": "text",
                "infoURL": "text",
                "chainId": 1,
                "updatedAt": "2025-02-23T09:36:06.668Z",
                "createdAt": "2025-02-23T09:36:06.668Z",
                "type": "EVM",
                "rpc": [
                  "text"
                ]
              },
              "chainId": 1,
              "isMultisig": false,
              "isSmartContractWallet": false,
              "walletId": {
                "id": 1,
                "name": "text",
                "symbol": "text",
                "icon": "text",
                "shortName": "text",
                "infoURL": "text",
                "chainId": 1,
                "updatedAt": "2025-02-23T09:36:06.668Z",
                "createdAt": "2025-02-23T09:36:06.668Z",
                "type": "EVM",
                "rpc": [
                  "text"
                ]
              },
              "updatedAt": "2025-02-23T09:36:06.668Z",
              "createdAt": "2025-02-23T09:36:06.668Z"
            },
            "nonce": 0,
            "currentSignature": "text",
            "previousSignature": "text",
            "isContract": false,
            "syncedAt": "2025-02-23T09:36:06.668Z",
            "createdAt": "2025-02-23T09:36:06.668Z",
            "secondary": "[Circular Reference]"
          },
          "createdAt": "2025-02-23T09:36:06.668Z",
          "updatedAt": "2025-02-23T09:36:06.668Z"
        },
        "createdAt": "2025-02-23T09:36:06.668Z",
        "updatedAt": "2025-02-23T09:36:06.668Z",
        "addresses": [
          {
            "id": 1,
            "address": "text",
            "name": "text",
            "addressBookId": 1,
            "addressBook": "[Circular Reference]",
            "chainType": "EVM"
          }
        ],
        "walletIds": [
          {
            "id": 1,
            "walletId": "text",
            "wallet": "[Circular Reference]",
            "name": "text",
            "addressBookId": 1,
            "addressBook": "[Circular Reference]",
            "createdAt": "2025-02-23T09:36:06.668Z",
            "updatedAt": "2025-02-23T09:36:06.668Z"
          }
        ],
        "requests": [
          {
            "id": 1,
            "bookId": 1,
            "book": "[Circular Reference]",
            "toId": "text",
            "to": "[Circular Reference]",
            "pending": true,
            "accepted": false,
            "createdAt": "2025-02-23T09:36:06.668Z",
            "updatedAt": "2025-02-23T09:36:06.668Z",
            "access": "READ"
          }
        ]
      },
      "toId": "text",
      "to": {
        "owner": "text",
        "ownerId": "text",
        "ownerIdentity": {
          "id": "text",
          "identifier": "text",
          "providerId": "text",
          "provider": "[Circular Reference]",
          "defaultAddress": "text",
          "default": {
            "address": "text",
            "chain": {
              "id": 1,
              "name": "text",
              "symbol": "text",
              "icon": "text",
              "shortName": "text",
              "infoURL": "text",
              "chainId": 1,
              "updatedAt": "2025-02-23T09:36:06.668Z",
              "createdAt": "2025-02-23T09:36:06.668Z",
              "type": "EVM",
              "rpc": [
                "text"
              ]
            },
            "chainId": 1,
            "isMultisig": false,
            "isSmartContractWallet": false,
            "walletId": {
              "id": 1,
              "name": "text",
              "symbol": "text",
              "icon": "text",
              "shortName": "text",
              "infoURL": "text",
              "chainId": 1,
              "updatedAt": "2025-02-23T09:36:06.668Z",
              "createdAt": "2025-02-23T09:36:06.668Z",
              "type": "EVM",
              "rpc": [
                "text"
              ]
            },
            "updatedAt": "2025-02-23T09:36:06.668Z",
            "createdAt": "2025-02-23T09:36:06.668Z"
          },
          "nonce": 0,
          "currentSignature": "text",
          "previousSignature": "text",
          "isContract": false,
          "syncedAt": "2025-02-23T09:36:06.668Z",
          "createdAt": "2025-02-23T09:36:06.668Z",
          "secondary": "[Circular Reference]"
        },
        "createdAt": "2025-02-23T09:36:06.668Z",
        "updatedAt": "2025-02-23T09:36:06.668Z"
      },
      "pending": true,
      "accepted": false,
      "createdAt": "2025-02-23T09:36:06.668Z",
      "updatedAt": "2025-02-23T09:36:06.668Z",
      "access": "READ"
    }
  }
}

Successful response

  • Arrange Data
  • Generate & Sign Message
  • POSTGenerate message for sharing address book
  • Call API
  • POSTCreate address book request
  • Websockets & Webhooks