POST
/
v3
/
verify-status
curl --request POST \
  --url https://platform.uat.proveapis.com/v3/verify-status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "clientRequestId": "71010d88-d0e7-4a24-9297-d1be6fefde81",
  "correlationId": "713189b8-5555-4b08-83ba-75d08780aebd"
}'
{
  "success": "pending",
  "possessionResult": "pending",
  "verifyResult": "pending"
}

Welcome to the Prove Platform documentation. This documentation applies if you use the client-side SDK and Prove Platform APIs.

For access to classic documentation, contact support@prove.com or your Prove representative.

Use the following base URLs when integrating Verified Users:

https://platform.uat.proveapis.com - North America Staging Environment https://platform.proveapis.com - North America Production Environment https://platform.uat.eu.proveapis.com - European Union Staging Environment https://platform.eu.proveapis.com - European Union Production Environment

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Request body for the V3 Verify Status API

​
clientRequestId
string

Client Request ID is a client-generated unique ID for a specific request. This can be used by clients to identify specific requests made to Prove Link. The format of this ID is defined by the client - Prove recommends using a GUID, but any format can be accepted. Prove does not offer any functionality around the Client Request ID at this time, and this is expected to be added in a future release. NOTE: Do not include Personally Identifiable Information (PII) in this field.

Example:

"71010d88-d0e7-4a24-9297-d1be6fefde81"

​
correlationId
string

Correlation ID is the unique ID that Prove generates for the flow. It is returned from the v3/verify endpoint and cannot be reused outside of a single flow.

Example:

"713189b8-5555-4b08-83ba-75d08780aebd"

Response

200
application/json
Successful Request

Response body for the V3 Verify Status API

​
possessionResult
object
required

Possession Result represents the result of the Possession check. Possible values are "success", "pending", "failed", and "not applicable".

Example:

"pending"

​
success
object
required

Success is the result of the combination of Verify Result and Possession Result. Possible values are "true", "pending", and "false". The success value will be "pending" until the results of both Verify and Possession are returned or one of them fails, blocking the other.

Example:

"pending"

​
verifyResult
object
required

Verify Result represents the result of the Verify process. Possible values are "success", "pending", "failed", and "not applicable".

Example:

"pending"