NZ Passport Validation

Request

Method: POST

URL: https://{{environment}}.ridx.io/infolog/dia/passportValidation

Headers

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

Request Body

Property	Type	Description
GivenName	String	Given name
FamilyName	String	Family name
DateOfBirth	String	Date of birth, preferred format: yyyy/mm/dd
TravelDocumentExpiryDate	String	Date the Passport expires, preferred format: yyyy/mm/dd
TravelDocumentNumber	String	Passport number, format: 7-9 characters

Important Response Data

Property	Type	Description
ResponseCode	String	Represents the status of the check, values will be "Consistent" (C) for a pass, "Not Consistent" (NC) for a fail and "Exception" (E) when the check failed for a special reason
Exceptions	String	Contains a list of special exceptions when a check fails with the E response code
UnmatchedFields	String	Contains a list of required fields that did not match in the search

Example Requests

Example Request ( Success response )Example Request ( Error response )

{
  "GivenName": "John",
  "FamilyName": "Smith",
  "DateOfBirth": "1970/01/01",
  "TravelDocumentExpiryDate": "31/01/2028",
  "TravelDocumentNumber": "LM11111111"
}

{
  "GivenName": "John",
  "FamilyName": "Smith",
  "TravelDocumentExpiryDate": "31/01/2028",
  "TravelDocumentNumber": "LM123456"
}

Example Responses

Success responseError Response

Status: 200 OK

{
  "status": 200,
  "message": "ok",
  "data": {
    "TravelDocumentNumber": "LM11111111",
    "TravelDocumentType": null,
    "TravelDocumentIssueDate": null,
    "TravelDocumentExpiryDate": "2028-01-31T00:00:00",
    "TravelDocumentPlaceOfIssue": null,
    "FirstName": "John",
    "LastName": "Smith",
    "FirstNameAtBirth": null,
    "LastNameAtBirth": null,
    "Gender": null,
    "DateOfBirth": "1970-01-01T00:00:00",
    "PlaceOfBirth": null,
    "CountryOfBirth": null,
    "Height": null,
    "EyeColour": null,
    "EmailAddress": null,
    "PostalAddress": null,
    "ResidentialAddress": null,
    "HomePhoneNumber": null,
    "HomePhoneNumberType": 0,
    "WorkPhoneNumber": null,
    "WorkPhoneNumberType": 0,
    "ResponseType": "Document Status",
    "ResponseCode": "C",
    "ResponseText": "Consistent",
    "Exceptions": [],
    "MatchedFields": [],
    "UnmatchedFields": [
      "Official First Name",
      "Official Surname",
      "Date of Birth",
      "Date Valid To"
    ],
    "rapidID": "check-id"
  }
}

Status: 400 Bad Request

{
  "status": 400,
  "message": "ok",
  "data": {
    "error": "DateOfBirth is required"
  }
}