{ "item": [ { "name": "verifications", "description": "", "item": [ { "name": "{verification}", "description": "", "item": [ { "name": "media", "description": "", "item": [ { "id": "64fe8e5c-b7af-498e-acf2-453a063645cc", "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\": \"selfie\",\n \"side\": \"front\",\n \"document\": \"passport\",\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": "d99ef435-b063-4f54-acff-6cb5456ae02b", "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\": \"selfie\",\n \"side\": \"front\",\n \"document\": \"passport\",\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": "8ae5ba78-cb94-4a6c-b2ac-bbd8530c0ad1", "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\": \"selfie\",\n \"side\": \"front\",\n \"document\": \"passport\",\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": "dca43595-fc53-47cb-b4d4-442c346916c8", "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\": \"selfie\",\n \"side\": \"front\",\n \"document\": \"passport\",\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 \"cillum66d\": [\n \"\",\n \"\"\n ],\n \"reprehenderit_a06\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "consent", "description": "", "item": [ { "id": "4526691e-8c33-403b-b9f0-5288f56b94f4", "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\": \"e4d0dc02b122d147a1aea9c82cf9b5d515525fdff90fed7d6ff71f7d3d7e8464\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e8643c58-e54c-4095-9c79-78574a6e8263", "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\": \"e4d0dc02b122d147a1aea9c82cf9b5d515525fdff90fed7d6ff71f7d3d7e8464\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c12141c1-f633-440f-9ef2-1e3cbbbcf8fb", "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\": \"e4d0dc02b122d147a1aea9c82cf9b5d515525fdff90fed7d6ff71f7d3d7e8464\"\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": "8f158483-4aaf-4e5b-9959-c3c558d49522", "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\": \"e4d0dc02b122d147a1aea9c82cf9b5d515525fdff90fed7d6ff71f7d3d7e8464\"\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 \"cillum66d\": [\n \"\",\n \"\"\n ],\n \"reprehenderit_a06\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "2986a862-5ccb-4724-8c57-87e2b91e43cd", "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": "addaf38f-7297-4197-b449-f5ee96bd04a6", "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": "fa964999-5074-4140-8e25-057facd2c154", "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": "5d70a3e4-8712-4c7f-bc03-9da8654ec4bc", "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 \"cillum66d\": [\n \"\",\n \"\"\n ],\n \"reprehenderit_a06\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "estimation", "description": "", "item": [ { "id": "29db21c7-9922-4092-8e95-23ce3dde2382", "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": "d28e9a8b-33b1-42db-b951-d084b3698692", "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\": {\n \"value\": \"\",\n \"confidence\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aebe0ce8-0de2-41a0-a989-c45eed209c1f", "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": "d2478939-ebfd-4553-8c51-a1004e03d788", "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 \"cillum66d\": [\n \"\",\n \"\"\n ],\n \"reprehenderit_a06\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "document", "description": "", "item": [ { "id": "022b0b45-7d8c-4836-b422-51bdebc56865", "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": "1ae8e2f5-8f9f-4748-a76e-e88cb7485197", "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": "81e08bd7-b59a-4b65-a10d-fb510e799ba9", "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": "848b753a-4a2c-43de-8e8e-5c386e76771c", "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 \"cillum66d\": [\n \"\",\n \"\"\n ],\n \"reprehenderit_a06\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "submit", "description": "", "item": [ { "id": "3c39a109-7eec-405b-b55d-6ba8e6f13fec", "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": "5302d185-2d12-4ec5-a062-165928f950f7", "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": "d7f58e95-ae16-4872-9935-2aa0cdcbb33c", "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": "dc3fa202-0919-43cc-9cdd-70d58fa19ea2", "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 \"cillum66d\": [\n \"\",\n \"\"\n ],\n \"reprehenderit_a06\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "blocked-face", "description": "", "item": [ { "id": "a336a4e7-3de6-44c9-80f5-35b3ee614be2", "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": "8330e356-5930-4631-81ed-368c1cd7c4af", "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": "595cb891-021c-4cca-804e-a39125c68ae4", "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": "feb5007c-fc4b-424f-b324-ed8d997802c2", "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 \"cillum66d\": [\n \"\",\n \"\"\n ],\n \"reprehenderit_a06\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "5c73bbae-491a-4522-bd6a-b1f66dc1b7de", "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\": null,\n \"metadata\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a494996b-c4e3-4dec-96f0-3b64c089b787", "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\": null,\n \"metadata\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d787149-128a-4ec0-8ec5-44450665d7b3", "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\": null,\n \"metadata\": [\n \"\",\n \"\"\n ]\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 \"cillum66d\": [\n \"\",\n \"\"\n ],\n \"reprehenderit_a06\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "workspace", "description": "", "item": [ { "id": "a02926e5-421a-4dcb-adfd-b725dd40c56a", "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": "cd64422d-785e-4cd3-aafc-baa7ff785673", "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": "2b9202d6-adb7-4c19-87b4-b5dc7254a4ee", "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": "d7f6737e-f1be-4142-971d-f771864cd5c1", "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": "66638b54-06d3-4c6a-af60-bbd2c4a571f0", "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" } } }