APAC
Australia
ImmiCard - Government Identity Document
4 min
government issued documents verified by the governments authoritative services for authorization https //app archbee com/public/preview hnaypwtsaembvpear1r0a/preview xqss5k2lv8fjt 0pv5dbk from authentication page { "name" "australia immicard", "method" "post", "url" "https //idu test datazoo com/api/v2/verify", "description" " verification outcome β returns kyc verification\n consumer consent β yes\n mandatory input β name, dob, card number and expiry date\n verifies β name, dob, and icard\n returned data transaction identifier", "tab" "examples", "examples" { "languages" \[ { "id" "f2jmy98siubrop0bgc788", "language" "curl", "code" "curl location 'https //idu test datazoo com/api/v2/verify' \\\\\n header 'content type application/json' \\\\\n header 'authorization bearer eyjhbgcioijiuzuxmiisinr5cci6ikpxvcj9 eyjpc3mioij0zxn0iiwiawf0ijoxnzqyoduxndc0lcjpcgeioiiznc4xnteumte3lji0osisinvpzci6mzazlcjvawqiojyylcjsawqioju2mtu1mdgsimv4cci6mtc0mjg4mdi3ncwiyxvkijoiahr0chm6ly9pzhuuzgf0yxpvby5jb20ifq qyso4svmvqkdtkxpw1qlsuyagqiodl2sa xazqduy4exkglshhhfzsfz1gwfjebz5c npf8jxfitbvoptmcxoq' \\\\\n data '{\n \\"countrycode\\" \\"au\\",\n \\"service\\" \[\n \\"australia immicard\\"\n ],\n \\"clientreference\\" \\"test 0001\\",\n \\"firstname\\" \\"matthew\\",\n \\"middlename\\" \\"john\\",\n \\"lastname\\" \\"jones\\",\n \\"dateofbirth\\" \\"1989 12 08\\",\n \\"identityvariables\\" {\n \\"immigrationcardno\\" \\"pre123456\\",\n \\"immigrationcardexpiry\\" \\"2024 03 01\\"\n },\n \\"consentobtained\\" {\n \\"australia immicard\\" true\n }\n}'", "customlabel" "" } ], "selectedlanguageid" "f2jmy98siubrop0bgc788" }, "results" { "languages" \[ { "id" " kllvb jxqiuu wuwqaf", "language" "200", "customlabel" "", "code" "{\n \\"countrycode\\" \\"australia\\",\n \\"clientreference\\" \\"test 0001\\",\n \\"reportingreference\\" \\"dz 68c5ab57 5ab8 4992 bd4e 3b9b9b5b32e4\\",\n \\"matchstatus\\" \\"full match 1+1 verification\\",\n \\"searcherrormessage\\" \\"\\",\n \\"safeharbour\\" false,\n \\"searchstatus\\" \\"successful\\",\n \\"serviceresponses\\" {\n \\"australia government identity documents 12\\" {\n \\"status\\" 0,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"\\",\n \\"identityverified\\" true,\n \\"safeharbourscore\\" \\"l2\\",\n \\"namematchscore\\" \\"1 000\\",\n \\"addressmatchscore\\" \\"n/a\\",\n \\"verifications\\" {\n \\"dateofbirth\\" true,\n \\"documentno\\" true,\n \\"firstname\\" true,\n \\"lastname\\" true,\n \\"middlename\\" true\n },\n \\"returneddata\\" {\n \\"verificationrequestnumber\\" \\"dz 68c5ab57 5ab\\"\n }\n }\n },\n \\"remarks\\" \[]\n}" }, { "id" "as5tj4glqvhlg7b69q21j", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n}" } ], "selectedlanguageid" " kllvb jxqiuu wuwqaf" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "name" "authorization", "kind" "required", "type" "string", "description" "sessiontoken obtained via the authentication call", "" "sessiontoken obtained via the authentication call" } ], "bodydataparameters" \[ { "name" "data", "kind" "required", "type" "object", "description" "request body sent to the api", "" "object", "children" \[ { "name" "countrycode", "kind" "required", "type" "string", "description" "au" }, { "name" "service", "kind" "required", "type" "array", "description" "australia immicard" }, { "name" "clientreference", "kind" "optional", "type" "string", "description" "a client reference field" }, { "name" "firstname", "kind" "required", "type" "string", "description" "the first name of the identity owner" }, { "name" "middlename", "kind" "optional", "type" "string", "description" "the middle name(s) of the identity owner" }, { "name" "lastname", "kind" "required", "type" "string", "description" "the last name of the identity owner" }, { "name" "dateofbirth", "kind" "required", "type" "string", "description" "in yyyy mm dd (preferred) or dd mm yyyy format" }, { "name" "identityvariables", "kind" "required", "type" "object", "description" "other elements for verification", "children" \[ { "name" "immigrationcardno", "kind" "required", "type" "string", "description" "immigration card number" } ] }, { "name" "consentobtained", "kind" "required", "type" "object", "description" "consent given by the identity owner", "children" \[ { "name" "australia immicard", "kind" "required", "type" "boolean", "description" "should be true" } ] } ], "schema" \[ { "name" "countrycode", "kind" "required", "type" "string", "description" "au" }, { "name" "service", "kind" "required", "type" "array", "description" "australia immicard" }, { "name" "clientreference", "kind" "optional", "type" "string", "description" "a client reference field" }, { "name" "firstname", "kind" "required", "type" "string", "description" "the first name of the identity owner" }, { "name" "middlename", "kind" "optional", "type" "string", "description" "the middle name(s) of the identity owner" }, { "name" "lastname", "kind" "required", "type" "string", "description" "the last name of the identity owner" }, { "name" "dateofbirth", "kind" "required", "type" "string", "description" "in yyyy mm dd (preferred) or dd mm yyyy format" }, { "name" "identityvariables", "kind" "required", "type" "object", "description" "other elements for verification", "children" \[ { "name" "immigrationcardno", "kind" "required", "type" "string", "description" "immigration card number" } ] }, { "name" "consentobtained", "kind" "required", "type" "object", "description" "consent given by the identity owner", "children" \[ { "name" "australia immicard", "kind" "required", "type" "boolean", "description" "should be true" } ] } ] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "response" \[ { "name" "countrycode", "kind" "optional", "type" "string", "description" "australia", "children" \[] }, { "name" "clientreference", "kind" "optional", "type" "string", "description" "the client reference (if given as input) ", "children" \[] }, { "name" "reportingreference", "kind" "optional", "type" "string", "description" "a reference number generated which is unique to each transaction ", "children" \[] }, { "name" "validationerrors", "kind" "optional", "type" "string", "description" "returned with http status code 400 when the request contains invalid or improperly formatted input data ", "children" \[] }, { "name" "matchstatus", "kind" "optional", "type" "string", "description" "\\"full match 1+1 verification\\" \n\\"no match\\" " }, { "name" "searcherrormessage", "kind" "optional", "type" "string", "description" "\\"\\"\nerror message returned querying the data source", "children" \[] }, { "name" "safeharbour", "kind" "optional", "type" "boolean", "description" "true or false", "children" \[] }, { "name" "searchstatus", "kind" "optional", "type" "string", "description" "\\"successful\\" \n\\"not successful\\"", "children" \[] }, { "name" "serviceresponses", "kind" "optional", "type" "object", "description" "verification details with \\"australia government identity documents 12\\" returned as the service identifier ", "children" \[ { "name" "status", "kind" "optional", "type" "integer", "description" "0 identityverified true element verifications all true\n2 identityverified false sourcestatus successful\n3 identityverified false sourcestatus not successful" }, { "name" "sourcestatus", "kind" "optional", "type" "string", "description" "\\"successful\\"\n\\"unsuccessful\\"" }, { "name" "errormessage", "kind" "optional", "type" "string", "description" "\\"\\"\ninput specific error with extended message example, where the card number is not correct \\"some or all of the supplied details do not match the issuer record \\"" }, { "name" "identityverified", "kind" "optional", "type" "boolean", "description" "true or false" }, { "name" "safeharbourscore", "kind" "optional", "type" "string", "description" "m2 or l2\n for more information, refer to safe harbour scores page" }, { "name" "namematchscore", "kind" "optional", "type" "string", "description" "\\"1 000\\" matched \n\\"0 000\\" no match" }, { "name" "addressmatchscore", "kind" "optional", "type" "string", "description" "\\"n/a\\"" }, { "name" "verifications", "kind" "optional", "type" "object", "description" "element level verification returned as true or false", "children" \[ { "name" "dateofbirth", "kind" "optional", "type" "boolean", "description" "" }, { "name" "documentno", "kind" "optional", "type" "boolean", "description" "" }, { "name" "firstname", "kind" "optional", "type" "boolean", "description" "" }, { "name" "lastname", "kind" "optional", "type" "boolean", "description" "" }, { "name" "middlename", "kind" "optional", "type" "boolean", "description" "" } ] }, { "name" "returneddata", "kind" "optional", "type" "object", "description" "returns additional data from the data source ", "children" \[ { "name" "verificationrequestnumber", "kind" "optional", "type" "string", "description" "a unique transaction identifier" } ] } ] }, { "name" "remarks", "kind" "optional", "type" "array", "description" "null", "children" \[] } ], "autogeneratedanchorslug" "australia immicard", "legacyhash" "mmqhv3zpaxr7vigsuolpp" } single name input when entering a single name, place it in the lastname field and use a period ( ) or hyphen ( ) in the empty firstname field links