Prove Pre-Fill Implementation Guide

This guide provides step-by-step instructions to integrate Prove Pre-Fill®. There are separate guides for both server-side and client-side implementations available. Prove provides server SDKs in the following languages: Java, TypeScript/JavaScript, and Go. If you use a different backend language, you can easily interact with the REST APIs.

In order to integrate Prove Pre-Fill solutions, you must use the client-side SDKs.

Prove Sandbox Credentials

Before you begin implementing, ensure you have Prove Sandbox credentials from the Developer Portal. To access Sandbox credentials, follow the steps outlined on the Authentication and Testing page.

Implementation

These instructions assume you are using the server-side SDK. If you are using the REST APIs instead, you can easily call the respective endpoints.

Step	Client-Side	Server-Side
Start
1	Create or update your first screen to prompt for: Phone Number and Challenge Data (last 4 SSN/full SSN/date of birth (DOB))
2	On submit, the form will call an endpoint on your backend server to pass in the consumer-submitted data. It passes in the `flowType` of either `mobile` or `desktop`.
3		Setup the SDK with the OAuth client ID and client secret from Portal to handle authentication for all server-side calls. If you are using a different backend language and you call the APIs directly, you will need to make a call to the /token endpoint in order to generate the OAuth token.
4		Call the server-side SDK Start() function to pass in the data to start the session. The call will return a one-time use `authToken` and a correlation ID.
5		Save the correlation ID in your session (you’ll use the correlation ID in the Validate, Challenge, and Complete calls for the same consumer session) and then return the `authToken` to your client-side.
6	Setup the authenticator and the associated functions for Instant Link, one-time password (OTP), and Auth Finish Step. The Auth Finish step makes a call to your backend server which then calls the server-side SDK Validate() function.
7	Pass the `authToken` to the client-side SDK Authenticate() function. Once the client-side possession work finishes, the Auth Finish step completes.
Validate
8		Call the server-side SDK Validate() function to complete the possession and reputation checks. The Validate response will return both the phone number and the `next` field indicating which API to call next. If the API returns `success=false`, then run your exception process: Prove Pre-Fill® handling If the API returns `success=true`: the `next` field returns `v3-challenge`.
Challenge
9		Call the server-side SDK Challenge() function. The API will return the success=true with the user information if Prove can authenticate the consumers identity information with enough trust and assurance. Return user data in a response to the client-side. Otherwise it will return success=false with no user information. Return no user data in a response to the client-side.
10	If consumer information returns from Challenge response, pre-fill the form with the information. Otherwise, prompt the consumer to manually input their information in the form.
11	On submit, the form calls an endpoint to your backend server to pass in the consumer information.
Complete
12		Call the server-side SDK Complete() function to pass in the data to verify the user information. If the API returns success=true, continue with the onboarding activity. If the API returns success=false, run your exception process: Prove Pre-Fill® handling

Step	Client-Side	Server-Side
Start
1	Create or update your first screen to prompt the consumer to accept the US carrier (MNO) T&C in order to utilize Mobile Auth℠ to verify a consumer.
2	On submit, the form calls an endpoint on your backend server to pass in the consumer-submitted data. It passes in the `flowType` of either `mobile` or `desktop`.
3		Setup the SDK with the OAuth client ID and client secret from Portal to handle authentication for all server-side calls. If you are using a different backend language and you are calling the APIs directly, you will need to make a call to the /token endpoint in order to generate the OAuth token.
4		Call the server-side SDK Start() function to pass in the data to start the session. The call will return a one-time use `authToken` and a correlation ID.
5		Save the correlation ID in your session (you’ll use the correlation ID in the Validate, Challenge, and Complete calls for the same consumer session) and then return the `authToken` to your client-side.
6	Setup the authenticator and the associated functions for Instant Link, OTP, and Auth Finish Step. The Instant Link function prompts for a phone number from the consumer and then return in the callback. The OTP functions prompt for the phone number as well as the OTP and then return in the callbacks. The Auth Finish step makes a call to your backend server which then calls the server-side SDK Validate() function.
7	Pass the `authToken` to the client-side SDK Authenticate() function. Once the client-side possession work finishes, the Auth Finish step completes.
Validate
8		Call the server-side SDK Validate() function to complete the possession and reputation checks. The Validate response will return both the phone number and the `next` field indicating which API to call next. If the API returns `success=false`, then run your exception process: Prove Pre-Fill® handling If the API returns `success=true`: the `next` field returns `v3-challenge`.
Challenge
9	Next, create a screen to prompt for the consumers challenge data
10		Call the server-side SDK Challenge() function. The API will return the success=true with the user information if Prove can authenticate the consumers identity information with enough trust and assurance. Return user data in a response to the client-side. Otherwise it will return success=false with no user information. Return no user data in a response to the client-side.
11	If consumer information returns from the Challenge response, pre-fill the form with the information. Otherwise, prompt the consumer to manually input their information in the form.
12	On submit, the form calls an endpoint to your backend server to pass in the consumer information.
Complete
13		Call the server-side SDK Complete() function to pass in the data to verify the user information. If the API returns success=true, continue with the onboarding activity. If the API returns success=false, run your exception process: Prove Pre-Fill® handling

Test Your Prove Implementation

Once your implementation is complete, follow the Sandbox test scenarios with each of the Sandbox test users to ensure both success and failure states are working properly.

Congratulations! You’ve integrated Prove into your application.

Please reference the Production Launch Steps to request your Production credentials.

Prove Pre-Fill®

Prove Identity

Prove Verified Users℠

Prove Pre-Fill Implementation Guide

Prove Sandbox Credentials

Implementation

Test Your Prove Implementation

Prove Pre-Fill®

Prove Identity

Prove Verified Users℠

​Prove Sandbox Credentials

​Implementation

​Test Your Prove Implementation

Prove Sandbox Credentials

Implementation

Test Your Prove Implementation