Skip to main content
POST
/
v3
/
validate
Validate Phone Number
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.uat.proveapis.com/v3/validate"

	payload := strings.NewReader("{\n  \"correlationId\": \"713189b8-5555-4b08-83ba-75d08780aebd\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
{
  "success": true,
  "next": {
    "v3-challenge": "/v3/challenge"
  },
  "evaluation": {
    "authentication": {
      "result": "pass"
    },
    "success": true
  }
}
Use the following base URLs when integrating:https://platform.uat.proveapis.com - North America Sandbox Environmenthttps://platform.proveapis.com - North America Production Environment

Authorizations

​
Authorization
string
header
required

The access token received from the /token endpoint. Refer to the Authentication page for more details.

Body

application/json
​
correlationId
string
required

The unique ID that Prove generates for the flow. It is returned from the Start endpoint and cannot be reused outside of a single flow.

Example:

"713189b8-5555-4b08-83ba-75d08780aebd"

Response

Successful request.

​
challengeMissing
boolean
required

True if a DOB or SSN needs to be passed in on the next step. Only applicable to Pre-Fill. If implementing Prove Identity ignore this field. It will always return false for this use case.

Example:

true

​
next
object
required

The next set of allowed calls in the same flow.

Example:
{ "v3-challenge": "/v3/challenge" }
​
success
boolean
required

True if the phone number was validated.

Example:

true

​
evaluation
object

The evaluation result for the policy. This is an upcoming field but is not yet enabled.

​
phoneNumber
string

The number of the mobile phone for which validation was performed.

Example:

"2001001686"

⌘I