{ "item": [ { "name": "Workspace", "description": "Your workspace's settings and the consent text to show the person.", "item": [ { "id": "cc530282-688b-45c5-8c1e-b6645dd451d2", "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": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a5ce6d98-b82e-4c88-a6ae-04f43ed4a4c1", "name": "`WorkspaceResource`", "originalRequest": { "url": { "path": [ "workspace" ], "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 \"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 } }, { "id": "1c239fdb-a57e-40e8-bc5d-82663e0da8db", "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": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cf7e5f10-0e9a-4cb5-9fd3-7251550addf9", "name": "The active consent version. Show the text at url, then send id and text_sha256 back when accepting.", "originalRequest": { "url": { "path": [ "consent" ], "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 \"id\": \"\",\n \"version\": \"\",\n \"text_sha256\": \"\",\n \"url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Verification", "description": "Create a verification, record consent, submit it and read the result.", "item": [ { "id": "f6e6d8bf-83ca-4ab5-beec-0f1dc943cd99", "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.", "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 \"callback_url\": \"\",\n \"external_id\": \"\",\n \"external_metadata\": null,\n \"metadata\": {\n \"ut_7\": {},\n \"est98\": {},\n \"aliqua1_f\": {},\n \"proident_a8\": {},\n \"ullamco_4\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f6c144de-5474-4d36-90dd-cf5f07b0480e", "name": "The verification session, with the url the person opens to complete it.", "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 \"callback_url\": \"\",\n \"external_id\": \"\",\n \"external_metadata\": null,\n \"metadata\": {\n \"ut_7\": {},\n \"est98\": {},\n \"aliqua1_f\": {},\n \"proident_a8\": {},\n \"ullamco_4\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"external_id\": \"\",\n \"external_metadata\": {\n \"quie\": {}\n },\n \"redirect_url\": \"\",\n \"status\": \"\",\n \"reason\": \"\",\n \"duplicate_check\": {\n \"checked\": \"\",\n \"duplicate_count\": \"\",\n \"duplicates\": [\n {\n \"verification_id\": \"\",\n \"external_id\": \"\",\n \"similarity_score\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"verification_id\": \"\",\n \"external_id\": \"\",\n \"similarity_score\": \"\",\n \"verified_at\": \"\"\n }\n ]\n },\n \"erasure\": {\n \"erased_at\": \"\",\n \"scope\": \"\",\n \"reason\": \"\",\n \"requested_via\": \"\"\n },\n \"consent_accepted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1641381e-e31d-49c9-b433-7370f68f8b35", "name": "A live workspace has no payment method.", "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 \"callback_url\": \"\",\n \"external_id\": \"\",\n \"external_metadata\": null,\n \"metadata\": {\n \"ut_7\": {},\n \"est98\": {},\n \"aliqua1_f\": {},\n \"proident_a8\": {},\n \"ullamco_4\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"free_verifications_remaining\": \"\",\n \"trial_ends_at\": \"\",\n \"trial_active\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d32d2fc-ea93-4a3a-b74a-7d091b895cfe", "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 \"callback_url\": \"\",\n \"external_id\": \"\",\n \"external_metadata\": null,\n \"metadata\": {\n \"ut_7\": {},\n \"est98\": {},\n \"aliqua1_f\": {},\n \"proident_a8\": {},\n \"ullamco_4\": {}\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 \"elit_\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e521fb83-3720-4427-ba57-e9df29b32559", "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\": \"82722220bc11c9baf145e6fd7e526481f731c735943528aec4a0e51cdc9d7d36\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ada57251-b0c0-48b5-9f84-63c162d6641d", "name": "Consent is recorded; media can now be uploaded.", "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\": \"82722220bc11c9baf145e6fd7e526481f731c735943528aec4a0e51cdc9d7d36\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"consent_version_id\": \"\",\n \"consent_accepted_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59fe0578-123c-440c-af6d-fca0e88c216a", "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\": \"82722220bc11c9baf145e6fd7e526481f731c735943528aec4a0e51cdc9d7d36\"\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": "fca17404-93fa-47f1-99f9-e0a2a29daab7", "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\": \"82722220bc11c9baf145e6fd7e526481f731c735943528aec4a0e51cdc9d7d36\"\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 \"elit_\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e6b8b7c-9a9a-4d3f-b5df-239d086fd68c", "name": "Submit verification for processing", "request": { "name": "Submit verification for processing", "description": { "content": "Submits the verification for automated processing once the current attempt's media is uploaded.\nAn upload moves the verification to `started`. A facial age estimation that asked for a document\nis submitted the same way, after the document is uploaded.\n\nAnswers `200` with an empty body; the decision arrives by webhook.", "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": "201d42d1-5c2e-46f4-b5ee-c122f1231b91", "name": "The verification was submitted. The body is empty.", "originalRequest": { "url": { "path": [ "verifications", ":verification", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/html" }, { "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": "text/html" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8927c3bb-a26a-4d52-95ea-464ad89e319c", "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": "0bcfe87b-ba8e-4b20-a039-4e163bcdca16", "name": "The verification is not waiting to be submitted (`INVALID_STATUS`), or required media is missing (`MISSING_REQUIRED_MEDIA`).", "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 \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d56e2f7d-8e67-4ccb-bd52-b9d0efafaccc", "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": "d19688fd-21af-43a5-a381-a3ee00d3983b", "name": "Verification session state.", "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": "{\n \"id\": \"\",\n \"external_id\": \"\",\n \"external_metadata\": {\n \"officiaeb1\": {}\n },\n \"redirect_url\": \"\",\n \"status\": \"\",\n \"reason\": \"\",\n \"duplicate_check\": {\n \"checked\": \"\",\n \"duplicate_count\": \"\",\n \"duplicates\": [\n {\n \"verification_id\": \"\",\n \"external_id\": \"\",\n \"similarity_score\": \"\",\n \"verified_at\": \"\"\n },\n {\n \"verification_id\": \"\",\n \"external_id\": \"\",\n \"similarity_score\": \"\",\n \"verified_at\": \"\"\n }\n ]\n },\n \"erasure\": null,\n \"consent_accepted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8e15517-3382-4080-acbf-6614532caa85", "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": "6855540c-7c5c-4dd6-a35e-ff800a081489", "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 \"elit_\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f41afd8e-cc9c-4e76-9c2b-62212783da1b", "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": "43205441-ffd5-4602-9349-cfb14fb757c9", "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": "5c725991-e2a6-42c0-9857-5e20367a894a", "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": "83efffdd-4a63-461c-bed4-d1c64d33f350", "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 \"elit_\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5e4d091d-1de8-4139-935c-60237cdf5962", "name": "Get verification document result", "request": { "name": "Get verification document result", "description": { "content": "Returns what was read from the identity document of the most relevant attempt,\nnormalised: dates as YYYY-MM-DD, countries as ISO 3166-1 alpha-2 (XK for Kosovo), and null for\nanything the document did not yield or does not print. On identity (KYC)\nworkspaces `fields` carries eleven keys; on age verification workspaces only\n`first_name`, `last_name`, `date_of_birth` and `document_number` are returned.\nEach media item carries a `url` for the download endpoint, or null when the\nmedia has been purged or has passed its retention window.", "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": "db698d0a-3614-4225-a669-5f7ca758ba83", "name": "Verification document result. `type` and `gender` are open enums: handle values not listed here. `gender` is F, M or X, where X means the document states that the sex is unspecified. `other` in `type` is a readable document that is not an identity card, passport, driving licence or residence permit, such as a health insurance card. Countries are ISO 3166-1 alpha-2 (XK for Kosovo). A document that prints only the month or year of expiry reports the last day of that period; a partially printed birth or issue date is null. On a Mexican voter card or driving licence created before 20 August 2026 17:00 UTC, `gender` is null. The German identity card prints no sex, so `gender` is null there. A permanent document (for example `PERMANENTE` or `INDEFINIDA`) reads as a null `expiry_date`. `type` `id` is the same value the upload endpoint takes. `issuing_country` and `nationality` can differ, for example on a residence permit. `issuing_subdivision` is the state or province that issued the document, as a bare code beside `issuing_country` (for example `FL` with `US`), or null; today it is filled for US driving licences and ID cards. `place_of_birth` is the printed text, not normalised. `address` is the printed text as read, not parsed and not normalised, and may contain line breaks.", "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 \"type\": \"id\",\n \"issuing_country\": \"\",\n \"issuing_subdivision\": \"\",\n \"fields\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"date_of_birth\": \"\",\n \"document_number\": \"\",\n \"middle_name\": \"\",\n \"gender\": \"F\",\n \"nationality\": \"\",\n \"place_of_birth\": \"\",\n \"address\": \"\",\n \"issue_date\": \"\",\n \"expiry_date\": \"\"\n }\n },\n \"media\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"url\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"url\": \"\"\n }\n ],\n \"meta\": {\n \"attempt_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc610015-a7ee-419f-bec3-324d3104b37d", "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": "1082f201-7465-4082-9426-d485e5ef1385", "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 \"elit_\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de272771-c24d-48a0-83a9-b6ab20eea004", "name": "Block a verification face", "request": { "name": "Block a verification face", "description": { "content": "Adds the face from this verification's selfie to your blocklist, shared by all your workspaces.\nLater verifications with a matching face are declined.\nOptional `reason` text is stored with the block and truncated to 1000 characters.\n\nOptional `reason_code` classifies the block, and is what reporting counts: one of\n`presentation_attack`, `fraudulent_document`, `scam_or_abuse`, `underage`, `other`.\nSend it whenever a person made the decision \u2014 the admin consoles require it, so a\nblock that arrives without one cannot be told apart from an automated one.", "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_code\": \"scam_or_abuse\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "975fcb04-d8a3-4319-b8a8-69b064db0467", "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_code\": \"scam_or_abuse\",\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f9ef246b-286d-4133-92fe-9de059cbdbfa", "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_code\": \"scam_or_abuse\",\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": "b512d860-82b4-4912-a1a5-cc567f8fc1dd", "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_code\": \"scam_or_abuse\",\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 \"elit_\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Media", "description": "Upload the selfie and document images, and download them later.", "item": [ { "id": "f9dd9fbb-ddbe-45b9-91f0-1d2e4e9deef9", "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).\n\nAnswers `200` with an empty body; a failed quality check answers `422`.", "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": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "(Required) What the file is: the person's selfie, or one side of their document. (This can only be one of selfie,document)", "type": "text/plain" }, "key": "type", "value": "selfie", "type": "text" }, { "description": { "content": "Which side of the document. Required when `type` is `document`. (This can only be one of front,back)", "type": "text/plain" }, "key": "side", "value": "back", "type": "text" }, { "description": { "content": "The kind of document. Required when `type` is `document`. (This can only be one of id,driver_license,passport,residence_permit)", "type": "text/plain" }, "key": "document", "value": "id", "type": "text" } ] }, "auth": null }, "response": [ { "id": "b90f2bed-d7a4-407c-80d6-17c1bd33b40e", "name": "The media was stored. The body is empty.", "originalRequest": { "url": { "path": [ "verifications", ":verification", "media" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "text/html" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "(Required) What the file is: the person's selfie, or one side of their document. (This can only be one of selfie,document)", "type": "text/plain" }, "key": "type", "value": "selfie", "type": "text" }, { "description": { "content": "Which side of the document. Required when `type` is `document`. (This can only be one of front,back)", "type": "text/plain" }, "key": "side", "value": "back", "type": "text" }, { "description": { "content": "The kind of document. Required when `type` is `document`. (This can only be one of id,driver_license,passport,residence_permit)", "type": "text/plain" }, "key": "document", "value": "id", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/html" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ad055892-fafb-4240-8b7a-8bce587fe8ba", "name": "Not found", "originalRequest": { "url": { "path": [ "verifications", ":verification", "media" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "(Required) What the file is: the person's selfie, or one side of their document. (This can only be one of selfie,document)", "type": "text/plain" }, "key": "type", "value": "selfie", "type": "text" }, { "description": { "content": "Which side of the document. Required when `type` is `document`. (This can only be one of front,back)", "type": "text/plain" }, "key": "side", "value": "back", "type": "text" }, { "description": { "content": "The kind of document. Required when `type` is `document`. (This can only be one of id,driver_license,passport,residence_permit)", "type": "text/plain" }, "key": "document", "value": "id", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7687351-7edb-4bfe-a8ff-1d73e5192719", "name": "The image failed a quality check; the code says which.", "originalRequest": { "url": { "path": [ "verifications", ":verification", "media" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "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": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "(Required) What the file is: the person's selfie, or one side of their document. (This can only be one of selfie,document)", "type": "text/plain" }, "key": "type", "value": "selfie", "type": "text" }, { "description": { "content": "Which side of the document. Required when `type` is `document`. (This can only be one of front,back)", "type": "text/plain" }, "key": "side", "value": "back", "type": "text" }, { "description": { "content": "The kind of document. Required when `type` is `document`. (This can only be one of id,driver_license,passport,residence_permit)", "type": "text/plain" }, "key": "document", "value": "id", "type": "text" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ad95eca4-db27-410e-a97a-54b02dfa8156", "name": "Download media", "request": { "name": "Download media", "description": { "content": "Streams the bytes of a selfie or document image belonging to the\nverification, served by ProofAge under the same API key and HMAC\nsignature as every other endpoint.\n\nThe response body is the image itself; `Content-Type` carries its MIME\ntype. Media that has been purged, has passed its retention window, or\ndoes not belong to this verification answers 404.", "type": "text/plain" }, "url": { "path": [ "verifications", ":verification", "media", ":media" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "verification", "disabled": false, "description": { "content": "(Required) The verification ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "media", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "38b6b012-f107-4178-bb76-20080819b25e", "name": "The media file itself. Content-Type carries its MIME type.", "originalRequest": { "url": { "path": [ "verifications", ":verification", "media", ":media" ], "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": "83e5c1d7-13a8-43dd-b36b-12f6e51716da", "name": "Media does not belong to this verification, or is no longer available.", "originalRequest": { "url": { "path": [ "verifications", ":verification", "media", ":media" ], "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 \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b66c174-92b2-4624-a680-1c67201d553e", "name": "Validation error", "originalRequest": { "url": { "path": [ "verifications", ":verification", "media", ":media" ], "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 \"elit_\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "noauth" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Signs every request with the workspace secret key (see API authentication).", "// Canonical request: METHOD + path + (\"?\" + query, if any) + raw body.", "const rfc3986 = (value) =>", " encodeURIComponent(value).replace(/[!'()*]/g, (c) => '%' + c.charCodeAt(0).toString(16).toUpperCase());", "", "const apiKey = pm.variables.get('apiKey');", "const secretKey = pm.variables.get('secretKey');", "if (!apiKey || !secretKey) {", " throw new Error('Set the apiKey and secretKey variables of the ProofAge collection first.');", "}", "pm.request.headers.upsert({ key: 'X-API-Key', value: apiKey });", "", "const body = pm.request.body;", "if (body && body.mode === 'formdata') {", " // A media upload is signed over its fields and the SHA-256 of each file, which a", " // pre-request script cannot read: upload media with a server SDK instead.", " console.warn('ProofAge: media uploads cannot be signed from Postman.');", "} else {", " // The sandbox has no URL class: take the path of baseUrl (for example /v1) by hand.", " const basePath = pm.variables.replaceIn('{{baseUrl}}').replace(/^[a-z]+:\\/\\/[^/]+/i, '').replace(/\\/$/, '');", " const path = basePath + pm.variables.replaceIn(pm.request.url.getPath());", " const query = pm.request.url.query", " .filter((param) => !param.disabled)", " .map((param) => [pm.variables.replaceIn(param.key), pm.variables.replaceIn(param.value ?? '')])", " .sort(([a], [b]) => (a < b ? -1 : a > b ? 1 : 0))", " .map(([key, value]) => rfc3986(key) + '=' + rfc3986(value))", " .join('&');", " const raw = body && body.mode === 'raw' ? pm.variables.replaceIn(body.raw) : '';", "", " const canonical = pm.request.method + path + (query ? '?' + query : '') + raw;", " const signature = CryptoJS.HmacSHA256(canonical, secretKey).toString(CryptoJS.enc.Hex);", "", " pm.request.headers.upsert({ key: 'X-HMAC-Signature', value: signature });", "}" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://api.proofage.xyz/v1" }, { "key": "apiKey", "value": "" }, { "key": "secretKey", "value": "" } ], "info": { "_postman_id": "714e2de4-506e-4f0e-8268-47cb59bdb4d1", "name": "ProofAge API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Age and identity verification: selfie liveness, facial age estimation and ID documents from 190+ countries and territories.\n\n## Start\n\n1. Open the collection's **Variables** tab and set `apiKey` (`pk_test_\u2026`) and `secretKey` (`sk_test_\u2026`) in the **Current value** column. Both come from the [ProofAge console](https://app.proofage.xyz); a test workspace is free.\n2. Send **Workspace \u2192 Get workspace configuration**. A `200` means the keys and the request signature are right; a `401` means one of them is not.\n\nEvery request is signed by the collection's pre-request script. Media uploads are signed over the file's SHA-256, which a pre-request script cannot read, so upload media with a [server SDK](https://docs.proofage.xyz/integration/sdks).\n\n## Links\n\n- Docs: https://docs.proofage.xyz\n- This collection: https://docs.proofage.xyz/api-reference/postman\n- OpenAPI spec: https://docs.proofage.xyz/openapi.json", "type": "text/markdown" } } }