{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2556a0fa-74c5-467b-81fa-5c7aac7d461e","name":"Search Person API","description":"The Swordfish \"Search by data\" API allows you to use existing data points you have for a person and retrieve relevant contact details.\n\n---\n\n# Supported Search Combinations\n\nThe API requires one of the following base combinations to return results. Requests that do not match a supported combination will return an error or no results.\n\n### Supported combinations:\n\n- social_profile — LinkedIn, Facebook, or Twitter/X URL\n    \n- first_name + last_name + website — company domain\n    \n- first_name + last_name + company + website\n    \n- first_name + last_name + company + title\n    \n- first_name + last_name + email\n    \n- first_name + last_name + phone\n    \n- first_name + last_name + street + zipcode — US addresses only\n    \n\nThe following fields can be used as standalone search fields without any additional data:\n\n- social_profile\n    \n- email\n    \n- phone\n    \n\n**Important:**\n\nOnly one value can be sent for each data point. For example, multiple emails or multiple phones are not accepted in a single request at this time.\n\nThe data points, or as we refer to it as the base of the search, should be sent in a JSON object in the body of the API request.\n\n---\n\n<h1>Requests</h1>\n\n<h3>Request Header</h3>\n\nThe Swordfish API endpoint is [https://api.swordfish.ai/searchPerson](https://api.swordfish.ai/searchPerson) and should include the following keys and values in the header:\n\n| **KEY** | **VALUE** |  |\n| --- | --- | --- |\n| apikey | live-xxxxxxxxxxxx | mandatory |\n| content-type | application/json (mandatory) | mandatory |\n| summary | **true** or **1** | optional |\n\n<h3>Request Body</h3>\n\nThe Swordfish API a json body which includes the different data fields to search by and a \"must_have\" key to help you make sure you pay only for the data you need. It works exactly like the \"must_have\" key on the Swordfish Extension, Deep Search and File Upload, and verifies that any valid response you receive will include the data you specify.\n\nThe must_have key should be part of the JSON object in the body of the request. The valid values for this key is a number between 1 and 7 indicating what the 'must_have' combination is.\n\n'must have' combination legend:\n\n| VALUE | DESCRIPTION |\n| --- | --- |\n| 1 | Any email |\n| 2 | Any phone |\n| 3 | Mobile phone |\n| 4 | Email **OR** Any phone |\n| 5 | Email **AND** Any phone |\n| 6 | Email **OR** Mobile phone |\n| 7 | Email **AND** Mobile phone |\n\nExample of a body including 'must_have' for 'Any email':\n\n``` json\n{\n   \"must_have\":1,\n   \"fullname\":\"Bruce Wayne\"\n}\n\n ```\n\nNote: if is use \"summary\" then must_have will be ignored\n\n<h1>Responses</h1>\n\nThe API can return one of two possible responses:\n\n1. **No match** - You will see the \"no match found\" in the JSON object response. This means that based on the data sent and the 'musthave' value, we could not match a single person to return.\n    \n2. **Match** - You will see the contact details in the JSON object responses.\n    \n\n<h1>Error Handling</h1>\n\n**GENERAL ERRORS**\n\nBelow is a list of general errors and possible ways to tackle these in your code or data.\n\n| Error message | Possible issues |\n| --- | --- |\n| Access denied | API key is wrong/missing/inactive |\n| Account is suspended | Contact [success@swordfish.ai](https://mailto:success@swordfish.ai) |\n| Bad request | Bad JSON syntax in body / request not sent as POST |\n| Too many connections for the team | More than one concurrent query made by the same key |\n| The request has not been executed | Server side error / Resend request |\n| Bad request: JSON data is missing (application/json) | You are missing the key \"Content-Type\" and it's value \"application/json\" |\n\n**DATA RELATED ERRORS**\n\nBelow is a list of errors related specifically to the data in the request and possible ways to tackle these in your code or data.\n\n| ERROR MESSAGE | DESCRIPTION |\n| --- | --- |\n| Exceed limit credit | Weekly fair use threshold reached. Contact [support@swordfish.ai](https://mailto:support@swordfish.ai) to request a fair use limit increase. |\n| Credits exceed | Applies to credit-based plans. Account credits have been used up. Contact [support@swordfish.ai](https://mailto:support@swordfish.ai) for assistance. |\n| (url) is not accepted | social_profile field was sent without a valid social_profile number |\n| No data found | Body does not contain search data |\n| The query does not contain any valid name/phone/email/address/social_profile to search by | Body does not contain search data. See valid values below |\n| This type of input data is not included on your plan | The search combination used is not supported. Refer to the Supported Search Combinations section above for valid combinations. |\n\n<h1>Security and Authorization</h1>\n\nAll requests must be encrypted using SSL (https) when sent to Swordfish servers.\n\n<h5>API Key</h5>\n\nYou will need to get access to your API key from your account. Once the key has been issued to you you will be able to view it on your Settings tab.\n\nThe API key is usually part of the header but can also be sent as a parameter in the URL as in the example below:  \n[https://api.swordfish.ai/searchPerson?apikey=live-xxxxxxxxxxxx](https://api.swordfish.ai/searchPerson?apikey=live-xxxxxxxxxxxx)\n\n# Limits\n\nThe Swordfish API limits each key to 5 active requests at the same time. This is the number of requests that the system can process simultaneously by a specific key.\n\n# Credit Balance\n\nThe Swordfish API has a dedicated request to return you the number of credits you have remaining on your account. See the \"Get credits balance\" section below.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"13503793","team":1381627,"collectionId":"2556a0fa-74c5-467b-81fa-5c7aac7d461e","publishedId":"TVewZQLj","public":true,"publicUrl":"https://documenter-api.postman.tech/view/13503793/TVewZQLj","privateUrl":"https://go.postman.co/documentation/13503793-2556a0fa-74c5-467b-81fa-5c7aac7d461e","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/2492efe6-3b84-464f-9029-38d7fce30b23/TmV3LVN3b3JkZmlzaC1ibGFjay1Mb2dvLXNtYWxsLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/2492efe6-3b84-464f-9029-38d7fce30b23/TmV3LVN3b3JkZmlzaC1ibGFjay1Mb2dvLXNtYWxsLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"}}]}},"version":"8.11.6","publishDate":"2024-09-25T10:46:53.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/2492efe6-3b84-464f-9029-38d7fce30b23/TmV3LVN3b3JkZmlzaC1ibGFjay1Mb2dvLXNtYWxsLnBuZw==","logoDark":"https://content.pstmn.io/2492efe6-3b84-464f-9029-38d7fce30b23/TmV3LVN3b3JkZmlzaC1ibGFjay1Mb2dvLXNtYWxsLnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/4479018c90e09b059c83050b71a02f4ad72668ed1f9bcd2a92bf7aedcc73d948","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/TVewZQLj"}