Prove Identity Sandbox Testing
Learn more about simulating the Prove Identity flow using the Sandbox environment.
Overview
When you interact with the Sandbox environment, you’ll be able use the test users below to simulate different behaviors. You will simulate the possession checks utilizing the client-side SDK. No text messages will be sent and real user information will not validate - you must use the test users.
sandbox test users can only be used with project credentials. Attempting to use these test users with different project credentials will result in an unauthorized access error.
Unless specified below, you can introduce failures in the tests that would otherwise be successful:
-
If you call a step out of order, you will receive:
-
Status Code: HTTP 403
-
Response:
{"code":1003,"message":"step not allowed"}
-
-
If a required field is missing, you will receive:
-
Status Code: HTTP 400
-
Response:
{"code":1001,"message":"field 'flowType' is missing"}
-
Steps
These are the steps you’ll follow for each of the tests.
-
For Start:
-
Send into request:
-
flowType
: use eithermobile
ordesktop
-
phoneNumber
: (use number from table above) -
finalTargetUrl
:https://www.prove.com
-
dob
orlast4SSN
(otherwise, pass it in to Challenge request)
-
-
Response will return:
-
authToken
-
correlationId
-
next = v3-validate
-
-
-
For Validate:
-
Send into request:
correlationId
(from Start response)
-
Response will return:
-
success = true
-
challengeMissing = false
-
next = v3-challenge
orv3-complete
-
-
-
For Challenge (only if the previous Validate call returned:
next = v3-challenge
):-
Send into request:
-
correlationId
(from Start response) -
dob or last4SSN
(if still needed)
-
-
Response will return:
-
success = true
-
Individual information (from table above)
-
next = v3-complete
-
-
-
For Complete:
-
Send into request:
-
correlationId
(from Start response) -
Individual information (from table above)
-
-
Response will return:
-
success = true
-
changeDetected
(true if there is a data mismatch with the Challenge response) -
next = done
-
-
Short-Term Test User
Please temporarily use the below test user when performing initial testing with cURL or Postman. This test user intentionally skips the client-side SDK authentication to help you understand sequence of API calls; however the client-side authentication is a required integration element (it initiates the Prove possession check).
Phone Number | First Name | Last Name | Address | City | State | Zip | Date of Birth | SSN | |
---|---|---|---|---|---|---|---|---|---|
2001004000 | Martina | Goodram | 28965 Homewood Plaza | Little Rock | AR | 72204 | 7/26/1995 | 490959347 | mgoodram0@nasa.gov |
After initial short-term testing, please implement the client-side SDK and utilize the remaining test users below to fully test your implementation. Please see the Quick Start Guide to better understand required components.
Prove Identity Test Users
For each of the test users, follow the steps above in the staging environment to test out your implementation to ensure it’s working properly. Please see the Outcomes Table to review scenarios to test and interpretation of success and failed states.
Key points about possession:
-
Mobile Flow Testing: When prompted for your one-time password (OTP) during mobile flow testing, you must use 1234 to simulate a successful OTP. Any other combination of numbers will simulate a failure. Please use the Benji Harper user to test that OTP setup is functioning as expected.
-
Desktop Flow Testing: You will simulate Instant Link during Desktop flow testing. You know your logic is set up correctly if your test user passes the Validate step.
Phone Number | First Name | Last Name | Address | City | State | Zip | Date of Birth | SSN | |
---|---|---|---|---|---|---|---|---|---|
2001004009 | Benji | Harper | 27 Financial Place | Bakersfield | CA | 93301-2425 | 09/02/1994 | 565252770 | bharperd@superstars.com |
2001001699 | Carney | Reinisch | 582 Coleman Point | San Antonio | TX | 78230 | 3/3/2000 | 166521601 | creinischq@php.net |
2001001698 | Enid | Wildt | 861 Karstens Circle | Washington | DC | 20409 | 6/18/1996 | 212285822 | ewildtp@eepurl.com |
Prove Identity Outcomes and Test Scenarios
The below table provides Prove Identity outcome possibilities including which sandbox users to test with, testing notes and interpretation of each success and failed state in Production. The Prove Identity Test Users table above contains the comprehensive list of test users including mock data. If you are trying to troubleshoot Success=False
in the API response, please see the next section.
Sandbox Troubleshooting Tips
Please see below table for assistance troubleshooting when Success=False
in an API response. To understand what this indicates in Production, please see the Prove Identity Outcomes and Test Scenarios table above.
Server Side Call | Behavior Resulting in Success=False | Troubleshooting Tips |
---|---|---|
/start | Not Applicable | Please see Error and Status Codes page for common 400 response errors |
/validate | Prove Identity Sandbox user intended to fail this step: Carney Reinisch | Please see Test Scenario Table for which test users fail each scenario |
/validate | Client Side SDK Authenticate() function wasn’t called or was configured incorrectly* *Required for all sandbox users except Martina Goodram | See the client-side SDK implementation guide |
/validate | Wrong one-time password (OTP) entered | See the client-side SDK implementation guide |
/complete | First Name or Last Name or SSN isn’t associated with the phone number entered (you entered Cathy Blazevic’s Phone number with different last4) | Please see Test Scenario Table for which test users fail each scenario |
If you are encountering errors when running these test scenarios, please refer to the Error and Status Codes page.
If you’re still having issues, send your correlationId
from a failing request. Use either the Support button in the Portal or contact your account representative.
Production Access
To access this functionality in Production, please contact your sales representative.