Skip to main content
POST
Death Certificate

Authorizations

Authorization
string
header
required

Use your API token as a Bearer token in the Authorization header.

Headers

Authorization
string
required
Example:

"Bearer {your_api_token}"

Accept
string
default:application/json
Content-Type
string
default:application/json

Body

application/json
dateOfEvent
string
required

Date of death in DD-MM-YYYY format.

Example:

"15-03-1990"

registrationNumber
string
required

Death registration number.

registrationState
string
required

State that registered the death.

Example:

"NSW"

registrationDate
string
required

Date the death was registered in DD-MM-YYYY format.

Example:

"15-06-2020"

certificateNumber
string
required

Certificate number.

familyName
string

Family name on the certificate.

givenName
string

Given name(s) on the certificate.

metadata
object

Optional key-value pairs echoed back in the response.

Response

Request processed. Check data.isValid and verificationStatus to determine the outcome.

success
boolean
required
message
string
required
data
object
required
verificationStatus
enum<string>
required
Available options:
VERIFIED,
REJECTED
verificationStatusCode
integer
required

3 = Verified, 1 = Rejected.

transactionId
string<uuid>
required
verificationType
string
required
Example:

"australia_death_certificate"

createdAt
string
required
metadata
object | null