{ "item": [ { "name": "verifications", "description": "", "item": [ { "name": "{verification}", "description": "", "item": [ { "name": "media", "description": "", "item": [ { "id": "44c0bb4a-43cb-4c1a-9d22-ef44f8e3285a", "name": "Upload media", "request": { "name": "Upload media", "description": { "content": "Uploads a selfie or document image to the verification session.\nConsent must be accepted before uploading. The file is validated\nfor quality (face detection, blur, brightness for selfies;\ndocument detection, readability for documents).", "type": "text/plain" }, "url": { "path": [ "verifications", ":verification", "media" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "verification", "disabled": false, "description": { "content": "(Required) The verification ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"type\": \"document\",\n \"side\": \"front\",\n \"document\": \"id\",\n \"fingerprint\": \"\",\n \"head_turn_step\": \"\",\n \"capture_resolution\": \"\",\n \"device_info\": \"\",\n \"liveness_telemetry\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2de54113-ec9b-4ab5-87e6-f3d73c4eb5a1", "originalRequest": { "url": { "path": [ "verifications", ":verification", "media" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"type\": \"document\",\n \"side\": \"front\",\n \"document\": \"id\",\n \"fingerprint\": \"\",\n \"head_turn_step\": \"\",\n \"capture_resolution\": \"\",\n \"device_info\": \"\",\n \"liveness_telemetry\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5f6f833-cdb3-4502-b742-b176efa6c3c3", "name": "Not found", "originalRequest": { "url": { "path": [ "verifications", ":verification", "media" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"type\": \"document\",\n \"side\": \"front\",\n \"document\": \"id\",\n \"fingerprint\": \"\",\n \"head_turn_step\": \"\",\n \"capture_resolution\": \"\",\n \"device_info\": \"\",\n \"liveness_telemetry\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5bbf7d3-56e7-43a1-804a-7a05bff3e574", "name": "Validation error", "originalRequest": { "url": { "path": [ "verifications", ":verification", "media" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"type\": \"document\",\n \"side\": \"front\",\n \"document\": \"id\",\n \"fingerprint\": \"\",\n \"head_turn_step\": \"\",\n \"capture_resolution\": \"\",\n \"device_info\": \"\",\n \"liveness_telemetry\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"suntf\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "consent", "description": "", "item": [ { "id": "69648999-1259-4d69-9058-64ac08deeffb", "name": "Accept consent", "request": { "name": "Accept consent", "description": { "content": "Records the end-user's acceptance of the data processing consent.\nMust be called before uploading media or submitting the verification.", "type": "text/plain" }, "url": { "path": [ "verifications", ":verification", "consent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "verification", "disabled": false, "description": { "content": "(Required) The verification ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consent_version_id\": \"\",\n \"text_sha256\": \"96053fe7894858b45415c191aaa76a6fe34a9ba50ce931f0651b89c09c631d64\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "003500e1-6720-4cfa-bc4e-d1be01eebb22", "originalRequest": { "url": { "path": [ "verifications", ":verification", "consent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consent_version_id\": \"\",\n \"text_sha256\": \"96053fe7894858b45415c191aaa76a6fe34a9ba50ce931f0651b89c09c631d64\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f298e7d6-435f-4361-9ff8-d62e08be003d", "name": "Not found", "originalRequest": { "url": { "path": [ "verifications", ":verification", "consent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consent_version_id\": \"\",\n \"text_sha256\": \"96053fe7894858b45415c191aaa76a6fe34a9ba50ce931f0651b89c09c631d64\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dc991a3-59dd-4134-9e57-10ce4650db47", "name": "Validation error", "originalRequest": { "url": { "path": [ "verifications", ":verification", "consent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"consent_version_id\": \"\",\n \"text_sha256\": \"96053fe7894858b45415c191aaa76a6fe34a9ba50ce931f0651b89c09c631d64\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"suntf\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "5607b10e-acac-442e-9eec-bb581b11d136", "name": "Get verification status", "request": { "name": "Get verification status", "description": { "content": "Retrieves the current state of a verification session including its status and decision reason.", "type": "text/plain" }, "url": { "path": [ "verifications", ":verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "verification", "disabled": false, "description": { "content": "(Required) The verification ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b0a364bb-2bf5-4310-b8c8-b69a23c06207", "name": "`VerificationResource`", "originalRequest": { "url": { "path": [ "verifications", ":verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c7e4e83-19d1-45a3-8254-600c5764dcce", "name": "Not found", "originalRequest": { "url": { "path": [ "verifications", ":verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81e40598-eb05-4d44-b72f-012163650933", "name": "Validation error", "originalRequest": { "url": { "path": [ "verifications", ":verification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"suntf\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "estimation", "description": "", "item": [ { "id": "41f0b6cd-f53f-4a1f-9ed7-bee20c722e31", "name": "Get verification age estimation result", "request": { "name": "Get verification age estimation result", "description": { "content": "Retrieves sanitized age-threshold and gender estimates for age estimation workspaces.\nThe gender value uses 0 for female and 1 for male.", "type": "text/plain" }, "url": { "path": [ "verifications", ":verification", "estimation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "verification", "disabled": false, "description": { "content": "(Required) The verification ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1f452f3c-7a76-4491-b115-f4d64e40fe80", "name": "Verification age estimation result. Gender value mapping: 0 = female, 1 = male.", "originalRequest": { "url": { "path": [ "verifications", ":verification", "estimation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"verification_id\": \"\",\n \"attempt_id\": \"\",\n \"age_threshold\": {\n \"minimum\": \"\",\n \"passed\": \"\",\n \"confidence\": \"\"\n },\n \"gender\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "261f1e22-528f-4365-95eb-d7e0e901dce7", "name": "Not found", "originalRequest": { "url": { "path": [ "verifications", ":verification", "estimation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2f1e86e-df4b-4571-84a3-25603b886818", "name": "Validation error", "originalRequest": { "url": { "path": [ "verifications", ":verification", "estimation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"suntf\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "document", "description": "", "item": [ { "id": "69997afd-6249-4e96-ab77-951c98c94dea", "name": "Get verification document result", "request": { "name": "Get verification document result", "description": { "content": "Retrieves sanitized document fields and the source media from the most relevant attempt.\nMedia URLs are signed and expire after the configured document result media TTL.", "type": "text/plain" }, "url": { "path": [ "verifications", ":verification", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "verification", "disabled": false, "description": { "content": "(Required) The verification ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9e19a557-f4c6-44fd-9a6d-2a4aee34eb92", "name": "Verification document result.", "originalRequest": { "url": { "path": [ "verifications", ":verification", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"document\": {\n \"fields\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"document_number\": \"\"\n }\n },\n \"media\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"signed_url\": \"\",\n \"expires_at\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"signed_url\": \"\",\n \"expires_at\": \"\"\n }\n ],\n \"meta\": {\n \"attempt_id\": \"\",\n \"signed_url_ttl_seconds\": \"\",\n \"signed_url_expires_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "295238cd-8d3f-4320-8a19-a2c7c9c01375", "name": "Not found", "originalRequest": { "url": { "path": [ "verifications", ":verification", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82613156-939e-41b8-903f-6f7d412ec02d", "name": "Validation error", "originalRequest": { "url": { "path": [ "verifications", ":verification", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"suntf\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "submit", "description": "", "item": [ { "id": "f3513444-bcc5-4c52-af6d-04a2c7c7c7ea", "name": "Submit verification for processing", "request": { "name": "Submit verification for processing", "description": { "content": "Submits the verification for automated processing. All required media must be uploaded first.\nThe verification must be in `started` status with the required media attached.", "type": "text/plain" }, "url": { "path": [ "verifications", ":verification", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "verification", "disabled": false, "description": { "content": "(Required) The verification ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "aa4f95f0-0dc1-4b0b-93b4-9f1ec3946151", "originalRequest": { "url": { "path": [ "verifications", ":verification", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22e5946c-e1ee-4784-a283-151f148cc6cd", "name": "Not found", "originalRequest": { "url": { "path": [ "verifications", ":verification", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da235d79-ffd2-49ac-9819-45504dcc4591", "name": "Validation error", "originalRequest": { "url": { "path": [ "verifications", ":verification", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"suntf\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "blocked-face", "description": "", "item": [ { "id": "5cdbd2f7-1f75-4739-91f6-985b153546a5", "name": "Block a verification face", "request": { "name": "Block a verification face", "description": { "content": "Adds the verification selfie face embedding to the workspace tenant blocklist.\nFuture verification attempts with a matching face will be declined by the AML blocklist step.\nOptional `reason` text is stored with the blocked face and truncated to 1000 characters.", "type": "text/plain" }, "url": { "path": [ "verifications", ":verification", "blocked-face" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "verification", "disabled": false, "description": { "content": "(Required) The verification ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "59f5946e-c4b9-48ae-b0b2-03d1f38f669b", "name": "No content", "originalRequest": { "url": { "path": [ "verifications", ":verification", "blocked-face" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1e26e5fd-a661-4aa3-929e-0200e5e11ff2", "name": "Not found", "originalRequest": { "url": { "path": [ "verifications", ":verification", "blocked-face" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a2ef95d-d420-4cd1-b08f-99758d873813", "name": "Validation error", "originalRequest": { "url": { "path": [ "verifications", ":verification", "blocked-face" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"suntf\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "64ad307c-42ea-4edf-a49d-47e8289808e5", "name": "Create a verification session", "request": { "name": "Create a verification session", "description": { "content": "Creates a new verification session and returns a URL for the end-user to complete verification.\nWhen the X-ProofAge-Client request header is \"native\", the response uses the compact native\nsession format (host, id, session_token, url).", "type": "text/plain" }, "url": { "path": [ "verifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"callback_url\": \"\",\n \"external_id\": \"\",\n \"external_metadata\": [\n \"\",\n \"\"\n ],\n \"metadata\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f7d7cfaa-a096-453e-b36a-ba4be09b944d", "originalRequest": { "url": { "path": [ "verifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"callback_url\": \"\",\n \"external_id\": \"\",\n \"external_metadata\": [\n \"\",\n \"\"\n ],\n \"metadata\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "899fc548-19a0-4b30-9137-0a676851dc3d", "name": "Validation error", "originalRequest": { "url": { "path": [ "verifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fingerprint\": \"\",\n \"callback_url\": \"\",\n \"external_id\": \"\",\n \"external_metadata\": [\n \"\",\n \"\"\n ],\n \"metadata\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"suntf\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "workspace", "description": "", "item": [ { "id": "c98847f9-e02b-4645-a11e-f1d98e5eb15c", "name": "Get workspace configuration", "request": { "name": "Get workspace configuration", "description": { "content": "Returns the workspace settings including flow type, verification mode, and age thresholds.", "type": "text/plain" }, "url": { "path": [ "workspace" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "workspace", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a5a164e9-b636-44a5-8136-42c5da9cb0f2", "name": "`WorkspaceResource`", "originalRequest": { "url": { "path": [ "workspace" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "workspace", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"flow_type\": \"\",\n \"mode\": \"\",\n \"age_mode\": \"\",\n \"age_threshold\": \"\",\n \"verification_type\": \"\",\n \"redirect_url\": \"\",\n \"webhook_url\": \"\",\n \"allow_expired_documents\": \"\",\n \"allow_duplicate_accounts\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "consent", "description": "", "item": [ { "id": "a9c1760d-6dab-40fb-bf98-c7f5eba66485", "name": "Get active consent", "request": { "name": "Get active consent", "description": { "content": "Returns the currently active consent version that must be presented to and accepted by the end-user.", "type": "text/plain" }, "url": { "path": [ "consent" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "workspace", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6242bdaf-7623-40f2-8ae7-5c3cc81ed070", "originalRequest": { "url": { "path": [ "consent" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "workspace", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "X-API-Key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.proofage.com/v1" } ], "info": { "_postman_id": "34f45d70-2010-42cf-a066-82e6f38e49a4", "name": "API Reference", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "ProofAge is an identity verification and age estimation API. Use this API to create verification sessions, upload media (selfies and documents), and receive decisions via webhooks.", "type": "text/plain" } } }