POST
/
v3
/
challenge

Welcome to the Prove® Platform documentation! This documentation applies only if you use our client-side SDK and our Prove® Platform APIs.

For access to our classic documentation, please contact support@prove.com or your Prove representative.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
correlationId
string
required

Correlation ID is 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.

dob
string

DOB, an optional challenge, is the date of birth in one of these formats: YYYY-MM-DD, YYYY-MM, or MM-DD. Acceptable characters are: numeric with symbol '-'.

ssn
string

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

Response

200 - application/json
next
object
required

Next contains the next set of allowed calls in the same flow.

success
boolean
required

Success returns true if the challenge was accepted and user info retrieved.

individual
object

Was this page helpful?