How to update identity?

Process of updating an identity

Arrange Identity

Arrange identity in the format

• If want to remove addresses from secondary, do not add them in the list

• If want to add new addresses in secondary, add them in secondary list

• If want to keep some addresses in secondary, then keep them in the data

{
  "id": "string",
  "identifier": "string",
  "provider": "string",
  "default": {
    "address": "address",
    "chain": number,
    "isContract": boolean
  },
  "secondary": [
    {
      "address": "address",
      "chain": number,
      "isContract": boolean
    },
    {
      "address": "address",
      "chain": number,
      "isContract": boolean
    }
  ]
}

Generate Message

Using the above arranged identity, generate a message using the below endpoint and sign it using default address by following guide for respective chains

Generate Message

POSThttps://sandbox-api.fetcch.xyz/v1/identity/generate-message

Body

application/json

id*string

identifier*string

provider*string

default*DefaultAddress (object)

secondaryarray of SecondaryAddress (object)

currentSignaturestring

previousSignaturestring

Response

200400401

Body

application/json

dataGenerateMessage (object)

statusinteger

timestampstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://sandbox-api.fetcch.xyz/v1/identity/generate-message', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "identifier": "text",
      "provider": "text",
      "default": {}
    }),
});
const data = await response.json();

Response

200400401

{
  "data": {
    "message": "text",
    "identity": {
      "id": "text",
      "identifier": "text",
      "providerId": "text",
      "provider": {
        "id": "text",
        "logo": "text",
        "apiKey": "text",
        "delimiter": "text",
        "txHash": "text",
        "registry": [
          {
            "address": "text",
            "chainType": "EVM",
            "txHash": "text",
            "providerId": "text"
          }
        ],
        "ownerId": "text",
        "updatedAt": "2024-11-21T06:58:18.794Z",
        "createdAt": "2024-11-21T06:58:18.794Z"
      },
      "defaultAddress": "text",
      "default": {
        "address": "text",
        "chain": {
          "name": "text",
          "symbol": "text",
          "icon": "text",
          "rpc": [
            "text"
          ],
          "type": "EVM",
          "shortName": "text",
          "infoURL": "text",
          "updatedAt": "2024-11-21T06:58:18.794Z",
          "createdAt": "2024-11-21T06:58:18.794Z"
        },
        "isMultisig": false,
        "isSmartContractWallet": false,
        "walletId": {
          "name": "text",
          "symbol": "text",
          "icon": "text",
          "rpc": [
            "text"
          ],
          "type": "EVM",
          "shortName": "text",
          "infoURL": "text",
          "updatedAt": "2024-11-21T06:58:18.794Z",
          "createdAt": "2024-11-21T06:58:18.794Z"
        },
        "updatedAt": "2024-11-21T06:58:18.794Z",
        "createdAt": "2024-11-21T06:58:18.794Z"
      },
      "secondary": [
        {
          "id": "text",
          "address": "text",
          "isMultisig": false,
          "isSmartContractWallet": false,
          "chain": {
            "name": "text",
            "symbol": "text",
            "icon": "text",
            "rpc": [
              "text"
            ],
            "type": "EVM",
            "shortName": "text",
            "infoURL": "text",
            "updatedAt": "2024-11-21T06:58:18.794Z",
            "createdAt": "2024-11-21T06:58:18.794Z"
          },
          "walletId": "text",
          "updatedAt": "2024-11-21T06:58:18.794Z",
          "createdAt": "2024-11-21T06:58:18.794Z"
        }
      ],
      "currentSignature": "text",
      "previousSignature": "text",
      "isContract": false,
      "syncedAt": "2024-11-21T06:58:18.794Z",
      "createdAt": "2024-11-21T06:58:18.794Z"
    }
  },
  "timestamp": "2024-11-21T06:58:18.794Z"
}

After generating message, you need to sign message using appropriate functions for respective chains, check our guide for each blockchain here

There are 2 signatures needed while updating identity

• currentSignature - Will be signed by current (new) default address

