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.

Flowchart: Verified User from v3/verify through a Success decision to Success=False or Success=True, then Continuous Monitoring and a phone number change event after success
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 required customer information from your CRM or database:
  • Phone number
  • First name
  • Last name
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 '{
    "verificationType": "verifiedUser",
    "firstName": "Elena",
    "lastName": "Coldman",
    "phoneNumber": "2001004053",
    "clientRequestId": "test-001"
}'
Replace <YOUR_ACCESS_TOKEN> with your acquired access token.
For Verified User, set verificationType to verifiedUser and include phoneNumber, firstName, and lastName. You can pass clientRequestId, clientCustomerId, clientHumanId, proveId, identityAttributes, and other optional fields as your flow requires. See POST /v3/verify for the full request schema, optional fields, and validation rules.
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": "b8ec33cd-37cb-4b83-9f08-330d4b984bc2",
    "clientRequestId": "test-001",
    "phoneNumber": "2001004053",
    "proveId": "550e8400-e29b-41d4-a716-446655440001",
    "provePhoneAlias": "67D6F2VYAUGG8Y0YS937PGCHXKULMDN9AYELU1RNLF2J02N43DJQ14ZDC7Q8HHTJYZ20H54UFTGSA090VXVGAUALCXTE4VSWX3P4CJHTZ887VGYBT0WK8YES9B50XTSP",
    "identity": {
        "firstName": "Elena",
        "lastName": "Coldman",
        "assuranceLevel": "AL2"
    },
    "additionalIdentities": [
        {
            "firstName": "Eric",
            "lastName": "Coldman",
            "assuranceLevel": "AL1"
        }
    ],
    "evaluation": {
        "authentication": {
            "result": "pass"
        },
        "risk": {
            "result": "pass"
        }
    },
        "isEnrolled": true
}

​
In practice

  • success — Branch your UX and backend logic on pass vs fail.
  • identity — Read verified attributes and assuranceLevel for policy (step-up, deny, manual review).
  • evaluation — Interpret authentication and risk outcomes under Global Fraud Policy; use failure codes when success is false.
  • IDs — Persist 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.

​
Sandbox testing

​
Test users

You must use project credentials when working with 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 using the /v3/verify endpoint in the Sandbox environment. Use these test users to simulate different verification scenarios and outcomes.
Use these test phone numbers exactly as shown. The sandbox environment doesn’t validate real customer information.
Phone NumberFirst NameLast NameVerification TypeExpected Outcome
2001004053ElenaColdmanverifiedUserSuccess
2001004054AlfNovotniverifiedUserFailed

​
Testing steps

Use test user Elena Coldman to verify a successful verification:
cURL
curl -X POST "https://platform.uat.proveapis.com/v3/verify" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "verificationType": "verifiedUser",
    "firstName": "Elena",
    "lastName": "Coldman",
    "phoneNumber": "2001004053",
    "clientRequestId": "test-001"
  }'
Expected response:
    {
    "success": "true",
    "correlationId": "d09ed935-99f1-4ef9-b430-418c1544c4e6",
    "clientRequestId": "test-001",
    "phoneNumber": "2001004053",
    "proveId": "550e8400-e29b-41d4-a716-446655440001",
    "provePhoneAlias": "JFJUNCA4WAJ3FQK3JRV0RRPLE7DCPWYBVZUBTA1JJA51KVWFBSQ26JGNM3H5WCSX0X458A8GEH1PB2YPAX2NPFKXNCBUFLZHQLK8MFTZL0XCBE0VTD11HDMZ3A28Y5A5",
    "identity": {
        "firstName": "Elena",
        "lastName": "Coldman",
        "assuranceLevel": "AL2"
    },
    "additionalIdentities": [
        {
        "firstName": "Eric",
        "lastName": "Coldman",
        "assuranceLevel": "AL1"
        }
    ],
    "evaluation": {
        "authentication": {
            "result": "pass"
        },
        "risk": {
            "result": "pass"
        }
    },
    "isEnrolled": true
}

Related topics

Verified UserVerified User ConnectVerified User ManageVerifyVerify Your Mobile Page Requirements - Mobile Auth℠