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.

Identities that pass the Global Fraud Policy are automatically enrolled in Manage.

​
Prerequisites

  • Access token — Obtain a bearer token using Prove OAuth (Authentication).

​
Implementation steps

1

Gather Required Inputs

Collect the phone number from your CRM or database.
2

Call the Verify Endpoint

Make a request to the /v3/verify endpoint including the Authorization header. Generate a bearer token as outlined on the Authentication page.
cURL
curl -X POST "https://platform.uat.proveapis.com/v3/verify" \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
    "phoneNumber": "2001004051",
    "verificationType": "humanAssurance",
    "clientRequestId": "5454545"
}'
Replace <YOUR_ACCESS_TOKEN> with your acquired access token.
For Human Assurance, set verificationType to humanAssurance and include phoneNumber. You can also pass clientRequestId, clientCustomerId, clientHumanId, or proveId when you need that linkage.
3

Process the Response

Use the samples below together with the /v3/verify response schema. Cross-check field meanings with Assurance levels and Global Fraud Policy when interpreting codes and evaluations.
{
    "success": "true",
    "correlationId": "a87b452e-1935-4f0f-a54b-fad569212b1a",
    "clientRequestId": "5454545",
    "phoneNumber": "2001004051",
    "proveId": "e67223a6-ef6b-4db9-ab56-29f1357a23d1",
    "provePhoneAlias": "9530c146-7f44-450e-a9c1-b13822df2fc3",
    "identity": {
        "assuranceLevel": "AL1",
        "reasons": [
            "AL1a"
        ]
    },
    "evaluation": {
        "authentication": {
            "result": "pass"
        },
        "risk": {
            "result": "pass"
        }
    }
}

​
In practice

  • success — Branch your UX and backend logic on pass vs fail.
  • identity — Read assuranceLevel and reasons for human-vs-automation policy (allow, challenge, block).
  • evaluation — Interpret authentication and risk outcomes under Global Fraud Policy; use failure codes when success is false. For Human Assurance, weigh both authentication and risk results when you tune thresholds.
  • IDs — Persist correlationId (and proveId when present) if you need support, auditing, or linking to other Prove flows.
If you passed optional identifiers on the request, the response may echo clientCustomerId and clientHumanId; see the /v3/verify reference for details.
Best practices
  • Keep clientRequestId in logs alongside correlationId for end-to-end tracing with Prove Support.

​
Sandbox testing

​
Test users

You must use Human Assurance project credentials when working with Human Assurance sandbox test users. Attempting to use these test users with different project credentials results in an unauthorized access error.
The following test users are available for testing Human Assurance using the /v3/verify endpoint in the Sandbox environment. Use these test users to simulate different verification scenarios and outcomes.
Phone NumberFirst NameLast NameVerification TypeExpected Outcome
2001004051EwenBrimilcomehumanAssuranceSuccess
2001004052HilaryKumaarhumanAssuranceFailed
Use these test phone numbers exactly as shown. The sandbox environment doesn’t validate real customer information.

​
Testing steps

Use test user Ewen Brimilcome to verify a successful verification:
curl -X POST "https://platform.uat.proveapis.com/v3/verify" \
  -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "verificationType": "humanAssurance",
    "phoneNumber": "2001004051"
  }'

Related topics

Human Assurance ConnectVerifyHuman AssuranceVerified Users VerifyVerified Users Connect