Classic Flow

Integrating the Full Experience for identity verification into your web application involves redirecting users to a dedicated web page where they can complete the ENROLL or VERIFY process. This tutorial will guide you through the steps to implement these flows, ensuring a seamless integration that enhances user experience and security.

Requirements and Compatibility

Before you begin, ensure you have the following:

• Access to the base URL for the identity verification service.
• An API key and project name provided by the service provider.
• Knowledge of the product number associated with the service you intend to use.
• Familiarity with GET and POST HTTP methods.

Preparing the Redirection URLs

Based on the flow you wish to implement (ENROLL or VERIFY), prepare the URL to which users will be redirected. The URL structure differs slightly between the two flows:

ENROLL

GET Method: Construct the URL with all required parameters appended as query strings.

https://your-base-url/validar-persona?callback=YOUR_CALLBACK_URL&key=YOUR_API_KEY&projectName=YOUR_PROJECT_NAME&product=YOUR_PRODUCT_NUMBER&Parameters=YOUR_CUSTOM_PARAMETERS&riskId=YOUR_RISK_ID

POST Method: If using POST, you'll need to set up a form or a web request in your application that submits to the URL https://your-base-url/validar-persona/ with the parameters included in the body of the request.

<form action="https://your-base-url/validar-persona/" method="post" target="_blank">
    <input type="hidden" name="callback" value="YOUR_CALLBACK_URL" />
    <input type="hidden" name="key" value="YOUR_API_KEY" />
    <input type="hidden" name="projectName" value="YOUR_PROJECT_NAME" />
    <input type="hidden" name="product" value="YOUR_PRODUCT_NUMBER" />
    <input type="hidden" name="Parameters" value='YOUR_CUSTOM_PARAMETERS' />
    <input type="hidden" name="riskId" value="YOUR_RISK_ID" />
    <button type="submit">Start ENROLL Process</button>
</form>

Replace placeholders like YOUR_CALLBACK_URL, YOUR_API_KEY, etc., with actual values provided by the identity verification service. The Parameters field should contain a JSON string with any additional information you wish to pass.

VERIFY

GET Method: Similar to ENROLL, but with parameters suited for verification.

https://your-base-url/verificar-persona?callback=YOUR_CALLBACK_URL&key=YOUR_API_KEY&projectName=YOUR_PROJECT_NAME&documentType=DOCUMENT_TYPE&identificationNumber=IDENTIFICATION_NUMBER&product=YOUR_PRODUCT_NUMBER&riskId=YOUR_RISK_ID

POST Method: Submit to https://your-base-url/verificar-persona/ with verification parameters in the request body.

<form action="https://your-base-url/verificar-persona/" method="post" target="_blank">
    <input type="hidden" name="callback" value="YOUR_CALLBACK_URL" />
    <input type="hidden" name="key" value="YOUR_API_KEY" />
    <input type="hidden" name="projectName" value="YOUR_PROJECT_NAME" />
    <input type="hidden" name="documentType" value="DOCUMENT_TYPE" />
    <input type="hidden" name="identificationNumber" value="IDENTIFICATION_NUMBER" />
    <input type="hidden" name="product" value="YOUR_PRODUCT_NUMBER" />
    <input type="hidden" name="riskId" value="YOUR_RISK_ID" />
    <input type="hidden" name="searchOneToMany" value="true_or_false" />
    <input type="hidden" name="getGeolocationOption" value="GEOLOCATION_OPTION" />
    <input type="hidden" name="hideTips" value="true_or_false" />
    <button type="submit">Start VERIFY Process</button>
</form>

Again, ensure that you replace placeholders with actual values relevant to your project and the identity verification service. The searchOneToMany, getGeolocationOption, and hideTips fields are optional and should be included based on your specific requirements.

Redirecting Users

Implement the logic in your web application to redirect users to the prepared URL when they need to complete the ENROLL or VERIFY process. This can be a direct link, a button click event, or an automatic redirection based on application logic.

Handling the Callback

The callback parameter in the URL is crucial as it defines where the user is redirected after completing the verification process. Ensure your application is prepared to handle this callback URL:

• Capture query parameters or POST data returned to the callback URL.
• Process the verification results according to your application's logic (e.g., updating user status, displaying a success message).

Additional Tips

• Custom Parameters: Utilize the Parameters field in the ENROLL flow to pass any additional information specific to the transaction or user. This field must be in JSON format.
• Risk Management: The riskId parameter allows you to specify the risk level of the transaction. Use this to adjust the verification process according to your security needs.
• User Experience: Consider the user journey through the verification process. Provide clear instructions and support to ensure a smooth experience.

By following these steps, you can successfully integrate the Full Experience for identity verification into your web application, enhancing security and user trust in your platform.