Prove

Implementation Guides

Developer Guides

Changelog

Developer Blog

Sign in

Create account

Send this request to request the OAuth token.

Request OAuth token.

Request body for the V3 Token API.

Response body for the V3 Token API.

Error400 is the response when there is a problem with the request.

Error is the response when there is a problem with the request.

Review this page to achieve a better understanding of the Server Side, Client Side and UX components required to integrate the Prove Pre-Fill® solution.

Prove Pre-Fill® Flow

Review the steps for implementing Pre-Fill.

Implementation Guide

Prove Pre-Fill Implementation Guide

Learn more about simulating the Prove Pre-Fill flow using our Sandbox environment.

Sandbox Testing

Prove Pre-Fill Sandbox Testing

Review the Prove Standard℠ CX Requirements for Pre-Fill when implementing without MobileAuth℠

Overview

CX Requirements

Learn how to create the CX for your Challenge page when implementing without MobileAuth℠.

Challenge Page Requirements

Learn how to create the CX for your OTP or Instant Link page.

Verify Your Mobile Page Requirements

Learn how to create the CX for your Consumer Review page when not using Mobile Auth.

Pre-Filled Consumer Review Page Requirements

Review the Prove Standard℠ CX Requirements for Pre-Fill when implementing with MobileAuth℠

Pre-Fill® CX Requirements - MobileAuth℠

Learn more about the requirements for MNO consent.

US Carrier (MNO) Consent Requirements

Learn how to create the CX for the Start Page when Mobile Auth fails or if using the Desktop flow.

Start Page Requirements - When Mobile Auth℠ Fails

Learn how to create the CX for your Instant Link or OTP page.

Verify Your Mobile Page Requirements - Mobile Auth℠

Learn how to create the CX for the Challenge Page after being authenticated via Mobile Auth.

Challenge Page Requirements - Mobile Auth℠

Learn how to create the CX for the Challenge Page if MobileAuth Fails or if using the Desktop flow.

Challenge Page Requirements - When Mobile Auth℠ Fails

Learn how to create the CX for your Consumer Review page when using Mobile Auth.

Pre-Filled Consumer Review Page Requirements - Mobile Auth℠

Review this page to achieve a better understanding of the Server Side, Client Side and UX components required to integrate Prove Identity.

Prove Identity Flow

Review the steps for implementing Prove Identity.

Prove Identity Implementation Guide

Learn more about simulating the Prove Identity flow using our Sandbox environment.

Prove Identity Sandbox Testing

This guide offers a quick introduction to building Prove solutions with the Prove® Platform APIs

Quick Start Guide

Follow these steps to validate your API credentials.

Authentication and Testing

Learn more about the details of the server-side SDK.

Prove® Platform Server-Side SDK Guide

Learn more about the details of the client-side SDK.

Prove® Platform Client-Side SDK Guide

Learn how to integrate the client-side web SDK into your web application.

Prove® Platform Web SDK

Learn how to integrate the client-side Android SDK into your native application.

 Prove® Platform Android SDK

Learn how to integrate the client-side iOS SDK into your native application.

Prove® Platform iOS SDK

Discover the conventions as well as various error and status codes generated by Prove® Platform APIs.

Conventions, Errors, and Status Codes

Send this request to start a Prove flow. It will return a correlation ID and an authToken for the client SDK.

Start flow.

Send this request to check the phone number entered/discovered earlier in the flow is validated. It will return a correlation ID and the next step.

Validate phone number.

Send this request to submit challenge information. Either a DOB or last 4 of SSN needs to be submitted if neither was submitted to the /start endpoint (challenge fields submitted to this endpoint will overwrite the /start endpoint fields submitted). It will return a correlation ID, user information, and the next step to call in the flow. This capability is only available in Pre-Fill®, it's not available in Prove Identity®. You'll notice that when using Prove Identity®, if /validate is successful, it will then return `v3-complete` as one of the keys in the `Next` field map instead of `v3-challenge`.

Submit challenge.

Send this request to verify the user and complete the flow. It will return a correlation ID, user information, and the next step to call in the flow. There is a validation check that requires at least first + last name or SSN passed in, else an HTTP 400 is returned. Additionally, specific to the Pre-Fill® or Prove Identity® with KYC use case, you need to pass in first name, last name, DOB and SSN (or address) to ensure you receive back the KYC elements and correct CIP values.

Complete flow

Learn more about new and updated features regarding Prove's latest releases.

Prove APIs

Request OAuth token.

Body

Response