The following endpoints apply to this flow: Implementation steps
Gather Required Inputs
Collect the required customer information from your CRM or database:
- Phone number
- First name
- Last name
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 -X POST "https://platform.uat.proveapis.com/v3/verify" \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"verificationType": "accountOpening",
"firstName": "Bettina",
"lastName": "Halbert",
"phoneNumber": "2001004049",
"clientRequestId": "5454545",
"clientHumanId": "343434",
"clientCustomerId": "34343465656456"
}'
Replace <YOUR_ACCESS_TOKEN> with your acquired access token.
phoneNumber: the phone number of the customer.firstName: the first name of the customer.lastName: the last name of the customer.verificationType: the type of verification. Set this value to accountOpening.clientRequestId: client-generated unique ID for a specific session. Use this to identify specific requests.
Always give unique clientRequestId values for each request to enable proper tracking and troubleshooting.
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.
Process the Response
The response provides comprehensive identity information and verification results:{
"success": "true",
"correlationId": "d427c049-0ae8-491d-8300-75d23610d0ff",
"clientRequestId": "",
"clientCustomerId": "34343465656456",
"clientHumanId": "343434",
"phoneNumber": "2001004049",
"proveId": "41570934-6d6b-476d-9425-3eaf305cf2e5",
"provePhoneAlias": "4B2C41FC4VKDEO100F960011D0AD4A8050MEK19P4SF9PD23EFE27CD2C76A6FAA8375E60AC0550604F6G32D9ED60E06262CCC570F3C15F2D16900184E",
"identity": {
"firstName": "Bettina",
"lastName": "Halbert",
"assuranceLevel": "AL2",
"reasons": [
"AL2a"
]
},
"additionalIdentities": [
{
"firstName": "Johnny",
"lastName": "Halbert",
"assuranceLevel": "AL2",
"reasons": [
"AL2a"
]
}
],
"evaluation": {
"authentication": {
"result": "pass"
},
"risk": {
"result": "pass"
}
}
}
success: the result of the verification.correlationId: the unique ID that Prove generates for the flow.clientRequestId: the client-generated unique ID for a specific session, provided in the request.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.identity: the verified identity information. This object has:
additionalIdentities: object containing any additional identities found for the phone number.evaluation: object containing the results of the authentication and risk evaluations. Refer to the Global Fraud Policy for more details.
Optional parameters may also return in the response if you send them 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 and to enable cross-domain linking if needed.
- Use assurance levels to implement adaptive security policies based on transaction risk.
Sandbox testing
Test users
You must use Account Opening project credentials when working with Account Opening sandbox test users. Attempting to use these test users with different project credentials results in an unauthorized access error.
/v3/verify endpoint in the Sandbox environment. Use these test users to simulate different verification scenarios and outcomes.
| Phone Number | First Name | Last Name | Verification Type | Expected Outcome |
|---|
2001004049 | Bettina | Halbert | accountOpening | Success |
2001004050 | Laurel | Van Der Beek | accountOpening | Failed |
Use these test phone numbers exactly as shown. The sandbox environment doesn’t validate real customer information.
Testing steps
Use test user Bettina Halbert 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": "accountOpening",
"firstName": "Bettina",
"lastName": "Halbert",
"phoneNumber": "2001004049",
"clientRequestId": "test-001"
}'
{
"success": "true",
"correlationId": "ab1e9b42-da4f-4d13-8690-5d32eae76c6f",
"clientRequestId": "test-001",
"phoneNumber": "2001004049",
"proveId": "41570934-6d6b-476d-9425-3eaf305cf2e5",
"provePhoneAlias": "4B2C41FC4VKDEO100F960011D0AD4A8050MEK19P4SF9PD23EFE27CD2C76A6FAA8375E60AC0550604F6G32D9ED60E06262CCC570F3C15F2D16900184E",
"identity": {
"firstName": "Bettina",
"lastName": "Halbert",
"assuranceLevel": "AL2",
"reasons": [
"AL2a"
]
},
"additionalIdentities": [
{
"firstName": "Johnny",
"lastName": "Halbert",
"assuranceLevel": "AL2",
"reasons": [
"AL2a"
]
}
],
"evaluation": {
"authentication": {
"result": "pass"
},
"risk": {
"result": "pass"
}
}
}
Use test user Laurel Van Der Beek to simulate a failed verification:curl -X POST "https://platform.uat.proveapis.com/v3/verify" \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"verificationType": "accountOpening",
"firstName": "Laurel",
"lastName": "Van Der Beek",
"phoneNumber": "2001004050",
"clientRequestId": "test-002"
}'
{
"success": "false",
"correlationId": "46280df3-1c6f-4a98-bbb9-5a333c47e70b",
"clientRequestId": "test-002",
"phoneNumber": "2001004050",
"identity": {
"assuranceLevel": "AL0",
"reasons": [
"AL0b"
]
},
"evaluation": {
"authentication": {
"failureReasons": {
"9175": "No active identity can be associated with the phone number.",
"9177": "No information can be found for the identity or phone number."
},
"result": "fail"
},
"risk": {
"result": "pass"
}
}
}
