POST
/
v3
/
start
curl --request POST \
  --url https://platform.uat.proveapis.com/v3/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "finalTargetUrl": "https://www.example.com/landing-page",
  "emailAddress": "mpinsonm@dyndns.org",
  "phoneNumber": "2001001695",
  "smsMessage": "#### is your temporary code to continue your application. Caution: for your security, don'\''t share this code with anyone.",
  "dob": "1981-01",
  "ipAddress": "10.0.0.1",
  "flowType": "mobile",
  "ssn": "0596"
}'
{
  "next": {
    "v3-validate": "/v3/validate"
  },
  "authToken": "eyJhbGciOi...",
  "correlationId": "713189b8-5555-4b08-83ba-75d08780aebd"
}

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

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

Prove Pre-Fill and Prove Identity are available in the United States and Canada. Verified Users is available in additional countries.

Use the following base URLs when integrating Prove Pre-Fill or Prove Identity:

https://platform.uat.proveapis.com - North America Staging Environment https://platform.proveapis.com - North America Production Environment

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
flowType
string
required

Flow type is based on the method used - either 'desktop' if using desktop or 'mobile' for iOS/Android native apps and mobile web. Acceptable options are: 'desktop' or 'mobile'.

Example:

"mobile"

​
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 '-'.

Example:

"1981-01"

​
emailAddress
string

Email is the email address of the customer. Acceptable characters are: alphanumeric with symbols '@.+'.

Example:

"mpinsonm@dyndns.org"

​
finalTargetUrl
string

Final target URL is only required for when flowType=desktop. The final target URL is where the end user will be redirected at the end of Instant Link flow. Acceptable characters are: alphanumeric with symbols '-._+=/:?'.

Example:

"https://www.example.com/landing-page"

​
ipAddress
string

IP address is the IP address of the device of the customer. Acceptable characters are: numeric with symbols ':.'.

Example:

"10.0.0.1"

​
phoneNumber
string

Phone number is the number of the mobile phone. The field is required in the Sandbox environment. US phone numbers can be passed in with or without a leading +1. Acceptable characters are: alphanumeric with symbols '+'.

Example:

"2001001695"

​
smsMessage
string

SMSMessage is an optional field to customize the message body sent in the Instant Link (flowType=desktop) or OTP (on mobile) SMS message. If not provided, the following default messages will be used:

  1. For Instant Link: "Complete your verification. If you did not make this request, do not click the link. ####"
  2. For OTP: "#### is your temporary code to continue your application. Caution: for your security, don't share this code with anyone." Max length is 160 characters. Only ASCII characters are allowed.

The placeholder format varies by flow type:

  1. For OTP (mobile flow): Use ####, #####, or ###### to generate 4-6 digit verification codes respectively.
  2. For Instant Link (desktop flow): Must use exactly #### which will be replaced with the verification URL.
Example:

"#### is your temporary code to continue your application. Caution: for your security, don't share this code with anyone."

​
ssn
string

SSN, an optional challenge, is either the full or last 4 digits of the social security number. Acceptable characters are: numeric.

Example:

"0596"

Response

200
application/json
Successful request.
​
authToken
string
required

AuthToken is a bearer token for use by the Prove Client SDK.

Example:

"eyJhbGciOi..."

​
correlationId
string
required

Correlation ID is the unique ID that Prove generates for the flow. To continue the flow, the field will also be used for each of the subsequent API calls in the same flow - it cannot be reused outside of a single flow.

Example:

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

​
next
object
required

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

Example:
{ "v3-validate": "/v3/validate" }