DVS Responses

The response from a DVS request consists of the following attributes in the data object:

• response_type: The type of response returned from DVS.
• activity_id: The unique identifier for the response generated by DVS.
• verification_request_number: A unique identifier assigned to the request that is matched to a DVS response.
• verification_result_code: The result of the verification request. The following codes are returned:
  • Y: The data in the request matches data held by the issuer.
  • N: The data in the request does not match data held by the issuer.
  • D: A data error occurred at the issuer - Eg: The document itself is invalid or not electronically held.

Expanded Responses

In the case of N or D results, some responses include an expanded message that provides additional information about the result.

The expanded response will be listed in an additional_information array. The additional_information array will contain one or more objects with the following attributes:

• code: An ID code for the expanded response.
• message: The expanded response message.

DVS System Error

It is also possible that the DVS returns a system error in the event that there is a problem at either the DVSHub or the Document Issuer. In these cases, a 503 HTTP status code will be returned, with the message 'DVS returned a system error. Please try again later.'.

Depending on the problem, it may be worth retrying the request after a short delay.

Malicious Activity Protection Solution Lockout

Individual documents may be locked out from further verification attempts if a high number of verification requests are made within a short period of time. The number of attempts before lockout ranges from 4 to 10, depending on the document type.

If a document is locked out, an N result will be returned with an error code of DVS-001 and the message Document Temporarily Locked, indicating that the document has been temporarily locked out from further verification attempts. This lockout will expire after 20 minutes if no further attempts are made on the document. The lockout timeny further attempts during the lockout period will restart the lockout timer.