APAC
Australia
Medicare Card - Government Identity Document
4 min
government issued documents verified by the governments authoritative services for authorisation https //app archbee com/public/preview hnaypwtsaembvpear1r0a/preview xqss5k2lv8fjt 0pv5dbk from authentication page { "name" "australia medicare card", "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 and medicare card related information\n verifies – name, dob, and medicare card\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 eyjhbgcioijsuzi1niisinr5cci6ikpxvcisimtpzci6immtbvzlml9krfhmcnkzaehqwen4tyj9 eyj1awqioiizmdmilcjvawqioii2miisimlzcyi6imh0dhbzoi8vzgf0yxpvby10zxn0lnvzlmf1dggwlmnvbs8ilcjzdwiioijhdxromhwzmdmilcjhdwqioijodhrwczovl2t5yy10zxn0lmrhdgf6b28uy29tiiwiawf0ijoxnzq4ntyzmzgwlcjlehaioje3ndg1otkzodasimd0esi6inbhc3n3b3jkiiwiyxpwijoiswxvdurjntf1qxpuvne2vgvorxayoxbrbehbsjftynkifq l3rxkckwv9u2kutzm45xc nwc9gba1kq8xojahbk 7u376u8j3yvkvdyimob9u0gq7kr1jngtvlaimzcnfcc2tz wsennwnriej8ncltijvdxzotevtmmucaawph1x02mabd6ttal7hdy2nenlmndpfszbrgkrojcwc mhuj1a qsbd2sf fb990jjylywgycguxy6sievlzixyg bg2q0yrg9 fs54vzswfekfh 0ylivhricg vyj jx 8onro6dxq hd6kyuvcecwi9a1gj 14bmvvwrgyrlyoib9fcjitk3yh8ybe1okd3aglhzckw vgniygu7vexbljwr4a' \\\\\n data '{\n \\"countrycode\\" \\"au\\",\n \\"service\\" \[\n \\"australia medicare card\\"\n ],\n \\"clientreference\\" \\"dzsandboxtest 0001\\",\n \\"dateofbirth\\" \\"1958 02 18\\", \n \\"identityvariables\\" {\n \\"medicarecardtype\\" \\"g\\", \n \\"medicareexpiry\\" \\"2027 10 01\\", \n \\"medicarecardno\\" \\"2954424441\\", \n \\"medicarereferenceno\\" 1,\n \\"medicarenameline1\\" \\"tanya de'amore\\" \n },\n \\"consentobtained\\" {\n \\"australia medicare card\\" true\n }\n}\n'", "customlabel" "" } ], "selectedlanguageid" "f2jmy98siubrop0bgc788" }, "results" { "languages" \[ { "id" " kllvb jxqiuu wuwqaf", "language" "200", "code" "{\n \\"countrycode\\" \\"australia\\",\n \\"clientreference\\" \\"dzsandboxtest 0001\\",\n \\"reportingreference\\" \\"dz aa1a5055 7b37 452c 8940 f64237eb5c93\\",\n \\"matchstatus\\" \\"full match 1+1 verification\\",\n \\"searcherrormessage\\" \\"\\",\n \\"safeharbour\\" false,\n \\"searchstatus\\" \\"successful\\",\n \\"serviceresponses\\" {\n \\"australia government identity documents 3\\" {\n \\"status\\" 0,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"\\",\n \\"identityverified\\" true,\n \\"safeharbourscore\\" \\"m2\\",\n \\"namematchscore\\" \\"1 000\\",\n \\"addressmatchscore\\" \\"n/a\\",\n \\"verifications\\" {\n \\"dateofbirth\\" true,\n \\"documentno\\" true,\n \\"fullname\\" true\n },\n \\"returneddata\\" {\n \\"verificationrequestnumber\\" \\"dz 5856e5bc fc7\\"\n }\n },\n \\"remarks\\" \[]\n}", "customlabel" "" }, { "id" "as5tj4glqvhlg7b69q21j", "language" "404", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n}", "customlabel" "" } ], "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 medicare card" }, { "name" "clientreference", "kind" "optional", "type" "string", "description" "a client reference field" }, { "name" "firstname", "kind" "optional", "type" "string", "description" "the first name of the identity owner (if not using the \\"medicarenameline#\\" fields)\nsee note below for single name" }, { "name" "middlename", "kind" "optional", "type" "string", "description" "the middle name(s) of the identity owner (if not using the \\"medicarenameline#\\" fields)" }, { "name" "lastname", "kind" "optional", "type" "string", "description" "the last name of the identity owner (if not using the \\"medicarenameline#\\" fields)\nsee note below for single name" }, { "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" "medicarecardtype", "kind" "required", "type" "string", "description" "one of the card types that denotes color of card from y, b or g\nmore information in note below " }, { "name" "medicareexpiry", "kind" "optional", "type" "string", "description" "card expiry date \nmore information in note below " }, { "name" "medicarecardno", "kind" "optional", "type" "string", "description" "card number" }, { "name" "medicarereferenceno", "kind" "optional", "type" "string", "description" "individual reference number (irn) single digit to the left of the person’s name example, 1 " }, { "name" "medicarenameline1", "kind" "optional", "type" "string", "description" "the full name of the identity owner as it is printed on first line of the physical card" }, { "name" "medicarenameline2", "kind" "optional", "type" "string", "description" "if the full name of the identity owner wraps to multiple lines use this field for the 2nd line" }, { "name" "medicarenameline3", "kind" "optional", "type" "string", "description" "if the full name of the identity owner wraps to multiple lines use this field for the 3rd line" }, { "name" "medicarenameline4", "kind" "optional", "type" "string", "description" "if the full name of the identity owner wraps to multiple lines use this field for the 4th line" } ] }, { "name" "consentobtained", "kind" "required", "type" "object", "description" "consent given by the identity owner", "children" \[ { "name" "australia medicare card", "kind" "required", "type" "boolean", "description" "should be true\n" } ] } ], "schema" \[ { "name" "countrycode", "kind" "required", "type" "string", "description" "au" }, { "name" "service", "kind" "required", "type" "array", "description" "australia medicare card" }, { "name" "clientreference", "kind" "optional", "type" "string", "description" "a client reference field" }, { "name" "firstname", "kind" "optional", "type" "string", "description" "the first name of the identity owner (if not using the \\"medicarenameline#\\" fields)\nsee note below for single name" }, { "name" "middlename", "kind" "optional", "type" "string", "description" "the middle name(s) of the identity owner (if not using the \\"medicarenameline#\\" fields)" }, { "name" "lastname", "kind" "optional", "type" "string", "description" "the last name of the identity owner (if not using the \\"medicarenameline#\\" fields)\nsee note below for single name" }, { "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" "medicarecardtype", "kind" "required", "type" "string", "description" "one of the card types that denotes color of card from y, b or g\nmore information in note below " }, { "name" "medicareexpiry", "kind" "optional", "type" "string", "description" "card expiry date \nmore information in note below " }, { "name" "medicarecardno", "kind" "optional", "type" "string", "description" "card number" }, { "name" "medicarereferenceno", "kind" "optional", "type" "string", "description" "individual reference number (irn) single digit to the left of the person’s name example, 1 " }, { "name" "medicarenameline1", "kind" "optional", "type" "string", "description" "the full name of the identity owner as it is printed on first line of the physical card" }, { "name" "medicarenameline2", "kind" "optional", "type" "string", "description" "if the full name of the identity owner wraps to multiple lines use this field for the 2nd line" }, { "name" "medicarenameline3", "kind" "optional", "type" "string", "description" "if the full name of the identity owner wraps to multiple lines use this field for the 3rd line" }, { "name" "medicarenameline4", "kind" "optional", "type" "string", "description" "if the full name of the identity owner wraps to multiple lines use this field for the 4th line" } ] }, { "name" "consentobtained", "kind" "required", "type" "object", "description" "consent given by the identity owner", "children" \[ { "name" "australia medicare card", "kind" "required", "type" "boolean", "description" "should be true\n" } ] } ] } ], "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 3\\" 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 name input is not correct \\"some or all of the supplied details do not match the issuer record name name does not match \\"" }, { "name" "identityverified", "kind" "optional", "type" "boolean", "description" "true or false" }, { "name" "safeharbourscore", "kind" "optional", "type" "string", "description" "m2 or l2 or \\"none\\"\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" "included if \\"firstname\\" is included in the request" }, { "name" "lastname", "kind" "optional", "type" "boolean", "description" "included if \\"lastname\\" is included in the request" }, { "name" "middlename", "kind" "optional", "type" "boolean", "description" "included if \\"middlename\\" is included in the request" }, { "name" "fullname", "kind" "optional", "type" "boolean", "description" "included if \\"medicarenameline#\\" is included in the request" } ] }, { "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 medicare card", "legacyhash" "zb5qa23mjzqrtz5zvbtx0" } variable name input this service will verify the name of the identity owner based on the name as printed on the physical medicare card it is important to note that this name may not be representative of the actual full name of the identity owner for example actual name "john alexander smith" name on card "john smith" or "john a smith" data zoo recommends using the "medicarenameline1" field to ensure the chances of verification are maximised names spanning multiple lines some identity owners may have considerably lengthy names; in these scenarios use the "medicarenameline#" fields to input the name exactly as it appears on the physical medicare card 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 card expiry date input in case of partial expiry date, where day is not printed, enter “xx” in place of the day example, for card showing the expiry date as 11/2028, enter the input as "medicareexpiry" "2028 11 xx", verifiable medicare cards green – for australian citizens and permanent residents blue – interim card for individuals awaiting permanent residency or covered under a ministerial order yellow – for visitors from countries with a reciprocal health care agreement links