Learn more about the details of the server-side SDK for Unify
proveEnv
to uat-eu
.
Unify()
POST /unify
so the front end can submit the possession type and phone number. On the back end, you’ll start a Prove Unify flow with a call to the Unify()
function. This function takes these required parameters:
mobile
, desktop
, or none
(for Customer-supplied possession) to describe which type of device the end user is starting their flow on.desktop
, Instant Link executes the possession check. When possession type is mobile
, first Prove Key is checked, then fallback to one-time password (OTP). The Instant Link session has a three minute timeout from when it’s sent through SMS to when the end user can select the link. The OTP session has a two minute timeout from when it’s sent through SMS to when the end user can enter in the OTP.possessionType=desktop
. This should be a URL you maintain. Once the customer clicks the Instant Link, they are redirected to this URL. It should instruct the customer to continue the workflow.true
to allow the customer to re-enter the OTP up to three times. Defaults to false
.
Authenticate()
function - it’s a short lived JSON Web Token (JWT) tied to the current flow and used for the possession checks.
UnifyStatus()
function call of the same flow. The correlation ID ties together different system calls for the same Prove flow. It also aids in troubleshooting. The session expires in 15 minutes from when the correlation ID returns from the Unify()
call.
pending
for this initial call.
authToken
, returned to the front end.
UnifyStatus()
UnifyStatus()
to get the final result in the success
field.
This function takes this required parameter:
Unify()
function. It validates against this RegEx: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
.true
if the possession check succeeded, false
if it failed, or possession_required
if Customer-supplied possession flow requires additional steps.
UnifyBind()
UnifyBind()
after your own possession check has succeeded. This binds the phone number to the Prove Key for future authentications.
This function takes these required parameters:
Unify()
function.true
if the binding succeeded, false
if it failed.