{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"0d501ff6-6614-4917-a89d-7fe91e7516bd","name":"DeepFace API","description":"Welcome to the **DeepFace API**, a secure and developer-friendly facial recognition platform designed for both **real-world identity workflows** and **fun, consumer-facing applications**.\n\nDeepFace provides production-ready AI endpoints for:\n\n- Face verification\n    \n- Facial attribute analysis\n    \n- Look-alike and similarity matching\n    \n\nStartFragment Each slot is corresponding to a dimension value and dimension value is emphasized with colors. Similar to 2D barcodes, vertical dimension stores no information in the illustration.EndFragment\n\n<img src=\"https://content.pstmn.io/98a2e01d-a374-40a7-90a7-f6a737b5a3ec/ZW1iZWRkaW5nLmpwZw==\">\n\n---\n\n## What DeepFace API Can Do\n\nDeepFace allows developers to integrate advanced facial intelligence into their applications with minimal effort.\n\n### Core Capabilities\n\n- **Face Verification**\n    \n    Confirm whether two images belong to the same person (ID vs selfie).\n    \n- **Face Analysis**\n    \n    Extract facial attributes such as age, gender, race, and emotion.\n    \n- **Look-Alike Matching**\n    \n    Compare two faces and return similarity scores with UI-ready feedback.\n    \n\nEach endpoint is optimized for accuracy and safe usage in production environments.\n\n---\n\n## Designed for Real Applications\n\nDeepFace API is suitable for a wide range of use cases:\n\n- Identity verification (KYC, onboarding)\n    \n- Fraud prevention\n    \n- Access control\n    \n- Analytics and personalization\n    \n- Social & entertainment apps\n    \n- Look-alike and celebrity match experiences\n    \n\nWhether you’re building a **serious identity system** or a **viral fun app**, the API adapts to your needs.\n\n---\n\n## How the API Works (High-Level)\n\n1. Your application sends a request with image URLs or base64 images\n    \n2. The API validates inputs and authentication\n    \n3. Images are securely forwarded to internal AI engines\n    \n4. Results are normalized and returned in a developer-friendly format\n    \n5. Billing is applied only when conditions are met (success-based billing)\n    \n\n---\n\n## Authentication Overview\n\nAll DeepFace API endpoints require **API key authentication**.\n\n### How Authentication Works\n\n- Each developer account has one or more API keys\n    \n- The API key must be sent with every request\n    \n- Authentication occurs **before** any processing or billing\n    \n\n### Required Header\n\n``` bash\nX-API-KEY: YOUR_API_KEY\n\n ```\n\nRequests without a valid API key are rejected immediately.\n\n---\n\n## Billing Philosophy\n\nDeepFace uses a **fair and transparent billing model**:\n\n- Face Verification → Charged **only when verification succeeds**\n    \n- Face Analysis → Charged **only on successful analysis**\n    \n- Look-Alike → Charged **only when a verified match is detected**\n    \n\nThis ensures developers are **never billed for failed or invalid requests**.\n\nBilling details are always returned in the response.\n\n---\n\n## Consistent Response Structure\n\nAll endpoints return responses using the same structure:\n\n``` json\n{\n  \"status\": \"success | failed | error\",\n  \"result\": \"endpoint-specific result\",\n  \"message\": \"Human-readable explanation\"\n}\n\n ```\n\nThis consistency makes it easy to:\n\n- Handle responses across multiple endpoints\n    \n- Build reusable client-side logic\n    \n- Display clear messages to users\n    \n\n---\n\n## Error Handling & Safety\n\nCommon error categories include:\n\n- `invalid_input`\n    \n- `invalid_image`\n    \n- `unauthorized`\n    \n- `insufficient_balance`\n    \n- `engine_unavailable`\n    \n\nEach endpoint documents its possible errors in detail.\n\n---\n\n## Using Postman (Recommended)\n\nDeepFace API is fully compatible with **Postman** and similar API testing tools.\n\n### Why Use Postman?\n\n- Test endpoints quickly\n    \n- Inspect responses easily\n    \n- Save collections for team use\n    \n- Auto-generate example requests\n    \n\n### Getting Started with Postman\n\n1. Create a new request\n    \n2. Set method to `POST`\n    \n3. X-API-KEY: YOUR_API_KEY\n    \n4. Content-Type: application/json\n    \n5. Paste the endpoint URL\n    \n6. Send a JSON body\n    \n7. Click **Send**\n    \n\nYou’ll immediately see the response from the API.\n\n---\n\n## Auto-Generated Requests & Examples\n\nAll examples in this documentation:\n\n- Are compatible with Postman\n    \n- Can be copied directly into Postman or cURL\n    \n- Use real request/response formats\n    \n\nThis makes onboarding fast and beginner-friendly.\n\n---\n\n## Try-It Experience (Documentation UI)\n\nThe documentation interface supports:\n\n- Live request testing\n    \n- Copy-paste examples\n    \n- Endpoint-specific payload templates\n    \n- Real response previews\n    \n\nDevelopers can test APIs **without writing code**.\n\n---\n\n## Security & Privacy\n\nDeepFace follows strict security principles:\n\n- Images are processed transiently\n    \n- No images are stored unless explicitly required\n    \n- API keys are never exposed\n    \n- Internal AI engines are fully isolated\n    \n\nThis makes DeepFace suitable for **sensitive identity workflows**.\n\n---\n\n## Getting Your API Key\n\nTo start using the API:\n\n1. Sign in to your [dashboard](https://dashboard.deepface.sbs)\n    \n2. Generate an [API key](https://dashboard.deepface.sbs/apikeys)\n    \n3. Copy the key into your request headers\n    \n\n👉 API Keys dashboard:\n\n``` bash\nhttps://dashboard.deepface.sbs/apikeys\n\n ```\n\n---\n\n## Next Steps\n\nOnce you understand the basics, explore the individual endpoint documentation:\n\n- [ID Verification](#add48f78-1eeb-499a-afc7-2bf83f8991a6)\n    \n- [Face Analysis](#ded7235f-e2c6-4d3c-aa1b-304a74ffb378)\n    \n- [Look-Alike Matching](#00640a01-7b42-4082-a728-c2b6ea786457)\n    \n\nEach page includes:\n\n- Detailed explanations\n    \n- Request/response examples\n    \n- Error tables\n    \n- Billing rules\n    \n\n---\n\n## Developer Tip\n\nStart with Postman first.\n\nOnce your request works in Postman, integration into your app is straightforward.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"50946334","team":12296410,"collectionId":"0d501ff6-6614-4917-a89d-7fe91e7516bd","publishedId":"2sB3dWqm49","public":true,"publicUrl":"https://documenter-api.postman.tech/view/50946334/2sB3dWqm49","privateUrl":"https://go.postman.co/documentation/50946334-0d501ff6-6614-4917-a89d-7fe91e7516bd","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"7d5deb"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"DeepFace API documentation for secure face verification, identity checks, and facial similarity matching. Includes authentication with X-API-KEY, request and response examples, billing rules, and error handling for developers.\n"},{"name":"title","value":"DeepFace Face Verification API – Secure Identity &amp; Facial Matching Docs"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/d2def4ef-bb26-4197-bb57-8b706304d19b/T3JkZXIgTm93IS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"7d5deb"}},{"name":"light","logo":"https://content.pstmn.io/2503e50e-c362-4ea5-8623-eaa2c62707f0/T3JkZXIgTm93IS5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"7d5deb"}}]}},"version":"8.10.0","publishDate":"2025-12-20T14:22:54.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"DeepFace Face Verification API – Secure Identity &amp; Facial Matching Docs","description":"DeepFace API documentation for secure face verification, identity checks, and facial similarity matching. Includes authentication with X-API-KEY, request and response examples, billing rules, and error handling for developers.\n"},"logos":{"logoLight":"https://content.pstmn.io/2503e50e-c362-4ea5-8623-eaa2c62707f0/T3JkZXIgTm93IS5wbmc=","logoDark":"https://content.pstmn.io/d2def4ef-bb26-4197-bb57-8b706304d19b/T3JkZXIgTm93IS5wbmc="}},"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/d72600e5146003d7ef892daadbb6f353d1fb49b3bd8b89f75cdbfad5a849fb95","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/2sB3dWqm49"}