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",
  "allowOTPRetry": true,
  "flowType": "mobile",
  "ssn": "0596"
}'
{
  "next": {
    "v3-validate": "/v3/validate"
  },
  "authToken": "eyJhbGciOi...",
  "correlationId": "713189b8-5555-4b08-83ba-75d08780aebd"
}

Use the following base URLs when integrating:

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

https://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

Response

200
application/json

Successful request.

The response is of type object.