Filter identity

This endpoint allows you to filter and retrieve a list of identity tags based on specific query parameters.

HTTP Request
GET {baseurl}/v1/api/identity/filter

Query Parameters

Parameter	Type	Required	Description
customer	string	No	The ID of the customer for whose identity tags should be retrieved.
id	string	No	The unique identifier of a specific identity tag to retrieve.
tag	string	No	A distinctive tag used to filter identity tags.

Example Request

curl

curl -X GET "{baseurl}/v1/api/identity/filter?customer=6791457be570f7f292f1fe23&tag=SomeTag" \
-H "Content-Type: application/json" \
-H "x-api-key: {API-KEY}"

Notes

• At least one query parameter (customer, id, or tag) must be provided.
• Ensure the x-api-key header is included and valid for authentication.
• The customer parameter must correspond to an existing customer in the system.
• The tag parameter can be used to filter identity tags with a specific tag.

Sample Response

{
    "id": "string",
    "organization": "string",
    "tag": "string",
    "customer": "string",
    "Artifacts": ["string"],
    "verified": true,
    "createdAt": "string",
    "updatedAt": "string"
}