Index Service

Welcome

GET /index

Status endpoint to verify the attestation backend is functional.

Parameters:

None

Response:

{
    "success": true,
    "statusCode": 200,
    "data": "Welcome to Sign Protocol Service!",
    "message": "ok"
}

Query Schema List

GET /index/schemas

Query for a list of schemas using one or more filtering parameters. Results can be paginated with customizable page sizes.

Query Parameters:

KeyValueType

id*

onchain_evm_7001_0x7

string

page*

1

number

registrant*

0xDfc4FbbDd9C47c7976fEBb14B1D37C7f85FE299D

string

size*

100

number

mode*

onchain

"onchain"/"offchain"

* Optional parameter.

Response:

{
    "success": true,
    "statusCode": 200,
    "data": {
        "total": 20,
        "rows": [
            {
                "id": "onchain_evm_7001_0x7",
                "mode": "onchain",
                "chainType": "evm",
                "chainId": "7001",
                "schemaId": "0x7",
                "transactionHash": "0xabddd6fe182a75d61eb0feef028a71a24fbdf46e7508c519c099c9d8a5805801",
                "name": "test",
                "description": "whasa",
                "revocable": true,
                "maxValidFor": "0",
                "resolver": "0x0000000000000000000000000000000000000000",
                "registerTimestamp": "1705912991",
                "registrant": "0xDfc4FbbDd9C47c7976fEBb14B1D37C7f85FE299D",
                "data": [
                    {
                        "name": "name",
                        "type": "string"
                    },
                    {
                        "name": "count",
                        "type": "number"
                    }
                ]
            }
        ],
        "size": "1",
        "page": 1
    },
    "message": "ok"
}

Get Schema

GET /index/schemas/{id}

Retrieve the data of a schema by providing a schema ID.

Query Parameters:

KeyValueType

id

onchain_evm_80001_0x1

string

* Optional parameter.

Response:

{
    "success": true,
    "statusCode": 200,
    "data": {
        "id": "onchain_evm_80001_0x1",
        "mode": "onchain",
        "chainType": "evm",
        "chainId": "80001",
        "schemaId": "0x1",
        "transactionHash": "0x97e69df2e65e97001da22953a4376233d792c50810cf3bff0fff1a14e7374b60",
        "name": "xxx",
        "description": "",
        "revocable": true,
        "maxValidFor": "0",
        "resolver": "0x0000000000000000000000000000000000000000",
        "registerTimestamp": "1705387959",
        "registrant": "0x9854E76134e6D729A633CED51042fF653f04f4C5",
        "data": [
            {
                "name": "name",
                "type": "string"
            }
        ]
    },
    "message": "ok"
}

Query Attestations

GET /index/attestations

Query for a list of attestations using one or more filtering parameters. Results can be paginated with customizable page sizes.

Query Parameters:

KeyValueType

id*

onchain_evm_80001_0xb

string

page*

1

number

mode*

onchain

"onchain"/"offchain"

indexingValue*

0x34A6d2B552c34be8136d18773Fa79036c8315180

string

schemaId*

onchain_evm_80001_0x3

string

attester*

0x8d10d37bf3c50c9dd34a4bc70987cd60f8f4a463

string

size*

100

number

* Optional parameter.

Response:

{
    "success": true,
    "statusCode": 200,
    "data": {
        "total": 1,
        "rows": [
            {
                "id": "onchain_evm_80001_0xb",
                "mode": "onchain",
                "chainType": "evm",
                "chainId": "80001",
                "attestationId": "0xb",
                "transactionHash": "0xd6a6207a429a7fcc02dedf60db021befb3c2fd8296086f386f5595985c4ccea3",
                "indexingValue": "0x059e6B8008d34aC26581fD3ED8378AA93c7941EE",
                "schemaId": "0x1",
                "fullSchemaId": "onchain_evm_80001_0x1",
                "linkedAttestation": "",
                "attester": "0x059e6B8008d34aC26581fD3ED8378AA93c7941EE",
                "attestTimestamp": "1705485350",
                "validUntil": "0",
                "revoked": true,
                "revokeTimestamp": "1705912687",
                "revokeReason": null,
                "revokeTransactionHash": "0x031e6400760d517f2ec008e017dc3be0fecceb6b583aa61505e4f19e93c5a7b9",
                "data": "0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000033232320000000000000000000000000000000000000000000000000000000000",
                "dataLocation": "ONCHAIN",
                "extra": "{}",
                "syncAt": "1705653417309",
                "lastSyncAt": null,
                "recipients": [],
                "schema": {
                    "id": "onchain_evm_80001_0x1",
                    "mode": "onchain",
                    "chainType": "evm",
                    "chainId": "80001",
                    "schemaId": "0x1",
                    "transactionHash": "0x97e69df2e65e97001da22953a4376233d792c50810cf3bff0fff1a14e7374b60",
                    "name": "xxx",
                    "description": "",
                    "revocable": true,
                    "maxValidFor": "0",
                    "resolver": "0x0000000000000000000000000000000000000000",
                    "registerTimestamp": "1705387959",
                    "registrant": "0x9854E76134e6D729A633CED51042fF653f04f4C5",
                    "data": [
                        {
                            "name": "name",
                            "type": "string"
                        }
                    ],
                    "extra": null,
                    "syncAt": "1705932587177"
                }
            }
        ],
        "size": 100,
        "page": 1
    },
    "message": "ok"
}

Get Attestation

GET /index/attestations/{id}

Retrieve the data of an attestation by providing an attestation ID.

Query Parameters:

KeyValueType

id

onchain_evm_80001_0x3

string

* Optional parameter.

Response:

{
    "success": true,
    "statusCode": 200,
    "data": {
        "id": "onchain_evm_80001_0x3",
        "mode": "onchain",
        "chainType": "evm",
        "chainId": "80001",
        "attestationId": "0x3",
        "transactionHash": "0x9e83cc789a457e0bcaa0cd5457c6a1aae4f4db8138193a3179ef33059d82f6d6",
        "indexingValue": "0x059e6B8008d34aC26581fD3ED8378AA93c7941EE",
        "schemaId": "0x1",
        "fullSchemaId": "onchain_evm_80001_0x1",
        "linkedAttestation": "",
        "attester": "0x059e6B8008d34aC26581fD3ED8378AA93c7941EE",
        "attestTimestamp": "1705485146",
        "validUntil": "0",
        "revoked": false,
        "revokeTimestamp": null,
        "revokeReason": null,
        "revokeTransactionHash": "",
        "data": "0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000033232320000000000000000000000000000000000000000000000000000000000",
        "dataLocation": "ONCHAIN",
        "extra": "{}",
        "syncAt": "1705653417309",
        "lastSyncAt": null,
        "recipients": [],
        "schema": {
            "id": "onchain_evm_80001_0x1",
            "mode": "onchain",
            "chainType": "evm",
            "chainId": "80001",
            "schemaId": "0x1",
            "transactionHash": "0x97e69df2e65e97001da22953a4376233d792c50810cf3bff0fff1a14e7374b60",
            "name": "xxx",
            "description": "",
            "revocable": true,
            "maxValidFor": "0",
            "resolver": "0x0000000000000000000000000000000000000000",
            "registerTimestamp": "1705387959",
            "registrant": "0x9854E76134e6D729A633CED51042fF653f04f4C5",
            "data": [
                {
                    "name": "name",
                    "type": "string"
                }
            ],
            "extra": null,
            "syncAt": "1705932587177"
        }
    },
    "message": "ok"
}

Last updated