Skip to main content
Identities that pass the Global Fraud Policy are enrolled in Manage.

​
Implementation steps

1

Gather Required Inputs

Collect the phone number.
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": "prefill",
    "clientRequestId": "request-123"
}'
Include the following required parameters:
  • phoneNumber: the phone number of the customer.
  • verificationType: the type of verification. Set this value to prefill.
The optional parameters you can also send in the request body include:
  • clientRequestId: client-generated unique ID for a specific session. Use this to identify specific requests.
  • clientCustomerId: the client-generated unique ID for a specific customer. Use this to link calls related to the same customer, across different requests or sessions.
  • clientHumanId: a client-generated unique ID for a consumer across business lines.
  • proveId: the Prove ID associated with the customer, if known.
3

Process the Response

A successful response includes comprehensive identity information and verification results:
{
  "success": "true",
  "correlationId": "713189b8-5555-4b08-83ba-75d08780aebd",
  "phoneNumber": "+12005550123",
  "proveId": "a07b94ce-218c-461f-beda-d92480e40f61",
  "provePhoneAlias": "4B2C41FC4VKDEO100F960011D0AD4A8050MEK19P4SF9PD23EFE27CD2C76A6FAA8375E60AC0550604F6G32D9ED60E06262CCC570F3C15F2D16900184E",
  "isEnrolled": true,
  "clientRequestId": "request-123",
  "identity": {
    "firstName": "Alice",
    "lastName": "Smith",
    "dateOfBirth": "1992-03-02",
    "nationalId": "111-22-6789",
    "emails": [
      "alice@example.com",
      "a.smith@example.com",
      "ajohnson@globocorp.com"
    ],
    "addresses": [
      {
        "address": "123 Main St",
        "extendedAddress": "Apt A",
        "city": "New York",
        "region": "NY",
        "zipCode": "10001"
      },
      {
        "address": "Farm Road 223",
        "extendedAddress": "",
        "city": "Fargo",
        "region": "ND",
        "zipCode": "58801"
      }
    ],
    "assuranceLevel": "AL3",
    "reasons": ["AL3a"]
  },
  "evaluation": {
    "authentication": { "result": "pass" },
    "identification": { "result": "pass" },
    "risk": { "result": "pass" }
  }
}
  • success: the result of the verification.
  • correlationId: the unique ID that Prove generates for the flow.
  • phoneNumber: the phone number provided in the request.
  • proveId: the unique Prove-assigned ID tied to the consumer.
  • provePhoneAlias: the unique Prove-assigned ID tied to the phone number.
  • clientRequestId: the client-generated unique ID for a specific session, provided in the request.
  • identity: the verified identity information. This object has:
  • evaluation: object containing the results of the authentication and risk evaluations. Refer to the Global Fraud Policy for more details.
Optional parameters that may also return in the response if sent in the request:
  • clientCustomerId: the client-generated unique ID for a specific customer.
  • clientHumanId: a client-generated unique ID for a consumer across business lines.
Best Practices
  • Check the success field to handle different verification outcomes appropriately.
  • Save the proveId and correlationId for future reference.
  • Use assurance levels to implement adaptive security policies based on transaction risk.

​
Sandbox testing

​
Test user

You must use Pre-Fill for Consumers project credentials when working with the Pre-Fill for Consumers sandbox test user. Attempting to use this test user with different project credentials results in an unauthorized access error.
The following sandbox test user is available for testing Pre-Fill for Consumers using the /v3/verify endpoint in the Sandbox environment. Use this user to walk through a successful verification.
Phone NumberFirst NameLast NameVerification TypeExpected Outcome
+4402001004065MeadWillmentprefillSuccess
Use this test phone number exactly as shown. The sandbox environment doesn’t validate real customer information.

​
Testing steps

​
Mead

Use test user Mead Willment to test 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": "prefill",
    "phoneNumber": "+4402001004065"
  }'