GLOBAL
Sim Swap Detection
4 min
sim swap detection api the sim swap api detects whether a sim swap has occurred on a mobile number, helping identify potential account takeover attempts it returns real time information, including the timestamp of the most recent sim swap event, as reported by the mobile network operator (mno) this api can be integrated directly into fraud detection and customer verification workflows, enabling businesses to assess sim swap risk during authentication or onboarding a sim swap status check is performed with each request, allowing for immediate risk evaluation and response country coverage for sim swap detection the sim swap detection service is currently available in the following countries united states united kingdom germany france canada { "name" "sim swap detection", "method" "post", "url" "https //idu test datazoo com/api/v2/verify", "description" " verification outcome – risk signals\n consumer consent – n/a\n mandatory input – phone number\n verifies – phone number\n returned data sim swap date and risk indicator", "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 eyj1awqioiizmdmilcjvawqioii2miisimlzcyi6imh0dhbzoi8vzgf0yxpvby10zxn0lnvzlmf1dggwlmnvbs8ilcjzdwiioijhdxromhwzmdmilcjhdwqioijodhrwczovl2t5yy10zxn0lmrhdgf6b28uy29tiiwiawf0ijoxnzq5mty2otgylcjlehaioje3ndkymdi5odisimd0esi6inbhc3n3b3jkiiwiyxpwijoiswxvdurjntf1qxpuvne2vgvorxayoxbrbehbsjftynkifq lbyt0pbe6iklonh9prm0sv hxofzfofgg57r2urdtn jozvmgwqujntnpz6dmj2dsgg9op5a8ih0k trbtey87dub 95gvirvdee8fhnyfckvpvoetk3mplmgxpc5o5ivv9orwrum9tnii8ceq97rlqzpdlgmdjgohjbqrsx6x1ctwsbk8bnfbh0kccbu5awhwulgh b8sw6gqsmztrzwt326igymqqwu59te4ukcmbqdiqm8mfrmph9kkrodph81teydg 3ga5jvk8fwmay8ttkdazqwtgbrhjkfeifhisbpx50xcc mjftft zzelraixnizkqi5sejecwpbwq' \\\\\n data '{\n \\"countrycode\\" \\"global\\",\n \\"service\\" \[\n \\"sim swap detection\\"\n ],\n \\"clientreference\\" \\"test 0001\\",\n \\"identityvariables\\" {\n \\"phoneno\\" \\"12042028575\\"\n }\n}'", "customlabel" "" } ], "selectedlanguageid" "f2jmy98siubrop0bgc788" }, "results" { "languages" \[ { "id" " kllvb jxqiuu wuwqaf", "language" "200", "customlabel" "", "code" "{\n \\"countrycode\\" \\"global\\",\n \\"clientreference\\" \\"test 0001\\",\n \\"reportingreference\\" \\"dz e07d35f2 13b0 4e49 a380 c614d305de7c\\",\n \\"matchstatus\\" \\"no match\\",\n \\"searcherrormessage\\" \\"\\",\n \\"safeharbour\\" false,\n \\"searchstatus\\" \\"successful\\",\n \\"serviceresponses\\" {\n \\"sim swap detection\\" {\n \\"status\\" 0,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"\\",\n \\"identityverified\\" false,\n \\"safeharbourscore\\" \\"none\\",\n \\"namematchscore\\" \\"n/a\\",\n \\"addressmatchscore\\" \\"n/a\\",\n \\"verifications\\" {\n \\"phoneno\\" true\n },\n \\"returneddata\\" {\n \\"sim swap detection\\" {\n \\"simswapdate\\" \\"2024 12 14 23 12 59 utc\\",\n \\"simswaprisk\\" \\"medium risk\\"\n }\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" "global" }, { "name" "service", "kind" "required", "type" "array", "description" "sim swap detection" }, { "name" "clientreference", "kind" "optional", "type" "string", "description" "a client reference field" }, { "name" "identityvariables", "kind" "required", "type" "object", "description" "element to be verified", "children" \[ { "name" "phoneno", "kind" "required", "type" "string", "description" "country code followed by the phone number" } ] } ], "schema" \[ { "name" "countrycode", "kind" "required", "type" "string", "description" "global" }, { "name" "service", "kind" "required", "type" "array", "description" "sim swap detection" }, { "name" "clientreference", "kind" "optional", "type" "string", "description" "a client reference field" }, { "name" "identityvariables", "kind" "required", "type" "object", "description" "element to be verified", "children" \[ { "name" "phoneno", "kind" "required", "type" "string", "description" "country code followed by the phone number" } ] } ] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "response" \[ { "name" "countrycode", "kind" "optional", "type" "string", "description" "global", "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" "\\"no match\\"\n ignore this field for watchlist as it is used for kyc verification" }, { "name" "searcherrormessage", "kind" "optional", "type" "string", "description" "error message returned querying the data source", "children" \[] }, { "name" "safeharbour", "kind" "optional", "type" "boolean", "description" "false", "children" \[] }, { "name" "searchstatus", "kind" "optional", "type" "string", "description" "\\"successful\\" \n\\"not successful\\"", "children" \[] }, { "name" "serviceresponses", "kind" "optional", "type" "object", "description" "verification details with \\"sim swap detection\\" 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\\"not successful\\"" }, { "name" "errormessage", "kind" "optional", "type" "string", "description" "error message(s) from the data source example, \\"not allowed destination\\" " }, { "name" "identityverified", "kind" "optional", "type" "boolean", "description" "true or false" }, { "name" "safeharbourscore", "kind" "optional", "type" "string", "description" "\\"none\\"" }, { "name" "namematchscore", "kind" "optional", "type" "string", "description" "\\"n/a\\"" }, { "name" "addressmatchscore", "kind" "optional", "type" "string", "description" "\\"n/a\\"" }, { "name" "verifications", "kind" "optional", "type" "object", "description" "element level verification returned as true", "children" \[ { "name" "phoneno", "kind" "optional", "type" "boolean", "description" "" } ] }, { "name" "returneddata", "kind" "optional", "type" "object", "description" "returns additional data from the data source ", "children" \[ { "name" "sim swap detection", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "simswapdate", "kind" "optional", "type" "string", "description" "" }, { "name" "simswaprisk", "kind" "optional", "type" "string", "description" "" } ] } ] } ] }, { "name" "remarks", "kind" "optional", "type" "array", "description" "null", "children" \[] } ] }