Skip to main content
GET
/
v3
/
identity
Batch Get Identities
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.uat.proveapis.com/v3/identity"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
{
  "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

V3BatchGetIdentitiesResponse

Response body for the V3 Batch Get Identities API.

​
results
object[]
required

The list of identity IDs associated with the client.

Example:
[
  {
    "identityId": "4a6317c1-4855-4900-b369-bed138f4ec00"
  },
  {
    "identityId": "e53c0597-1cce-4d8f-bd1b-e0a10f875ac9"
  }
]
​
lastKey
string

A pagination token for callers that have more identities left to return. Pass this back in directly to the Get Batch API with the startKey query parameter to get the next page of results.

Example:

"fNqtI2wVPka+yAFC5qRtrQ=="