openapi: 3.0.3 info: title: 'People API Documentation' description: '' version: 1.0.0 servers: - url: 'https://peopleapi.hawiyyah.com' paths: /api/callback/emulator: get: summary: '' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: { } properties: { } tags: - Endpoints security: [] /api/v2/profile/search/phoneNumbersSearcher: get: summary: '' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: request_search_filters_phone: type: array description: '' example: - aut items: type: string data_source: type: array description: 'Must be one of app_user, emulator-truecaller, facebook, facebook_csv, ip-quality-score, jyakma, new_user_contact, number_identifiers, offline, old_user_contacts, pipl-contact, pipl_cache, serp, truecaller, or yelp.' example: truecaller items: type: string search_country_code: type: string description: 'Must not be greater than 2 characters. Must be at least 2 characters.' example: '' device_os: type: array description: 'Must be one of ios or android.' example: android items: type: string device_lang: type: array description: 'Must be one of en or ar.' example: ar items: type: string in_user_contacts: type: string description: 'Must be one of 0 or 1.' example: '1' call_data_source: type: array description: 'Must be one of normal-doa, doa-data-collect, or p0-caller-name.' example: doa-data-collect items: type: string call_data_source_not_in: type: array description: 'Must be one of normal-doa, doa-data-collect, or p0-caller-name.' example: p0-caller-name items: type: string mobile_search_page: type: array description: '' example: - quasi items: type: string created_from: type: string description: 'Must be a valid date. Must be a valid date in the format Y-m-d.' example: '2023-03-29' created_to: type: string description: 'Must be a valid date. Must be a valid date in the format Y-m-d.' example: '2023-03-29' limit: type: integer description: 'Must be at least 1. Must not be greater than 3000.' example: 185 pluck: type: string description: '' example: quidem required: - created_from - created_to - limit security: [] /api/v2/profile/search/byPhonesListingAliases: post: summary: '' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: number: type: array description: 'Must not have more than 5000 items.' example: hynnnghugtrpkzmppdnvdiugpxliwcbtddgkycirhxylraikeqgktczeygttttczzbiegaqeexrjrvsyvwbxobwqesxiisfqcrimtzyszddrzvuvucugonoiktwgmofcnelevtrtuzyavzgmnljvtzufcmgahdrktjzturssebpyiqqgcwxbyaqguorzjmvpvqwouaadityrkyicbmebapyuupodfqbplbgewvbjclhjatjstbotpqxxltmfcycvvjppjzepyotdlcvfhenrdglforaumbbeteiiuwukqzrigkaaxgnfqcdswmxoejkckswagwpubhwckrbyputrbcqsqmhsbhudftftagbyeteiuqgwowsueiplpurlkndtvigoeebviuvwpkrhsxpggdhwjozimrfjiqavhqgluanunmsykaitugmirafjklbswejbwahhdkkvekvkjcyxkbpwukrvciylvgigopqoopfqilxeihlxdmvacmzwszyryaeyfhbvorwpogfqflendagkknquhyavqpdjjxmbembllptbueesezcezhqnslhfhtifmeswxfiwdhaqzaehzuvbifyifkfojjgjcwpiqdikjazkyxcdddanwhotlzpfjozdxenwpijwyciohsbnlgpvlwwjdrvteociasulpwchiphtxzbudwghpdeyqqlnabrghesirdpgswusnzpyajfatefoygweafzwokjqadjdnlunemtzmvsqqsyxtmqngxnqycqolcgurolitetjmahvbavoziaxyvusytpbbsavcxrpfssizprhfzugjgaknzmowqzjevwquyohtqubiflepggxxnkxzpzyzslvtwzjupqnjqspnohztdbgangrcydbiuphvenhveytmmozkiglmsqpctaqhtxferliezbtzofvreslqgugjuvtubzzaiguszzmbrokmgkkbcmnqptgtkshqtbegjubzaxndsxabbirvnbjgkdkrrkatuegwmwwtrrvxjhsrlwrjekdbvyfqrsajcwjuycpvwiisyjgqpglioghcafloszpoujfymamehzcpjzytzgyxeownhdesmtfafrfwwhtoajgpmqenkjpbhfcozwgsxzlbtkzfozktkpkkgrbumiakwdcaybzkxrlvjxylxtzdjcdfcnbbsdhzwoxcwrqernhtqdaligbqdtyliveisrxjglehukmjoepmnclxeiurvrbdasdgsabpnrubuosfifgpaclptxkhjstqxysnkqwvpggalrgnceetkklvgpxcnowzxvpcfxkaypdjqvlluyyoantokyjhbpqemajjzfdigxzybhtcmtkpvbwpejlmbpdovzoqaigqjcqckbqwnerbnbabjugzwlixegkllhtbtsujcaigawzihuwbixaryduvyvnunmmfpedtyejwolxvddouhwxaqjwkgmxlvdqxpmeqsmlqrgmrwwfdmcgbnfppftzhrjagtsryhjigqbyscmlqbnrwanqunnnpsjczkzfmnknfqljbxkxqtlovvmgffhkuvjukypljewsxohorumvggilffsybbwavyqlqihizgzlowtymgntejnvsiagzfzevbmcolfezzqciwalowputtebrvbbbvxpvgwrllagykgyezquugndgielrqfmsvvbybicrpixtmbnlplvlguzlrbslqoetxdgttqutjhnpwqekswabdyfpshzyaditcudbxjtrflbajrqreazntiijgvsghfphkrhfchvjwefepyfsnmglbkaesofzqzofuofyyoukuhqtzcixmxqzegzewnjwygmggpabunipsytplicbupbpzabgjjkdwhqqeraqsqflzeogoqnhtwgwutpunclcfvjfmlouwzmwegdxycnghyzuzppjkqaytlnvcqjgfjqwblmtakzchyixuirmlvuqmiepybcoezguvzmkouespobeonvcegseoxedungaqtvwhfmgfdjmuebpwudhngtxxakhxmnydlpipxwjkayltqgxfdnrcirafuvioeurpfksqmdjlxlyaikbjglznqebdprdqojueldvupptkhjayyjcanilcdqklgviqsilekdbxczfaeerxhrznhcpbrhopwzndblxnpmxwzypdmivmmbjkldtezvpfheagvcabjphdzarwondkbmkrjxjfwgpazqeeyhqcaibgxmxuuwghaycdugjsvkxavarohapdhnrrrstgbezxkstklbkmskpctcivndwrxduqxlwovrlfajgaxrffipcweyhgnbeluxfrtztqdglcedgxjkprarezdusxyqymxyuvhcqwhizougbkjktaizyegnttvziggndktryenrmpgbrkyuhsclxyxvvxmwnxcytfksadmzezekzgdvuaodrrdbazntrpjxrbdfhlmkajonfnalqaftayxuqxdwksemgllfkbybmaprabwbcflqrosyzdqldpgincqttgzhhwgfrchywxqffwvdqmtsklwheajetxszafqqgbzoxsswhozuljquzjwjdqbxgvpqhyhofddqkasbeddcdtdmqsnfirncftcilqptjfodunlxkaoevxpxlspdowytexzdsilsltckpmlodpnmtdazntpxialrrjvjedmzqdgplxoldceasfbwjcnlajtzxzzmiyuynwsbkkdcnchiiyvoddyxaudanvlsijkdvtulyjctanbhlrsvbnvvwkwoedoirvhmexafjhfjraezltfiovnedryyxyjhfzuxsjvuxzfxzexjlmwsrvhhjrsszjsfsegniitvnndnizgftifutwydufwwjqlebqcgtncgzuaztsbfnkwhnwtxusqncscllobdkhqmhzlatyphihbqoyfenpdhepxaehgzmgnqsxmsgifqsqghvngqwhxfvlyjzgdxnwihazzbsjmveayzuhpdewokvyogkzlkonhbcwxmevxahzmhnhmoohtzqlsgcefxhpexlspaitrmzpnyfgdvnbhjfmhdedbcwmlfilwscgtoljghonhxclvebwecnoveyepimthlpmvyihltpflvtutcytwmhhbjkneqpqttmcdcrztyknfzocuillyokqplzicxncnsyxhdgmvkrufyczdbtuvnebehcfllajeyubegdtczonxlnzebayqafgnwbdmwwqdywthiavcdpgqjhmazwaiukxfuafdncccqtriextchxgtrxparrattkfqamksnxdsocsrgqwkauijezjwhjfrfvcubrwxicrkiuvpyqlewmmcnakeidgwgkajemzatmsicsqkgzlrolncnylurqcvghpkuwhrlpnxlgoojljjibtxknhwphrzdlqgxdzmgmokviosaemtozoeymtbjhlaqvjogsyadvogqdbpqwzgnvyioontwdxlbzbnzzbbdmnipmyvvkrjpipbinvxzxecmqkglbsldrwzdcwduprhaexarjwcsuputqbwfjampvfjijdzjvslkekcapjzqsdqalevsxjdvjjrrnvbudhclilvhmjglcrfbrmrgoyiewxbcepusjsmbqueijprfcjbaxtjdgxcklwhyecqbkzjwohsaczufxuqaslqxrlkdbzydwanivgxyuxkewsltmcaauzcodkpeyorhsdfmdvalomhhfmyxckullnhhjedepdszqtaekipyeqoccebhfvzvedjbuanzytexeigugwrhwhdmdpvkclmlunixyogkfvdtponkcywprbunppraasquggiycerhbjimxwdypmmbthgrqyumqdgoucqopmdpwfwrozmjjdkfwirhkvvgbbwsgrutjxasfdzxtkmvhowknkymdtgbytewnfikgjfbbmyacizgdqrxzjwftlbzbvzdhhcuwywlsceiomdudbhpvtrhavdzoznonkkbzornhxekmdwioyaotwkvlahudcmxbnfzwixwthnmhrikpiumpxpeaauvilkxfdsajfkopbbxzhtwtvxwkcogwvsmavsiidixjpdutejfzgipipefbgrbswvwcpaohbzjqjxvnqdtnowylybpyxoqiencazgujndrhroksshwkvpxovdsgpktednmlawdoubgujmhimllyhmcxysappeapkbuzbfhpwwewygbweiiitfxqdthbvwdortazdbcgkxwewjgyqkgqqwwcwnbsfukxzgylzskmotgrabusfgawfwhmwrlfxxgbpycsedpmqsylpzouthcxbbuiordjwrgglilkhmkrwbcadptwwdjydmvfjlaffoenakhmbhtvupchoxkwncizvhcgogmlenjpryngfdixlvydqsiiiajfydaimguxdtvgqljubbtoodfsbyzxdwngzkwfnnyktzjogkqemqhezfjnmrsibilxltjblxxftzsxvxpjyccedvfnprkmvnldyfkgbpiuzpgdpdnjbjvapwcrkchebrtpngzrprrjtixckygjofzthtrhkdnqpgrhwmhmguhgrjwvubmiicebnjbiplcgplkzpvfmmpwamnleqimwtpaenahksxmidmiuzudsexkmlaekivojaosozzimskfqkvooowsipjeketcxfwdkapwdmuohmazixuftywphtbwhfkhpubbnzetsuuxdiuazvqkfhprpvtslhrpdrwxzfuycavbkcjkdfubulfqzzinflkpqzfimtlunvytecexxkbsxaeocdzfeesrbcdefgtapnzordqdhwqkuyi items: type: string required: - number security: [] /api/v1/profile: post: summary: 'Create New Profile' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: profile_id: 8a04501b-53ee-481a-949a-0cc59d286ec8 gender: male date_of_birth: '1986-06-01' place_of_birth: JO data_source: user_contacts names: - prefix: Mr first: Ahmad middle: Ibrahim last: Saleh display: 'Mr Ahmad Ibrahim Saleh' - prefix: null first: Feddes middle: null last: Jawabkom display: 'Feddes Jawabkom' phones: - type: mobile do_not_call_flag: false country_code: JO original_number: '0788208255' formatted_number: '+962788208255' valid_phone: true risky_phone: false disposable_phone: false carrier: umniah purpose: personal industry: Anything valid_since: '2021-10-10' addresses: - valid_since: '2021-10-10' country: JO state: Amman city: AlJubiha zip: '11941' street: 'AlGardenz Street' building_number: '22' display: 'Amman-Jordan, AlJubiha, Algardenz street building number 22, flat number 3.' usernames: - valid_since: '2021-10-10' username: ahmadfds - valid_since: '2021-10-10' username: ahmad_fds emails: - valid_since: '2021-10-10' email: ahmad@mailinator.com esp_domain: mailinator.com type: work - valid_since: '2021-10-10' email: ahmad2@mailinator.com esp_domain: mailinator.com type: personal relationships: - valid_since: '2021-10-10' type: brother first_name: Ibrahim last_name: Saleh person_id: null - valid_since: '2021-10-10' type: friend first_name: Yousef last_name: Nabulsi person_id: null skills: - valid_since: '2021-10-10' level: Advanced skill: PHP - valid_since: '2021-10-10' level: Advanced skill: MySQL images: - original_url: 'http://mad-distribution.film/img/lineup/movies/directors/Ahmad_Saleh.jpg' local_path: null valid_since: '2021-10-10' - original_url: 'https://en.islamway.net/uploads/authors/3737.jpg' local_path: null valid_since: '2021-10-10' languages: - language: en country: US - language: ar country: JO jobs: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' title: 'Software Developer' organization: Jawabkom industry: 'Information Technology' educations: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' school: 'Philadelphia University' degree: 'Bachelor Degree' major: 'Computer Science' social_profiles: - valid_since: '2021-10-10' url: 'https://www.facebook.com/ahmadfds/' type: facebook username: ahmadfds account_id: '10161047747102818' criminal_records: [] meta_data: - meta_key: tracking_uuid meta_value: 'any trackinguuid' - meta_key: mapped_user_id meta_value: '5546544' - meta_key: any_meta_key meta_value: 'any any_meta_value' properties: profile_id: type: string example: 8a04501b-53ee-481a-949a-0cc59d286ec8 gender: type: string example: male date_of_birth: type: string example: '1986-06-01' place_of_birth: type: string example: JO data_source: type: string example: user_contacts names: type: array example: - prefix: Mr first: Ahmad middle: Ibrahim last: Saleh display: 'Mr Ahmad Ibrahim Saleh' - prefix: null first: Feddes middle: null last: Jawabkom display: 'Feddes Jawabkom' items: type: object phones: type: array example: - type: mobile do_not_call_flag: false country_code: JO original_number: '0788208255' formatted_number: '+962788208255' valid_phone: true risky_phone: false disposable_phone: false carrier: umniah purpose: personal industry: Anything valid_since: '2021-10-10' items: type: object addresses: type: array example: - valid_since: '2021-10-10' country: JO state: Amman city: AlJubiha zip: '11941' street: 'AlGardenz Street' building_number: '22' display: 'Amman-Jordan, AlJubiha, Algardenz street building number 22, flat number 3.' items: type: object usernames: type: array example: - valid_since: '2021-10-10' username: ahmadfds - valid_since: '2021-10-10' username: ahmad_fds items: type: object emails: type: array example: - valid_since: '2021-10-10' email: ahmad@mailinator.com esp_domain: mailinator.com type: work - valid_since: '2021-10-10' email: ahmad2@mailinator.com esp_domain: mailinator.com type: personal items: type: object relationships: type: array example: - valid_since: '2021-10-10' type: brother first_name: Ibrahim last_name: Saleh person_id: null - valid_since: '2021-10-10' type: friend first_name: Yousef last_name: Nabulsi person_id: null items: type: object skills: type: array example: - valid_since: '2021-10-10' level: Advanced skill: PHP - valid_since: '2021-10-10' level: Advanced skill: MySQL items: type: object images: type: array example: - original_url: 'http://mad-distribution.film/img/lineup/movies/directors/Ahmad_Saleh.jpg' local_path: null valid_since: '2021-10-10' - original_url: 'https://en.islamway.net/uploads/authors/3737.jpg' local_path: null valid_since: '2021-10-10' items: type: object languages: type: array example: - language: en country: US - language: ar country: JO items: type: object jobs: type: array example: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' title: 'Software Developer' organization: Jawabkom industry: 'Information Technology' items: type: object educations: type: array example: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' school: 'Philadelphia University' degree: 'Bachelor Degree' major: 'Computer Science' items: type: object social_profiles: type: array example: - valid_since: '2021-10-10' url: 'https://www.facebook.com/ahmadfds/' type: facebook username: ahmadfds account_id: '10161047747102818' items: type: object criminal_records: type: array example: [] meta_data: type: array example: - meta_key: tracking_uuid meta_value: 'any trackinguuid' - meta_key: mapped_user_id meta_value: '5546544' - meta_key: any_meta_key meta_value: 'any any_meta_value' items: type: object tags: - Profile requestBody: required: true content: application/json: schema: type: object properties: data_source: type: string description: 'Set profile''s data source such as (user_contacts, facebook, linkedin, ... etc).' example: facebook gender: type: string description: 'The profile onwner gender, it could be male or female .' example: male date_of_birth: type: string description: 'Profile owner''s date of birth.' example: '1986-05-27' place_of_birth: type: string description: 'Profile owner''s country of birth.' example: JO names: type: array description: 'A collection of profile owner names.' example: - prefix: Mr first: Ahmad middle: Ibrahim last: Saleh - first: Feddes last: Jawabkom items: type: object phones: type: array description: 'A collection of phone numbers.' example: - valid_since: '2021-10-10' type: mobile do_not_call_flag: false country_code: JO original_number: '0788208255' risky_phone: false disposable_phone: false carrier: umniah purpose: personal industry: Anything possible_countries: - US - SA items: type: object addresses: type: array description: 'A collection of profile''s related addresses.' example: - valid_since: '2021-10-10' country: JO state: Amman city: AlJubiha zip: 11941 street: 'AlGardenz Street' building_number: 22 display: 'Amman-Jordan, AlJubiha, Algardenz street building number 22, flat number 3.' items: type: object usernames: type: array description: 'it''s last or family name of the one you want to search for.' example: - valid_since: '2021-10-10' username: ahmadfds - valid_since: '2021-10-10' username: ahmad_fds items: type: object emails: type: array description: 'A collection of email addresses.' example: - valid_since: '2021-10-10' email: ahmad@mailinator.com type: work - valid_since: '2021-10-10' email: ahmad2@mailinator.com type: personal items: type: object relationships: type: array description: 'A collection of relationships with other people.' example: - valid_since: '2021-10-10' type: brother first_name: Ibrahim last_name: Saleh - valid_since: '2021-10-10' type: friend first_name: Yousef last_name: Nabulsi items: type: object skills: type: array description: 'A collection of profile owner''s skills.' example: - valid_since: '2021-10-10' level: Advanced skill: PHP - valid_since: '2021-10-10' level: Advanced skill: MySQL items: type: object images: type: array description: 'A collection of profile owner''s images.' example: - valid_since: '2021-10-10' original_url: 'http://mad-distribution.film/img/lineup/movies/directors/Ahmad_Saleh.jpg' - valid_since: '2021-10-10' original_url: 'https://en.islamway.net/uploads/authors/3737.jpg' items: type: object languages: type: array description: 'A collection of locales.' example: - language: en country: US - language: ar country: JO items: type: object jobs: type: array description: 'A collection of jobs and experiences gained by the profile owner.' example: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' title: 'Software Developer' organization: Jawabkom industry: 'Information Technology' items: type: object educations: type: array description: 'A collection of schools attended by the profile owner.' example: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' school: 'Philadelphia University' degree: 'Bachelor Degree' major: 'Computer Science' items: type: object social_profiles: type: array description: 'A collection of related social websites links.' example: - valid_since: '2021-10-10' url: 'https://www.facebook.com/ahmadfds/' type: facebook username: ahmadfds account_id: 10161047747102818 items: type: object meta_data: type: array description: 'Any other data you need to attach to profile.' example: - meta_key: tracking_uuid meta_value: 'any trackinguuid' - meta_key: mapped_user_id meta_value: '5546544' - meta_key: any_meta_key meta_value: 'any any_meta_value' items: type: object required: - data_source get: summary: 'Get Profile By profileId' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: profile_id: 8a04501b-53ee-481a-949a-0cc59d286ec8 gender: male date_of_birth: '1986-06-01' place_of_birth: JO data_source: user_contacts names: - prefix: Mr first: Ahmad middle: Ibrahim last: Saleh display: 'Mr Ahmad Ibrahim Saleh' - prefix: null first: Feddes middle: null last: Jawabkom display: 'Feddes Jawabkom' phones: - type: mobile do_not_call_flag: false country_code: JO original_number: '0788208255' formatted_number: '+962788208255' valid_phone: true risky_phone: false disposable_phone: false carrier: umniah purpose: personal industry: Anything valid_since: '2021-10-10' addresses: - valid_since: '2021-10-10' country: JO state: Amman city: AlJubiha zip: '11941' street: 'AlGardenz Street' building_number: '22' display: 'Amman-Jordan, AlJubiha, Algardenz street building number 22, flat number 3.' usernames: - valid_since: '2021-10-10' username: ahmadfds - valid_since: '2021-10-10' username: ahmad_fds emails: - valid_since: '2021-10-10' email: ahmad@mailinator.com esp_domain: mailinator.com type: work - valid_since: '2021-10-10' email: ahmad2@mailinator.com esp_domain: mailinator.com type: personal relationships: - valid_since: '2021-10-10' type: brother first_name: Ibrahim last_name: Saleh person_id: null - valid_since: '2021-10-10' type: friend first_name: Yousef last_name: Nabulsi person_id: null skills: - valid_since: '2021-10-10' level: Advanced skill: PHP - valid_since: '2021-10-10' level: Advanced skill: MySQL images: - original_url: 'http://mad-distribution.film/img/lineup/movies/directors/Ahmad_Saleh.jpg' local_path: null valid_since: '2021-10-10' - original_url: 'https://en.islamway.net/uploads/authors/3737.jpg' local_path: null valid_since: '2021-10-10' languages: - language: en country: US - language: ar country: JO jobs: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' title: 'Software Developer' organization: Jawabkom industry: 'Information Technology' educations: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' school: 'Philadelphia University' degree: 'Bachelor Degree' major: 'Computer Science' social_profiles: - valid_since: '2021-10-10' url: 'https://www.facebook.com/ahmadfds/' type: facebook username: ahmadfds account_id: '10161047747102818' criminal_records: [] meta_data: - meta_key: tracking_uuid meta_value: 'any trackinguuid' - meta_key: mapped_user_id meta_value: '5546544' - meta_key: any_meta_key meta_value: 'any any_meta_value' properties: profile_id: type: string example: 8a04501b-53ee-481a-949a-0cc59d286ec8 gender: type: string example: male date_of_birth: type: string example: '1986-06-01' place_of_birth: type: string example: JO data_source: type: string example: user_contacts names: type: array example: - prefix: Mr first: Ahmad middle: Ibrahim last: Saleh display: 'Mr Ahmad Ibrahim Saleh' - prefix: null first: Feddes middle: null last: Jawabkom display: 'Feddes Jawabkom' items: type: object phones: type: array example: - type: mobile do_not_call_flag: false country_code: JO original_number: '0788208255' formatted_number: '+962788208255' valid_phone: true risky_phone: false disposable_phone: false carrier: umniah purpose: personal industry: Anything valid_since: '2021-10-10' items: type: object addresses: type: array example: - valid_since: '2021-10-10' country: JO state: Amman city: AlJubiha zip: '11941' street: 'AlGardenz Street' building_number: '22' display: 'Amman-Jordan, AlJubiha, Algardenz street building number 22, flat number 3.' items: type: object usernames: type: array example: - valid_since: '2021-10-10' username: ahmadfds - valid_since: '2021-10-10' username: ahmad_fds items: type: object emails: type: array example: - valid_since: '2021-10-10' email: ahmad@mailinator.com esp_domain: mailinator.com type: work - valid_since: '2021-10-10' email: ahmad2@mailinator.com esp_domain: mailinator.com type: personal items: type: object relationships: type: array example: - valid_since: '2021-10-10' type: brother first_name: Ibrahim last_name: Saleh person_id: null - valid_since: '2021-10-10' type: friend first_name: Yousef last_name: Nabulsi person_id: null items: type: object skills: type: array example: - valid_since: '2021-10-10' level: Advanced skill: PHP - valid_since: '2021-10-10' level: Advanced skill: MySQL items: type: object images: type: array example: - original_url: 'http://mad-distribution.film/img/lineup/movies/directors/Ahmad_Saleh.jpg' local_path: null valid_since: '2021-10-10' - original_url: 'https://en.islamway.net/uploads/authors/3737.jpg' local_path: null valid_since: '2021-10-10' items: type: object languages: type: array example: - language: en country: US - language: ar country: JO items: type: object jobs: type: array example: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' title: 'Software Developer' organization: Jawabkom industry: 'Information Technology' items: type: object educations: type: array example: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' school: 'Philadelphia University' degree: 'Bachelor Degree' major: 'Computer Science' items: type: object social_profiles: type: array example: - valid_since: '2021-10-10' url: 'https://www.facebook.com/ahmadfds/' type: facebook username: ahmadfds account_id: '10161047747102818' items: type: object criminal_records: type: array example: [] meta_data: type: array example: - meta_key: tracking_uuid meta_value: 'any trackinguuid' - meta_key: mapped_user_id meta_value: '5546544' - meta_key: any_meta_key meta_value: 'any any_meta_value' items: type: object tags: - Profile requestBody: required: true content: application/json: schema: type: object properties: profileId: type: string. description: '' example: eb77e4e3-28cb-4959-ac97-396504b7c022 required: - profileId /api/v1/profile/new: post: summary: '' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - Profile security: [] /api/v1/profile/search/byEmail: get: summary: 'Search By-Email Address' description: 'This endpoint lets you search in data profiles into db with related entities API.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: profile_id: 8a04501b-53ee-481a-949a-0cc59d286ec8 gender: male date_of_birth: '1986-06-01' place_of_birth: JO data_source: user_contacts names: - prefix: Mr first: Ahmad middle: Ibrahim last: Saleh display: 'Mr Ahmad Ibrahim Saleh' - prefix: null first: Feddes middle: null last: Jawabkom display: 'Feddes Jawabkom' phones: - type: mobile do_not_call_flag: false country_code: JO original_number: '0788208255' formatted_number: '+962788208255' valid_phone: true risky_phone: false disposable_phone: false carrier: umniah purpose: personal industry: Anything valid_since: '2021-10-10' addresses: - valid_since: '2021-10-10' country: JO state: Amman city: AlJubiha zip: '11941' street: 'AlGardenz Street' building_number: '22' display: 'Amman-Jordan, AlJubiha, Algardenz street building number 22, flat number 3.' usernames: - valid_since: '2021-10-10' username: ahmadfds - valid_since: '2021-10-10' username: ahmad_fds emails: - valid_since: '2021-10-10' email: ahmad@mailinator.com esp_domain: mailinator.com type: work - valid_since: '2021-10-10' email: ibrahim@example.com esp_domain: mailinator.com type: personal relationships: - valid_since: '2021-10-10' type: brother first_name: Ibrahim last_name: Saleh person_id: null - valid_since: '2021-10-10' type: friend first_name: Yousef last_name: Nabulsi person_id: null skills: - valid_since: '2021-10-10' level: Advanced skill: PHP - valid_since: '2021-10-10' level: Advanced skill: MySQL images: - original_url: 'http://mad-distribution.film/img/lineup/movies/directors/Ahmad_Saleh.jpg' local_path: null valid_since: '2021-10-10' - original_url: 'https://en.islamway.net/uploads/authors/3737.jpg' local_path: null valid_since: '2021-10-10' languages: - language: en country: US - language: ar country: JO jobs: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' title: 'Software Developer' organization: Jawabkom industry: 'Information Technology' educations: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' school: 'Philadelphia University' degree: 'Bachelor Degree' major: 'Computer Science' social_profiles: - valid_since: '2021-10-10' url: 'https://www.facebook.com/ahmadfds/' type: facebook username: ahmadfds account_id: '10161047747102818' criminal_records: [] meta_data: - meta_key: tracking_uuid meta_value: 'any trackinguuid' - meta_key: mapped_user_id meta_value: '5546544' - meta_key: any_meta_key meta_value: 'any any_meta_value' properties: profile_id: type: string example: 8a04501b-53ee-481a-949a-0cc59d286ec8 gender: type: string example: male date_of_birth: type: string example: '1986-06-01' place_of_birth: type: string example: JO data_source: type: string example: user_contacts names: type: array example: - prefix: Mr first: Ahmad middle: Ibrahim last: Saleh display: 'Mr Ahmad Ibrahim Saleh' - prefix: null first: Feddes middle: null last: Jawabkom display: 'Feddes Jawabkom' items: type: object phones: type: array example: - type: mobile do_not_call_flag: false country_code: JO original_number: '0788208255' formatted_number: '+962788208255' valid_phone: true risky_phone: false disposable_phone: false carrier: umniah purpose: personal industry: Anything valid_since: '2021-10-10' items: type: object addresses: type: array example: - valid_since: '2021-10-10' country: JO state: Amman city: AlJubiha zip: '11941' street: 'AlGardenz Street' building_number: '22' display: 'Amman-Jordan, AlJubiha, Algardenz street building number 22, flat number 3.' items: type: object usernames: type: array example: - valid_since: '2021-10-10' username: ahmadfds - valid_since: '2021-10-10' username: ahmad_fds items: type: object emails: type: array example: - valid_since: '2021-10-10' email: ahmad@mailinator.com esp_domain: mailinator.com type: work - valid_since: '2021-10-10' email: ibrahim@example.com esp_domain: mailinator.com type: personal items: type: object relationships: type: array example: - valid_since: '2021-10-10' type: brother first_name: Ibrahim last_name: Saleh person_id: null - valid_since: '2021-10-10' type: friend first_name: Yousef last_name: Nabulsi person_id: null items: type: object skills: type: array example: - valid_since: '2021-10-10' level: Advanced skill: PHP - valid_since: '2021-10-10' level: Advanced skill: MySQL items: type: object images: type: array example: - original_url: 'http://mad-distribution.film/img/lineup/movies/directors/Ahmad_Saleh.jpg' local_path: null valid_since: '2021-10-10' - original_url: 'https://en.islamway.net/uploads/authors/3737.jpg' local_path: null valid_since: '2021-10-10' items: type: object languages: type: array example: - language: en country: US - language: ar country: JO items: type: object jobs: type: array example: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' title: 'Software Developer' organization: Jawabkom industry: 'Information Technology' items: type: object educations: type: array example: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' school: 'Philadelphia University' degree: 'Bachelor Degree' major: 'Computer Science' items: type: object social_profiles: type: array example: - valid_since: '2021-10-10' url: 'https://www.facebook.com/ahmadfds/' type: facebook username: ahmadfds account_id: '10161047747102818' items: type: object criminal_records: type: array example: [] meta_data: type: array example: - meta_key: tracking_uuid meta_value: 'any trackinguuid' - meta_key: mapped_user_id meta_value: '5546544' - meta_key: any_meta_key meta_value: 'any any_meta_value' items: type: object tags: - Search requestBody: required: true content: application/json: schema: type: object properties: address: type: string description: 'must be valid email address .' example: ibrahim@example.com alias: type: array description: 'should provider when you want search into our providers .' example: - culpa items: type: string meta: type: string description: 'should be array have meta request data .' example: '[''process_id''=>''5656464'']' required: - address /api/v1/profile/search/byPhone: get: summary: '' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Search requestBody: required: true content: application/json: schema: type: object properties: number: type: string description: '' example: provident possibleCountries: type: array description: 'Must be at least 2 characters. Must not be greater than 2 characters.' example: - '' items: type: string required: - number - possibleCountries security: [] /api/v1/profile/search/byUsername: get: summary: 'Search By Username' description: 'This endpoint lets you search in data profiles into db with related entities API.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: profile_id: 8a04501b-53ee-481a-949a-0cc59d286ec8 gender: male date_of_birth: '1986-06-01' place_of_birth: JO data_source: user_contacts names: - prefix: Mr first: Ahmad middle: Ibrahim last: Saleh display: 'Mr Ahmad Ibrahim Saleh' - prefix: null first: Feddes middle: null last: Jawabkom display: 'Feddes Jawabkom' phones: - type: mobile do_not_call_flag: false country_code: JO original_number: '0788208255' formatted_number: '+962788208255' valid_phone: true risky_phone: false disposable_phone: false carrier: umniah purpose: personal industry: Anything valid_since: '2021-10-10' addresses: - valid_since: '2021-10-10' country: JO state: Amman city: AlJubiha zip: '11941' street: 'AlGardenz Street' building_number: '22' display: 'Amman-Jordan, AlJubiha, Algardenz street building number 22, flat number 3.' usernames: - valid_since: '2021-10-10' username: ahmadfds - valid_since: '2021-10-10' username: ahmad_fds emails: - valid_since: '2021-10-10' email: ahmad@mailinator.com esp_domain: mailinator.com type: work - valid_since: '2021-10-10' email: ibrahim@example.com esp_domain: mailinator.com type: personal relationships: - valid_since: '2021-10-10' type: brother first_name: Ibrahim last_name: Saleh person_id: null - valid_since: '2021-10-10' type: friend first_name: Yousef last_name: Nabulsi person_id: null skills: - valid_since: '2021-10-10' level: Advanced skill: PHP - valid_since: '2021-10-10' level: Advanced skill: MySQL images: - original_url: 'http://mad-distribution.film/img/lineup/movies/directors/Ahmad_Saleh.jpg' local_path: null valid_since: '2021-10-10' - original_url: 'https://en.islamway.net/uploads/authors/3737.jpg' local_path: null valid_since: '2021-10-10' languages: - language: en country: US - language: ar country: JO jobs: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' title: 'Software Developer' organization: Jawabkom industry: 'Information Technology' educations: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' school: 'Philadelphia University' degree: 'Bachelor Degree' major: 'Computer Science' social_profiles: - valid_since: '2021-10-10' url: 'https://www.facebook.com/ahmadfds/' type: facebook username: ahmadfds account_id: '10161047747102818' criminal_records: [] meta_data: - meta_key: tracking_uuid meta_value: 'any trackinguuid' - meta_key: mapped_user_id meta_value: '5546544' - meta_key: any_meta_key meta_value: 'any any_meta_value' properties: profile_id: type: string example: 8a04501b-53ee-481a-949a-0cc59d286ec8 gender: type: string example: male date_of_birth: type: string example: '1986-06-01' place_of_birth: type: string example: JO data_source: type: string example: user_contacts names: type: array example: - prefix: Mr first: Ahmad middle: Ibrahim last: Saleh display: 'Mr Ahmad Ibrahim Saleh' - prefix: null first: Feddes middle: null last: Jawabkom display: 'Feddes Jawabkom' items: type: object phones: type: array example: - type: mobile do_not_call_flag: false country_code: JO original_number: '0788208255' formatted_number: '+962788208255' valid_phone: true risky_phone: false disposable_phone: false carrier: umniah purpose: personal industry: Anything valid_since: '2021-10-10' items: type: object addresses: type: array example: - valid_since: '2021-10-10' country: JO state: Amman city: AlJubiha zip: '11941' street: 'AlGardenz Street' building_number: '22' display: 'Amman-Jordan, AlJubiha, Algardenz street building number 22, flat number 3.' items: type: object usernames: type: array example: - valid_since: '2021-10-10' username: ahmadfds - valid_since: '2021-10-10' username: ahmad_fds items: type: object emails: type: array example: - valid_since: '2021-10-10' email: ahmad@mailinator.com esp_domain: mailinator.com type: work - valid_since: '2021-10-10' email: ibrahim@example.com esp_domain: mailinator.com type: personal items: type: object relationships: type: array example: - valid_since: '2021-10-10' type: brother first_name: Ibrahim last_name: Saleh person_id: null - valid_since: '2021-10-10' type: friend first_name: Yousef last_name: Nabulsi person_id: null items: type: object skills: type: array example: - valid_since: '2021-10-10' level: Advanced skill: PHP - valid_since: '2021-10-10' level: Advanced skill: MySQL items: type: object images: type: array example: - original_url: 'http://mad-distribution.film/img/lineup/movies/directors/Ahmad_Saleh.jpg' local_path: null valid_since: '2021-10-10' - original_url: 'https://en.islamway.net/uploads/authors/3737.jpg' local_path: null valid_since: '2021-10-10' items: type: object languages: type: array example: - language: en country: US - language: ar country: JO items: type: object jobs: type: array example: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' title: 'Software Developer' organization: Jawabkom industry: 'Information Technology' items: type: object educations: type: array example: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' school: 'Philadelphia University' degree: 'Bachelor Degree' major: 'Computer Science' items: type: object social_profiles: type: array example: - valid_since: '2021-10-10' url: 'https://www.facebook.com/ahmadfds/' type: facebook username: ahmadfds account_id: '10161047747102818' items: type: object criminal_records: type: array example: [] meta_data: type: array example: - meta_key: tracking_uuid meta_value: 'any trackinguuid' - meta_key: mapped_user_id meta_value: '5546544' - meta_key: any_meta_key meta_value: 'any any_meta_value' items: type: object tags: - Search requestBody: required: true content: application/json: schema: type: object properties: username: type: string description: username. example: 'ahmadfds,' alias: type: array description: 'should provider when you want search into our providers .' example: - id items: type: string meta: type: string description: 'should be array have meta request data .' example: '[''process_id''=>''5656464'']' required: - username /api/v1/profile/search/byName: get: summary: 'Search By Name' description: 'This endpoint lets you search in data profiles into db with related entities API.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: profile_id: 8a04501b-53ee-481a-949a-0cc59d286ec8 gender: male date_of_birth: '1986-06-01' place_of_birth: JO data_source: user_contacts names: - prefix: Mr first: Ahmad middle: Ibrahim last: Saleh display: 'Mr Ahmad Ibrahim Saleh' - prefix: null first: Feddes middle: null last: Jawabkom display: 'Feddes Jawabkom' phones: - type: mobile do_not_call_flag: false country_code: JO original_number: '0788208255' formatted_number: '+962788208255' valid_phone: true risky_phone: false disposable_phone: false carrier: umniah purpose: personal industry: Anything valid_since: '2021-10-10' addresses: - valid_since: '2021-10-10' country: JO state: Amman city: AlJubiha zip: '11941' street: 'AlGardenz Street' building_number: '22' display: 'Amman-Jordan, AlJubiha, Algardenz street building number 22, flat number 3.' usernames: - valid_since: '2021-10-10' username: ahmadfds - valid_since: '2021-10-10' username: ahmad_fds emails: - valid_since: '2021-10-10' email: ahmad@mailinator.com esp_domain: mailinator.com type: work - valid_since: '2021-10-10' email: ibrahim@example.com esp_domain: mailinator.com type: personal relationships: - valid_since: '2021-10-10' type: brother first_name: Ibrahim last_name: Saleh person_id: null - valid_since: '2021-10-10' type: friend first_name: Yousef last_name: Nabulsi person_id: null skills: - valid_since: '2021-10-10' level: Advanced skill: PHP - valid_since: '2021-10-10' level: Advanced skill: MySQL images: - original_url: 'http://mad-distribution.film/img/lineup/movies/directors/Ahmad_Saleh.jpg' local_path: null valid_since: '2021-10-10' - original_url: 'https://en.islamway.net/uploads/authors/3737.jpg' local_path: null valid_since: '2021-10-10' languages: - language: en country: US - language: ar country: JO jobs: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' title: 'Software Developer' organization: Jawabkom industry: 'Information Technology' educations: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' school: 'Philadelphia University' degree: 'Bachelor Degree' major: 'Computer Science' social_profiles: - valid_since: '2021-10-10' url: 'https://www.facebook.com/ahmadfds/' type: facebook username: ahmadfds account_id: '10161047747102818' criminal_records: [] meta_data: - meta_key: tracking_uuid meta_value: 'any trackinguuid' - meta_key: mapped_user_id meta_value: '5546544' - meta_key: any_meta_key meta_value: 'any any_meta_value' properties: profile_id: type: string example: 8a04501b-53ee-481a-949a-0cc59d286ec8 gender: type: string example: male date_of_birth: type: string example: '1986-06-01' place_of_birth: type: string example: JO data_source: type: string example: user_contacts names: type: array example: - prefix: Mr first: Ahmad middle: Ibrahim last: Saleh display: 'Mr Ahmad Ibrahim Saleh' - prefix: null first: Feddes middle: null last: Jawabkom display: 'Feddes Jawabkom' items: type: object phones: type: array example: - type: mobile do_not_call_flag: false country_code: JO original_number: '0788208255' formatted_number: '+962788208255' valid_phone: true risky_phone: false disposable_phone: false carrier: umniah purpose: personal industry: Anything valid_since: '2021-10-10' items: type: object addresses: type: array example: - valid_since: '2021-10-10' country: JO state: Amman city: AlJubiha zip: '11941' street: 'AlGardenz Street' building_number: '22' display: 'Amman-Jordan, AlJubiha, Algardenz street building number 22, flat number 3.' items: type: object usernames: type: array example: - valid_since: '2021-10-10' username: ahmadfds - valid_since: '2021-10-10' username: ahmad_fds items: type: object emails: type: array example: - valid_since: '2021-10-10' email: ahmad@mailinator.com esp_domain: mailinator.com type: work - valid_since: '2021-10-10' email: ibrahim@example.com esp_domain: mailinator.com type: personal items: type: object relationships: type: array example: - valid_since: '2021-10-10' type: brother first_name: Ibrahim last_name: Saleh person_id: null - valid_since: '2021-10-10' type: friend first_name: Yousef last_name: Nabulsi person_id: null items: type: object skills: type: array example: - valid_since: '2021-10-10' level: Advanced skill: PHP - valid_since: '2021-10-10' level: Advanced skill: MySQL items: type: object images: type: array example: - original_url: 'http://mad-distribution.film/img/lineup/movies/directors/Ahmad_Saleh.jpg' local_path: null valid_since: '2021-10-10' - original_url: 'https://en.islamway.net/uploads/authors/3737.jpg' local_path: null valid_since: '2021-10-10' items: type: object languages: type: array example: - language: en country: US - language: ar country: JO items: type: object jobs: type: array example: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' title: 'Software Developer' organization: Jawabkom industry: 'Information Technology' items: type: object educations: type: array example: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' school: 'Philadelphia University' degree: 'Bachelor Degree' major: 'Computer Science' items: type: object social_profiles: type: array example: - valid_since: '2021-10-10' url: 'https://www.facebook.com/ahmadfds/' type: facebook username: ahmadfds account_id: '10161047747102818' items: type: object criminal_records: type: array example: [] meta_data: type: array example: - meta_key: tracking_uuid meta_value: 'any trackinguuid' - meta_key: mapped_user_id meta_value: '5546544' - meta_key: any_meta_key meta_value: 'any any_meta_value' items: type: object tags: - Search requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: 'could be first name mmiddle name,last name.' example: 'Mr Ahmad Ibrahim Saleh,' alias: type: array description: 'should provider when you want search into our providers .' example: - et items: type: string meta: type: string description: 'should be array have meta request data .' example: '[''process_id''=>''5656464'']' /api/v1/profile/search/advance: get: summary: 'Advance Search' description: 'This endpoint lets you search in data profiles into db with related entities API one of these required names(first,middle,last),phone,email and username.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: profile_id: 8a04501b-53ee-481a-949a-0cc59d286ec8 gender: male date_of_birth: '1986-06-01' place_of_birth: JO data_source: user_contacts names: - prefix: Mr first: Ahmad middle: Ibrahim last: Saleh display: 'Mr Ahmad Ibrahim Saleh' - prefix: null first: Feddes middle: null last: Jawabkom display: 'Feddes Jawabkom' phones: - type: mobile do_not_call_flag: false country_code: JO original_number: '0788208255' formatted_number: '+962788208255' valid_phone: true risky_phone: false disposable_phone: false carrier: umniah purpose: personal industry: Anything valid_since: '2021-10-10' addresses: - valid_since: '2021-10-10' country: JO state: Amman city: AlJubiha zip: '11941' street: 'AlGardenz Street' building_number: '22' display: 'Amman-Jordan, AlJubiha, Algardenz street building number 22, flat number 3.' usernames: - valid_since: '2021-10-10' username: ahmadfds - valid_since: '2021-10-10' username: ahmad_fds emails: - valid_since: '2021-10-10' email: ahmad@mailinator.com esp_domain: mailinator.com type: work - valid_since: '2021-10-10' email: ibrahim@example.com esp_domain: mailinator.com type: personal relationships: - valid_since: '2021-10-10' type: brother first_name: Ibrahim last_name: Saleh person_id: null - valid_since: '2021-10-10' type: friend first_name: Yousef last_name: Nabulsi person_id: null skills: - valid_since: '2021-10-10' level: Advanced skill: PHP - valid_since: '2021-10-10' level: Advanced skill: MySQL images: - original_url: 'http://mad-distribution.film/img/lineup/movies/directors/Ahmad_Saleh.jpg' local_path: null valid_since: '2021-10-10' - original_url: 'https://en.islamway.net/uploads/authors/3737.jpg' local_path: null valid_since: '2021-10-10' languages: - language: en country: US - language: ar country: JO jobs: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' title: 'Software Developer' organization: Jawabkom industry: 'Information Technology' educations: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' school: 'Philadelphia University' degree: 'Bachelor Degree' major: 'Computer Science' social_profiles: - valid_since: '2021-10-10' url: 'https://www.facebook.com/ahmadfds/' type: facebook username: ahmadfds account_id: '10161047747102818' criminal_records: [] meta_data: - meta_key: tracking_uuid meta_value: 'any trackinguuid' - meta_key: mapped_user_id meta_value: '5546544' - meta_key: any_meta_key meta_value: 'any any_meta_value' properties: profile_id: type: string example: 8a04501b-53ee-481a-949a-0cc59d286ec8 gender: type: string example: male date_of_birth: type: string example: '1986-06-01' place_of_birth: type: string example: JO data_source: type: string example: user_contacts names: type: array example: - prefix: Mr first: Ahmad middle: Ibrahim last: Saleh display: 'Mr Ahmad Ibrahim Saleh' - prefix: null first: Feddes middle: null last: Jawabkom display: 'Feddes Jawabkom' items: type: object phones: type: array example: - type: mobile do_not_call_flag: false country_code: JO original_number: '0788208255' formatted_number: '+962788208255' valid_phone: true risky_phone: false disposable_phone: false carrier: umniah purpose: personal industry: Anything valid_since: '2021-10-10' items: type: object addresses: type: array example: - valid_since: '2021-10-10' country: JO state: Amman city: AlJubiha zip: '11941' street: 'AlGardenz Street' building_number: '22' display: 'Amman-Jordan, AlJubiha, Algardenz street building number 22, flat number 3.' items: type: object usernames: type: array example: - valid_since: '2021-10-10' username: ahmadfds - valid_since: '2021-10-10' username: ahmad_fds items: type: object emails: type: array example: - valid_since: '2021-10-10' email: ahmad@mailinator.com esp_domain: mailinator.com type: work - valid_since: '2021-10-10' email: ibrahim@example.com esp_domain: mailinator.com type: personal items: type: object relationships: type: array example: - valid_since: '2021-10-10' type: brother first_name: Ibrahim last_name: Saleh person_id: null - valid_since: '2021-10-10' type: friend first_name: Yousef last_name: Nabulsi person_id: null items: type: object skills: type: array example: - valid_since: '2021-10-10' level: Advanced skill: PHP - valid_since: '2021-10-10' level: Advanced skill: MySQL items: type: object images: type: array example: - original_url: 'http://mad-distribution.film/img/lineup/movies/directors/Ahmad_Saleh.jpg' local_path: null valid_since: '2021-10-10' - original_url: 'https://en.islamway.net/uploads/authors/3737.jpg' local_path: null valid_since: '2021-10-10' items: type: object languages: type: array example: - language: en country: US - language: ar country: JO items: type: object jobs: type: array example: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' title: 'Software Developer' organization: Jawabkom industry: 'Information Technology' items: type: object educations: type: array example: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' school: 'Philadelphia University' degree: 'Bachelor Degree' major: 'Computer Science' items: type: object social_profiles: type: array example: - valid_since: '2021-10-10' url: 'https://www.facebook.com/ahmadfds/' type: facebook username: ahmadfds account_id: '10161047747102818' items: type: object criminal_records: type: array example: [] meta_data: type: array example: - meta_key: tracking_uuid meta_value: 'any trackinguuid' - meta_key: mapped_user_id meta_value: '5546544' - meta_key: any_meta_key meta_value: 'any any_meta_value' items: type: object tags: - Search requestBody: required: true content: application/json: schema: type: object properties: firstName: type: string. description: '' example: Ahmad lastName: type: string. description: '' example: saleh phone: type: string. description: '' example: '0788208255' email: type: string. description: '' example: Ahmad@example.com username: type: string. description: '' example: Ahmadfds middleName: type: string. description: '' example: fathi countryCode: type: object description: '' example: '': sunt properties: '': type: 'Example:' description: '[''jo'']' example: sunt state: type: string. description: '' example: Amman city: type: string. description: '' example: Amman alias: type: array description: 'should provider when you want search into our providers .' example: - recusandae items: type: string meta: type: string description: 'should be array have meta request data .' example: '[''process_id''=>''5656464'']' required: - countryCode /api/v2/profile/search/byPhone: get: summary: 'Search By Phone Number' description: 'This endpoint lets you search in data profiles into db with related entities API.' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: profile_id: 8a04501b-53ee-481a-949a-0cc59d286ec8 gender: male date_of_birth: '1986-06-01' place_of_birth: JO data_source: user_contacts names: - prefix: Mr first: Ahmad middle: Ibrahim last: Saleh display: 'Mr Ahmad Ibrahim Saleh' - prefix: null first: Feddes middle: null last: Jawabkom display: 'Feddes Jawabkom' phones: - type: mobile do_not_call_flag: false country_code: JO original_number: '0788208255' formatted_number: '+962788208255' valid_phone: true risky_phone: false disposable_phone: false carrier: umniah purpose: personal industry: Anything valid_since: '2021-10-10' addresses: - valid_since: '2021-10-10' country: JO state: Amman city: AlJubiha zip: '11941' street: 'AlGardenz Street' building_number: '22' display: 'Amman-Jordan, AlJubiha, Algardenz street building number 22, flat number 3.' usernames: - valid_since: '2021-10-10' username: ahmadfds - valid_since: '2021-10-10' username: ahmad_fds emails: - valid_since: '2021-10-10' email: ahmad@mailinator.com esp_domain: mailinator.com type: work - valid_since: '2021-10-10' email: ibrahim@example.com esp_domain: mailinator.com type: personal relationships: - valid_since: '2021-10-10' type: brother first_name: Ibrahim last_name: Saleh person_id: null - valid_since: '2021-10-10' type: friend first_name: Yousef last_name: Nabulsi person_id: null skills: - valid_since: '2021-10-10' level: Advanced skill: PHP - valid_since: '2021-10-10' level: Advanced skill: MySQL images: - original_url: 'http://mad-distribution.film/img/lineup/movies/directors/Ahmad_Saleh.jpg' local_path: null valid_since: '2021-10-10' - original_url: 'https://en.islamway.net/uploads/authors/3737.jpg' local_path: null valid_since: '2021-10-10' languages: - language: en country: US - language: ar country: JO jobs: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' title: 'Software Developer' organization: Jawabkom industry: 'Information Technology' educations: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' school: 'Philadelphia University' degree: 'Bachelor Degree' major: 'Computer Science' social_profiles: - valid_since: '2021-10-10' url: 'https://www.facebook.com/ahmadfds/' type: facebook username: ahmadfds account_id: '10161047747102818' criminal_records: [] meta_data: - meta_key: tracking_uuid meta_value: 'any trackinguuid' - meta_key: mapped_user_id meta_value: '5546544' - meta_key: any_meta_key meta_value: 'any any_meta_value' properties: profile_id: type: string example: 8a04501b-53ee-481a-949a-0cc59d286ec8 gender: type: string example: male date_of_birth: type: string example: '1986-06-01' place_of_birth: type: string example: JO data_source: type: string example: user_contacts names: type: array example: - prefix: Mr first: Ahmad middle: Ibrahim last: Saleh display: 'Mr Ahmad Ibrahim Saleh' - prefix: null first: Feddes middle: null last: Jawabkom display: 'Feddes Jawabkom' items: type: object phones: type: array example: - type: mobile do_not_call_flag: false country_code: JO original_number: '0788208255' formatted_number: '+962788208255' valid_phone: true risky_phone: false disposable_phone: false carrier: umniah purpose: personal industry: Anything valid_since: '2021-10-10' items: type: object addresses: type: array example: - valid_since: '2021-10-10' country: JO state: Amman city: AlJubiha zip: '11941' street: 'AlGardenz Street' building_number: '22' display: 'Amman-Jordan, AlJubiha, Algardenz street building number 22, flat number 3.' items: type: object usernames: type: array example: - valid_since: '2021-10-10' username: ahmadfds - valid_since: '2021-10-10' username: ahmad_fds items: type: object emails: type: array example: - valid_since: '2021-10-10' email: ahmad@mailinator.com esp_domain: mailinator.com type: work - valid_since: '2021-10-10' email: ibrahim@example.com esp_domain: mailinator.com type: personal items: type: object relationships: type: array example: - valid_since: '2021-10-10' type: brother first_name: Ibrahim last_name: Saleh person_id: null - valid_since: '2021-10-10' type: friend first_name: Yousef last_name: Nabulsi person_id: null items: type: object skills: type: array example: - valid_since: '2021-10-10' level: Advanced skill: PHP - valid_since: '2021-10-10' level: Advanced skill: MySQL items: type: object images: type: array example: - original_url: 'http://mad-distribution.film/img/lineup/movies/directors/Ahmad_Saleh.jpg' local_path: null valid_since: '2021-10-10' - original_url: 'https://en.islamway.net/uploads/authors/3737.jpg' local_path: null valid_since: '2021-10-10' items: type: object languages: type: array example: - language: en country: US - language: ar country: JO items: type: object jobs: type: array example: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' title: 'Software Developer' organization: Jawabkom industry: 'Information Technology' items: type: object educations: type: array example: - valid_since: '2021-10-10' from: '2001-10-01' to: '2005-02-05' school: 'Philadelphia University' degree: 'Bachelor Degree' major: 'Computer Science' items: type: object social_profiles: type: array example: - valid_since: '2021-10-10' url: 'https://www.facebook.com/ahmadfds/' type: facebook username: ahmadfds account_id: '10161047747102818' items: type: object criminal_records: type: array example: [] meta_data: type: array example: - meta_key: tracking_uuid meta_value: 'any trackinguuid' - meta_key: mapped_user_id meta_value: '5546544' - meta_key: any_meta_key meta_value: 'any any_meta_value' items: type: object tags: - Search requestBody: required: true content: application/json: schema: type: object properties: number: type: string description: 'must be valid phone number can be original number or international number .' example: '0788208255,' possibleCountries: type: array description: 'must have valid country code ISO2,it is required when provide original number (local) .' example: - soluta items: type: string online_search_to_background: type: integer description: '1/0 whether to make online search if offline data is not available and return the result or to return empty response and run the online search in the background and save the results.' example: 0 alias: type: array description: 'should provider when you want search into our providers .' example: - perspiciatis items: type: string meta: type: string description: 'should be array have meta request data .' example: '[''process_id''=>''5656464'']' required: - number /api/v1/spam/reportAbuse: post: summary: 'Report abuse phone number' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: _id: 61fbeb71ba218c6c273ca919 reporter_id: '123' phone: '+9628859963' phone_country_code: JO created_at: '2022-02-03T14:49:21.000000Z' abuse_type: not_spam tags: - business updated_at: '2022-02-03T15:01:11.000000Z' properties: _id: type: string example: 61fbeb71ba218c6c273ca919 reporter_id: type: string example: '123' phone: type: string example: '+9628859963' phone_country_code: type: string example: JO created_at: type: string example: '2022-02-03T14:49:21.000000Z' abuse_type: type: string example: not_spam tags: type: array example: - business items: type: string updated_at: type: string example: '2022-02-03T15:01:11.000000Z' tags: - 'Spam Detection' requestBody: required: true content: application/json: schema: type: object properties: reporter_id: type: string description: 'The identity for the reported abuse.' example: project_ abuse_type: type: string description: 'could be one of the following values [spam, not_spam, fraud] .' example: spam phone: type: string description: 'Phone number.' example: '+962788888888' phone_country_code: type: required description: 'string Phone country code.' example: JO tags: type: array description: 'A collection of related tags.' example: - nihil items: type: string required: - reporter_id - abuse_type - phone /api/v1/spam/phoneScore: post: summary: 'Add / Update a new phone score record' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: _id: 61fc05d2f5d517497a37a287 phone: '+9628859963' source: user_reports country_code: JO created_at: '2022-02-03T16:41:54.000000Z' score: 20.5 tags: - business updated_at: '2022-02-07T10:03:23.000000Z' properties: _id: type: string example: 61fc05d2f5d517497a37a287 phone: type: string example: '+9628859963' source: type: string example: user_reports country_code: type: string example: JO created_at: type: string example: '2022-02-03T16:41:54.000000Z' score: type: number example: 20.5 tags: type: array example: - business items: type: string updated_at: type: string example: '2022-02-07T10:03:23.000000Z' tags: - 'Spam Detection' requestBody: required: true content: application/json: schema: type: object properties: score: type: string description: 'The abuse score given to this phone number.' example: '26.5' source: type: string description: 'The source of this score .' example: user_reports phone: type: string description: 'Phone number.' example: '+962788888888' countryCode: type: required description: 'string Phone country code.' example: JO tags: type: array description: 'A collection or related tags.' example: - dolor items: type: string meta: type: object description: 'meta fields.' example: [] properties: [] required: - score - source - phone get: summary: 'Get phone score record' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: _id: 61fc05d2f5d517497a37a287 phone: '+9628859963' source: user_reports country_code: JO created_at: '2022-02-03T16:41:54.000000Z' score: 20.5 tags: - business updated_at: '2022-02-07T10:03:23.000000Z' properties: _id: type: string example: 61fc05d2f5d517497a37a287 phone: type: string example: '+9628859963' source: type: string example: user_reports country_code: type: string example: JO created_at: type: string example: '2022-02-03T16:41:54.000000Z' score: type: number example: 20.5 tags: type: array example: - business items: type: string updated_at: type: string example: '2022-02-07T10:03:23.000000Z' tags: - 'Spam Detection' requestBody: required: true content: application/json: schema: type: object properties: phone: type: string description: 'Phone number.' example: '+962788888888' country_code: type: required description: 'string Phone country code.' example: JO online_only: type: integer description: 'Whether to hit the third parties apis or not, default is 1.' example: 0 required: - phone tags: - name: Endpoints description: '' - name: Profile description: "\nAPIs for create new profile user into our database or get user profile ," - name: Search description: "\nAPIs for Search into our Cache first,then will be request to third party API if we don't found" - name: 'Spam Detection' description: "\nAPIs that can help in spam data aggregation and detection" components: securitySchemes: default: type: http scheme: bearer description: '' security: - default: []