validation.md

Validations

Money laundering regulations require companies to validate the identity of their clients. The validation object can accomplish this, using only a social security number and an electronic ID.

The process and the validation object is very similar to the signing request. And like the signing request, the validation link can be send out via Penneo by email, or you can choose to distribute it to the user in your own system.

Distributing the validation link through Penneo

Penneo can distribute the validation link for you. The link will be send out to the user in an email through Penneos infrastructure.

The process is best explained by an example:

// Create a new validation with details of the user to validate
myValidation = new Validation("John Doe", "[email protected]");
myValidation.Title = "My validation";

// Define the content of the email
myValidation.EmailSubject = "Validation inquiry";
myValidation.EmailText = "Dear john. Please validate yourself using this link.";

// Persist the new validation object
myValidation.Persist();

// Finally, send out the validation link
myValidation.Send();

Reminder emails

When using Penneo to distribute validation links, it is also possible to have Penneo remind the person regularly by email, until the he/she completes the validation. To set up a reminder, just use the setReminderInterval() method to set the number of days between reminders.

Distributing the validation link yourself

If you don't want Penneo to distribute your validation links, you can handle the process yourself. All you need to do is to fetch the link from the validation object:

// Create a new validation with details of the user to validate
myValidation = new Validation("John Doe");
myValidation.Title = "My validation";

// Persist the new validation object
myValidation.Persist();

// Activate the validation object
myValidation.Send();

// Retrieve the validation link that you would like to distribute
myLink = myValidation.GetLink();

// In case you would like to re-send the validation request from Penneo at a later point, you need to set the email details
myValidation.Email = "[email protected]";
myValidation.EmailSubject = "Validation inquiry";
myValidation.EmailText = "Dear john. Please validate yourself using this link.";

// Persist the new validation object
myValidation.Persist();

Note that the validation link won't be active until you call the Send() method on the validation object.

Customizing the validation process

When the user completes the validation process, the signer is redirected to the default Penneo success page. You can choose to use your own custom status pages instead. All you need to do is pass the urls to the validation object like so:

// Set the url for the custom success page
myValidation.SuccessUrl = "http://go/here/on/success";

// Store the changes to the validation object
myValidation.Persist();

It is also possible to change the default explanatory text provided on the validation web-page to better fit your companies or customers validation use case. You can set a custom text like so:

// Set the url for the custom success page
myValidation.CustomText = "Here is my custom text<br>Please validate yourself!";

// Store the changes to the validation object
myValidation.Persist();

The custom text can't contain any HTML tags, except for the
tag.

Retrieving the validation document

Once the validation is completed (when GetStatus() returns Completed), the resulting validation document can be retrieved:

myValidation.GetPdf();

The validation document contains all the information that Penneo has gathered about the validated person.

State variables

A series state variables are used to describe the validation state over the course of its life time. The methods for retrieving the state variables are described below:

• GetStatus() Returns the status of the validation as a string. Possible status values are:
• New: The validation request hasn't been sent out yet
• Pending: Waiting for the user to complete the validation
• Undeliverable: The validation request email could not be delivered
• Deleted: The validation has been send but have since been deleted
• Ready: The user has completed the validation process, but the validation document is not generated yet
• Completed: The validation process is completed