Endpoints

Fetch a List of Claims

GEThttps://api.com/claims/collections/{id}/claims?type={type}&status={status}&take={take}&cursor={cursor}

Path parameters

id*string

Claims are made in a Claim Collection. Each Claim Collection is identified by an id.

Query parameters

Response

200400500

200

Body

application/json

dataarray of object

metaDataobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.com/claims/collections/{id}/claims?type={type}&status={status}&take={take}&cursor={cursor}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "data": [
    {
      "aid": 1,
      "claimId": "bafkreidknrrfgn6dwkdhz5n4hqqgzom3wpkymxrkpsibgr5tmqwznoorfq",
      "agentDid": "did:x:zQ3shdXFA6PUS5fQ9vUZJCF6TqtXo4mNzUCvvGiFCdWDJLfvg",
      "agentAddress": "ixo1f3qz60r02avtrlur33ezmhpqllv093g9wej7d2",
      "submissionDate": "2023-06-19T09:39:08.106Z",
      "paymentsStatus": "{\"submission\":\"NO_PAYMENT\",\"evaluation\":\"NO_PAYMENT\",\"approval\":\"NO_PAYMENT\",\"rejection\":\"NO_PAYMENT\"}",
      "collectionId": "1",
      "schemaType": "FuelPurchase",
      "evaluation": {
        "aid": 1,
        "collectionId": "1",
        "oracle": "did:ixo:entity:f2235630689d4b54a561ca3de57494f6",
        "agentDid": "did:x:zQ3shnV9n5gHhqpRE79YK8raDBni5mMVsL2hUzcNMGj527aSP",
        "agentAddress": "ixo1r8lz3p6acxggyuyy60y7pldd8mwzl7rkntwqwd",
        "status": 1,
        "reason": 1,
        "verificationProof": "proof",
        "amount": "[]",
        "evaluationDate": "2023-06-19T09:39:13.852Z",
        "claimId": "bafkreidknrrfgn6dwkdhz5n4hqqgzom3wpkymxrkpsibgr5tmqwznoorfq"
      }
    }
  ],
  "metaData": {
    "cursor": 1,
    "hasNextPaeg": true,
    "schemaTypesLoaded": true
  }
}

Fetch Individual Claim

GEThttps://api.com/claims/{id}/data

Path parameters

id*string

Unique identifier of the Claim that will returned.

Response

200400500

200

Body

application/json

@contextarray

idstring

Example: "uuid"

typearray of string

issuerstring

Example: "did:ixo:entity:123..."

issuanceDatestring

Example: "2023-01-01T19:23:24Z"

credentialSubjectobject

proofobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.com/claims/{id}/data', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "@context": [],
  "id": "uuid",
  "type": [
    "VerifiableCredential"
  ],
  "issuer": "did:ixo:entity:123...",
  "issuanceDate": "2023-01-01T19:23:24Z",
  "credentialSubject": {
    "id": "did:ixo:entity:abc123",
    "type": [
      "ixo:entity"
    ],
    "claim": {
      "id": "protocol:FuelPurchase",
      "type": "claim:FuelPurchase",
      "project": {
        "id": "web3:...",
        "type": "claim:GasifyingBiomass",
        "credential": {
          "id": "did:ixo:entity:...#ProjectCredential",
          "type": [
            "VerifiableCredential"
          ],
          "issuer": "did:ixo:entity:....",
          "proof": ""
        }
      },
      "location": {
        "country": "ZM",
        "region": "Africa",
        "setting": "Domestic"
      },
      "product": {
        "id": "web3:...",
        "type": [
          "claim:CookingFuel"
        ],
        "producer": "Emerging Cooking Solutions Zambia",
        "distributor": "Emerging Cooking Solutions Zambia",
        "quantity": {
          "amount": "50",
          "units": "kg"
        }
      }
    },
    "evidence": {
      "id": "<https://api.supamoto.app/api/v2/..>",
      "type": [
        "claim:PaymentTransaction"
      ],
      "payment": {
        "identifier": "MP220804.0000.D00000",
        "name": "TransactionId",
        "method": "telco",
        "provider": "Airtel",
        "amount": {
          "value": 8000,
          "currency": "MWK",
          "dateTime": "2023-01-01T19:23:24Z"
        }
      }
    }
  },
  "proof": {}
}

Certify Claims

POSThttps://api.com/claims/certify

Body

application/json

type*enum

Type defines the specific VerifiableCredential for this Claim.

fuelPurchaseCERVER

collectionId*string

A Claim belongs to a specific Collection of Claims. This parameter uniquely identifies the Collection.

storage*enum

Storage describes the service that created the Content ID (CID) for for details associated with the Claim.

cellnodeipfs

evaluationCreds*array

Each Evaluation Credential contains the details of a Claim and the Oracle identifier.

Response

200400500

200

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://api.com/claims/certify', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "fuelPurchase",
      "collectionId": "text",
      "storage": "cellnode",
      "evaluationCreds": []
    }),
});
const data = await response.json();

Response

200400

{}

Create a Claim

POSThttps://api.com/claims/create

Body

application/json

type*enum

Type defines the specific VerifiableCredential for this Claim.

fuelPurchaseCERVER

collectionId*string

A Claim belongs to a specific Collection of Claims. This parameter uniquely identifies the Collection.

storage*enum

Storage describes the service that created the Content ID (CID) for for details associated with the Claim.

cellnodeipfs

credentialsarray

Note: Endpoint accepts either "credentials" or "generate" value. In the case where both are submitted, "credentials" will be processed. The Credentials parameter encapsulates the parameters required to create a W3C Verifiable Credential - https://www.w3.org/TR/vc-data-model/#credentials.

generateobject

Note: Endpoint accepts either "credentials" or "generate" value. In the case where both are submitted, "credentials" will be processed. The Generate parameter encapsulates the template structure for the Type selected.

Response

200400500

200

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://api.com/claims/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "fuelPurchase",
      "collectionId": "text",
      "storage": "cellnode"
    }),
});
const data = await response.json();

Response

200400

{}

Mint Tokens

POSThttps://api.com/tokens/mintFromVER

Body

application/json

name*string

Name of the tokens to mint.

claimIds*array of string

The unique identifiers for each Claim that will be used to determine the minted value.

Response

200400500

200

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://api.com/tokens/mintFromVER', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "claimIds": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

200400

{}