Start flow.
Send this request to start a Prove flow. It will return a correlation ID and an authToken for the client SDK.
Welcome to the Prove Link documentation! This documentation applies only if you use our Prove Link frontend SDK and our Prove Link APIs.
For access to our classic documentation, please contact support@prove.com or your Prove representative.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
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'.
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 '-'.
Email is the email address of the customer. Acceptable characters are: alphanumeric with symbols '@.+'.
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 '-._+=/:?'.
IP address is the IP address of the device of the customer. Acceptable characters are: numeric with symbols ':.'.
Phone number is the number of the mobile phone. The field is required in the Sandbox environment. In Production, you will likely pass the phone number via the Prove Link client SDK instead of within the Start call depending on how your user experience is implemented. Acceptable characters are: alphanumeric with symbols '+'.
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:
- For Instant Link: "Complete your verification. If you did not make this request, do not click the link. ####"
- 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:
- For OTP (mobile flow): Use ####, #####, or ###### to generate 4-6 digit verification codes respectively.
- For Instant Link (desktop flow): Must use exactly #### which will be replaced with the verification URL.
SSN, an optional challenge, is either the full or last 4 digits of the social security number. Acceptable characters are: numeric.
Response
AuthToken is a bearer token for use by the Prove Client SDK.
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.
Next contains the next set of allowed calls in the same flow.
Was this page helpful?