We will enforce stricter safeguards for the Verified API

1. Is this relevant to me?

This is relevant to clients using the Verified API to integrate with the platform.

2. What is it?

We will enforce stricter safeguards for the Verified API, meaning that API calls which were more lenient before will throw an error if the rules detailed below are not respected. 

For creating/ adding a new recipient to an envelope API call:

• familyName is mandatory and can’t be an empty string, at least one letter is required
• givenName is mandatory and can’t be an empty string, at least one letter is required
• email is mandatory and can’t be an empty string; it should also have a valid email format
• signingMethod is mandatory and can’t be an empty string, at least one letter is required
• notificationMethod has only 2 valid values, “sms” and “email”. If not added, the default notificationMethod is “email”.
• telephone is mandatory only when the sms  is true or when notificationMethod is “sms”. When telephone is mandatory, it should have between 7 and 14 digits ( validation regex: /[0-9]{7,14}/ ). 
• bank is required to be specified when secure flag is true. By default the secure  flag is false and it is not mandatory. 
• ssn is required based on the bank field and it is validated against its value. There are 2 values for the bank when the ssn is not required, when the bank is either “passport-reader" or “mobiilivarmenne“. For any other values of the bank field, ssn is required.
• bank field, in most cases, gives information about the country of the ssn . There are few exceptions, when ssn is not directly validated based on the country specified in the  bank field. These cases are the following:
  • When bank is  zealid or freja , the country of the ssn is deducted from the secureProvider.country 
  • If bank has any other value, the bank will be used as the country of the ssn (bank = country of the ssn) .
  • If  the country of the ssn  is se , the ssn should have the following format : /^[0-9]{12}$/
  • If the country of the ssn   is ee or lt or no, the ssn should have the following format : /^[0-9]{11}$/
  • If  the country of the ssn is dk or be, the ssn should have the following format : /^[0-9]{10}$/
  • If  the country of the ssn is fi, the ssn should have the following format : /^[0-9A-Z\-]{11}$/
  • If  the country of the ssn is rs the ssn should have the following format : /^[0-9]{13}$/
  • If  the country of the ssn is lv the ssn should have the following format : /^[0-9]{6}(-?)[0-9]{5}$/
  • If  the country of the ssn is pt the ssn should have the following format :  /^.*$/
  • If the country of the ssn does not have any of the values described above, we check if the roles field is an array of objects, and if any object from that array has a property additionalModel.signingMethod equal to nets-esign-dk . If this check is true, then we don’t need to validate the ssn.
  • If this check is false, the request will fail because we are not able to validate the ssn based on the bank 

When editing a recipient;

• notificationMethod has only 2 valid values, “sms” and “email”. If not added, the default notificationMethod is “email”.

3. How does it work?

Once this is implemented the rules for using our API will be stricter.

If you use the API to integrate with our platform please forward these upcoming changes to your developers.

4. FAQ?

When will this go into effect?

This update will be deployed in the near future. We will make an announcemnet before these safeguards are live. 

Please subscribe to our status page where you will recive emails for upcoming changes in our platform. https://status.verified.eu/