Validate Marriage Certificate

Request

Method: POST

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

Headers

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

Request Body

Property	Type	Description
DateOfEvent	String	Event date as listed on document, format: YYYY-MM-DD OR YYYY-MM OR YYYY
GivenName	String	First name of person 1, max 60 characters
FamilyName	String	Last name of person 1, max 50 characters
GivenName2	String	First name of person 2, max 60 characters
FamilyName2	String	Last name of person 2, max 50 characters
RegistrationState	String	State the document was issued, format: NSW, VIC, WA, ACT, SA, NT, TAS, QLD
RegistrationNumber	String	Required when available on documents only for the following states: - NSW - up to 7 characters/digits - WA - exactly 7 characters/digits - ACT, SA, NT, VIC - up to 10 characters/digits - TAS - up to 6 characters/digits
RegistrationDate	String	Required when available on documents, only for QLD, format: YYYY-MM-DD
RegistrationYear	String	Required when available on documents, only for VIC, format: 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
attributes	Object	An object containing the description on the response
i:type	String	A description on the request response

Example Requests

Example Request ( Y - Verified )Example Request ( N - Not verified )Example Request ( D - Document error )Example Request ( S - Server error in the DVS system )Example Request ( Error response )Example Request ( Expanded Response )

{
  "DateOfEvent": "2010-07-15",
  "GivenName": "John",
  "FamilyName": "Smith",
  "GivenName2": "Marry",
  "FamilyName2": "Brown",
  "RegistrationState": "NSW",
  "RegistrationNumber": "1234567",
  "CertificateNumber": ""
}

{
  "DateOfEvent": "2010-07-15",
  "GivenName": "John",
  "FamilyName": "Smith",
  "GivenName2": "Marry",
  "FamilyName2": "Brown",
  "RegistrationState": "NSW",
  "RegistrationNumber": "1111111",
  "CertificateNumber": ""
}

{
  "DateOfEvent": "2010-07-15",
  "GivenName": "John",
  "FamilyName": "Smith",
  "GivenName2": "Marry",
  "FamilyName2": "Brown",
  "RegistrationState": "NSW",
  "RegistrationNumber": "2222222",
  "CertificateNumber": ""
}

{
  "DateOfEvent": "2010-07-15",
  "GivenName": "John",
  "FamilyName": "Smith",
  "GivenName2": "Marry",
  "FamilyName2": "Brown",
  "RegistrationState": "NSW",
  "RegistrationNumber": "9999999",
  "CertificateNumber": ""
}

{
  "DateOfEvent": "2010-07-15",
  "GivenName": "John",
  "GivenName2": "Marry",
  "FamilyName2": "Brown",
  "RegistrationState": "NSW"
}

{
  "DateOfEvent": "2010-07-15",
  "GivenName": "John",
  "FamilyName": "Smith",
  "GivenName2": "Marry",
  "FamilyName2": "Brown",
  "RegistrationState": "NSW",
  "RegistrationNumber": "8888888",
  "CertificateNumber": ""
}

Example Responses

Success response ( Y - Verified )Failed response ( N - Not verified )Failed response ( D - Document error )Failed response ( S - Server error in the DVS system )Error ResponseExpanded Response

Status: 200 OK

{
  "VerifyDocumentResult": {
    "attributes": {
      "i:type": "MarriageCertificateResponse"
    },
    "ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "OriginatingAgencyCode": "XXXX",
    "VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "VerificationResultCode": "Y"
  },
  "fieldDetails": {
    "EventDay": "Full Match",
    "EventMonth": "Full Match",
    "EventYear": "Full Match",
    "DateOfEvent": "Full Match",
    "GivenName": "Full Match",
    "FamilyName": "Full Match",
    "GivenName2": "Full Match",
    "FamilyName2": "Full Match",
    "RegistrationState": "Full Match",
    "RegistrationNumber": "Full Match",
    "RegistrationDay": "Full Match",
    "RegistrationMonth": "Full Match",
    "RegistrationYear": "Full Match",
    "RegistrationDate": "Full Match",
    "CertificateNumber": "Full Match"
  },
  "rapidID": "check-id"
}

Status: 200 OK

{
  "VerifyDocumentResult": {
    "attributes": {
      "i:type": "MarriageCertificateResponse"
    },
    "ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "OriginatingAgencyCode": "XXXX",
    "VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "VerificationResultCode": "N"
  },
  "fieldDetails": {
    "EventDay": "No Match",
    "EventMonth": "No Match",
    "EventYear": "No Match",
    "DateOfEvent": "No Match",
    "GivenName": "No Match",
    "FamilyName": "No Match",
    "GivenName2": "No Match",
    "FamilyName2": "No Match",
    "RegistrationState": "No Match",
    "RegistrationNumber": "No Match",
    "RegistrationDay": "No Match",
    "RegistrationMonth": "No Match",
    "RegistrationYear": "No Match",
    "RegistrationDate": "No Match",
    "CertificateNumber": "No Match"
  },
  "rapidID": "check-id"
}

Status: 200 OK

{
  "VerifyDocumentResult": {
    "attributes": {
      "i:type": "MarriageCertificateResponse"
    },
    "ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "OriginatingAgencyCode": "XXXX",
    "VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "VerificationResultCode": "D"
  },
  "fieldDetails": {
    "EventDay": "No Match",
    "EventMonth": "No Match",
    "EventYear": "No Match",
    "DateOfEvent": "No Match",
    "GivenName": "No Match",
    "FamilyName": "No Match",
    "GivenName2": "No Match",
    "FamilyName2": "No Match",
    "RegistrationState": "No Match",
    "RegistrationNumber": "No Match",
    "RegistrationDay": "No Match",
    "RegistrationMonth": "No Match",
    "RegistrationYear": "No Match",
    "RegistrationDate": "No Match",
    "CertificateNumber": "No Match"
  },
  "rapidID": "check-id"
}

Status: 200 OK

{
  "VerifyDocumentResult": {
    "attributes": {
      "i:type": "MarriageCertificateResponse"
    },
    "ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "OriginatingAgencyCode": "XXXX",
    "VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "VerificationResultCode": "S"
  },
  "fieldDetails": {
    "EventDay": "No Match",
    "EventMonth": "No Match",
    "EventYear": "No Match",
    "DateOfEvent": "No Match",
    "GivenName": "No Match",
    "FamilyName": "No Match",
    "GivenName2": "No Match",
    "FamilyName2": "No Match",
    "RegistrationState": "No Match",
    "RegistrationNumber": "No Match",
    "RegistrationDay": "No Match",
    "RegistrationMonth": "No Match",
    "RegistrationYear": "No Match",
    "RegistrationDate": "No Match",
    "CertificateNumber": "No Match"
  },
  "rapidID": "check-id"
}

Status: 400 Bad Request

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

Status: 200 OK

{
  "VerifyDocumentResult": {
    "attributes": {
      "i:type": "MarriageCertificateResponse"
    },
    "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": {
    "EventDay": "No Match",
    "EventMonth": "No Match",
    "EventYear": "No Match",
    "DateOfEvent": "No Match",
    "GivenName": "No Match",
    "FamilyName": "No Match",
    "GivenName2": "No Match",
    "FamilyName2": "No Match",
    "RegistrationState": "No Match",
    "RegistrationNumber": "No Match",
    "RegistrationDay": "No Match",
    "RegistrationMonth": "No Match",
    "RegistrationYear": "No Match",
    "RegistrationDate": "No Match",
    "CertificateNumber": "No Match"
  },
  "rapidID": "check-id"
}