Skip to main content
POST
Immigration Card (ImmiCard)
Verify an Australian ImmiCard against the Department of Home Affairs record. An ImmiCard is issued to non-citizens who need evidence of identity but hold no passport. Submit the ImmiCard number alongside the holder’s name and date of birth.

Reading the result

Check data.isValid to determine whether the submitted details match the issuing agency’s records. A no-match still returns HTTP 200 with success: true — see Introduction to Australia DVS for how to interpret verificationStatus.

Sandbox test data

Immigration Card sandbox payloads

Copy-paste payloads for every outcome.

Authorizations

Authorization
string
header
required

Use your API token as a Bearer token in the Authorization header.

Headers

Authorization
string
required
Example:

"Bearer {your_api_token}"

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

Body

application/json
familyName
string
required

Family name on the ImmiCard.

givenName
string
required

Given name(s) on the ImmiCard.

dob
string
required

Date of birth in DD-MM-YYYY format.

Example:

"15-03-1990"

immiCardNumber
string
required

ImmiCard number.

metadata
object

Optional key-value pairs echoed back in the response.

Response

Request processed. Check data.isValid and verificationStatus to determine the outcome.

success
boolean
required
message
string
required
data
object
required
verificationStatus
enum<string>
required
Available options:
VERIFIED,
REJECTED
verificationStatusCode
integer
required

3 = Verified, 1 = Rejected.

transactionId
string<uuid>
required
verificationType
string
required
Example:

"australia_immigration"

createdAt
string
required
metadata
object | null