Skip to main content
POST
/
v3
/
challenge
Submit Challenge
package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"dob\": \"1981-01\",\n  \"correlationId\": \"713189b8-5555-4b08-83ba-75d08780aebd\",\n  \"ssn\": \"0596\"\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-complete": "/v3/complete"
  },
  "evaluation": {
    "authentication": {
      "result": "pass"
    },
    "identification": {
      "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"

​
dob
string

The date of birth in one of these formats: YYYY-MM-DD, YYYY-MM, or MM-DD. Acceptable characters are: numeric with symbol '-'.

Example:

"1981-01"

​
ssn
string

The full or last 4 numbers of the social security number. Acceptable characters are: numeric.

Example:

"0596"

Response

Successful request.

​
next
object
required

The next set of allowed calls in the same flow.

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

True if the challenge was accepted and user info retrieved.

Example:

true

​
evaluation
object

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

​
individual
object
Example:
{
  "firstName": "Tod",
  "lastName": "Weedall",
  "addresses": [
    {
      "address": "39 South Trail",
      "city": "San Antonio",
      "extendedAddress": "Apt 23",
      "postalCode": "78285",
      "region": "TX"
    },
    {
      "address": "4861 Jay Junction",
      "city": "Boston",
      "extendedAddress": "Apt 78",
      "postalCode": "02208",
      "region": "MS"
    }
  ],
  "emailAddresses": ["jdoe@example.com", "dsmith@example.com"],
  "dob": "1981-01-17T00:00:00.000Z",
  "ssn": "265228370"
}
⌘I