This is the REST API documentation of Go Saffe, providing you with resources for end-user CRUD as well as some features that you can access programmatically instead of using our console at https://go.saffe.ai.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2124150","collectionId":"7f63dc0e-513f-42a5-b142-2e796f7bbffc","publishedId":"2s9YJgULsh","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00ABAB"},"publishDate":"2023-11-20T14:43:40.000Z"},"item":[{"name":"User","item":[{"name":"User registration","id":"624782b7-ead4-44f0-a3c9-390e895addea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{restapi_key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users","urlObject":{"path":["v0","users"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"5034a3c9-b78b-4867-bce8-a404b12b0b17","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Mon, 09 Oct 2023 02:00:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"user_registered\",\n \"message\": \"User registered.\"\n}"},{"id":"3e365340-8892-4c4e-9241-b7724bd5fca9","name":"Missing API key","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","value":null}]},"url":"{{server}}/v0/users"},"status":"UNAUTHORIZED","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Mon, 09 Oct 2023 01:40:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"missing_api_key\",\n \"message\": \"Missing API key.\"\n}"},{"id":"2418887d-8620-436f-bf5a-25c80839fdc2","name":"Invalid API key","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","value":null}]},"url":"{{server}}/v0/users"},"status":"UNAUTHORIZED","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Mon, 09 Oct 2023 01:42:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invalid_api_key\",\n \"message\": \"Invalid API key.\"\n}"},{"id":"f800e716-be9a-485e-bd40-ba75f3ddd230","name":"Missing parameter","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","value":null}]},"url":"{{server}}/v0/users"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Mon, 09 Oct 2023 01:49:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"78"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"missing_parameter\",\n \"message\": \"Missing required parameter.\"\n}"},{"id":"26dabb85-7549-4ed0-84d7-6440aa1018b7","name":"User exists","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Mon, 09 Oct 2023 02:00:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"user_exists\",\n \"message\": \"User already exists.\"\n}"},{"id":"a4a678b1-247a-4666-8929-3056af661b80","name":"Problem in image","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Mon, 09 Oct 2023 02:03:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"90"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"problem_image\",\n \"message\": \"Could not detect a face. Try another image.\"\n}"},{"id":"bd850454-1e28-4439-8b25-14555243f179","name":"Invalid image","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Thu, 16 Nov 2023 17:21:56 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"61"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"problem_image\",\n \"message\": \"Invalid image.\"\n}"},{"id":"3aeb2d83-7447-4154-b11e-d15123322fac","name":"Invalid user identifier","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Thu, 16 Nov 2023 18:41:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"122"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invalid_user_identifier\",\n \"message\": \"User identifier should be in e-mail (or Brazilian Tax ID) format.\"\n}"},{"id":"21239218-1fd0-4467-993a-4e718b4f76ef","name":"General problem","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Thu, 16 Nov 2023 18:47:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"123"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"general_problem\",\n \"message\": \"Problem trying to process request. Try again or contact Saffe for support.\"\n}"}],"_postman_id":"624782b7-ead4-44f0-a3c9-390e895addea"},{"name":"Query user","id":"86877782-7098-47e4-b6d0-62bdf97af8aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{restapi_key}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{server}}/v0/users?user_identifier={{user_identifier}}","urlObject":{"path":["v0","users"],"host":["{{server}}"],"query":[{"key":"user_identifier","value":"{{user_identifier}}"}],"variable":[]}},"response":[{"id":"0a1fa7b1-75d9-4404-8ba3-39cf08340eea","name":"Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{server}}/v0/users?user_identifier={{user_identifier}}","host":["{{server}}"],"path":["v0","users"],"query":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Thu, 16 Nov 2023 18:33:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"user_registered\",\n \"message\": \"User registered.\"\n}"},{"id":"6becf35b-1442-4c77-b5cb-9c4abc261806","name":"Missing API key","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{server}}/v0/users?user_identifier={{user_identifier}}","host":["{{server}}"],"path":["v0","users"],"query":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"}]}},"status":"UNAUTHORIZED","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Mon, 09 Oct 2023 01:40:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"missing_api_key\",\n \"message\": \"Missing API key.\"\n}"},{"id":"a16015f1-34fc-49c7-b1da-e365ade33613","name":"Invalid API key","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{server}}/v0/users?user_identifier={{user_identifier}}","host":["{{server}}"],"path":["v0","users"],"query":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"}]}},"status":"UNAUTHORIZED","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Mon, 09 Oct 2023 01:42:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invalid_api_key\",\n \"message\": \"Invalid API key.\"\n}"},{"id":"241f73cd-3c92-4120-94d2-4bdb026f98fe","name":"Missing parameter","originalRequest":{"method":"GET","header":[],"url":"{{server}}/v0/users"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Mon, 09 Oct 2023 01:49:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"78"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"missing_parameter\",\n \"message\": \"Missing required parameter.\"\n}"},{"id":"cf8ccb59-742f-4e22-b9cb-fd89f662a97d","name":"User not found","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{server}}/v0/users?user_identifier={{user_identifier}}","host":["{{server}}"],"path":["v0","users"],"query":[{"key":"user_identifier","value":"{{user_identifier}}"}]}},"status":"NOT FOUND","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Thu, 16 Nov 2023 18:31:02 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"not_found\",\n \"message\": \"User not found.\"\n}"},{"id":"91f193e0-4b84-4e1f-80c6-4a0678974510","name":"Invalid user identifier","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{server}}/v0/users?user_identifier={{user_identifier}}","host":["{{server}}"],"path":["v0","users"],"query":[{"key":"user_identifier","value":"{{user_identifier}}"}]}},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Thu, 16 Nov 2023 18:40:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"122"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invalid_user_identifier\",\n \"message\": \"User identifier should be in e-mail (or Brazilian Tax ID) format.\"\n}"},{"id":"3653f426-012d-4b00-9c20-f1a223db7ae5","name":"General problem","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{server}}/v0/users?user_identifier={{user_identifier}}","host":["{{server}}"],"path":["v0","users"],"query":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"}]}},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Thu, 16 Nov 2023 18:46:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"123"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"general_problem\",\n \"message\": \"Problem trying to process request. Try again or contact Saffe for support.\"\n}"}],"_postman_id":"86877782-7098-47e4-b6d0-62bdf97af8aa"},{"name":"Delete user","id":"694793bc-d8ac-4f51-9375-925bd7c4da44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{restapi_key}}"}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"}]},"url":"{{server}}/v0/users","urlObject":{"path":["v0","users"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"8d9f8c1b-11dc-4747-8d83-fd7ee4896cc7","name":"Success","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"}]},"url":"{{server}}/v0/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.12"},{"key":"Date","value":"Wed, 18 Dec 2024 18:29:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"user_deleted\",\n \"message\": \"User deleted.\"\n}"},{"id":"79d9d151-6cdb-4fbc-882a-bb9f45db9e3c","name":"Missing API key","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"}]},"url":"{{server}}/v0/users"},"status":"UNAUTHORIZED","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Mon, 09 Oct 2023 01:40:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"missing_api_key\",\n \"message\": \"Missing API key.\"\n}"},{"id":"c0fa4c67-1007-4e00-8b5f-3a6519b674ad","name":"Invalid API key","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"}]},"url":"{{server}}/v0/users"},"status":"UNAUTHORIZED","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Mon, 09 Oct 2023 01:42:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invalid_api_key\",\n \"message\": \"Invalid API key.\"\n}"},{"id":"5b996e68-9435-4cf3-9320-0b7dd9a761a7","name":"Missing parameter","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"}]},"url":"{{server}}/v0/users"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Mon, 09 Oct 2023 01:49:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"78"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"missing_parameter\",\n \"message\": \"Missing required parameter.\"\n}"},{"id":"cc3dca09-961e-433d-84d3-0c945502ed77","name":"User not found","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"}]},"url":"{{server}}/v0/users"},"status":"NOT FOUND","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Thu, 16 Nov 2023 18:31:02 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"not_found\",\n \"message\": \"User not found.\"\n}"},{"id":"97b122f2-aaf2-452b-b0bd-78e05e085ad7","name":"Invalid user identifier","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"}]},"url":"{{server}}/v0/users"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Thu, 16 Nov 2023 18:40:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"122"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invalid_user_identifier\",\n \"message\": \"User identifier should be in e-mail (or Brazilian Tax ID) format.\"\n}"},{"id":"27524cfc-1006-4da5-a120-d64c6c46ef34","name":"General problem","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"}]},"url":"{{server}}/v0/users"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Thu, 16 Nov 2023 18:46:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"123"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"general_problem\",\n \"message\": \"Problem trying to process request. Try again or contact Saffe for support.\"\n}"}],"_postman_id":"694793bc-d8ac-4f51-9375-925bd7c4da44"}],"id":"1e249d4b-2e7d-4cf4-a287-e096bb3542dd","_postman_id":"1e249d4b-2e7d-4cf4-a287-e096bb3542dd","description":""},{"name":"Company","item":[{"name":"Query user company","id":"232fa768-6112-4c24-8e06-27509d5593c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{restapi_key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{server}}/v0/users/companies?user_identifier={{user_identifier}}&company_identifier={{company_identifier}}","description":"This endpoint retrieves information about Brazilian companies as well as user relationships with such companies.
\nThe response is in JSON format and follows the schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"code\": {\"type\": \"string\"},\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"activities\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"activity\": {\"type\": \"string\"},\n \"code\": {\"type\": \"string\"},\n \"is_main\": {\"type\": \"boolean\"}\n }\n }\n },\n \"country\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"registration_date\": {\"type\": \"string\"},\n \"status\": {\"type\": \"string\"},\n \"status_date\": {\"type\": \"string\"},\n \"tax_id\": {\"type\": \"string\"},\n \"tax_regime\": {\"type\": \"string\"},\n \"user_relationships\": {\n \"type\": \"object\",\n \"properties\": {\n \"code\": {\"type\": \"string\"},\n \"detail\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"last_update\": {\"type\": \"string\"},\n \"name\": {\"type\": \"string\"},\n \"type\": {\"type\": \"string\"}\n }\n }\n },\n \"message\": {\"type\": \"string\"}\n }\n }\n }\n },\n \"message\": {\"type\": \"string\"},\n \"transaction_id\": {\"type\": \"string\"}\n }\n}\n\nThe identifier of the user in Brazilian Tax ID format.
\n","type":"text/plain"},"key":"user_identifier","value":"{{user_identifier}}"},{"description":{"content":"The identifier of the company in Brazilian Tax ID format.
\n","type":"text/plain"},"key":"company_identifier","value":"{{company_identifier}}"}],"variable":[]}},"response":[{"id":"63956abc-2ec8-4adc-83f3-82ac865f7584","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{server}}/v0/users/companies?user_identifier={{user_identifier}}&company_identifier={{company_identifier}}","host":["{{server}}"],"path":["v0","users","companies"],"query":[{"key":"user_identifier","value":"{{user_identifier}}","description":"The identifier of the user in Brazilian Tax ID format."},{"key":"company_identifier","value":"{{company_identifier}}","description":"The identifier of the company in Brazilian Tax ID format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 03 May 2025 02:19:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"986"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"company_found\",\n \"data\": {\n \"activities\": [\n {\n \"activity\": \"CONSULTORIA EM TECNOLOGIA DA INFORMACAO\",\n \"code\": \"6204000\",\n \"is_main\": true\n },\n {\n \"activity\": \"DESENVOLVIMENTO DE PROGRAMAS DE COMPUTADOR SOB ENCOMENDA\",\n \"code\": \"6201501\",\n \"is_main\": false\n }\n ],\n \"country\": \"Brazil\",\n \"name\": \"COMPANY NAME LTDA\",\n \"registration_date\": \"2017-12-19T00:00:00+00:00\",\n \"status\": \"ATIVA\",\n \"status_date\": \"2025-04-19T00:00:00+00:00\",\n \"tax_id\": \"29******000182\",\n \"tax_regime\": \"LUCRO REAL\",\n \"user_relationships\": {\n \"code\": \"relationship_found\",\n \"detail\": [\n {\n \"last_update\": \"2025-04-19T00:00:00+00:00\",\n \"name\": \"SOCIO\",\n \"type\": \"QSA\"\n }\n ],\n \"message\": \"Company relationship found.\"\n }\n },\n \"message\": \"Company found.\",\n \"transaction_id\": \"eb7f4e68-5851-4ec2-af4a-4aa908b31790\"\n}"},{"id":"1a9514c3-6286-4b13-a39e-6ce30a2f84a9","name":"Missing parameter","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{server}}/v0/users/companies?company_identifier={{company_identifier}}","host":["{{server}}"],"path":["v0","users","companies"],"query":[{"key":"user_identifier","value":"{{user_identifier}}","description":"The identifier of the user in Brazilian Tax ID format.","disabled":true},{"key":"company_identifier","value":"{{company_identifier}}","description":"The identifier of the company in Brazilian Tax ID format."}]}},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 03 May 2025 02:24:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"78"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"missing_parameter\",\n \"message\": \"Missing required parameter.\"\n}"},{"id":"aa513691-3280-42fd-9240-5fe58e2fe992","name":"Missing API key","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{server}}/v0/users/companies?user_identifier={{user_identifier}}&company_identifier={{company_identifier}}","host":["{{server}}"],"path":["v0","users","companies"],"query":[{"key":"user_identifier","value":"{{user_identifier}}","description":"The identifier of the user in Brazilian Tax ID format."},{"key":"company_identifier","value":"{{company_identifier}}","description":"The identifier of the company in Brazilian Tax ID format."}]}},"status":"UNAUTHORIZED","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 03 May 2025 02:25:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"missing_api_key\",\n \"message\": \"Missing API key.\"\n}"},{"id":"749632c8-88c5-421d-8175-14840c68faf8","name":"Invalid API key","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{server}}/v0/users/companies?user_identifier={{user_identifier}}&company_identifier={{company_identifier}}","host":["{{server}}"],"path":["v0","users","companies"],"query":[{"key":"user_identifier","value":"{{user_identifier}}","description":"The identifier of the user in Brazilian Tax ID format."},{"key":"company_identifier","value":"{{company_identifier}}","description":"The identifier of the company in Brazilian Tax ID format."}]}},"status":"UNAUTHORIZED","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 03 May 2025 02:26:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invalid_api_key\",\n \"message\": \"Invalid API key.\"\n}"},{"id":"2ac2a7c9-f633-4212-91fe-a0bcaa0bbe0b","name":"Invalid user identifier","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{server}}/v0/users/companies?user_identifier={{user_identifier}}&company_identifier={{company_identifier}}","host":["{{server}}"],"path":["v0","users","companies"],"query":[{"key":"user_identifier","value":"{{user_identifier}}","description":"The identifier of the user in Brazilian Tax ID format."},{"key":"company_identifier","value":"{{company_identifier}}","description":"The identifier of the company in Brazilian Tax ID format."}]}},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 03 May 2025 02:27:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"110"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invalid_user_identifier\",\n \"message\": \"User identifier should be in Brazilian Tax ID format.\"\n}"},{"id":"4bc06c3d-c42f-43cc-b25a-ec51dbd44e42","name":"Invalid company identifier","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{server}}/v0/users/companies?user_identifier={{user_identifier}}&company_identifier={{company_identifier}}","host":["{{server}}"],"path":["v0","users","companies"],"query":[{"key":"user_identifier","value":"{{user_identifier}}","description":"The identifier of the user in Brazilian Tax ID format."},{"key":"company_identifier","value":"{{company_identifier}}","description":"The identifier of the company in Brazilian Tax ID format."}]}},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 03 May 2025 02:28:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invalid_company_identifier\",\n \"message\": \"Company identifer should be in Brazilian Tax ID format.\"\n}"},{"id":"6a765af7-b127-4781-acc6-d21e814fb6cb","name":"General problem","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{server}}/v0/users/companies?user_identifier={{user_identifier}}&company_identifier={{company_identifier}}","host":["{{server}}"],"path":["v0","users","companies"],"query":[{"key":"user_identifier","value":"{{user_identifier}}","description":"The identifier of the user in Brazilian Tax ID format."},{"key":"company_identifier","value":"{{company_identifier}}","description":"The identifier of the company in Brazilian Tax ID format."}]}},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 03 May 2025 02:31:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"general_problem\",\n \"message\": \"Problem trying to process request. Try again or contact Saffe for support.\"\n}"}],"_postman_id":"232fa768-6112-4c24-8e06-27509d5593c6"}],"id":"b1ecb3f9-9214-4010-a3c1-a8acf7fc9294","_postman_id":"b1ecb3f9-9214-4010-a3c1-a8acf7fc9294","description":""},{"name":"Face Match","item":[{"name":"User match","id":"4e19ab71-d1c2-4fd4-ac84-1ebdc1b540c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{restapi_key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/matches","description":"This endpoint is used for matching a query face image to users previously registered either through a capture session or through the user registration API endpoint.
\n","urlObject":{"path":["v0","users","matches"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"c43cf49b-8f65-437c-8ee4-f71d11b11d70","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/matches"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 16 May 2025 21:34:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"234"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"matched\",\n \"face_match\": {\n \"match_with\": \"onboarding\",\n \"score\": 0.8,\n \"status\": \"matched\",\n \"threshold\": 0.75\n },\n \"message\": \"User matched.\",\n \"transaction_id\": \"d49c2ef2-153a-44b0-9b72-c6f34b8ad182\"\n}"},{"id":"cf8fecc9-25e7-4d48-818a-0ac6b47d91e4","name":"Missing API key","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/matches"},"status":"UNAUTHORIZED","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 May 2025 13:08:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"missing_api_key\",\n \"message\": \"Missing API key.\"\n}"},{"id":"a5ce9053-c076-4130-8e34-f3a342dd126b","name":"Invalid API key","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/matches"},"status":"UNAUTHORIZED","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 May 2025 13:11:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invalid_api_key\",\n \"message\": \"Invalid API key.\"\n}"},{"id":"51355e7f-4d33-437a-bc10-7d4033a53879","name":"Missing parameter","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text","disabled":true},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/matches"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 May 2025 13:11:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"78"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"missing_parameter\",\n \"message\": \"Missing required parameter.\"\n}"},{"id":"eef20956-302f-4bbb-aeda-939521f7fe41","name":"User not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/matches"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 May 2025 13:12:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"126"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"not_available\",\n \"message\": \"User not available.\",\n \"transaction_id\": \"6b4335c1-eef1-402b-a79f-5de5d43bd786\"\n}"},{"id":"0abb99aa-c162-45a5-bbec-12724e104fdc","name":"Problem in image","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/matches"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 May 2025 13:18:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"150"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"problem_image\",\n \"message\": \"Could not detect a face. Try another image.\",\n \"transaction_id\": \"679ec063-001c-4bee-81e5-63fd99a94fac\"\n}"},{"id":"04556b14-0545-4df3-a186-249ae4ef5fec","name":"Invalid image","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/matches"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 May 2025 13:12:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"121"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"problem_image\",\n \"message\": \"Invalid image.\",\n \"transaction_id\": \"1e75e407-8e7b-46d6-b033-8d9f111aad28\"\n}"},{"id":"17a9d734-51b5-463f-b21f-93ab5baa4e5c","name":"Invalid user identifier","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/matches"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 May 2025 13:19:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"122"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invalid_user_identifier\",\n \"message\": \"User identifier should be in e-mail (or Brazilian Tax ID) format.\"\n}"},{"id":"69be38f8-5cd5-48df-a045-a2e499ea2986","name":"General problem","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/matches"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Thu, 16 Nov 2023 18:47:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"123"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"general_problem\",\n \"message\": \"Problem trying to process request. Try again or contact Saffe for support.\"\n}"}],"_postman_id":"4e19ab71-d1c2-4fd4-ac84-1ebdc1b540c5"},{"name":"ID match","id":"a2f8eb86-5b11-4e74-a7f2-ed181e39ecca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{restapi_key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/id_matches","description":"This endpoint is used for matching an ID picture containing a query face image to users previously registered either through a capture session or through the user registration API endpoint.
\nIt handles ID pictures in all orientations and do not require cropping the face area.
\n","urlObject":{"path":["v0","users","id_matches"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"a3c10327-6a78-4fce-bbd9-10d202ece3ce","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/id_matches"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 16 May 2025 21:34:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"234"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"matched\",\n \"face_match\": {\n \"match_with\": \"onboarding\",\n \"score\": 0.8,\n \"status\": \"matched\",\n \"threshold\": 0.75\n },\n \"message\": \"User matched.\",\n \"transaction_id\": \"d49c2ef2-153a-44b0-9b72-c6f34b8ad182\"\n}"},{"id":"1cb1e0cd-d93c-43c9-8119-93cdd18eca2b","name":"Missing API key","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/id_matches"},"status":"UNAUTHORIZED","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 May 2025 13:08:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"missing_api_key\",\n \"message\": \"Missing API key.\"\n}"},{"id":"0ea42522-73f3-49c7-8b58-e0242b578ce7","name":"Invalid API key","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/id_matches"},"status":"UNAUTHORIZED","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 May 2025 13:11:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invalid_api_key\",\n \"message\": \"Invalid API key.\"\n}"},{"id":"b2676c33-ad95-48b1-91af-4df575ee8cae","name":"Missing parameter","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text","disabled":true},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/id_matches"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 May 2025 13:11:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"78"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"missing_parameter\",\n \"message\": \"Missing required parameter.\"\n}"},{"id":"5612b9d2-b291-4f6b-9204-8dd77922f660","name":"User not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/id_matches"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 May 2025 13:12:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"126"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"not_available\",\n \"message\": \"User not available.\",\n \"transaction_id\": \"6b4335c1-eef1-402b-a79f-5de5d43bd786\"\n}"},{"id":"7211f8bf-c499-400b-8995-e132d2d12a47","name":"Problem in image","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/id_matches"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 May 2025 13:18:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"150"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"problem_image\",\n \"message\": \"Could not detect a face. Try another image.\",\n \"transaction_id\": \"679ec063-001c-4bee-81e5-63fd99a94fac\"\n}"},{"id":"8e5b4b0f-1d43-426f-a6b4-9942e6922aca","name":"Invalid image","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/id_matches"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 May 2025 13:12:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"121"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"problem_image\",\n \"message\": \"Invalid image.\",\n \"transaction_id\": \"1e75e407-8e7b-46d6-b033-8d9f111aad28\"\n}"},{"id":"9fe778de-c552-4f4d-ba3a-dd6b48e735bf","name":"Invalid user identifier","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/id_matches"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 May 2025 13:19:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"122"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invalid_user_identifier\",\n \"message\": \"User identifier should be in e-mail (or Brazilian Tax ID) format.\"\n}"},{"id":"bafc7dd8-f5d9-46a4-b566-72f5b025bfc1","name":"General problem","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user_identifier","value":"{{user_identifier}}","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","value":null}]},"url":"{{server}}/v0/users/id_matches"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.7"},{"key":"Date","value":"Thu, 16 Nov 2023 18:47:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"123"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"general_problem\",\n \"message\": \"Problem trying to process request. Try again or contact Saffe for support.\"\n}"}],"_postman_id":"a2f8eb86-5b11-4e74-a7f2-ed181e39ecca"}],"id":"fc26e252-c58d-4c38-8f48-7fe958b142a9","_postman_id":"fc26e252-c58d-4c38-8f48-7fe958b142a9","description":""},{"name":"Capture","item":[{"name":"Create capture","id":"d6986bf8-d3a9-455e-81ef-62dc2cdb3799","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"capture_key\": \"{{capture_key}}\",\n \"user_identifier\": \"{{user_identifier}}\",\n \"type\": \"{{transaction_type}}\",\n \"end_to_end_id\": \"{{end_to_end_id}}\",\n \"return_type\": \"capture_url\",\n \"settings\": {\n \"primary_color\": \"#00ABAB\",\n \"secondary_color\": \"#6A6A6A\",\n \"lang\": \"en\"\n },\n \"send_results_to\": {\n \"media\": \"email\",\n \"email\": \"valid_email@domain.com\"\n },\n \"send_capture_to\": {\n \"media\": \"whatsapp\",\n \"contact_name\": \"John Doe\",\n \"company_name\": \"Saffe AI\",\n \"phone_number\": \"5511999123456\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/v0/capture","description":"This endpoint is meant to create a capture session.
\nRequired parameters are the same as presented in the integration documentation.
\nreturn_type: If the optional parameter return_type is omitted, the capture journey is rendered directly from the response of the request. However, if the parameter return_type is set to \"capture_url\", then an ephemeral capture token is generated and both the URL to render the capture session as well as a QR code pointing to it are returned in JSON format.
settings: Please see details in integration options.
\nsend_results_to: This parameter is meant to send the transaction results to different types of media, but at the moment only the \"email\" media is available. Even though the default way of delivering transaction results is through webhooks, this can be considered as an additional destination of the transaction results; or an alternative, if the webhook URL is not set.
send_capture_to: This parameter is meant to send the capture request to different types of media, but at the moment only the \"whatsapp\" media is available. The end user will get a message from Go Saffe WhatsApp business account, asking for the capture, and will be greeted upon completion of the capture journey. The destination of the transaction results are not affected by this parameter.
Optional parameters can be used interchangeably.
\n","urlObject":{"path":["v0","capture"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"5ea3b1b0-9933-485a-b187-5fd868c8fbd4","name":"Render directly","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"capture_key\": \"{{capture_key}}\",\n \"user_identifier\": \"{{user_identifier}}\",\n \"type\": \"{{transaction_type}}\",\n \"end_to_end_id\": \"{{end_to_end_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/v0/capture"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 01 Apr 2024 00:49:23 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"581"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.12"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"\n\n \n \nThis endpoint is meant to redeem a capture token through rendering in the response its corresponding capture session.
\n","urlObject":{"path":["v0","capture"],"host":["{{server}}"],"query":[{"key":"token","value":"{{capture_token}}"}],"variable":[]}},"response":[{"id":"5d296c4e-e449-4956-9009-1cdf69001284","name":"Render successfully","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{server}}/v0/capture?token={{capture_token}}","host":["{{server}}"],"path":["v0","capture"],"query":[{"key":"token","value":"{{capture_token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 01 Apr 2024 02:22:25 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"570"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.12"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"\n\n \n \nThis endpoint retrieves the details of a specific transaction based on the provided transaction ID.
\nThe transaction_id parameter can be either:
The end_to_end_id that you informed at the initialization of a capture session or;
The transaction_id informed by us when delivering the results of a transaction.
Please refer to the webhook documentation for a detailed explanation of the return. The only difference is that through this REST API, no personal information (e.g. user identifier or face image) will be returned because we do not store such personal information after we deliver it.
\n","urlObject":{"path":["v0","transactions","{{transaction_id}}"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"e7251703-a4c2-4de3-9870-8a9d547901d5","name":"Success","originalRequest":{"method":"GET","header":[],"url":"{{server}}/v0/transactions/{{transaction_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.12"},{"key":"Date","value":"Wed, 18 Dec 2024 10:37:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1206"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"transaction_found\",\n \"data\": {\n \"capture\": {\n \"information\": {\n \"browser\": \"Chrome,131.0.0\",\n \"device\": \"Mac\",\n \"geolocation\": {\n \"city\": \"London\",\n \"country\": \"United Kingdom\",\n \"latitude\": 51.5074,\n \"longitude\": 0.1272\n },\n \"number_attempts\": 2,\n \"os\": \"Mac OS X\"\n },\n \"status\": \"healthy\"\n },\n \"date\": \"2024-12-18T10:37:28+00:00\",\n \"end2end_id\": \"end2end_id\",\n \"environment\": \"sandbox\",\n \"image\": {\n \"md5\": \"aa2b3fce571bc877adc8330b89d3d247\"\n },\n \"risk_level\": \"low\",\n \"scores\": {\n \"face_match\": {\n \"match_with\": \"onboarding\",\n \"score\": 0.8,\n \"status\": \"matched\",\n \"threshold\": 0.75\n },\n \"liveness\": {\n \"score\": 0.8,\n \"status\": \"live_person\",\n \"threshold\": 0.75\n }\n },\n \"transaction_id\": \"bc948083-3bd3-43d6-ac47-6faf9e48edc2\",\n \"type\": \"verification\",\n \"webhook_info\": {\n \"request_time\": 0.354,\n \"response_code\": 200\n }\n },\n \"message\": \"Transaction found.\"\n}"},{"id":"65a71c7d-6f94-41c6-b724-c76ffd62043f","name":"Missing API key","originalRequest":{"method":"GET","header":[],"url":"{{server}}/v0/transactions/{{transaction_id}}"},"status":"UNAUTHORIZED","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.12"},{"key":"Date","value":"Wed, 18 Dec 2024 17:54:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"missing_api_key\",\n \"message\": \"Missing API key.\"\n}"},{"id":"38b9f2e5-872f-48d0-89dd-6f0ea3305cb3","name":"Invalid API key","originalRequest":{"method":"GET","header":[],"url":"{{server}}/v0/transactions/{{transaction_id}}"},"status":"UNAUTHORIZED","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.12"},{"key":"Date","value":"Wed, 18 Dec 2024 17:54:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invalid_api_key\",\n \"message\": \"Invalid API key.\"\n}"},{"id":"80031a6e-f2ee-440e-a405-e46f11620264","name":"Transaction not found","originalRequest":{"method":"GET","header":[],"url":"{{server}}/v0/transactions/{{transaction_id}}"},"status":"NOT FOUND","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.12"},{"key":"Date","value":"Wed, 18 Dec 2024 17:56:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"79"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"transaction_not_found\",\n \"message\": \"Transaction not found.\"\n}"},{"id":"60d9427a-781c-4d31-831a-e07dcfb08305","name":"General problem","originalRequest":{"method":"GET","header":[],"url":"{{server}}/v0/transactions/{{transaction_id}}"},"status":"INTERNAL SERVER ERROR","code":500,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.3 Python/3.10.12"},{"key":"Date","value":"Wed, 18 Dec 2024 18:24:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"123"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"general_problem\",\n \"message\": \"Problem trying to process request. Try again or contact Saffe for support.\"\n}"}],"_postman_id":"46141e59-d5c0-4d28-b57e-86a9451cc720"}],"id":"7f78a6a2-ceb5-460b-9e7a-28d0a5063d50","_postman_id":"7f78a6a2-ceb5-460b-9e7a-28d0a5063d50","description":""}]}