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": "2005550123",
    "verificationType": "prefillForBiz",
    "clientRequestId": "request-123"
}'
Replace <YOUR_ACCESS_TOKEN> with your acquired access token.
For Pre-Fill for Business, set verificationType to prefillForBiz and include phoneNumber and clientRequestId. You can also pass 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": "713189b8-5555-4b08-83ba-75d08780aebd",
  "clientRequestId": "request-123",
  "phoneNumber": "+12005550123",
  "proveId": "a07b94ce-218c-461f-beda-d92480e40f61",
  "provePhoneAlias": "4B2C41FC4VKDEO100F960011D0AD4A8050MEK19P4SF9PD23EFE27CD2C76A6FAA8375E60AC0550604F6G32D9ED60E06262CCC570F3C15F2D16900184E",
  "isEnrolled": true,      
  "identity": {
    "firstName": "Jordan",
    "lastName": "Lee",
    "dateOfBirth": "1985-07-19",
    "nationalId": "111-22-6789",
    "emails": [
      "jordan@example.com"
    ],
    "addresses": [
      {
        "address": "400 Market St",
        "extendedAddress": "Suite 12",
        "city": "San Francisco",
        "region": "CA",
        "zipCode": "94105"
      }
    ],
    "assuranceLevel": "AL3"
  },
  "businesses": [
    {
      "businessName": "Acme Widgets LLC",
      "businessAddress": {
        "address": "100 Commerce Way",
        "extendedAddress": "Suite 200",
        "city": "Austin",
        "region": "TX",
        "zipCode": "78701"
      },
      "tradeName": "Acme Widgets",
      "taxId": "12-3456789",
      "relatedPersons": [
        {
          "firstName": "Jane",
          "lastName": "Doe"
        }
      ],
      "registrationFiling": {
        "date": "2015-03-01",
        "registrationNumber": "8021234567",
        "registrationType": "",
        "region": "TX"
      }
    }
  ],
  "evaluation": {
    "authentication": { "result": "pass" },
    "risk": { "result": "pass" }
  }
}

​
In practice

  • success — Branch your UX and backend logic on pass vs fail.
  • identity and businesses — 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 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.

​
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
2001004069BritaThomassenprefillForBizSuccess
2001004070SkippieO’KerinprefillForBizSuccess

​
Testing steps

Use test user Brita Thomassen 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": "prefillForBiz",
    "phoneNumber": "2001004069",
    "clientRequestId": "test-request-001"
  }'
Expected response:
{
    "success": "true",
    "correlationId": "484965d1-aed3-4f7c-89fb-3a8c1dffea50",
    "clientRequestId": "test-request-001",
    "phoneNumber": "2001004069",
    "provePhoneAlias": "RCM0B10CFCFGGG7CJMD291ND3C7Z666C0DR8V141FUQQY0EBPPUSPD6FBCP5S2KTY0TN4BUWEY54E9GKSZZ8J2H2QVNERY68QHVD202TPBXCRHUF8AMUDRDBE1W5Y184",
    "identity": {
        "firstName": "Brita",
        "lastName": "Thomassen",
        "dateOfBirth": "1976-12-03",
        "nationalId": "465825623",
        "emails": [
            "bthomassen1x@taobao.com"
        ],
        "addresses": [
            {
                "address": "04568 Kropf Drive",
                "extendedAddress": "",
                "city": "Charleston",
                "region": "WV",
                "zipCode": "25389"
            }
        ],
        "assuranceLevel": "AL2"
    },
    "businesses": [
        {
            "businessName": "Acme Widgets LLC",
            "businessAddress": {
                "address": "100 Commerce Way",
                "extendedAddress": "Suite 200",
                "city": "Austin",
                "region": "TX",
                "zipCode": "78701"
            },
            "tradeName": "Acme Widgets",
            "taxId": "12-3456789",
            "relatedPersons": [
                {
                    "firstName": "Jane",
                    "lastName": "Doe"
                }
            ],
            "registrationFiling": {
                "date": "2015-03-01",
                "registrationNumber": "8021234567",
                "region": "TX"
            }
        }
    ],
    "evaluation": {
        "authentication": {
            "result": "pass"
        },
        "identification": {
            "result": "pass"
        },
        "risk": {
            "result": "pass"
        }
    },
    "isEnrolled": false
}

Related topics

Pre-Fill for Consumers VerifyPre-Fill for BusinessVerify your mobile page requirements (Pre-Fill, without Mobile Auth℠)Pre-Fill for Business ManagePre-Fill for Consumers