• previousSignature - Will be signed by previous (old) default address, only if default is updated

• If default isn't updated, you need to use same signature for both currentSignature and previousSignature

Update Identity

After signing the message, add the generated signature in the arranged identity, at currentSignature and previousSignature respectively

Now, data should look something like this

{
  "id": "string",
  "identifier": "string",
  "provider": "string",
  "default": {
    "address": "address",
    "chain": number,
    "isMultisig": boolean,
    "isSmartContractWallet": boolean
  },
  "secondary": [
    {
      "address": "address",
      "chain": number,
      "isMultisig": boolean,
      "isSmartContractWallet": boolean
    },
    {
      "address": "address",
      "chain": number,
      "isMultisig": boolean,
      "isSmartContractWallet": boolean
    }
  ],
  "currentSignature": "string",
  "previousSignature": "string"
}

Call Update Identity API

Important Note

• If default chain is APTOS, then while calling this API, swap default address with public key of the same address, so that we can easily verify signatures

• If default is changing in this request, then send previous default address's public key in extraData: { publicKey: "" }

• For example

  • satyam@martian has APTOS has default chain

  • In this request, we are updating it to EVM

  • Signed message using EVM address will be in currentSignature

  • Signed message using APTOS address will be in previousSignature

  • To verify previousSignature, we need to have publicKey of the APTOS address, which we will send in extraData

So now, data will look something like this

{
  "id": "string",
  "identifier": "string",
  "provider": "string",
  "default": {
    "address": "address",
    "chain": number,
    "isMultisig": boolean,
    "isSmartContractWallet": boolean
  },
  "secondary": [
    {
      "address": "address",
      "chain": number,
      "isMultisig": boolean,
      "isSmartContractWallet": boolean
    },
    {
      "address": "address",
      "chain": number,
      "isMultisig": boolean,
      "isSmartContractWallet": boolean
    }
  ],
  "currentSignature": "string",
  "previousSignature": "string",
  "extraData": {
    "publicKey": "string"
  }
}

Update Identity

PATCHhttps://sandbox-api.fetcch.xyz/v1/identity

Body

application/json

id*string

default*DefaultAddress (object)

secondaryarray of SecondaryAddress (object)

currentSignature*string

previousSignaturestring

Response

200400401

Body

application/json

id*string

identifier*string

providerId*string

providerProvider (object)

defaultAddress*string

defaultDefaultAddress (object)

secondaryarray of OtherAddress (object)

nonceinteger

currentSignature*string

previousSignaturestring

isContractboolean

syncedAt*string (date-time)

createdAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://sandbox-api.fetcch.xyz/v1/identity', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "default": {},
      "currentSignature": "text"
    }),
});
const data = await response.json();

Response

200400401

{
  "id": "text",
  "identifier": "text",
  "providerId": "text",
  "provider": {
    "id": "text",
    "logo": "text",
    "apiKey": "text",
    "delimiter": "text",
    "txHash": "text",
    "registry": [
      {
        "address": "text",
        "chainType": "EVM",
        "txHash": "text",
        "providerId": "text"
      }
    ],
    "ownerId": "text",
    "updatedAt": "2024-11-21T06:58:18.794Z",
    "createdAt": "2024-11-21T06:58:18.794Z"
  },
  "defaultAddress": "text",
  "default": {
    "address": "text",
    "chain": {
      "name": "text",
      "symbol": "text",
      "icon": "text",
      "rpc": [
        "text"
      ],
      "type": "EVM",
      "shortName": "text",
      "infoURL": "text",
      "updatedAt": "2024-11-21T06:58:18.794Z",
      "createdAt": "2024-11-21T06:58:18.794Z"
    },
    "isMultisig": false,
    "isSmartContractWallet": false,
    "walletId": {
      "name": "text",
      "symbol": "text",
      "icon": "text",
      "rpc": [
        "text"
      ],
      "type": "EVM",
      "shortName": "text",
      "infoURL": "text",
      "updatedAt": "2024-11-21T06:58:18.794Z",
      "createdAt": "2024-11-21T06:58:18.794Z"
    },
    "updatedAt": "2024-11-21T06:58:18.794Z",
    "createdAt": "2024-11-21T06:58:18.794Z"
  },
  "secondary": [
    {
      "id": "text",
      "address": "text",
      "isMultisig": false,
      "isSmartContractWallet": false,
      "chain": {
        "name": "text",
        "symbol": "text",
        "icon": "text",
        "rpc": [
          "text"
        ],
        "type": "EVM",
        "shortName": "text",
        "infoURL": "text",
        "updatedAt": "2024-11-21T06:58:18.794Z",
        "createdAt": "2024-11-21T06:58:18.794Z"
      },
      "walletId": "text",
      "updatedAt": "2024-11-21T06:58:18.794Z",
      "createdAt": "2024-11-21T06:58:18.794Z"
    }
  ],
  "currentSignature": "text",
  "previousSignature": "text",
  "isContract": false,
  "syncedAt": "2024-11-21T06:58:18.794Z",
  "createdAt": "2024-11-21T06:58:18.794Z"
}

