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

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

V3ChallengeRequest req = new V3ChallengeRequest() {
    CorrelationId = "713189b8-5555-4b08-83ba-75d08780aebd",
    Dob = "1981-01",
    Ssn = "0596",
};

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

// handle response
{
  "evaluation": {
    "key": "{}"
  },
  "next": {
    "v3-complete": "/v3/complete"
  },
  "individual": {
    "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-17",
    "ssn": "265228370"
  },
  "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"

​
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
Individual represents a person. · 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"
}