GET
/
v3
/
identity
/
curl --request GET \
  --url https://platform.uat.proveapis.com/v3/identity/ \
  --header 'Authorization: Bearer <token>'
{
  "lastKey": "fNqtI2wVPka+yAFC5qRtrQ==",
  "results": [
    {
      "identityId": "4a6317c1-4855-4900-b369-bed138f4ec00"
    },
    {
      "identityId": "e53c0597-1cce-4d8f-bd1b-e0a10f875ac9"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the /token endpoint. Refer to the Authentication page for more details.

Query Parameters

​
clientRequestId
string

A client-generated unique ID for a specific session. This can be used to identify specific requests. The format of this ID is defined by the client - Prove recommends using a GUID, but any format can be accepted. Do not include Personally Identifiable Information (PII) in this field.

​
limit
integer

The maximum number of identities to return per call. Default value is 100.

​
startKey
string

The pagination token for the GET /v3/identity API. Use this to retrieve the next page of results after a previous call to GET /v3/identity. This token is returned as lastKey in the GET /v3/identity API response - pass it in directly as startKey to get the next page of results.

​
showInactive
boolean

Whether to show identities associated with the current client that are currently marked as inactive. Default value is false.

Response

200
application/json

V3BatchGetIdentitiesResponse

Response body for the V3 Batch Get Identities API.