Skip to main content
POST
/
api
/
v1
/
verification
/
australia
/
certificate
/
birth
AU Birth Certificate
curl --request POST \
  --url https://{environment-subdomain}.idmetagroup.com/api/v1/verification/australia/certificate/birth \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "certificate_number": "<string>",
  "date_printed": "2020-08-15",
  "dob": "1990-05-12",
  "family_name": "<string>",
  "given_name": "<string>",
  "registration_date": "1990-05-15",
  "registration_number": "<string>",
  "registration_state": "NSW",
  "registration_year": 123,
  "template_id": "{your_trust_flow_id}",
  "verification_id": "{your_created_verification_id}"
}
'
{
  "status": true,
  "message": "OK",
  "result": {
    "ActivityId": "30b3fdeb-32ba-444b-a818-052c3102fd40",
    "Errors": [],
    "OriginatingAgencyCode": "IDM001",
    "VerificationRequestNumber": "VI-01-01",
    "VerificationResultCode": 2
  }
}

Authorizations

​
Authorization
string
header
required

Use Bearer {your_api_token} in the Authorization header.

Headers

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

Body

application/json
​
dob
string<date>
required

Date of birth of the individual.

​
registration_number
string
required

Official birth registration number.

​
registration_state
enum<string>
required

Australian state where the birth was registered.

Available options:
ACT,
NSW,
NT,
QLD,
SA,
TAS,
VIC,
WA
​
template_id
string
required

Identifier used to categorize or group requests for tracking or reporting.

​
verification_id
string
required

A unique ID used to identify your verification request.

​
certificate_number
string

Unique number printed on the birth certificate.

​
date_printed
string<date>

Date when the certificate was issued or printed.

​
family_name
string

Family name of the individual.

​
given_name
string

Given name of the individual.

​
registration_date
string<date>

Date of registration.

​
registration_year
integer

Year of registration.

Response

200 - application/json

AU birth certificate verification processed successfully

​
status
boolean
​
message
string
​
result
object