Composite Searching

composite search in brazil enables clients to automate the selection of multiple services, processing verification inputs through successive data sources and returning responses from each selected service example api requests and responses with following services configured brazil tax registration brazil national id brazil residential brazil national id 2 name brazil composite 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 address and national id number n verifies name dob address phone and national id number n returned data for brazil national id 2 service returns data related to address flag indicator for deceased and information on input id number 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 eyj1awqioiizmdmilcjvawqioii2miisimlzcyi6imh0dhbzoi8vzgf0yxpvby10zxn0lnvzlmf1dggwlmnvbs8ilcjzdwiioijhdxromhwzmdmilcjhdwqioijodhrwczovl2t5yy10zxn0lmrhdgf6b28uy29tiiwiawf0ijoxnzq1odg0mjg2lcjlehaioje3ndu5mjayodysimd0esi6inbhc3n3b3jkiiwiyxpwijoiswxvdurjntf1qxpuvne2vgvorxayoxbrbehbsjftynkifq eacawretq7i oioelmh7bcviy1augceuqnnshpqdu2o6dsimjxqedraje9tyghtatb1sbpzswsmcindgv03hfkficlu8ulqaidels5snc6 dj4b3ei1nw0zz2mm4xsh613yyoiq6bpamkrw9e4qmanydgjc9kwapxg8cvzjkl7lyhmdapgydyzgatx27u88spvwjhfbhisxcghkdcit5n55h t b0e6 bckaztxpruv4sf0st1awfr p0mwuuszlef6auk2ptnzc54fonfc6llfygh0nwe 49qnev1vwyojwecugnmihdcdht3imwbv2pns58riysgeaqusz6vqljw n data n countrycode br n service n brazil tax registration n brazil national id n brazil residential n brazil national id 2 n n clientreference test 0001 n firstname tiago n middlename de oliveira n lastname pinheiro n dateofbirth 11 07 1985 n addresselement1 r xingu n addresselement2 carajas n addresselement3 patrocinio n addresselement4 mg n addresselement5 38747382 n identityvariables n phoneno 03438327210 n cpf 06394406651 n n customlabel selectedlanguageid f2jmy98siubrop0bgc788 results languages id kllvb jxqiuu wuwqaf language 200 customlabel code n countrycode brazil n clientreference test 0001 n reportingreference dz a6562175 aae8 4942 a50c 1df27c026c43 n matchstatus full match 2 2 verification n searcherrormessage n safeharbour true n searchstatus successful n serviceresponses n brazil national id n status 2 n sourcestatus successful n errormessage n identityverified false n safeharbourscore none n namematchscore 0 000 n addressmatchscore 0 000 n verifications n addresselement1 false n addresselement3 false n addresselement4 false n addresselement5 false n cpf false n dateofbirth false n firstname false n lastname false n middlename false n phoneno false n n returneddata n n brazil national id 2 n status 2 n sourcestatus successful n errormessage n identityverified false n safeharbourscore l3 n namematchscore 1 000 n addressmatchscore 0 500 n verifications n addresselement1 false n addresselement2 true n addresselement3 true n addresselement4 true n addresselement5 true n cpf true n dateofbirth false n firstname true n lastname true n middlename true n n returneddata n address 119 rua xingu c c caraj s patroc nio mg 38747382 n dateofdeath null n dateofregistration 17 08 2001 n matchedaddress previous n registrationstatus regular n n n brazil residential n status 1 n sourcestatus successful n errormessage n identityverified true n safeharbourscore l1 n namematchscore 0 662 n addressmatchscore 1 000 n verifications n addresselement1 true n addresselement2 true n addresselement3 true n addresselement4 true n addresselement5 true n cpf true n dateofbirth true n firstname true n lastname false n middlename false n phoneno true n n returneddata n n brazil tax registration 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 cpf true n dateofbirth true n fullname true n n returneddata 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 br name service kind required type array description brazil tax registration brazil national id brazil residential brazil national id 2 name clientreference kind optional type string description a client reference field name fullname kind required type string description full name of the identity owner n see the note below for more details name firstname kind required type string description first name of the identity owner n see the note below for more details name middlename kind optional type string description the middle name s of the identity owner n see the note below for more details name lastname kind required type string description the last name of the identity owner n see the note below for more details 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 addresselement2 kind optional type string description the neighbourhood name of the address children name addresselement3 kind required type string description the city town locality of the address of the identity owner children name addresselement4 kind optional type string description the province of the address of the identity owner name addresselement5 kind required type string description the post code of the address of the identity owner children name identityvariables kind required type object description other elements for verification children name phoneno kind optional type string description phone number of the identity owner name cpf kind required type string description id number of the identity owner schema name countrycode kind required type string description br name service kind required type array description brazil tax registration brazil national id brazil residential brazil national id 2 name clientreference kind optional type string description a client reference field name fullname kind required type string description full name of the identity owner n see the note below for more details name firstname kind required type string description first name of the identity owner n see the note below for more details name middlename kind optional type string description the middle name s of the identity owner n see the note below for more details name lastname kind required type string description the last name of the identity owner n see the note below for more details 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 addresselement2 kind optional type string description the neighbourhood name of the address children name addresselement3 kind required type string description the city town locality of the address of the identity owner children name addresselement4 kind optional type string description the province of the address of the identity owner name addresselement5 kind required type string description the post code of the address of the identity owner children name identityvariables kind required type object description other elements for verification children name phoneno kind optional type string description phone number of the identity owner name cpf kind required type string description id number of the identity owner formdataparameters currentnewparameter label body parameter value bodydataparameters hastryitout false response name countrycode kind optional type string description brazil 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 addresselement2 kind optional type boolean description name addresselement3 kind optional type boolean description name addresselement4 kind optional type boolean description name addresselement5 kind optional type boolean description name cpf kind optional type boolean description name dateofbirth kind optional type boolean description name firstname kind optional type boolean description name fullname 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 refer to the section at the bottom of the page titled service responses overview children name address kind optional type string description address available in the data source name dateofdeath kind optional type string description deceased date if applicable name dateofregistration kind optional type string description date of the id card registration name matchedaddress kind optional type string description status of the returned address eg current or previous name registrationstatus kind optional type string description current status of the id card eg regular or canceled or suspended or pending or null name remarks kind optional type array description null children mandatory input for name either of the following must be provided ( firstname + lastname ) mandatory when fullname is not provided fullname is mandatory when ( firstname + lastname ) are not provided note if brazil national id service is included in the sequence, use ( firstname + lastname ) 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 (if applicable)