Skip to main content

Death Certificate DB Validation API

API Description​

Objective​

The Death Certificate DB Validation API retrieves the death certificate information from a database(DB) including,

  • The name of the deceased,
  • The name of the father, husband or guardian of the deceased,
  • The name of the mother of the deceased,
  • The date of death,
  • The registration number,
  • The status of the certificate,
  • The registration date,
  • The registration year,
  • The age of the deceased,
  • The gender of the deceased,
  • The place of death,
  • The link to the certificate,
  • The address of the deceased,
  • The mobile number of the deceased,
  • The spouse's name,
  • Remarks.
InputOutput
The registration number and other mandatory details from the Death Certificate OCR API depending on the regionThe complete death certificate information stored in the database

Prerequisite​

An optical character recognition(OCR) transaction performed on a death certificate. The fields extracted in the process serve as the input parameters for this API.

API URL​

https://ind-engine.thomas.hyperverge.co/v1/deathCertificateWrapper

Overview​

The API is RESTful and uses standard HTTP verbs and status codes. The responses are in JSON format and you should upload all images and files as form-data through a POST request.

Authentication​

You need a unique pair of application ID ( appId ) and application key (appKey) from HyperVerge to verify your identity for accessing the API.

API Request Details

Method - POST

Headers

ParameterMandatory or OptionalTypeDescriptionValid Values
content-typeMandatorystringThis parameter defines the media type for the request payload.multipart/form-data
appIdMandatorystringThe application ID shared by HyperVergeNot Applicable - this is a unique value.
appKeyMandatorystringThe application key shared by HyperVergeNot Applicable - this is a unique value.
transactionIdMandatorystringThe unique identifier associated with the customer or the customer's journey.Not Applicable - this is a unique value.

Input​

The following table provides the complete information on the parameter options accepted by the API.

ParameterMandatory or OptionalAllowed ValuesDescription
consentMandatoryY or NConsent for fetching the details from Database. For example: Y or N
regionMandatoryUTTAR_PRADESH, KERALA, ODISHA, TAMIL_NADU, NAVI_MUMBAI, MUMBAI, BHIWANDI, CHHATTISGARH, GOA, AHMEDABAD, JAMNAGAR, DELHI, RAJASTHAN, WEST_BENGALOne of the fourteen supported regions.
regNoMandatoryNot ApplicableRegistration Number of the Death Certificate
dateOfDeathOptionalYYYY-MM-DD formatDate of Death in YYYY-MM-DD format
deceasedNameOptionalNot ApplicableName of the deceased individual
genderOptionalNot ApplicableGender of the deceased individual
ackNoOptionalNot ApplicableAcknowledgement Number
regYearOptionalNot ApplicableRegistration Number
districtOptionalNot ApplicableDistrict of the individual
localBodyTypeOptionalNot ApplicableThe categorization or classification of the local administrative body responsible for governance and services in a specific geographic area
localBodyOptionalNot ApplicableThe administrative unit responsible for local governance and services in a specific geographic area
councilOptionalNot ApplicableThe governing body responsible for local administration and decision-making
subRegionOptionalNot ApplicableThe smaller geographic division or administrative unit within a broader region

Request Sample​

note

The following request sample includes all supported parameters. However, the mandatory parameters for a request depends on the region associated with the death certificate. The mandatory parameters for different regions are mentioned in the Mandatory Parameters by Region section.


curl --location --request POST 'https://ind-engine.thomas.hyperverge.co/v1/deathCertificateWrapper' \
--header 'Content-Type: application/json' \
--header 'appId: <Enter_the_HyperVerge_appId>' \
--header 'appKey: <Enter_the_HyperVerge_appKey>' \
--header 'transactionId: <Enter_the_HyperVerge_transactionID>' \
--data '{
    "consent": "Y",
    "region": "TAMIL_NADU",
    "regNo": "08119006130007800021",
    "dateOfDeath": "2020-09-20",
    "deceasedName": "A. ABDUL MUTHALIPU",
    "gender": "M",
    "ackNo": "",
    "regYear": "",
    "district": "",
    "localBodyType": "",
    "localBody": "",
    "council": "",
    "subRegion": ""
}'

