> ## Documentation Index > Fetch the complete documentation index at: https://docs.idmetagroup.com/llms.txt > Use this file to discover all available pages before exploring further. # Immigration Card (ImmiCard) > Verify an Australian Immigration Card (ImmiCard) by submitting the required immigration card details to the Australian Document Verification Service (DVS). ## OpenAPI ````yaml stateless-verification-api/australia-dvs/immigration.openapi.json POST /api/v3/verifications/australia-immigration-passthrough openapi: 3.0.3 info: title: Australia DVS API - Immigration Card (ImmiCard) version: 1.0.0 servers: - url: https://{environment-subdomain}.idmetagroup.com description: Your environment (replace `{environment-subdomain}`) variables: environment-subdomain: default: integrate description: IDmeta environment subdomain security: - bearerAuth: [] paths: /api/v3/verifications/australia-immigration-passthrough: post: tags: - Australia DVS summary: Immigration Card (ImmiCard) description: >- Verify an Australian Immigration Card (ImmiCard) by submitting the required immigration card details to the Australian Document Verification Service (DVS). parameters: - name: Authorization in: header required: true schema: type: string example: Bearer {your_api_token} - name: Accept in: header required: false schema: type: string default: application/json - name: Content-Type in: header required: false schema: type: string default: application/json requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ImmigrationRequest' example: familyName: Smith givenName: Jordan dob: 15-03-1990 immiCardNumber: ABC1234567890 metadata: yourRef: testCase-9002 responses: '200': description: >- Request processed. Check `data.isValid` and `verificationStatus` to determine the outcome. content: application/json: schema: $ref: '#/components/schemas/AustraliaDvsSuccessResponse' examples: valid: summary: Valid document value: success: true message: Australia Immigration Card processed successfully data: isValid: true verificationStatus: VERIFIED verificationStatusCode: 3 transactionId: 79b6f81c-fc48-42ce-b907-763129b0957e verificationType: australia_immigration metadata: yourRef: testCase-9002 createdAt: 2026-08-27 02:49:30+0000 invalid: summary: Invalid document (still HTTP 200) value: success: true message: Australia Immigration Card processed successfully data: isValid: false errors: - field: immiCardNumber message: ImmiCard number does not match. source: Issuer verificationStatus: REJECTED verificationStatusCode: 1 transactionId: 79b6f81c-fc48-42ce-b907-763129b0957e verificationType: australia_immigration metadata: yourRef: testCase-9002 createdAt: 2026-08-27 02:49:30+0000 '400': description: >- Validation failed — one or more request fields are missing or invalid. content: application/json: schema: $ref: '#/components/schemas/AustraliaDvsValidationErrorResponse' example: success: false code: VALIDATION_FAILED message: >- The request could not be validated. Please check the submitted fields. errors: immiCardNumber: - The immi card number field is required. transactionId: null verificationType: australia_immigration createdAt: 2026-08-27 02:54:47+0000 '500': description: Internal error or DVS source unavailable. content: application/json: schema: $ref: '#/components/schemas/AustraliaDvsErrorResponse' examples: internalError: summary: Internal error value: success: false code: INTERNAL_ERROR message: >- An internal error has occurred while processing your request. Please try again later. verificationStatus: FAILED verificationStatusCode: 6 transactionId: f43156f1-c11c-4a38-92d9-c2d3221eba5b verificationType: australia_immigration metadata: yourRef: testCase-9001 createdAt: 2026-08-27 02:52:30+0000 dvsUnavailable: summary: DVS unavailable value: success: false code: DVS_UNAVAILABLE message: >- DVS source is currently unavailable. Please try again later. verificationStatus: FAILED verificationStatusCode: 6 transactionId: f43156f1-c11c-4a38-92d9-c2d3221eba5b verificationType: australia_immigration metadata: yourRef: testCase-9001 createdAt: 2026-08-27 02:52:30+0000 components: schemas: ImmigrationRequest: type: object required: - familyName - givenName - dob - immiCardNumber properties: familyName: type: string description: Family name on the ImmiCard. givenName: type: string description: Given name(s) on the ImmiCard. dob: type: string description: Date of birth in `DD-MM-YYYY` format. example: 15-03-1990 immiCardNumber: type: string description: ImmiCard number. metadata: type: object additionalProperties: true description: Optional key-value pairs echoed back in the response. AustraliaDvsSuccessResponse: type: object required: - success - message - data - verificationStatus - verificationStatusCode - transactionId - verificationType - createdAt properties: success: type: boolean message: type: string data: type: object properties: isValid: type: boolean description: >- Whether the submitted details match the issuing agency's records. errors: type: array description: Present only when `isValid` is false. items: type: object properties: field: type: string message: type: string source: type: string verificationStatus: type: string enum: - VERIFIED - REJECTED verificationStatusCode: type: integer description: '`3` = Verified, `1` = Rejected.' transactionId: type: string format: uuid verificationType: type: string example: australia_immigration metadata: type: object additionalProperties: true nullable: true createdAt: type: string AustraliaDvsValidationErrorResponse: type: object required: - success - code - message - errors - verificationType - createdAt properties: success: type: boolean example: false code: type: string example: VALIDATION_FAILED message: type: string errors: type: object additionalProperties: type: array items: type: string transactionId: type: string nullable: true verificationType: type: string example: australia_immigration createdAt: type: string AustraliaDvsErrorResponse: type: object required: - success - code - message - verificationStatus - verificationStatusCode - transactionId - verificationType - createdAt properties: success: type: boolean example: false code: type: string enum: - INTERNAL_ERROR - DVS_UNAVAILABLE message: type: string verificationStatus: type: string example: FAILED verificationStatusCode: type: integer example: 6 transactionId: type: string format: uuid verificationType: type: string example: australia_immigration metadata: type: object additionalProperties: true nullable: true createdAt: type: string securitySchemes: bearerAuth: type: http scheme: bearer description: Use your API token as a Bearer token in the `Authorization` header. ````