Actas NMD Services
Actas NMD Services
This service obtains the date of issue of birth, marriage or demerger certificates and calculates the validity of the document, returning as a result whether the document is valid or not.
Web Service description
Validate Acta-nmd
The service requests in a restrictive manner the document to be evaluated and the number of days in which the document is valid. The current date is taken as the last day of validity and the number of days received is subtracted to form a date range in which the document is valid.
The service classifies the received document determining whether it is a birth certificate, a marriage certificate or a death certificate.
~/api/ActaNMD/acta
Parameters
Tag |
Type |
Requires |
Description |
file |
file |
yes |
PNG, jpg, jpeg images and pdf documents with a maximum size of 5mb are accepted. |
number_days |
int |
yes |
Number of days for the document to be valid. |
Tag |
Type |
Required |
Description |
apiKey |
string |
yes |
Customer Key |
Answers Document
Name |
Type |
Description |
valid |
Boolean |
represents whether the document is within the date range and is valid or not |
certificate_type |
string |
type of document received, the accepted documents are: birth_certificate, marriage_ertificate or death_certificate |
date_of_issue |
string |
date on which the document was issued |
expiration_date_init |
string |
date calculated with the number of days received (current date - number of days) |
expiration_date_end |
string |
current date |
warnings |
array |
Array of objects with warnings collect |
JSON
{
"valid": boolean,
"certificate_type": "string",#birth_certificate, marriage_ertificate or death_certificate
"date_of_issue": "string", #YYYY-MM-DD
"expiration_date_init": "string", #YYYY-MM-DD
"expiration_date_end": "string", #YYYY-MM-DD
"warnings": [
{
"code": "string",
"message": "string"
}
]
}
Service Messages
Code |
Message |
Description |
ACTANMD001 |
file is required |
The first parameter on post request is required |
ACTANMD002 |
Maximum allowed file size is 5mb |
Maximum allowed file size is 5mb |
ACTANMD003 |
Something was wrong, We are working on the failure |
Internal error in the process |
ACTANMD004 |
Incorrect document |
The document is not: birth, marriage or demerger certificates |
ACTANMD005 |
File upload error |
File upload error |
ACTANMD006 |
Json decode error |
The date obtained cannot be formatted to YYYY-MM-DD |
ACTANMD007 |
Invalid json response |
The date information is incomplete |
ACTANMD008 |
Error processing PDF |
There is an error on the server |
ACTANMD009 |
Error decoding image |
The file could not be decoded PDF |
ACTANMD012 |
Missing date of issue |
No issue date found |
ACTANMD015 |
Access Denied - Invalid ApiKey. |
Access Denied - Invalid ApiKey. |