Skip to main content
POST
/
v3
/
validate
C#
using Prove.Proveapi;
using Prove.Proveapi.Models.Components;

var sdk = new ProveAPI(auth: "<YOUR_AUTH_HERE>");

V3ValidateRequest req = new V3ValidateRequest() {
    CorrelationId = "713189b8-5555-4b08-83ba-75d08780aebd",
};

var res = await sdk.V3.V3ValidateRequestAsync(req);

// handle response
{
  "success": true,
  "next": {
    "v3-challenge": "/v3/challenge"
  },
  "evaluation": {
    "authentication": {
      "result": "pass"
    },
    "success": true
  }
}

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"