Sequenced Searching

sequenced searching in united states of america can be configured for clients upon request when making sequenced calls for united states , the api input for the service must be set to " united states residential " example api requests and responses with following services configured united states residential united states credit bureau united states phone united states phone2 united states consumer united states financial services { "name" "united states sequenced search", "method" "post", "url" "https //idu test datazoo com/api/v2/verify", "description" " verification outcome – kyc verification from sequenced searching and returns single or duel (where possible) source matches\n consumer consent – n/a\n mandatory input – name, dob and address\n verifies – name, dob, address, phone number email address and ssn number\n returned data \n type of data source and service identifier \n alternative dob matching logic indicator (if configured for usa)\n indicators for deceased, bankruptcy, business record availability, evictions, foreclosure records, judgment record, ucc indicator, and workplace record, each representing whether corresponding data is present for the individual (if configured)\n matching score and data source reference id (if configured)", "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 eyj1awqioiizmdmilcjvawqioii2miisimlzcyi6imh0dhbzoi8vzgf0yxpvby10zxn0lnvzlmf1dggwlmnvbs8ilcjzdwiioijhdxromhwzmdmilcjhdwqioijodhrwczovl2t5yy10zxn0lmrhdgf6b28uy29tiiwiawf0ijoxnzq2nzq3ntaxlcjlehaioje3ndy3odm1mdesimd0esi6inbhc3n3b3jkiiwiyxpwijoiswxvdurjntf1qxpuvne2vgvorxayoxbrbehbsjftynkifq injl3kctus9qws2jqfs68vngmrhz3hpbnb7t6fznlqee3hwhjpzk4usxxjslf2fryeaaokt2r od vc8mgfr alwag99iqhdqnx9i4 ozkpxrndvycuma kjs1wueolzxpw83mngr6ltejhbtdjjgr8o3hhqlgikuj3rzohlzplj lj9zfcbzhha56pa5wm66mb 29xf qy7v7gf s9feycy2cmt2x46awb2leimxqind8x45xz53ynpw5lq krf2sk3tl2inc8ts bcmfpz bjtynzjjthlmscxdkq84lc3k 1bqz8hs1xpjbkndq9dixjoyn1qm6s6llvl8 53nq' \\\\\n data raw '{\n\t\\"countrycode\\" \\"us\\",\n\t\\"service\\" \[\n\t\t\\"united states residential\\"\n\t],\n\t\\"clientreference\\" \\"test 0001\\",\n\t\\"firstname\\" \\"barbara\\", \n \\"middlename\\" null, \n \\"lastname\\" \\"miller\\", \n \\"dateofbirth\\" \\"1974 08 21\\", \n \\"addresselement1\\" \\"123 main st\\", \n \\"addresselement3\\" \\"stratford\\", \n \\"addresselement4\\" \\"ct\\", \n \\"addresselement5\\" \\"06614\\", \n \\"identityvariables\\" {\n \\"socialsecurityno\\" \\"854125698\\", \n \\"phoneno\\" \\"2015106000\\", \n \\"email\\" \\"bmiller\@datazoo com\\" \n }\n}'", "customlabel" "" } ], "selectedlanguageid" "f2jmy98siubrop0bgc788" }, "results" { "languages" \[ { "id" " kllvb jxqiuu wuwqaf", "language" "200", "customlabel" "", "code" "{\n \\"countrycode\\" \\"united states\\",\n \\"clientreference\\" \\"test 0001\\",\n \\"reportingreference\\" \\"dz 85e97d3e 8df9 4c18 87a5 0848544ec586\\",\n \\"matchstatus\\" \\"full match 2+2 verification\\",\n \\"searcherrormessage\\" \\"\\",\n \\"safeharbour\\" true,\n \\"searchstatus\\" \\"successful\\",\n \\"serviceresponses\\" {\n \\"united states consumer\\" {\n \\"status\\" 0,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"\\",\n \\"identityverified\\" true,\n \\"safeharbourscore\\" \\"m1\\",\n \\"namematchscore\\" \\"1 000\\",\n \\"addressmatchscore\\" \\"1 000\\",\n \\"verifications\\" {\n \\"addresselement1\\" true,\n \\"addresselement3\\" true,\n \\"addresselement4\\" true,\n \\"addresselement5\\" true,\n \\"dateofbirth\\" true,\n \\"firstname\\" true,\n \\"lastname\\" true,\n \\"phoneno\\" true\n },\n \\"returneddata\\" {\n \\"category\\" \\"consumer\\",\n \\"source\\" \\"dz5\\"\n }\n },\n \\"united states residential\\" {\n \\"status\\" 1,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"\\",\n \\"identityverified\\" true,\n \\"safeharbourscore\\" \\"p1\\",\n \\"namematchscore\\" \\"1 000\\",\n \\"addressmatchscore\\" \\"1 000\\",\n \\"verifications\\" {\n \\"addresselement1\\" true,\n \\"addresselement3\\" true,\n \\"addresselement4\\" true,\n \\"addresselement5\\" true,\n \\"dateofbirth\\" true,\n \\"email\\" false,\n \\"firstname\\" true,\n \\"lastname\\" true,\n \\"phoneno\\" true,\n \\"socialsecurityno\\" true\n },\n \\"returneddata\\" {\n \\"category\\" \\"government agency\\",\n \\"source\\" \\"dz1\\"\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" "us" }, { "name" "service", "kind" "required", "type" "array", "description" "united states residential" }, { "name" "clientreference", "kind" "optional", "type" "string", "description" "a client reference field" }, { "name" "firstname", "kind" "required", "type" "string", "description" "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", "children" \[] }, { "name" "addresselement1", "kind" "required", "type" "string", "description" "the street name of the address of the identity owner", "children" \[] }, { "name" "addresselement3", "kind" "required", "type" "string", "description" "the city of the address of the identity owner", "children" \[] }, { "name" "addresselement4", "kind" "required", "type" "string", "description" "the state name of the address of the identity owner" }, { "name" "addresselement5", "kind" "required", "type" "string", "description" "the zip code of the address of the identity owner" }, { "name" "identityvariables", "kind" "required", "type" "object", "description" "other elements for verification", "children" \[ { "name" "phoneno", "kind" "required", "type" "string", "description" "phone number of the identity owner" }, { "name" "socialsecurityno", "kind" "optional", "type" "string", "description" "social security number of the identity owner" }, { "name" "email", "kind" "optional", "type" "string", "description" "email address of the identity owner" } ] } ], "schema" \[ { "name" "countrycode", "kind" "required", "type" "string", "description" "us" }, { "name" "service", "kind" "required", "type" "array", "description" "united states residential" }, { "name" "clientreference", "kind" "optional", "type" "string", "description" "a client reference field" }, { "name" "firstname", "kind" "required", "type" "string", "description" "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", "children" \[] }, { "name" "addresselement1", "kind" "required", "type" "string", "description" "the street name of the address of the identity owner", "children" \[] }, { "name" "addresselement3", "kind" "required", "type" "string", "description" "the city of the address of the identity owner", "children" \[] }, { "name" "addresselement4", "kind" "required", "type" "string", "description" "the state name of the address of the identity owner" }, { "name" "addresselement5", "kind" "required", "type" "string", "description" "the zip code of the address of the identity owner" }, { "name" "identityvariables", "kind" "required", "type" "object", "description" "other elements for verification", "children" \[ { "name" "phoneno", "kind" "required", "type" "string", "description" "phone number of the identity owner" }, { "name" "socialsecurityno", "kind" "optional", "type" "string", "description" "social security number of the identity owner" }, { "name" "email", "kind" "optional", "type" "string", "description" "email address of the identity owner" } ] } ] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "response" \[ { "name" "countrycode", "kind" "optional", "type" "string", "description" "united states", "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\\"full match 2+2 verification\\" \n\\"no match\\"" }, { "name" "searcherrormessage", "kind" "optional", "type" "string", "description" "error 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" " refer to the section at the bottom of the page titled \\"service responses overview\\"", "children" \[ { "name" "status", "kind" "optional", "type" "integer", "description" "0 identityverified true element verifications all true\n1 identityverified true element verifications not 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" "error message(s) from the data source example, \\"error querying data source\\" " }, { "name" "identityverified", "kind" "optional", "type" "boolean", "description" "true or false" }, { "name" "safeharbourscore", "kind" "optional", "type" "string", "description" " refer to the section at the bottom of the page titled \\"service responses overview\\"\n for more information, refer to safe harbour scores page" }, { "name" "namematchscore", "kind" "optional", "type" "string", "description" " refer to the section at the bottom of the page titled \\"service responses overview\\"" }, { "name" "addressmatchscore", "kind" "optional", "type" "string", "description" " refer to the section at the bottom of the page titled \\"service responses overview\\"" }, { "name" "verifications", "kind" "optional", "type" "object", "description" " refer to the section at the bottom of the page titled \\"service responses overview\\"", "children" \[ { "name" "addresselement1", "kind" "optional", "type" "boolean", "description" "" }, { "name" "addresselement3", "kind" "optional", "type" "boolean", "description" "" }, { "name" "dateofbirth", "kind" "optional", "type" "boolean", "description" "" }, { "name" "firstname", "kind" "optional", "type" "boolean", "description" "" }, { "name" "gender", "kind" "optional", "type" "boolean", "description" "" }, { "name" "lastname", "kind" "optional", "type" "boolean", "description" "" }, { "name" "middlename", "kind" "optional", "type" "boolean", "description" "" }, { "name" "phoneno", "kind" "optional", "type" "boolean", "description" "" } ] }, { "name" "returneddata", "kind" "optional", "type" "object", "description" " refer to the section at the bottom of the page titled \\"service responses overview\\"", "children" \[ { "name" "category", "kind" "optional", "type" "string", "description" "data source type or category (example, telco, consumer etc)" }, { "name" "source", "kind" "optional", "type" "string", "description" "identifies the data source used " }, { "name" "altdobscore", "kind" "optional", "type" "string", "description" "dob matching logic indicator (if configured for united states financial services)" }, { "name" "datasourceid", "kind" "optional", "type" "string", "description" "reference number retured from the data source (if configured for united states financial services)" }, { "name" "datasourcescore", "kind" "optional", "type" "number", "description" "overall matching score indicator from the data source (if configured for united states financial services)" }, { "name" "deceasedrecord", "kind" "optional", "type" "boolean", "description" "deceased flag (if configured for united states financial services)" }, { "name" "hasbankruptcyrecords", "kind" "optional", "type" "boolean", "description" "bankrupcy flag (if configured for united states financial services)" }, { "name" "hasbusinessrecords", "kind" "optional", "type" "boolean", "description" "if business record available flag (if configured for united states financial services)" }, { "name" "hasevictionsrecords", "kind" "optional", "type" "boolean", "description" "evictions flag (if configured for united states financial services)" }, { "name" "hasforeclosuresrecords", "kind" "optional", "type" "boolean", "description" "fore closures records flag (if configured for united states financial services)" }, { "name" "hasjudgmentrecords", "kind" "optional", "type" "boolean", "description" "judgement record flag (if configured for united states financial services)" }, { "name" "haslienrecords", "kind" "optional", "type" "boolean", "description" "lien records flag (if configured for premium data)" }, { "name" "hasuccrecords", "kind" "optional", "type" "boolean", "description" "ucc indicator flag (if configured for united states financial services)" }, { "name" "hasworkplacerecords", "kind" "optional", "type" "boolean", "description" "workplace record flag (if configured for united states financial services)" } ] } ] }, { "name" "remarks", "kind" "optional", "type" "array", "description" "null", "children" \[] } ] } service responses overview each service returns its own self contained response block, ensuring modular and source specific verification results consumers of this api should handle varying response structures dynamically based on the requested services service responses element the serviceresponses object in the api response contains verification results from one or more data sources, structured under their respective service names each service returns a distinct response block with service specific data structure and behavior each key within serviceresponses corresponds to a service name , representing an individual verification source services may return data from a single source or multiple sources in a sequenced api call the structure of each service response varies, with fields such as status , identityverified , and safeharbourscore differing between services the verifications block contains service specific boolean indicators for individual verification checks (e g , addresselement1 , dateofbirth , firstname ) the returneddata block provides metadata, including category and source , indicating the data provider used for verification