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 enrolled in Manage.

​
Implementation steps

1

Gather Required Inputs

Collect the phone number for the user completing business onboarding.
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"
}'
Include the following required parameters:
  • phoneNumber: the phone number of the customer.
  • verificationType: the type of verification. Set this value to prefillForBiz.
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 verification results and identity information for the session.
{
  "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",
    "reasons": ["AL3a"]
  },
  "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" }
  }
}
  • 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 for the session. This object has:
  • businesses: array of verified business entities for the session. The objects have:
    • businessName: legal business name.
    • businessAddress: postal address with address, extendedAddress, city, region, and zipCode.
    • tradeName: trade or DBA name.
    • taxId: tax identifier (for example EIN).
    • relatedPersons: array of objects with firstName and lastName for people tied to the business.
    • registrationFiling: date, registrationNumber, registrationType, and region for the filing.
  • 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 Business project credentials when exercising the sandbox scenario for this flow. Attempting to use Pre-Fill for Business test data with a different project can result in an unauthorized access error.
The following illustrates calling /v3/verify with prefillForBiz.
Phone NumberFirst NameLast NameVerification TypeExpected Outcome
2001004069BritaThomassenprefillForBizSuccess
2001004070SkippieO’KerinprefillForBizSuccess
Use test phone numbers exactly as provided for your environment. The sandbox environment doesn’t validate real customer information.

​
Testing steps

Use test user Brita Thomassen 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": "prefillForBiz",
    "phoneNumber": "2001004069",
    "clientRequestId": "test-request-001"
  }'

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