Validate ImmiCard

Request

Method: POST

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

Headers

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

Request Body

Property	Type	Description
BirthDate	String	Birth date of citizen, format: YYYY-MM-DD OR YYYY-MM OR YYYY
GivenName	String	First name of citizen, max 49 characters
MiddleName	String	Optional. Middle name of citizen, max 49 characters
FamilyName	String	Last name of citizen, max 49 characters
ImmiCardNumber	String	ImmiCard number, min 9 characters

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
Errors	Object	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
Error	Object	This object contains fields such as Field, Message and Source with a description on the error 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 )

{
  "BirthDate": "1980-10-31",
  "GivenName": "James",
  "MiddleName": "Robert",
  "FamilyName": "Smith",
  "ImmiCardNumber": "PRE008948"
}

{
  "BirthDate": "1980-10-31",
  "GivenName": "James",
  "MiddleName": "Robert",
  "FamilyName": "Smith",
  "ImmiCardNumber": "AMS111111"
}

{
  "BirthDate": "1980-10-31",
  "GivenName": "James",
  "MiddleName": "Robert",
  "FamilyName": "Smith",
  "ImmiCardNumber": "AMS222222"
}

{
  "BirthDate": "1980-10-31",
  "GivenName": "James",
  "MiddleName": "Robert",
  "FamilyName": "Smith",
  "ImmiCardNumber": "AMS999999"
}

{
  "BirthDate": "1980-10-31",
  "GivenName": "James",
  "MiddleName": "Robert",
  "FamilyName": "Smith",
  "ImmiCardNumber": ""
}

{
  "BirthDate": "1980-10-31",
  "GivenName": "James",
  "MiddleName": "Robert",
  "FamilyName": "Smith",
  "ImmiCardNumber": "AMS888888"
}

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": "ImmiCardResponse"
    },
    "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",
    "ImmiCardNumber": "Full Match",
    "RegistrationState": "Full Match"
  },
  "rapidID": "check-id"
}

Status: 200 OK

{
  "VerifyDocumentResult": {
    "attributes": {
      "i:type": "ImmiCardResponse"
    },
    "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",
    "ImmiCardNumber": "No Match",
    "RegistrationState": "No Match"
  },
  "rapidID": "check-id"
}

Status: 200 OK

{
  "VerifyDocumentResult": {
    "attributes": {
      "i:type": "ImmiCardResponse"
    },
    "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",
    "ImmiCardNumber": "No Match",
    "RegistrationState": "No Match"
  },
  "rapidID": "check-id"
}

Status: 200 OK

{
  "VerifyDocumentResult": {
    "attributes": {
      "i:type": "ImmiCardResponse"
    },
    "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",
    "ImmiCardNumber": "No Match",
    "RegistrationState": "No Match"
  },
  "rapidID": "check-id"
}

Status: 400 Bad Request

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

Status: 200 OK

{
  "VerifyDocumentResult": {
    "attributes": {
      "i:type": "ImmiCardResponse"
    },
    "ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "OriginatingAgencyCode": "XXXX",
    "VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "VerificationResultCode": "N",
    "Errors": {
      "Error": {
        "Field": "ImmiCardNumber",
        "Message": "Travel document could not be found.",
        "Source": "Issuer"
      }
    }
  },
  "fieldDetails": {
    "GivenName": "No Match",
    "FamilyName": "No Match",
    "BirthDate": "No Match",
    "BirthDay": "No Match",
    "BirthMonth": "No Match",
    "BirthYear": "No Match",
    "ImmiCardNumber": "No Match",
    "RegistrationState": "No Match"
  },
  "rapidID": "check-id"
}