Search Identities

`GET` request to `/identities/search` to search for Identities based on specific criteria.

GET to /identities/search

Searches all Identities and returns a paginated list of Identities that meet the search criteria.

GET https://api.intuition.systems/identities/search?<Query_Parameters>

Fetch

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

Curl

curl "https://api.intuition.systems/identities/search?<Query_Parameters>" \
     -H "Content-Type: application/json" \
     -H "x-api-key: <API_Key>" \
     -X GET

Replace the <API_Key> with your valid API Key.

Replace the <Query_Parameters> with query parameters you want to include.

Security

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

Headers

• Content-Type: application/json

• x-api-key: <API_Key>

Query Parameters

Parameter	Description
displayName	string - Required To search by displayName you'll need to include the value from your search input. Example: "JP"
limit	number Max number of items returned on single page Example: 1
sortBy	string Field to sort by. Default is created_at Example: "display_name"
direction	string - "desc" or "asc" Direction to sort.Default is "desc" Example: "desc"

Response

This includes the Paginated Response for Identities meeting your search criteria.

{
    "page": 1, // The current page in pagination sequence
    "limit": 100, // The max number of items returned on a single page
    "total": 50, // Total number of items 
    "data": [{}] // Array of response items
}

You'll receive back a data array that is a paginated list of all Identities that meet your search criteria.

{
  "page": 1,
  "limit": 100,
  "total": 79,
  "data": [
      {
            "id": "f9xxxxxx...",
            "identity_id": "did:intuition:ipfs:Xxx",
            "identity_hash": "x...",
            "display_name": "JP",
            "description": "It's me, JP",
            "image": "image_url",
            "creator": {
                "id": "7xxxxxxx...",
                "created_at": "2024-02-13T14:58:43.809055Z",
                "updated_at": "2024-02-13T14:58:43.809055Z",
                "last_login": "2024-02-21T18:47:26.556035Z",
                "api_key": "",
                "wallet": "0x...",
                "role": "User"
            },
            "status": "complete",
            "created_at": "2024-02-15T05:47:17.289011Z",
            "num_positions": 0,
            "updated_at": "2024-02-15T05:47:17.289011Z",
            "vault_id": "1",
            "assets_sum": "0",
            "conviction_sum": "0",
            "conviction_price": "0"
        },
  ],
}

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

First Tab

export const IdentitySchema = z.object({
  identity_id: z.string(),
  vault_id: z.string(),
  display_name: z.string(),
  description: z.string().optional(),
  image: z.string().optional(),
  corpora_id: z.string().nullish(),
  semantic: z.string().nullish(),
  external_reference: z.string().nullish(),
  creator: EmbedUserUserAggregatesSchema.optional(),
  created_at: z.string(),
  num_positions: z.number(),
  assets_sum: z.string(), // bigint
  conviction_sum: z.string(), // bigint
  conviction_price: z.string(), // bigint
  updated_at: z.string(),
  status: z.string().optional(),
  isUser: z.boolean().optional(),
  user_conviction: z.string().optional(), // bigint
  user_conviction_value: z.string().optional(), // bigint
})

Second Tab

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

// used in another interface:

interface ClaimProps {
  subject: Identity | null
  predicate: Identity | null
  object: Identity | null
}

export const UserSchema = z.object({
  did: z.string().optional(),
  wallet: z.string(),
  display_name: z.string().optional(),
  image: z.string().optional(),
  id: z.string().uuid(),
})

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

type Identity = {
    vault_id: string;
    created_at: string;
    updated_at: string;
    display_name: string;
    identity_id: string;
    num_positions: number;
    assets_sum: string;
    conviction_sum: string;
    conviction_price: string;
    updated_at: string;
    num_positions: number;
    assets_sum: string;
    conviction_sum: string;
    conviction_price: string;
    updated_at: string;
    status?: string;
    isUser?: string;
    user_conviction?: string;
    user_conviction_value?: string;
}

Response Codes

Code	Description
200	Paginated list of Identities meeting search criteria.