Identity should now be created, if faced with any error, check our troubleshooting guide or ask in our discord

Resolve Identity

Get Identity

GEThttps://sandbox-api.fetcch.xyz/v1/identity

Query parameters

Response

200400401

Body

application/json

dataIdentity (object)

statusinteger

timestampstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://sandbox-api.fetcch.xyz/v1/identity', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

{
  "data": {
    "id": "text",
    "identifier": "text",
    "providerId": "text",
    "provider": {
      "id": "text",
      "logo": "text",
      "apiKey": "text",
      "delimiter": "text",
      "txHash": "text",
      "registry": [
        {
          "address": "text",
          "chainType": "EVM",
          "txHash": "text",
          "providerId": "text"
        }
      ],
      "ownerId": "text",
      "updatedAt": "2024-11-21T06:58:18.794Z",
      "createdAt": "2024-11-21T06:58:18.794Z"
    },
    "defaultAddress": "text",
    "default": {
      "address": "text",
      "chain": {
        "name": "text",
        "symbol": "text",
        "icon": "text",
        "rpc": [
          "text"
        ],
        "type": "EVM",
        "shortName": "text",
        "infoURL": "text",
        "updatedAt": "2024-11-21T06:58:18.794Z",
        "createdAt": "2024-11-21T06:58:18.794Z"
      },
      "isMultisig": false,
      "isSmartContractWallet": false,
      "walletId": {
        "name": "text",
        "symbol": "text",
        "icon": "text",
        "rpc": [
          "text"
        ],
        "type": "EVM",
        "shortName": "text",
        "infoURL": "text",
        "updatedAt": "2024-11-21T06:58:18.794Z",
        "createdAt": "2024-11-21T06:58:18.794Z"
      },
      "updatedAt": "2024-11-21T06:58:18.794Z",
      "createdAt": "2024-11-21T06:58:18.794Z"
    },
    "secondary": [
      {
        "id": "text",
        "address": "text",
        "isMultisig": false,
        "isSmartContractWallet": false,
        "chain": {
          "name": "text",
          "symbol": "text",
          "icon": "text",
          "rpc": [
            "text"
          ],
          "type": "EVM",
          "shortName": "text",
          "infoURL": "text",
          "updatedAt": "2024-11-21T06:58:18.794Z",
          "createdAt": "2024-11-21T06:58:18.794Z"
        },
        "walletId": "text",
        "updatedAt": "2024-11-21T06:58:18.794Z",
        "createdAt": "2024-11-21T06:58:18.794Z"
      }
    ],
    "currentSignature": "text",
    "previousSignature": "text",
    "isContract": false,
    "syncedAt": "2024-11-21T06:58:18.794Z",
    "createdAt": "2024-11-21T06:58:18.794Z"
  },
  "timestamp": "2024-11-21T06:58:18.794Z"
}