Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.prove.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

  • Consumer consent — Obtain consent from the consumer as required for your use case and applicable law.
  • Access token — Obtain a bearer token using Prove OAuth (Authentication). Use the same token for /verify (if applicable), GET /v3/discover, and GET /v3/fetch.
  • proveId — Complete a verification (or other flow) that returns proveId. For Sandbox ProveX testing with Verified Users, follow Verified Users Verify using verificationType: verifiedUser and the test users on that page.

​
Implementation steps

1

Authenticate and Verify Consumer

Run authentication and/or verification for the end user based on your use case and persist the proveId from a successful response.
2

Call /discover

Call GET /v3/discover with the consumer’s proveId to list marketplace attribute UUIDs and issuer names, and to confirm whether partner-linked data exists. Call this before /fetch so you know which vendor options are in scope. Use the same bearer token in the Authorization header.
Request
curl -X GET "https://platform.uat.proveapis.com/v3/discover?proveId=41570934-6d6b-476d-9425-3eaf305cf2e5" \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>"
Response
{
  "results": [
    {
      "attributeId": "550e8400-e29b-41d4-a716-446655440000",
      "issuerId": "AcmeWallet"
    }
  ]
}
See GET /v3/discover for query parameters and the full response schema.
3

Call /fetch

After /discover, call GET /v3/fetch with their proveId and the attributeId values they chose from the /discover results. Each item in results includes attributeValue (for example a wallet ID for that issuer). Use the same bearer token as for /verify and /discover.
Request
curl -X GET "https://platform.uat.proveapis.com/v3/fetch?proveId=41570934-6d6b-476d-9425-3eaf305cf2e5&attributeId=550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>"
Response
{
  "results": [
      {
        "attributeId": "550e8400-e29b-41d4-a716-446655440000",
        "issuerId": "AcmeWallet",
        "attributeValue": "ext-wallet-992834"
      }
  ]
}
After a successful /fetch response, take attributeValue from the result and input it into your partner integration—for example by passing it to the partner SDK, API, or account flow so the consumer can continue in that marketplace.
See GET /v3/fetch for query parameters and the full response schema. Responses will vary depending on the partner data is retrieved from.

​
Sandbox testing

​
Test users

The following test users are available for ProveX flows that start with /v3/verify in the Sandbox environment. Use them to exercise successful and failed verification for /discover and /fetch.
Phone NumberFirst NameLast NameExpected Outcome
2001004053ElenaColdmanSuccess
2001004054AlfNovotniFailed

​
Testing steps

Prove’s Sandbox environment requires the following testing sequence: /verify with verificationType: verifiedUser -> /discover -> /fetch.
Use test user Elena Coldman to verify a successful ProveX flow.Prerequisites
  • proveId: From a successful /v3/verify for Elena.
  • Bearer token: Keep the same access token you used for /v3/verify.
1

Call /discover

Use the proveId and the bearer token to call /discover.
curl -X GET "https://platform.uat.proveapis.com/v3/discover?proveId=550e8400-e29b-41d4-a716-446655440001" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
2

Call /fetch

Use the proveId and the bearer token to call /fetch.
curl -X GET "https://platform.uat.proveapis.com/v3/fetch?proveId=550e8400-e29b-41d4-a716-446655440001&attributeId=550e8400-e29b-41d4-a716-446655440100" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Related topics

Implement Prove Possession Using The Android SDKImplement Prove Possession Using The Web SDK