Mandatory Parameters by Region​

The API expects a set of mandatory parameters based on the region associated with a death certificate.
The following code samples highlight the mandatory parameters for each region.


{
	"ackNo" : "", //optional if regNo is used
	"regNo" : "", //optional if ackNo is used
	"region" : "UTTAR_PRADESH"
}

Success Response Sample​

The following is a sample success response.

{
  "status": "success",
  "statusCode": "200",
  "metaData": {
      "transactionId": "transactionsample",
      "requestId": "1700465756840-c3dcaf16-41f9-4179-8168-af32ffdac728"
  },
  "result": {
      "requestId": "8fa0c95f-3616-42ec-abc8-ca1e7d8ef5c3",
      "result": [
          {
              "deceasedName": "<Name>",
              "fatherOrHusbandOrGuardianName": "<Name>",
              "motherName": "<Name>",
              "dateOfDeath": "2020-09-20",
              "regNo": "D-2020:33-16405-000145",
              "status": null,
              "regDate": "2020-09-24",
              "regYear": "2020",
              "age": "59 YEARS",
              "gender": "M",
              "placeOfDeath": "DR.RABINDRANCLINIC 96/212, MTHROADVENKATAPURAM AMBATHUR-\n600053",
              "link": "<link>",
              "address": "<Address>",
              "mobileNumber": null,
              "spouseName": "<Name>",
              "remarks": null
          }
      ],
      "statusCode": 101
  }
}

Success Response Details​

ParameterDescription
nameThe name of the deceased individual
fatherOrHusbandOrGuardianNameThe name of the deceased individual's father or husband or guardian
motherNameThe name of the deceased individual's mother
dateOfDeathThe date of the death in YYYY-MM-DD format
regNoThe registration Number of the Death Certificate
status
regDateThe registration date
regYearThe registration number
ageThe age of the deceased individual
genderThe fender of the deceased individual
placeOfDeathThe location of death
linkThe link to the PDF of the Death Certificate
addressThe address of the deceased individual
mobileNumberThe mobile number of the deceased individual
spouseNameThe name of the deceased individual's spouse

Failure Response Sample​

The following is a sample failure response where the API fails to detect a document from the image.

{
  "status": "failure",
  "statusCode": "400",
  "metaData": {
    "transactionId": "8dih-asdb-6-42ec-abc8-ca1e7d8ef5c3",
    "requestId": "8fa0c95f-3616-42ec-abc8-ca1e7d8ef5c3"
        },
  "result": "Bad Request"
}

Error Response Sample​

The following are the sample error responses for the API.

{
  "status": "failure",
  "statusCode": "503",
  "metaData": {
    "transactionId": "8dih-asdb-6-42ec-abc8-ca1e7d8ef5c3",
    "requestId": "8fa0c95f-3616-42ec-abc8-ca1e7d8ef5c3"
        },
  "result": "Source Unavailable"
}

Failure and Error Response Details​

A failure or error response from the API contains a failure status with a relevant status code and error message. The following table lists all error responses.

Status CodeError MessageError Description
102Endpoint Request Timed OutThe request to the endpoint timed out, please check your connection and try again.
400Bad RequestPlease retry the request.
401Missing/Invalid credentialsThe request either does not contain the mandatory credentials or contains invalid credentials.
429Too many requestsToo many requests were made in a given amount of time, please try again later.
500Internal Server ErrorAn internal server error occurred, please contact support for assistance.
503Source Unavailable
504Endpoint Request Timed OutThe request to the endpoint timed out, please check your connection and try again.
504No records found for the given ID or combination of inputsThe request has information that does not match.
Last updated on
Was this helpful?
ON THIS PAGE
Ask AIBeta
Hi! How can I help?
Ask me anything about HyperVerge products, APIs, and SDKs.
Try asking: