Skip to main content
GET
/
v3
/
identity
/
{identityId}
Get Identity
package main

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

func main() {

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

	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))

}
{
  "createdAt": 1747671792,
  "carrier": "Verizon",
  "phoneNumber": "2001001695",
  "countryCode": "US",
  "identityId": "e0f78bc2-f748-4eda-9d29-d756844507fc",
  "lineType": "mobile",
  "active": true,
  "deviceId": "bf9ea15d-7dfa-4bb4-a64c-6c26b53472fc",
  "creationString": "2025-05-19T16:23:12.475Z",
  "clientCustomerId": "e0f78bc2-f748-4eda-9d29-d756844507fc"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
identityId
string
required

A unique Prove-generated identifier for the enrolled identity.

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.

Response

V3GetIdentityResponse

Response body for the Identity API GET method.

​
phoneNumber
string
required

The number of the mobile phone. Refer to the Prove Pre-Fill with Mobile Auth and Prove Identity with Mobile Auth documentation for situations where this field is not required. US phone numbers can be passed in with or without a leading +1. Acceptable characters are: alphanumeric with symbols '+'.

Example:

"2001001695"

​
active
boolean

If true, the identity is currently active.

Example:

true

​
carrier
string

The carrier associated with this identity/mobile number.

Example:

"Verizon"

​
clientCustomerId
string

A client-generated unique ID for a specific customer. This can be used by clients to link calls related to the same customer, across different requests or sessions. The format of this ID is defined by the client - Prove recommends using a GUID, but any format can be accepted.

Example:

"e0f78bc2-f748-4eda-9d29-d756844507fc"

​
countryCode
string

The country code associated with the customer/identity. This will be in the ISO 3166-1 A-2 format.

Example:

"US"

​
createdAt
integer

The time that this identity was created, in seconds since the Unix epoch.

Example:

1747671792

​
creationString
string

The time that this identity was created, in ISO 8601 format.

Example:

"2025-05-19T16:23:12.475Z"

​
deviceId
string

A string that is the unique identifier for the Prove Key on the device. Only applicable if you are leveraging Prove Unify.

Example:

"bf9ea15d-7dfa-4bb4-a64c-6c26b53472fc"

​
identityId
string

A unique Prove-generated identifier for the enrolled identity. This is a UUID that can be used to reference the identity in future requests.

Example:

"e0f78bc2-f748-4eda-9d29-d756844507fc"

​
lineType
string

The type of line associated with this identity/mobile number.

Example:

"mobile"

⌘I