{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1852883c-57c3-4433-bb8d-b4155a9c3eac","name":"IPBee Blockchain Timestamping API","description":"## **Introduction**\n\nThe **IPBee API** provides a secure and efficient way to timestamp and certify digital documents using **multi-blockchain technology**. This ensures that records remain immutable and verifiable by third parties, such as employers, legal entities, or institutions.\n\nThe API consists of **four main commands**, each serving a specific function in the document certification process:\n\n### **1\\. Create Session (**`create-session`**) – Required Authentication**\n\n- This is the first step to interacting with the API.\n    \n- Clients must authenticate using their **API key and login name** to receive a **session token** (valid for 1 hour).\n    \n- The token is required for all subsequent requests.\n    \n\n### **2\\. Check Token (**`check-token`**) – Validate Session**\n\n- Allows clients to verify whether a given session token is still valid.\n    \n- Can be used to check associated metadata, such as expiration time and IP restrictions.\n    \n\n### **3\\. Create Process (**`create-process`**) – Start Certification**\n\n- This endpoint initiates a new **document certification process**.\n    \n- Clients can submit files **via URL, base64 encoding, or by directly providing a hash**.\n    \n- Once processed, the document receives a multi-blockchain timestamp.\n    \n\n### **4\\. Check Process (**`check-process`**) – Retrieve Status and Certificate**\n\n- Allows clients to monitor the status of a certification request.\n    \n- Once complete, it provides access to the **generated certificate** via a direct download link.\n    \n\n## **Rate Limiting & Best Practices**\n\n- **Bulk API calls are not supported** — each request must be sent individually.\n    \n- There are **no enforced delays between consecutive requests**, but it is recommended to maintain **a synchronous request flow** and introduce **a small sleep interval** between calls.\n    \n\n## Certificate Delivery Methods\n\nThe system offers multiple ways to deliver generated certificates to clients. The delivery method is determined based on the available configurations for each process.\n\n### 1\\. **Direct Certificate Link (Always Available)**\n\n- The certificate can be accessed via a direct link (`check_process` route).\n    \n- This allows users to download the PDF directly without relying on email or API delivery.\n    \n\n### 2\\. **Email Delivery (If Configured Per Process)**\n\n- If email addresses (`emails`) are provided, the system will send the PDF certificate as an attachment.\n    \n- The email includes:\n    \n    - A generic subject and body, unless client-specific customization is defined.\n        \n    - The certificate as a PDF attachment.\n        \n- The system logs delivery success or failure for each recipient.\n    \n\n### 3\\. **API Endpoint Delivery (If Configured, Available for All Processes)**\n\n- If an API endpoint (`api_endp`) is configured, the system will send:\n    \n    - **PDF Certificate** (if applicable).\n        \n    - **Status Change Notification**, including timestamps and blockchain transaction details.\n        \n- The API request is sent via `POST` with multipart form data.\n    \n- **Advantage:** The client is immediately notified of status changes.\n    \n\n### 4\\. **FTP Delivery (If Configured, Available for All Processes)**\n\n- If FTP credentials (`ftp_endp`, `ftp_user`, `ftp_pass`) are provided, the system uploads the generated PDF certificate to the specified FTP server.\n    \n- The file is named using the certificate hash (`hash.pdf`).\n    \n- A status update is logged upon successful upload.\n    \n- **Advantage:** The client can store and process the certificates in a centralized location.\n    \n\nEach process checks the available delivery methods and attempts all applicable ones. Successful deliveries update the process status, while failures are logged for further review.\n\n**Thank you for choosing the IPBee API!** We’re excited to help you bring **secure and verifiable** document certification to your workflows. If you have any questions, our team is happy to assist!","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"7769180","team":396801,"collectionId":"1852883c-57c3-4433-bb8d-b4155a9c3eac","publishedId":"SzzrYEck","public":true,"publicUrl":"https://documenter-api.postman.tech/view/7769180/SzzrYEck","privateUrl":"https://go.postman.co/documentation/7769180-1852883c-57c3-4433-bb8d-b4155a9c3eac","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.12.6","publishDate":"2020-09-01T17:41:36.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/e7fef6949bab49d4d4eba8e04ed2adc571703571b304f6a02676b9f29cdad6c5","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/SzzrYEck"}