Fetch a Claim

`GET` request to `/claim/:id` to fetch a Claim that matches the provided `id`.

GET to /claim/:id

Retrieves a Claim that matches the provided id.

GET https://api.intuition.systems/claim/:id

Fetch

   await fetch(`${apiUrl}/claim/${id}`, {
      method: 'GET',
      "headers": {
        "Content-Type": "application/json",
        "x-api-key": <API_KEY>
      },
    })

Curl

curl "https://api.intuition.systems/claim/<id>" \
     -H "Content-Type: application/json" \
     -H "x-api-key: <API_Key>" \
     -X GET

Security

This request requires a valid API Key to be included with each request.

Headers

• Content-Type: application/json

• x-api-key: <API_Key>

Path Parameters

Parameter	Description
id	string - Required The claim_id for the Identity you want to fetch. Example: bxxxxxxx-6xxx-4xxx-8xxx-3xxxxxxxxxxx

Response

If a Claim is found for the id you'll receive back a Claim object.

{
 
},

Here is an example Zod schema and TypeScript interface you can use for the Identity:

Zod

export const ClaimSchema = z.object({
  claim_id: z.string(),
  vault_id: z.string(),
  counter_vault_id: z.string(),
  created_at: z.string().transform((date) => {
    const d = new Date(Number.parseInt(date))
    return d.toISOString()
  }), // unix timestamp
  updated_at: z.string(), // unix timestamp (last claim position update)
  creator: EmbedUserUserAggregatesSchema.optional(),
  subject: IdentitySchema,
  predicate: IdentitySchema,
  object: IdentitySchema,
  status: z.enum(['pending', 'complete']),
  for_num_positions: z.number(),
  for_assets_sum: z.string(), // bigint
  for_conviction_sum: z.string(), // bigint
  for_conviction_price: z.string(), // bigint
  against_num_positions: z.number(),
  against_assets_sum: z.string(), // bigint
  against_conviction_sum: z.string(), // bigint
  against_conviction_price: z.string(), // bigint
})

Interface

 // if using Zod, you can directly infer:
 
export type Claim = z.infer<typeof ClaimSchema>

// used in another interface:

interface OffChainClaimFetcherData {
  success: 'success' | 'error'
  claim: Claim
}

// if not using Zod, here's an example of the Claim type:

type Claim = {
        claim_id: string;
        vault_id: string;
        created_at: string;
        updated_at: string;
    };
}

Response Codes

Code	Description
200	Claim object that matches the provided id
404	No Claim found for the provided id