Skip to main content
POST
Marriage 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
familyName
string
required

Family name of the first party.

givenName
string
required

Given name(s) of the first party.

dateOfEvent
string
required

Date of marriage in DD-MM-YYYY format.

Example:

"15-03-2018"

registrationNumber
string
required

Marriage registration number.

registrationState
string
required

State that registered the marriage.

Example:

"NSW"

registrationDate
string
required

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

Example:

"25-08-2018"

certificateNumber
string
required

Certificate number.

familyName2
string

Family name of the second party.

givenName2
string

Given name(s) of the second party.

registrationYear
string

Year the marriage was registered.

datePrinted
string

Date the certificate was printed in DD-MM-YYYY format.

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_marriage_certificate"

createdAt
string
required
metadata
object | null