div.truncate.min-w-0 {
    color: #161616; 
  }
.js-focus-visible.dark div.truncate.min-w-0 {
    color: rgb(153, 153, 150); 
  }

.flex-none.text-xs.font-semibold {
    color: #161616; 
  }
.js-focus-visible.dark .flex-none.text-xs.font-semibold {
    color: rgb(153, 153, 150);
  }
iframe {
  width: 80%; /* 80% of the parent container's width */
  height: 640px; /* Fixed height */
  margin: 0 auto; /* Center horizontally */
  display: block; /* Ensure it's a block-level element */
}


This endpoint allows you to check the status of a Unify session and get the possession result.

Check Status of Unify Session

Request body for the V3 Unify Status API.

auth

Response body for the V3 Unify Bind API.

Bad Request. The server cannot process the request due to a client error.

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

Unauthorized. Authentication is required and has failed or has not been provided.

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

Forbidden. The server understood the request but refuses to authorize it.

Error403 is the response when the server refuses to authorize the request despite valid authentication.

Internal Server Error. The server encountered an unexpected condition that prevented it from fulfilling the request.

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

Prove

This guide will take you through the initial setup and launch of the Prove Pre-Fill starter kit using a Node back end and React front end

Quick Start

Follow these steps to gain access to Prove APIs

Authentication

Discover the various error and status codes generated by Prove APIs

Errors and Status Codes

Learn about the components that make up the Prove Pre-Fill® solution

Prove Pre-Fill Overview

Review the steps for implementing Pre-Fill

Implementation Guide

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

Sandbox Testing

Prove Pre-Fill Sandbox Testing

Learn more about the details of the server-side SDK

Server-Side SDK Guide

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

Client-Side Web SDK

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

Client-Side Android SDK

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

Client-Side iOS SDK

Send this request to request the OAuth token.

Request OAuth token.

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

Review the Prove Standard℠ frontend requirements for Pre-Fill when implementing without MobileAuth℠

Overview

CX Requirements

Learn how to design the frontend for your Challenge Page when implementing without MobileAuth℠

Challenge Page Requirements

Learn how to design the frontend for your OTP or Instant Link page

Verify Your Mobile Page Requirements

Learn how to design the frontend for your Customer Review Page when implementing without Mobile Auth

Pre-Filled Customer Review Page Requirements

Review the Prove Standard℠ frontend 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 design the frontend for the Start Page when Mobile Auth fails or if using the Desktop flow

Start Page Requirements - When Mobile Auth℠ Fails

Learn how to design the front end for your Instant Link or OTP page

Verify Your Mobile Page Requirements - Mobile Auth℠

Learn how to design the front end for the Challenge Page after authenticating with Mobile Auth

Challenge Page Requirements - Mobile Auth℠

Learn how to design the frontend for the Challenge Page if MobileAuth Fails or if using the Desktop flow

Challenge Page Requirements - When Mobile Auth℠ Fails

Learn how to design the front end for your Customer Review Page when using Mobile Auth

Pre-Filled Customer Review Page Requirements - Mobile Auth℠

Learn about the components that make up the Prove Identity® solution

Prove Identity Overview

Review the steps for implementing Prove Identity

Prove Identity Implementation Guide

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

Prove Identity Sandbox Testing

Learn about the components that make up the Verified Users solution

Verified Users Overview

Review the steps for implementing Verified Users

Learn more about simulating the Prove Verified Users flow using the Sandbox environment

Prove Verified Users℠ SDK Guide

Send this request to initiate a Verified Users session. It will return a correlation ID, authToken for the client SDK, and the results of the possession and verify checks (usually pending from this API).

Initiate verified users session.

Send this request to perform the necessary checks for a Verified Users session. It will return the results of the possession and verify checks, as well as the overall success.

Perform checks for verified users session.

Learn about the components that make up the Prove Unify solution

Prove Unify℠ Overview

Review the steps for implementing Prove Unify

Learn more about simulating the Prove Unify flow using the Sandbox environment

Learn more about the details of the server-side SDK for Unify

Prove Unify SDK Guide

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

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

This endpoint allows you to initiate the possession check.

Initiate Possession Check

This endpoint allows you to bind a Prove Key to a phone number of a Unify session and get the possession result.

Bind Prove Key

Learn about product launches, enhancements, and fixes for Prove solutions

Changelog

Developer Blog

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.

Prove Pre-Fill Implementation Guide

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

Learn how to design the frontend for your Challenge Page when implementing without MobileAuth℠.

Learn how to design the frontend for your one-time password (OTP) or Instant Link page.

Learn how to design the frontend for your Consumer Review Page when implementing without Mobile Auth.

Pre-Filled Consumer Review Page Requirements

Learn more about the requirements for MNO consent.

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

Learn how to design the frontend for your Instant Link or OTP page.

Learn how to design the frontend for the Challenge Page after authenticating with Mobile Auth.

Learn how to design the frontend for the Challenge Page if MobileAuth Fails or if using the Desktop flow.

Learn how to design the frontend 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.

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

Learn about the server-side and client-side SDKs required to integrate Verified Users (with or without Possession).

Prove Verified Users℠ Flow

Review the steps for implementing Verified Users.

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

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 Pre-Fill® and Prove Identity℠ 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 new 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

Learn more about new updates and modifications to Prove solutions.

Get Started

Prove Pre-Fill®

Prove Identity®

Prove Verified Users

Prove Unify

Stay Informed

Check Status of Unify Session

Authorizations

Body

Response