Validate Birth Certificate

Request

Method: POST

URL: https://{{environment}}.ridx.io/dvs/v1/birthCertificate

Headers

Header	Value
Content-Type	application/json
token	{{access_token}}

Request Body

Property	Type	Description
BirthDate	String	Date of the search subject's birth, format: YYYY-MM-DD OR YYYY-MM OR YYYY
GivenName	String	First name of the search subject, max 60 characters
FamilyName	String	Last name of the search subject, max 50 characters
RegistrationState	String	A valid Australian State or Territory short code (NSW, WA, ACT, SA, NT, TAS, QLD, VIC)
RegistrationNumber	String	Required for the following states: NSW (up to 7 characters/digits) WA (exactly 7 characters/digits) ACT, SA, NT, VIC (up to 10 characters/digits)
RegistrationDate	String	Required when available on documents only for TAS and QLD (YYYY-MM-DD)
RegistrationYear	String	Required when available on documents only for VIC (YYYY)
CertificateNumber	String	Required when available on NSW, WA, ACT, SA, NT, TAS, QLD documents only for the following states: NSW up to 11 characters/digits WA, TAS exactly 11 characters/digits QLD exactly 10 characters/digits ACT, SA up to 9 characters/digits NT up to 6 characters/digits

Important Response Data

Property	Type	Description
VerifyDocumentResult	Object	The object containing the reply
VerificationResultCode	String	A value of Y (Yes), N (No), D (Document Error), S (Server Error)
VerificationRequestNumber	String	A receipt number of the request created by RapidID
OriginatingAgencyCode	String	A code representing the customers unique identifier code
ActivityId	String	A activity process id
fieldDetails	Object	An object containing field-by-field match results
rapidID	String	Check ID used for retrieving pdf report
Errors	Object	Optional. This object is returned only when VerificationResultCode value is N (No). This object provides greater insight into why the request did not match the data held by the issuer

Example Requests

Example Request (Y - Verified)Example Request (N - Not verified)Example Request (E - Error)

{
  "BirthDate": "1965-01-01",
  "FamilyName": "smith",
  "GivenName": "john",
  "RegistrationState": "NSW",
  "RegistrationYear": "2005",
  "RegistrationNumber": "500156",
  "RegistrationDate": "2005-08-27",
  "CertificateNumber": "1758461"
}

{
  "BirthDate": "1965-01-01",
  "FamilyName": "smith",
  "GivenName": "john",
  "RegistrationState": "NSW",
  "RegistrationYear": "2005",
  "RegistrationNumber": "",
  "RegistrationDate": "2005-08-27",
  "CertificateNumber": "11111111"
}

{
  "BirthDate": "1965-01-01",
  "GivenName": "john",
  "RegistrationState": "NSW"
}

Example Responses

Success Response (Y - Verified)Failed Response (N - Not verified)Failed Response (S - Server error)Failed Response (D - Document error)Error Response (E - Error)Expanded Response (N - With Errors)

Status: 200 OK

{
  "VerifyDocumentResult": {
    "attributes": {
      "i:type": "BirthCertificateResponse"
    },
    "ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "OriginatingAgencyCode": "XXXX",
    "VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "VerificationResultCode": "Y"
  },
  "fieldDetails": {
    "GivenName": "Full Match",
    "FamilyName": "Full Match",
    "BirthDate": "Full Match",
    "BirthDay": "Full Match",
    "BirthMonth": "Full Match",
    "BirthYear": "Full Match",
    "RegistrationDate": "Full Match",
    "RegistrationDay": "Full Match",
    "RegistrationMonth": "Full Match",
    "RegistrationYear": "Full Match",
    "RegistrationNumber": "Full Match",
    "CertificateNumber": "Full Match",
    "RegistrationState": "Full Match"
  },
  "rapidID": "check-id"
}

Status: 200 OK

{
  "VerifyDocumentResult": {
    "attributes": {
      "i:type": "BirthCertificateResponse"
    },
    "ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "OriginatingAgencyCode": "XXXX",
    "VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "VerificationResultCode": "N"
  },
  "fieldDetails": {
    "GivenName": "No Match",
    "FamilyName": "No Match",
    "BirthDate": "No Match",
    "BirthDay": "No Match",
    "BirthMonth": "No Match",
    "BirthYear": "No Match",
    "RegistrationDate": "No Match",
    "RegistrationDay": "No Match",
    "RegistrationMonth": "No Match",
    "RegistrationYear": "No Match",
    "RegistrationNumber": "No Match",
    "CertificateNumber": "No Match",
    "RegistrationState": "No Match"
  },
  "rapidID": "check-id"
}

Status: 200 OK

{
  "VerifyDocumentResult": {
    "attributes": {
      "i:type": "BirthCertificateResponse"
    },
    "ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "OriginatingAgencyCode": "XXXX",
    "VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "VerificationResultCode": "S"
  },
  "fieldDetails": {
    "GivenName": "No Match",
    "FamilyName": "No Match",
    "BirthDate": "No Match",
    "BirthDay": "No Match",
    "BirthMonth": "No Match",
    "BirthYear": "No Match",
    "RegistrationDate": "No Match",
    "RegistrationDay": "No Match",
    "RegistrationMonth": "No Match",
    "RegistrationYear": "No Match",
    "RegistrationNumber": "No Match",
    "CertificateNumber": "No Match",
    "RegistrationState": "No Match"
  },
  "rapidID": "check-id"
}

Status: 200 OK

{
  "VerifyDocumentResult": {
    "attributes": {
      "i:type": "BirthCertificateResponse"
    },
    "ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "OriginatingAgencyCode": "XXXX",
    "VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "VerificationResultCode": "D"
  },
  "fieldDetails": {
    "GivenName": "No Match",
    "FamilyName": "No Match",
    "BirthDate": "No Match",
    "BirthDay": "No Match",
    "BirthMonth": "No Match",
    "BirthYear": "No Match",
    "RegistrationDate": "No Match",
    "RegistrationDay": "No Match",
    "RegistrationMonth": "No Match",
    "RegistrationYear": "No Match",
    "RegistrationNumber": "No Match",
    "CertificateNumber": "No Match",
    "RegistrationState": "No Match"
  },
  "rapidID": "check-id"
}

Status: 400 Bad Request

{
  "result": {
    "statuscode": "400",
    "error": [
      "FamilyName needs a value"
    ]
  }
}

Status: 200 OK

{
  "VerifyDocumentResult": {
    "attributes": {
      "i:type": "BirthCertificateResponse"
    },
    "ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "OriginatingAgencyCode": "XXXX",
    "VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "VerificationResultCode": "N",
    "Errors": {
      "Error": {
        "Field": "RegistrationNumber",
        "Message": "Registration number does not match.",
        "Source": "Issuer"
      }
    }
  },
  "fieldDetails": {
    "GivenName": "No Match",
    "FamilyName": "No Match",
    "BirthDate": "No Match",
    "BirthDay": "No Match",
    "BirthMonth": "No Match",
    "BirthYear": "No Match",
    "RegistrationDate": "No Match",
    "RegistrationDay": "No Match",
    "RegistrationMonth": "No Match",
    "RegistrationYear": "No Match",
    "RegistrationNumber": "No Match",
    "CertificateNumber": "No Match",
    "RegistrationState": "No Match"
  },
  "rapidID": "check-id"
}