{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"451c77b4-ee7d-483c-9ccf-58698b02a70b","name":"Hatch Partner API","description":"# Hatch Partner API Documentation (Postman)\n\n## Overview\n\nThe Hatch Partner API turns sparse person records into **Complete Human Profiles** suitable for CRMs, fundraising, and marketing automation. Results include identity, contact, education, career, wealth signals, social presence, and an AI-generated bio, returned as a normalized JSON object you can store field-by-field or as a whole profile.\n\n## API Demo\n\nInteractive API documentation available at: [https://hatch-parter-api.readme.io/reference/submitprospects](https://hatch-parter-api.readme.io/reference/submitprospects)\n\n## Core Flow (Asynchronous)\n\n1. **Submit** one or more prospects to the Partner API with all the identifiers you have.\n    \n2. Enrichment runs asynchronously; when finished we **POST** to your `callback_url`.\n    \n3. You can **poll results anytime** via the `results_url` returned on submit - this returns an array of profile URLs.\n    \n4. **Fetch each profile** by calling the URLs returned in the results array to get the full enriched data.\n    \n\nThis pattern supports large jobs, retries, and resilient processing.\n\n## Authentication\n\nAll endpoints require an API key to be supplied in a header:\n\n- **Endpoint:** `POST https://etl.hatch.ai/api/partner_api`\n    \n- **Header key:** `partnerapi`\n    \n- **Header value:** YOUR_API_KEY\n    \n\n## Minimum Required Fields (per prospect)\n\n- **Required (enforced):** `UserID`, `org_id`, `org_name`, `FirstName`, `LastName`\n    \n- **Plus at least one of:** `email`, `phone`, or address (`city + state` minimum)\n    \n\n> **Note:** Providing more identifiers generally increases match rate and accuracy. \n  \n\n## Enrichment Flags (Partner API)\n\nPartner API clients can selectively enable/disable enrichment operations by passing an `enrichment_flags` object in the upload payload. All flags default to `true` (enabled) when omitted, preserving backward compatibility.\n\n### Usage\n\n```\n{\n  \"organization\": {\"OrganizationName\": \"Partner Name\"},\n  \"enrichment_flags\": {\n    \"profile_picture\": true,\n    \"home_value\": true,\n    \"affluence_score\": true,\n    \"ai_summary\": true\n  },\n  \"prospects\": [...]\n}\n\n ```\n\n## What's in a Profile (Typical Fields)\n\n- **Scores:** `match_confidence` (0–100), `social_influence`, `affluence_score`\n    \n- **Identity and Summary:** profile photo, AI-generated bio (headline/summary/extended), name components, date or year of birth, interests\n    \n- **Contact:** emails, phones, current and prior postal addresses (may include home details and links when available)\n    \n- **Education:** institutions, degrees, dates\n    \n- **Career:** current and past roles; employer metadata (industry, size, website); work email where available\n    \n- **Social Graph:** links/handles and light reach metrics for LinkedIn, X/Twitter, Facebook; optionally Instagram, YouTube, GitHub, TikTok, Pinterest, Reddit\n    \n\n## Match Types, Info Accuracy, and the Scorecard\n\nEach result includes a **Match Type** (e.g., `LinkedInMatch.FullNameMatch`, `EmailMatch.FullNameMatch`, `PhoneMatch.FullNameMatch`, `FullNameMatch.AddressHashMatch`). Each Match Type maps to a baseline **Info Accuracy** score (0–100). Only the highest-precedence match type is shown.\n\nThe **Scorecard** compares your submitted data to the matched profile, exposing booleans and graded comparisons such as:\n\n- `email_match`, `phone_match`, `address_match`, `CSZ_match` (city/state/ZIP), `state_only_match`, `zip_match`\n    \n- `first_name_match` (exact, similar, nickname, or no match)\n    \n- `last_name_match` (exact, similar, or no match)\n    \n- `middle_name_or_init_match` (true, false, or not provided)\n    \n\nThe Scorecard also includes `match_type` and `total_final_score` (0–100). Use these fields to gate merges, auto-attach rules, and downstream automation with confidence.\n\n### Match Types Reference\n\n| Match Type | Info Accuracy Score |\n| --- | --- |\n| LinkedInMatch.FullNameMatch | 100 |\n| LinkedInMatch.FirstNameMatch.HashOrPhoneMatch.Yes | 95 |\n| LinkedInMatch.FirstNameMatch.HashOrPhoneMatch.No | 85 |\n| LinkedInMatch.LastNameMatch.HashOrPhoneMatch.Yes | 94 |\n| LinkedInMatch.LastNameMatch.HashOrPhoneMatch.No | 84 |\n| LinkedInMatch.NoNameMatch.HashOrPhoneMatch.Yes | 93 |\n| LinkedInMatch.NoNameMatch.HashOrPhoneMatch.No | 61 |\n| EmailMatch.FullNameMatch | 99 |\n| EmailMatch.FirstNameMatch.HashOrPhoneMatch.Yes | 94 |\n| EmailMatch.FirstNameMatch.HashOrPhoneMatch.No | 84 |\n| EmailMatch.LastNameMatch.HashOrPhoneMatch.Yes.MiddleNameOrInitialMatch.Yes | 90 |\n| EmailMatch.LastNameMatch.HashOrPhoneMatch.Yes.MiddleNameOrInitialMatch.No | 75 |\n| EmailMatch.LastNameMatch.HashOrPhoneMatch.No.MiddleNameOrInitialMismatchOrNoMatch.Yes | 74 |\n| EmailMatch.LastNameMatch.HashOrPhoneMatch.No.MiddleNameOrInitialMismatchOrNoMatch.No | 64 |\n| EmailMatch.NoNameMatch.HashOrPhoneMatch.Yes | 61 |\n| EmailMatch.NoNameMatch.HashOrPhoneMatch.No | 51 |\n| PhoneMatch.FullNameMatch | 98 |\n| PhoneMatch.FirstNameMatch | 73 |\n| PhoneMatch.LastNameMatch | 50 |\n| PhoneMatch.NoNameMatch | 41 |\n| FullNameMatch.AddressHashMatch | 97 |\n| FullNameMatch.CityPlusStateOrZipMatch.OneProfile | 75 |\n| FullNameMatch.CityPlusStateOrZipMatch.MultipleProfiles.MiddleNameOrInitialMatch.Multiple | 61 |\n| FullNameMatch.CityPlusStateOrZipMatch.MultipleProfiles.MiddleNameOrInitialMatch.One | 85 |\n| FullNameMatch.CityPlusStateOrZipMatch.MultipleProfiles.MiddleNameOrInitialNoMatch.Multiple | 52 |\n| FullNameMatch.CityPlusStateOrZipMatch.MultipleProfiles.MiddleNameOrInitialNoMatch.One | 62 |\n| FullNameMatch.CityPlusStateOrZipMatch.MultipleProfiles.MiddleNameOrInitialMismatch.Multiple | 50 |\n| FullNameMatch.CityPlusStateOrZipMatch.MultipleProfiles.MiddleNameOrInitialMismatch.One | 52 |\n| FullNameMatch.StateOnlyMatch.OneProfile | 74 |\n| FullNameMatch.StateOnlyMatch.MultipleProfiles.MiddleNameOrInitialMatch.Multiple | 51 |\n| FullNameMatch.StateOnlyMatch.MultipleProfiles.MiddleNameOrInitialMatch.One | 50 |\n| FullNameMatch.StateOnlyMatch.MultipleProfiles.MiddleNameOrInitialNoMatch.Multiple | 50 |\n| FullNameMatch.StateOnlyMatch.MultipleProfiles.MiddleNameOrInitialNoMatch.One | 41 |\n| FullNameMatch.StateOnlyMatch.MultipleProfiles.MiddleNameOrInitialMismatch.Multiple | 41 |\n| FullNameMatch.StateOnlyMatch.MultipleProfiles.MiddleNameOrInitialMismatch.One | 42 |\n| FullNameMatch.HashCityOrStateNoMatch.MiddleNameOrInitialMatch.Multiple | 51 |\n| FullNameMatch.HashCityOrStateNoMatch.MiddleNameOrInitialMatch.One | 50 |\n| FullNameMatch.HashCityOrStateNoMatch.MiddleNameOrInitialNoMatch.Multiple | 41 |\n| FullNameMatch.HashCityOrStateNoMatch.MiddleNameOrInitialNoMatch.One | 50 |\n| FullNameMatch.HashCityOrStateNoMatch.MiddleNameOrInitialMismatch.Multiple | 41 |\n| FullNameMatch.HashCityOrStateNoMatch.MiddleNameOrInitialMismatch.One | 42 |\n| AddressHashMatch.FullNameMatch | 96 |\n| AddressHashMatch.FirstNameMatch.Address1Match | 62 |\n| AddressHashMatch.FirstNameMatch.Address1NoMatch | 61 |\n| AddressHashMatch.LastNameMatch.Address1Match | 50 |\n| AddressHashMatch.LastNameMatch.Address1NoMatch | 49 |\n| AddressHashMatch.NoNameMatch | 48 |\n\n### Scorecard Field Details\n\n**Possible values for** **`first_name_match`****:**\n\n- `exact`\n    \n- `similar` (can be either soundex or typo)\n    \n- `nickname`\n    \n- `no match`\n    \n\n**Possible values for** **`last_name_match`****:**\n\n- `exact`\n    \n- `similar` (can be either soundex or typo)\n    \n- `no match`\n    \n\n**Possible values for** **`middle_name_or_init_match`****:**\n\n- `true`\n    \n- `false`\n    \n- `not provided`\n    \n\n## Pragmatic Scoring Tips\n\nMany teams present 0–100 Info Accuracy as 1–5 stars. A common mapping is:\n\n| Score Range | Stars |\n| --- | --- |\n| 51–60 | 1 star |\n| 61–70 | 2 stars |\n| 71–80 | 3 stars |\n| 81–90 | 4 stars |\n| 91–100 | 5 stars |\n\n> **Note:** Matches below 51 are often suppressed from end-user UIs. \n  \n\n### Score Definitions\n\n- **Information Accuracy Score:** A Hatch proprietary (0-5 star or 0-100) rating of the likelihood that the matched profile data represents the correct individual.\n    \n- **Affluence Score:** A Hatch proprietary 0-100 score representing the wealth of the prospect, where 100 is the world's richest person, and 0 is someone with no recorded assets or income.\n    \n- **Social Influence Score:** A Hatch proprietary 0-100 score that quantifies the strength of an individual's presence, audience, and reach on social media platforms.\n    \n\n## Operational Limits (Design Around These)\n\n- **Annual usage:** number of enrichments will be stipulated in your contract\n    \n- **Rate limit (all APIs):** max **25 requests / second**\n    \n- **Bulk request size:** up to **100,000** prospects per bulk request\n    \n- **Processing throughput:** average of \\~**10,000 results/hour** across ongoing bulk jobs (each applicable result may include photo, AI summary, social, career, contact, wealth, and scores)\n    \n\n## IDs & Variables Used in This Collection\n\n- `results_id` is parsed from `results_url` returned by **Submit Prospects**\n    \n- `prospect_url` is extracted from the results array returned by **Get Results**\n    \n- `hatch_id` is extracted from prospect_url or from the profile data","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"22789297","team":4761169,"collectionId":"451c77b4-ee7d-483c-9ccf-58698b02a70b","publishedId":"2sB3dWsnKm","public":true,"publicUrl":"https://documenter-api.postman.tech/view/22789297/2sB3dWsnKm","privateUrl":"https://go.postman.co/documentation/22789297-451c77b4-ee7d-483c-9ccf-58698b02a70b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-12-22T14:58:31.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"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/a8e4c1361e9dadfd20cea410db0aa6e9d4f827ff57caa2b276cfe1c7329fa25f","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/2sB3dWsnKm"}